Chapter 62. Spring LDAP

The component level is the highest level. The configurations you define at this level are inherited by all the endpoints. For example, a component can have security settings, credentials for authentication, urls for network connection, and so on.

Since components typically have pre-configured defaults for the most common cases, you may need to only configure a few component options, or maybe none at all.

You can configure components with Component DSL in a configuration file (application.properties|yaml), or directly with Java code.

At the Endpoint level you have many options, which you can use to configure what you want the endpoint to do. The options are categorized according to whether the endpoint is used as a consumer (from) or as a producer (to) or used for both.

You can configure endpoints directly in the endpoint URI as path and query parameters. You can also use Endpoint DSL and DataFormat DSL as type safe ways of configuring endpoints and data formats in Java.

When configuring options, use Property Placeholders for urls, port numbers, sensitive information, and other settings.

Placeholders allows you to externalize the configuration from your code, giving you more flexible and reusable code.

The message body must have an entry with the key filter. The value must be a String representing a valid LDAP filter, see http://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol#Search_and_Compare.

The message body must have an entry with the key attributes. The value must be an instance of javax.naming.directory.Attributes This entry specifies the LDAP node to be created.

No further entries are necessary, the node with the specified dn is deleted.

The message body must have entries with the keys filter and password. The values must be an instance of String representing a valid LDAP filter and a user password, respectively.

The message body must have an entry with the key modificationItems. The value must be an instance of any array of type javax.naming.directory.ModificationItem

The message body must have entries with the keys function and request. The function value must be of type java.util.function.BiFunction<L, Q, S>. The L type parameter must be of type org.springframework.ldap.core.LdapOperations. The request value must be the same type as the Q type parameter in the function and it must encapsulate the parameters expected by the LdapTemplate method being invoked within the function. The S type parameter represents the response type as returned by the LdapTemplate method being invoked. This operation allows dynamic invocation of LdapTemplate methods that are not covered by the operations mentioned above.

Key definitions

In order to avoid spelling errors, the following constants are defined in org.apache.camel.springldap.SpringLdapProducer:

Following is an example of createMap function:

from(“direct:start”)
    .setBody(constant(createMap()))
    .to("spring-ldap:ldapTemplate?operation=BIND");

from(“direct:start”)
    .setBody(constant(createMap()))
    .to("spring-ldap:ldapTemplate?operation=BIND");

Here, createMap function returns Map object that contains information about attributes and domain name of ldap server.

private static Map<String, Object> createMap() {
    BasicAttributes basicAttributes = new BasicAttributes();
    basicAttributes.put("cn", "Name Surname");
    basicAttributes.put("sn", "Surname");
    basicAttributes.put("objectClass", "person");
    Map<String, Object> map = new HashMap<>();
    map.put(SpringLdapProducer.DN, "cn=LdapDN,dc=example,dc=org");
    map.put(SpringLdapProducer.ATTRIBUTES, basicAttributes);
    return map;
}

private static Map<String, Object> createMap() {
    BasicAttributes basicAttributes = new BasicAttributes();
    basicAttributes.put("cn", "Name Surname");
    basicAttributes.put("sn", "Surname");
    basicAttributes.put("objectClass", "person");
    Map<String, Object> map = new HashMap<>();
    map.put(SpringLdapProducer.DN, "cn=LdapDN,dc=example,dc=org");
    map.put(SpringLdapProducer.ATTRIBUTES, basicAttributes);
    return map;
}

You must also configure ldap connection using Spring Boot auto-configuration or LdapTemplate Bean for the above example.

Example for Spring Boot auto-configuration:

spring.ldap.password=passwordforldapserver
spring.ldap.urls=urlForLdapServer
spring.ldap.username=usernameForLdapServer

spring.ldap.password=passwordforldapserver
spring.ldap.urls=urlForLdapServer
spring.ldap.username=usernameForLdapServer