Runtime components : Service components : LDAP Access Service : Reference : LDAP format definitions
  
LDAP format definitions
The LDAPRequestFormat and LDAPResponseFormat classes support externalization of input and output data, respectively, for the LDAP Access Service. These formatters utilize a MapFormat to translate data from toolkit contexts to the LDAP Access Service, and from the LDAP Access Service back into the contexts. The complete externalized forms of the LDAPRequestFormat, LDAPResponseFormat, and MapFormat are shown below. Italicized type is used to denote variable names that the user defines. Bold type is used to indicate names that must appear exactly as shown.
See also
Externalized structure for MapFormat
Externalized structure for LDAPRequestFormat
Externalized structure for LDAPResponseFormat
Reference
Externalized structure for MapFormat
<map id="name" source="sourceCtx" target="targetCtx"
sourcePrefix=" aPrefix" targetPrefix="aPrefix">
<!-- one or more of the following mappings-->
<mapping source="source" target="target" value="value"/>
<!-- or one or more of the following modification mappings-->
<mod source="source" target="target" value="value" modcode="code"/>
</map>
A map tag may contain mapping subtags, OR mod subtags, but not both.
See also
LDAP format definitions
Externalized structure for LDAPRequestFormat
<fmtDef id="aFormatDefinition">
<ldapRequest id="anLdapRequestFormat"
requestType="request" filterType="type">
<map id="dynamicName" source="sourceCtx"
target="ldapInCtx">
</map>
<map id="filterList" source="sourceCtx"
target="ldapInCtx">
</map>
<map id="modificationList" source="sourceCtx"
target="ldapInCtx">
</map>
<map id="attributeList" source="sourceCtx"
target="ldapInCtx">
</map>
</ldapRequest>
</fmtDef>
For the LDAPRequestFormat, a dynamicName map will almost always be required. The filterList map is used in search requests. The modificationList map is used in modify requests. The attributeList map is used by both search and create requests.
See also
LDAP format definitions
Externalized structure for LDAPResponseFormat
<fmtDef id="aFormatDefinition">
<ldapResponse id="anLdapResponseFormat"
responseType="response">
<map source="ldapOutCtx" target="targetCtx">
</map>
</ldapResponse>
</fmtDef>
The tags that make up these formats, their attributes and the acceptable values for these attributes, are further described in the table below.
LDAP format attributes
ldapRequest
requestType - A required attribute that should be one of the following values:
▪ list
▪ listbindings
▪ lookup
▪ search
▪ create
▪ destroy
▪ modify
▪ getattributes
▪ filterType - An optional attribute that should be one of the following values:
value
expression
attributes
ldapResponse
responseType - A required attribute that should be one of the following values:
▪ list
▪ listbindings
▪ lookup
▪ search
▪ create
▪ destroy
▪ modify
▪ getattributes
map
sourceContext - A required attribute that contains the name of a valid toolkit context to be used as the source of data.
targetContext - A required attribute that contains the name of a valid toolkit context that will be filled with data.
sourcePrefix - An optional attribute that contains a string value to be appended to the source data names.
sourcePrefix - An optional attribute that contains a string value to be appended to the source data names.
mapping
source - A required attribute that specifies a valid data name from the source context (see the map tag).
target - A required attribute that specifies a valid data name from the target context (see the map tag).
value - The default value for the target.
mod
source - A required attribute that specifies a valid data name from the source context (see the map tag).
target - A required attribute that specifies a valid data name from the target context (see the map tag).
value - The default value for the target.
modcode - A required attribute that is one of the following values:
add
remove
replace
See also
LDAP format definitions