LDAP library for Java.

Ldaptive is a simple, extensible Java API for interacting with LDAP servers. It was designed to provide easy LDAP integration for application developers.

Features

Netty based asynchronous networking
Reactive API
Connection pooling
Authentication API with support for password policy
JAAS modules for authentication and authorization
SSL/startTLS support with easy configuration of trust and key material
Input/output of LDIF
Supported controls:
- Authorization Identity (RFC 3829)
- Content Synchronization (RFC 4533)
- Entry Change Notification (draft-ietf-ldapext-psearch-03)
- ManageDsaIT (RFC 3296)
- Matched Values (RFC 3876)
- Paged Results (RFC 2696)
- Password Policy (draft-behera-ldap-password-policy-10 and draft-vchu-ldap-pwd-policy-00)
- Persistent Search (draft-ietf-ldapext-psearch-03)
- Proxy Authorization (RFC 4370)
- Server Side Sorting (RFC 2891)
- Session Tracking (draft-wahl-ldap-session-03)
- Tree Delete (draft-armijo-ldap-treedelete)
- Virtual List View (draft-ietf-ldapext-ldapv3-vlv-09)

Quick Start Guide

Searching

SearchOperation search = new SearchOperation(
  new DefaultConnectionFactory("ldap://directory.ldaptive.org"), "dc=ldaptive,dc=org");
SearchResponse response = search.execute("(uid=dfisher)");
LdapEntry entry = response.getEntry();
// do something useful with the entry

StartTLS

SearchOperation search = new SearchOperation(
  DefaultConnectionFactory.builder()
    .config(ConnectionConfig.builder()
      .url("ldap://directory.ldaptive.org")
      .useStartTLS(true)
      .build())
    .build(),
    "dc=ldaptive,dc=org");
SearchResponse response = search.execute("(uid=*fisher)", "mail", "sn");
for (LdapEntry entry : response.getEntries()) {
  // do something useful with the entry
}

Binding

SearchOperation search = new SearchOperation(
  DefaultConnectionFactory.builder()
    .config(ConnectionConfig.builder()
      .url("ldap://directory.ldaptive.org")
      .useStartTLS(true)
      .connectionInitializers(BindConnectionInitializer.builder()
        .dn("cn=manager,ou=people,dc=ldaptive,dc=org")
        .credential("manager_password")
        .build())
      .build())
    .build(),
  "dc=ldaptive,dc=org");
SearchResponse response = search.execute("(uid=*fisher)", "mail", "sn");
for (LdapEntry entry : response.getEntries()) {
  // do something useful with the entry
}

These search examples all leverage the SearchOperation class. For more details on searching and more control over the search operation in general, see the search operation documentation.

Authentication

ConnectionConfig connConfig = ConnectionConfig.builder()
  .url("ldap://directory.ldaptive.org")
  .useStartTLS(true)
  .build();

SearchDnResolver dnResolver = SearchDnResolver.builder()
  .factory(new DefaultConnectionFactory(connConfig))
  .dn("ou=people,dc=ldaptive,dc=org")
  .filter("uid={user}")
  .build();

SimpleBindAuthenticationHandler authHandler = new SimpleBindAuthenticationHandler(new DefaultConnectionFactory(connConfig));
Authenticator auth = new Authenticator(dnResolver, authHandler);
AuthenticationResponse response = auth.authenticate(new AuthenticationRequest("dfisher", new Credential("password")));
if (response.isSuccess()) {
  // authentication succeeded
} else {
  // authentication failed
}

For more details on authentication, see the authentication documentation.

What changed between v1 and v2?

Ldaptive is no longer a wrapper API around other Java libraries. It now includes it’s own LDAP protocol implementation.
The try-finally paradigm used for connection management has been removed. All operations use a connection factory and implement that pattern internally.
Most classes now include static builders.
The SearchExecutor functionality is now included in SearchOperation, that class has been removed.
SortBehavior has been removed in favor of providing static sort methods on individual classes.
Search result cache implementations have been removed. It’s trivial for application to do their own caching.
Transcoders have been moved to the transcode package.
SearchFilter has been renamed FilterTemplate.
Exceptions occur for I/O or configuration related problems, not LDAP server messages. To configure exception behavior see setThrowCondition on operations and throwIf on handles.