LDAPConnector

This is a Map instance holding extended configuration attributes that will be used in the Context environment.

The string representation of an integer that represents the number of connections per connection identity to create when initially creating a connection for the identity. To disable pooling, just set this value to 0 (zero).

The string representation of an integer that represents the maximum number of connections per connection identity that can be maintained concurrently.

The string representation of an integer that represents the number of milliseconds that an idle connection may remain in the pool without being closed and removed from the pool.

Constant that holds the name of the environment property for specifying how referrals encountered by the service provider are to be processed (follow, ignore, throw).

The implementation of the connection to be used.

The connection URL to the LDAP server with the following syntax: ldap[s]://hostname:port/base_dn.

Creates a new LDAPEntry in the LDAP server. The entry should contain the distinguished name (DN), the objectClass attributes that define its structure and at least a value for all the required attributes (required attributes depend on the object classes assigned to the entry. You can refer to RFC 4519 for standard object classes and attributes.

LDAPEntry object provided with expression

LDAPEntry object provided in payload

Creates a new entry in the LDAP server from a Map representation. The distinguished name (DN) of the entry is first obtained from the optional parameter dn and if this value is blank (null, empty string or string with only space chars) then the DN should be a present in the entry map as a String value under the key "dn" (see MAP_DN_KEY).

In order to represent a LDAP entry as a map, you should consider the following rules for the map key/value pair:

• Single Value Attributes: The key should be the name of the single value attribute (for example uid, cn, ...) as a String and the value is just the value of the attribute (most of the times represented by a String.
• Multi-value Attributes: The key should be the name of the multiple values attribute (for example objectClass, memberOf, mail, ...) as a String and the value should be a List holding the multiple values of the attribute. Usually it will be a list of strings.
• Distinguished name: As an alternative to passing the DN as a separate argument of the operation, you can include it in the entry map. In this case, the key should be the string "dn" (see MAP_DN_KEY) and the value a String representing the distinguished name (for example cn=andy,ou=people,dc=mulesoft,dc=org).

The map is provided as a reference and the DN is not in the map

The map is created in the XML file and the DN is another map entry

The map is provided in the payload and the DN is another map entry

Adds all the values for an attribute in an existing LDAP entry. If the entry already contained a value (or values) for the given attributeName then these values will be added. The attribute should allow multiple values or an exception will be raised.

Adds a value for an attribute in an existing LDAP entry. If the entry already contained a value for the given attributeName then this value will be added (only if the attribute is multi value and there entry didn't have the value already).

If you want to add a value with a type different than String, then you can use the add-multi-value-attribute operation and define a one element list with the value.

Performs an LDAP bind (login) operation. After login there will be a LDAP connection pool ready to use for other operations using the authenticated user. If no values are provided to override authDn and authPassword then using this operation will just re-bind (re-authenticate) the user/password defined in the config element. If new values are provided for authDn and authPassword, then authentication will be performed.

Re-authenticating and returning the LDAP entry using config level credentials (authDn & authPassword)

Authenticating and returning the LDAP entry using new credentials (authDn & authPassword)

Authenticating as anonymous user (returns always null)

Authenticating and returning the LDAP entry using credentials (authDn & authPassword) from Mule Expression

Establish the connection to the LDAP server and use connection management to handle different users.

Returns the connection ID

Deletes the LDAP entry represented by the provided distinguished name. The entry should not have child entries, in which case a ContextNotEmptyException is thrown.

This operation is idempotent. It succeeds even if the terminal atomic name is not bound in the target context, but throws NameNotFoundException if any of the intermediate contexts do not exist.

Deletes all the values matching attributeValues of the attribute defined by attributeName. Values that are not present in the entry are ignored. If no values are specified, then the whole attribute is deleted from the entry.

Deletes the value matching attributeValue of the attribute defined by attributeName. If the entry didn't have the value, then the entry stays the same. If no value is specified, then the whole attribute is deleted from the entry.

If you want to delete a value with a type different than String, then you can use the delete-multi-value-attribute operation and define a one element list with the value.

Disconnect the current connection

Are we connected?

Transforms a LDAPEntry to a String in LDIF representation (RFC 2849).

Creates the Map representation of an LDAPEntry.

The resulting map has the name of the attributes as String keys and the values for these keys are:

• Distinguished name: The DN is the value of the special string key "dn" (see MAP_DN_KEY).
• Single Value Attributes: The value is an Object (most of the cases a String and in some cases, like userPassword, a byte[]).
• Multi-value Attributes: The value is a List containing all the values for the attribute (most of the cases a String and in some cases, like userPassword, a byte[]).

Retrieves an entry from the LDAP server base on its distinguished name (DN). DNs are the unique identifiers of an LDAP entry, so this method will perform a search based on this ID and so return a single entry as result or throw an exception if the DN is invalid or inexistent.

Use this operation over searchOne(String, String, List, SearchScope, int, long, boolean) when you know the DN of the object you want to retrieve.

Lookup returning all attributes for the entry

Lookup returning the attributes in the list obtained by expression

Lookup returning the attributes defined in the XML config file

Creates a LDAPEntry from its Map representation. This transformer won't check that the entry is valid. The only validation that is performed is the presence of the distinguished name.

In order to represent a LDAP entry as a map, you should consider the following rules for the map key/value pair:

• Distinguished name: The map should have a special attribute for the distinguish name. In this case, the key should be the string "dn" (see MAP_DN_KEY) and the value a String representing the distinguished name (for example cn=andy,ou=people,dc=mulesoft,dc=org).
• Single Value Attributes: The key should be the name of the single value attribute (for example uid, cn, ...) as a String and the value is just the value of the attribute (most of the times represented by a String.
• Multi-value Attributes: The key should be the name of the multiple values attribute (for example objectClass, memberOf, mail, ...) as a String and the value should be a List holding the multiple values of the attribute. Usually it will be a list of strings.

Updates an existing LDAPEntry in the LDAP server. The entry should contain an existing distinguished name (DN), the objectClass attributes that define its structure and at least a value for all the required attributes (required attributes depend on the object classes assigned to the entry. You can refer to RFC 4519 for standard object classes and attributes.

When updating a LDAP entry, only the attributes in the entry passed as parameter are updated or added. If you need to delete an attribute, you should use the delete attribute operation.

Example: Updating one attributes and adding one.

Original LDAP server entry:
dn: cn=entry,ou=group,dc=company,dc=org
cn: entry
attr1: Value1
attr2: Value2
multi1: Value3
multi1: Value4
objectclass: top
objectclass: myentry

Entry map passed as parameter:
dn: cn=entry,ou=group,dc=company,dc=org
attr1: NewValue
attr3: NewAttributeValue

Resulting LDAP server entry:
dn: cn=entry,ou=group,dc=company,dc=org
cn: entry
attr1: NewValue
attr2: Value2
multi1: Value3
multi1: Value4
attr3: NewAttributeValue
objectclass: top
objectclass: myentry

The LDAP entry is in the payload

The LDAP entry is in a session variable

Updates an existing entry in the LDAP server from a Map representation. The distinguished name (DN) of the entry is first obtained from the optional parameter dn and if this value is blank (null, empty string or string with only space chars) then the DN should be a present in the entry map as a String value under the key "dn" (see MAP_DN_KEY).

When updating a LDAP entry, only the attributes in the entry passed as parameter are updated or added. If you need to delete an attribute, you should use the delete attribute operation.

Example: Updating one attributes and adding one.

Original LDAP server entry:
dn: cn=entry,ou=group,dc=company,dc=org
cn: entry
attr1: Value1
attr2: Value2
multi1: Value3
multi1: Value4
objectclass: top
objectclass: myentry

Entry map passed as parameter:
dn: cn=entry,ou=group,dc=company,dc=org
attr1: NewValue
attr3: NewAttributeValue

Resulting LDAP server entry:
dn: cn=entry,ou=group,dc=company,dc=org
cn: entry
attr1: NewValue
attr2: Value2
multi1: Value3
multi1: Value4
attr3: NewAttributeValue
objectclass: top
objectclass: myentry

In order to represent a LDAP entry as a map, you should consider the following rules for the map key/value pair:

• Single Value Attributes: The key should be the name of the single value attribute (for example uid, cn, ...) as a String and the value is just the value of the attribute (most of the times represented by a String.
• Multi-value Attributes: The key should be the name of the multiple values attribute (for example objectClass, memberOf, mail, ...) as a String and the value should be a List holding the multiple values of the attribute. Usually it will be a list of strings.
• Distinguished name: As an alternative to passing the DN as a separate argument of the operation, you can include it in the entry map. In this case, the key should be the string "dn" (see MAP_DN_KEY) and the value a String representing the distinguished name (for example cn=andy,ou=people,dc=mulesoft,dc=org).

The map is provided as a reference and the DN is not in the map

The map is created in the XML file and the DN is another map entry

The map is provided in the payload and the DN is another map entry

Updates (replaces) the value or values of the attribute defined by attributeName with the new values defined by attributeValues. If the attribute was not present in the entry, then the value is added.

Updates (replaces) the value or values of the attribute defined by attributeName with the new value defined by attributeValue. If the attribute was not present in the entry, then the value is added.

If you want to update a value with a type different than String, then you can use the update-multi-value-attribute operation and define a one element list with the value.

Performs a LDAP search and streams result to the rest of the flow. This means that instead of returning a list with all results it partitions the LDAP search result into pages (individual entry if resultPageSize is 1) or lists of size resultPageSize.

For queries returning large results it is recommended to use pagination (not all LDAP servers support this or are configured to support it). For that you need to provide a page size value that should be less or equal than max results (count limit). If you are getting a Size Limit Exceeded exception message then you should check that the authenticated user has enough privileges or the LDAP server is not limited by configuration.

Returning all persons one LDAP entry at a time

Returning all persons in lists of 100 LDAP entries

Renames and existing LDAP entry (moves and entry from a DN to another one).

Performs a LDAP search returning a list with all the resulting LDAP entries.

For queries returning large results it is recommended to use pagination (not all LDAP servers support this or are configured to support it). For that you need to provide a page size value that should be less or equal than max results (count limit). If you are getting a Sizelimit Exceeded exception then you should check that the authenticated user has enough privileges or the LDAP server is not limited by configuration.

Returning all attributes for all persons that have Doe as surname

Returning username and fullname for the first 100 person entries

Search that receives all configuration attributes using Mule Expressions

Performs a LDAP search that is supposed to return a unique result. If the search returns more than one result, then a warn log message is generated and the first element of the result is returned.

Use this operation over lookup(String, List) when you know don't know the DN of the entry you need to retrieve but you have a set of attributes that you know should return a single entry (for example an email address)