blob: a5642ba7f478e2a8f191b55ae0574421e08421af [file] [log] [blame]
{
"class" : "org.eclipse.smila.security.processing.SampleSecurityConverterPipelet",
"parameters": [
{
"name": "readUsersAttributeName",
"type": "string",
"description": "Name of the attribute to store the users with READ access rights to. This attribute can then be indexed, e.g. by Solr."
},
{
"name": "resolveGroups",
"type": "boolean",
"optional": true,
"description": "Boolean flag determining whether groups should be resolved to their user principals (true) or not (false). Default is false."
},
{
"name": "resolveUserNames",
"type": "boolean",
"optional": true,
"description": "Boolean flag determining whether user names should be resolved and replaced by the value described by resolvedUserNamePropertyName (true) or not (false). Default is false."
},
{
"name": "resolvedUserNamePropertyName",
"type": "string",
"optional": true,
"description": "Name of an LDAP property to use instead of the user/group principal (e.g. a display name). Only used if resolveUserNames is set to true."
}
],
"description": "This is a sample pipelet that gets and converts security information into record's metadata to allow indexing (e.g. in Solr), a filter used in a query to restrict the results to the users that have READ access. The pipelet uses the service a org.eclipse.smila.security.SecurityResolver, which is used to resolve groups and user names. If no SecurityResolver is available the configuration options are ignored and the security information already contained in the record is just added to the specified readUsersAttributeName. (see below)."
}