Each request that must be handled by the LDAP Access Service requires specific types of input data. A collection of data used by these requests has been created and collected into a toolkit context. Users of this service do not access this context directly, however the names of the data entries in this context correspond to ones that the user would use in defining mappings for output data from the LDAP Access Service.
Data Name | Data Type | Used By | Description |
---|---|---|---|
simpleName | field | all requests | Used to hold an LDAP name or suffix (not dynamic). |
filter | field | search | Used to specify a simple filter. |
filterExpression | field | search | Used to specify a filter expression. |
filterType | field | search | Used to indicate what type of filter will be used for this search. |
maxHits | field | search | Used to indicate the number of search results to return. |
followReferencesFlag | field | search | Used to specify whether LDAP should follow references. |
returnObjectFlag | field | search | Used to indicate whether LDAP should return objects along with search result data. |
searchScope | field | search | Used to specify the scope of the search. |
timeLimit | field | search | Used to specify the maximum time to carry out a search request. |
dynamicName | kColl | all requests | Contains data elements used to build an LDAP name dynamically. |
filterList | kColl | search | Used to hold a list of filter objects for dynamically building up a filter. (Used in conjunction with filterExpression.) |
attributeFilterList | kColl | search, getattributes | Used to specify what subset of attributes should be returned by these requests. |
attributeList | kColl | search, create | Used by the search request to build up a filter. Used by the create request to specify what attributes to associate with the newly created data entry. |
modificationList | kColl | modify | Used to specify a set of attributes and modification codes, for the modify request. |
<kColl id="ldapInData" dynamic="true"> <!-- field level definitions--> <field id="simpleName"/> <field id="filter"/> <field id="filterExpression"/> <field id="filterType"/> <field id="maxHits"/> <field id="followReferencesFlag"/> <field id="returnObjectFlag"/> <field id="searchScope"/> <field id="timeLimit"/> <field id="useFilter"/> <!-- collections--> <kColl id="dynamicName" dynamic="true"></kColl> <kColl id="filterList" dynamic="true"></kColl> <iColl id="attributeFilterList" dynamic="true"></iColl> <kColl id="attributeList" dynamic="true"></kColl> <kColl id="modificationList" dynamic="true"></kColl> </kColl> <context id="ldapInCtx" type="operation" parent="nil"> <refKColl refId="ldapInData"> </refKColl> </context>
Data Name | Data Type | Used By | Short Description |
---|---|---|---|
listResults | kColl | list | Holds data returned by the list request. |
listBindingsResults | kColl | listbindings | Holds data returned by the listbindings request. |
lookupResults | kColl | lookup | Holds data returned by the lookup request. |
searchResults | kColl | search | Holds data returned by the search request. |
getAttributesResults | kColl | getattributes | Holds data returned by the getattributes request. |
The output data collections contain data mapped from 'native' LDAP objects. The following section describes the contents of each of these collections.
listResults
listResults.0.name
listResults.name
listBindingsResults
listBindingsResults.0.object
listBindingsResults.object
lookupResults
lookupResults.object
searchResults
searchResults.0.className
searchResults.0.cn
getAttributesResults
getAttributesResults.telephonenumber.0
<kColl id="ldapOutData" dynamic="true"> <kColl id="listResults" dynamic="true"></kColl> <kColl id="listBindingsResults" dynamic="true"></kColl> <kColl id="lookupResults" dynamic="true"></kColl> <kColl id="searchResults" dynamic="true"></kColl> <kColl id="getAttributesResults" dynamic="true"></kColl> </kColl> <context id="ldapOutCtx" type="operation" parent="nil"> <refKColl refId="ldapOutData"> </refKColl> </context>