<ldap-search>
Performs the specified search within an LDAP data source and iterates over the results, performing SUBTASKS once for each entry.
Cernunnos' LDAP features are based off of Spring LDAP. Spring LDAP is a Java library for simplifying LDAP operations, based on the pattern of Spring's JdbcTemplate.
| Name | XPath | Description | Reagent Type | Expected Type | Required |
|---|---|---|---|---|---|
| ATTRIBUTE_NAME | @attribute-name | Optional name under which each search result will be registered as a request attribute. If omitted, the name 'Attributes.OBJECT' will be used. | PHRASE | java.lang.String | No |
| CONTEXT_SOURCE | @context-source | Spring-LDAP ContextSource object to use for executing the LDAP search. If omitted the request attribute under the name 'LdapAttributes.CONTEXT_SOURCE' will be used. | PHRASE | org.springframework.ldap.core.ContextSource | No |
| BASE_DN | @base-dn | Optional base DN from which the search will begin. The default is null. | PHRASE | java.lang.String | No |
| FILTER | @filter | The filter (query) to use in the search. | PHRASE | java.lang.String | Yes |
| SCOPE | @scope | Either SearchControls.OBJECT_SCOPE, SearchControls.ONELEVEL_SCOPE, or SearchControls.SUBTREE_SCOPE. SearchControls is provided by the JDK in the 'javax.naming.directory' package. The default is SearchControls.ONELEVEL_SCOPE. | PHRASE | java.lang.Integer | No |
| LIMIT | @limit | The maximum number of entries to return from the search. If 0 (zero) is specified, the search will return all entries that satisfy FILTER. The default is 0 (zero). | PHRASE | java.lang.String | No |
| TIMEOUT | @timeout | The number of milliseconds to wait before returning. If 0 (zero) is specified, this task will wait indefinitely. The default is 0 (zero). | PHRASE | java.lang.String | No |
| ATTRIBUTES | attribute/text() | The identifiers of the attributes to return along with the entry. If null, all attributes will be returned; If empty, no attributes will be returned. The default is null (all attributes). | NODE_LIST | java.util.List | No |
| RETURN_OBJECT | @return-object | Return the object bound to the entry name if true; otherwise, return only the name and class of the object. The default is Boolean.FALSE. | PHRASE | java.lang.Boolean | No |
| DEREFERENCE_LINKS | @dereference-links | If true, dereference links during search. The default is Boolean.FALSE. | PHRASE | java.lang.Boolean | No |
| MAPPER_TYPE | @mapper-type | The type of LDAP mapper to use. Possible values include 'attribute' or 'context'.The default is (attribute). | PHRASE | java.lang.String | No |
| ATTRIBUTES_MAPPER | @attributes-mapper | Interface defined by Spring LDAP for mapping LDAP Attributes to beans. The default ATTRIBUTES_MAPPER simply returns an instance of javax.naming.directory.Attributes. | PHRASE | org.springframework.ldap.core.AttributesMapper | No |
| CONTEXT_MAPPER | @context-mapper | Interface defined by Spring LDAP for mapping LDAP Context to bean. The default CONTEXT_MAPPER simply returns an instance of javax.naming.directory.Context. | PHRASE | org.springframework.ldap.core.ContextMapper | No |
| SUBTASKS | * | The set of tasks that are children of this task. | NODE_LIST | java.util.List | No |