LDAPWriter
We assume that you have already learned what is described in:
If you want to find the right Writer for your purposes, see Writers Comparison.
Short Summary
LDAPWriter writes information to an LDAP directory.
| Component | Data output | Input ports | Output ports | Transformation | Transf. required | Java | CTL |
|---|---|---|---|---|---|---|---|
| LDAPWriter | LDAP directory tree | 1 | 0-1 | no | no | no | no |
Abstract
LDAPWriter writes information to an LDAP directory. It provides the logic to update information on an LDAP directory. An update can be add/delete entries, add/replace/remove attributes. Metadata must match LDAP object attribute name. "DN" metadata attribute is required.
String, byte and cbyte are the only metadata types supported. Most of
the LDAP types are compatible with clover string, however, for
instance, the userPassword LDAP type is necessary
to populate from byte data field. LDAP rules are applied : to add an
entry, required attributes (even object class) are required in
metadata.
![[Note]](figures/note.png) | Note |
|---|---|
LDAP attribute may be multivalued. The default value separator is "|" and is reasonable only for string data fields. |
Icon
Ports
| Port type | Number | Required | Description | Metadata |
|---|---|---|---|---|
| Input | 1 | yes | For correct data records | Any1) |
| Output | 0-1 | no | For rejected records | Input 0 |
Legend:
1): Metadata on the input must precisely match the LDAP object attribute name. The Distinguished Name metadata attribute is required. As the LDAP attributes are multivalued, their values can be separated by pipe or specified separator. String and byte are the only metadata types supported.
LDAPWriter Attributes
| Attribute | Req | Description | Possible values |
|---|---|---|---|
| Basic | |||
| LDAP URL | yes | LDAP URL of the directory. Can be a list of URLs separated by pipe. | pattern: ldap://host:port/ |
| Action | Defines the action to be performed with the entry. | replace_attributes (default) | add_entry | remove_entry | remove_attributes | |
| User | User DN to be used when connecting to the LDAP
directory. Similar to the following:
cn=john.smith,dc=example,dc=com. | ||
| Password | Password to be used when connecting to the LDAP directory. | ||
| Advanced | |||
| Multi-value separator | LDAPWriter can handle keys with multiple values. These are delimited by this string or character. <none> is special escape value which turns off this functionality, then only first value is written. This attribute can only be used for string data type. When byte type is used, first value is the only one that is written. | "|" (default) | other character or string | |