About OpenDJ LDAP SDK

The OpenDJ LDAP SDK provides a set of modern, developer-friendly Java APIs as part of the OpenDJ product suite. The product suite includes the client SDK alongside command-line tools and sample code, a 100% pure Java directory server, and more. You can use OpenDJ SDK to create client applications for use with any server that complies with the, RFC 4510: Lightweight Directory Access Protocol (LDAP): Technical Specification Road Map.

The OpenDJ LDAP SDK brings you easy-to-use connection management, connection pooling, load balancing, and all the standard LDAP operations to read and write directory entries. OpenDJ LDAP SDK also lets you build applications with capabilities defined in additional draft and experimental RFCs that are supported by modern LDAP servers.

Documentation for OpenDJ SDK

Javadoc for this module can be found here. Read the developer guide for a deeper understanding of LDAP application development, as well as a detailed over of LDAP itself.

Get the OpenDJ LDAP SDK

You can start developing your LDAP applications now by obtaining the OpenDJ LDAP SDK using any of the following methods:

Maven

By far the simplest method is to develop your application using Maven and add the following settings to your pom.xml:

<repositories>
  <repository>
    <id>forgerock-staging-repository</id>
    <name>ForgeRock Release Repository</name>
    <url>http://maven.forgerock.org/repo/releases</url>
    <snapshots>
      <enabled>false</enabled>
    </snapshots>
  </repository>
  <repository>
    <id>forgerock-snapshots-repository</id>
    <name>ForgeRock Snapshot Repository</name>
    <url>http://maven.forgerock.org/repo/snapshots</url>
    <releases>
      <enabled>false</enabled>
    </releases>
  </repository>
</repositories>

The following dependency will load both the OpenDJ Core APIs and the OpenDJ Grizzly network transport:

<dependencies>
  <dependency>
    <groupId>org.forgerock.opendj</groupId>
    <artifactId>opendj-ldap-sdk</artifactId>
    <version>3.0.0-SNAPSHOT</version>
    <type>pom</type>
  </dependency>
</dependencies>

In some use-cases, such as developing LDAP unit tests or embedded LDAP applications, the network transport is not required, in which case you can simply declare a dependency on the OpenDJ core APIs:

<dependencies>
  <dependency>
    <groupId>org.forgerock.opendj</groupId>
    <artifactId>opendj-core</artifactId>
    <version>3.0.0-SNAPSHOT</version>
  </dependency>
</dependencies>

Download

If you are not using Maven then you will need to download a pre-built binary from the ForgeRock Maven repository, along with any compile time dependencies:

Build

For the DIY enthusiasts you can build it yourself by checking out the latest code using Subversion and building it with Maven 3.

Getting started

The following example shows how the OpenDJ SDK may be used to connect to a Directory Server, authenticate, and then perform a search. The search results are output as LDIF to the standard output:

// Create an LDIF writer which will write the search results to stdout.
final LDIFEntryWriter writer = new LDIFEntryWriter(System.out);
Connection connection = null;
try
{
  // Connect and bind to the server.
  final LDAPConnectionFactory factory = new LDAPConnectionFactory("localhost", 1389);

  connection = factory.getConnection();
  connection.bind(userName, password);

  // Read the entries and output them as LDIF.
  final ConnectionEntryReader reader = connection.search(baseDN, scope, filter, attributes);
  while (reader.hasNext())
  {
    if (reader.isEntry())
    {
      // Got an entry.
      final SearchResultEntry entry = reader.readEntry();
      writer.writeComment("Search result entry: " + entry.getName().toString());
      writer.writeEntry(entry);
    }
    else
    {
      // Got a continuation reference.
      final SearchResultReference ref = reader.readReference();
      writer.writeComment("Search result reference: " + ref.getURIs().toString());
    }
  }
  writer.flush();
}
catch (final Exception e)
{
  // Handle exceptions...
  System.err.println(e.getMessage());
}
finally
{
  if (connection != null)
  {
    connection.close();
  }
}

You can find more examples in the OpenDJ LDAP SDK Examples module.