Asynchronous Searching

Ldaptive is asynchronous at it’s core since it is built on Netty. The #execute method blocks until a result is received, however it’s possible to configure handlers to process results as they arrive.

SearchOperation search = SearchOperation.builder()
  .factory(new DefaultConnectionFactory("ldap://directory.ldaptive.org"))
  .onEntry(entry -> {
    // process the entry
    String uid = entry.getAttribute("uid").getStringValue();
    return entry;
  })
  .onResult(result -> {
    // search is complete
  })
  .build();

// non-blocking search
search.send(SearchRequest.builder()
  .dn("dc=ldaptive,dc=org")
  .filter("(&(givenName=d*)(sn=f*))")
  .returnAttributes("uid")
  .build());

If your goal is to execute non-blocking searches, also consider using one of the implementations in the concurrent package.

Search Entry Handlers

Ldaptive provides a few entry handler implementations for convenience:

CaseChangeEntryHandler

Provides the ability to modify the case of entry DNs, attribute names, and attribute values.

DnAttributeEntryHandler

Provides the ability to inject an attribute containing the entry DN into each entry. Provides a client side implementation of RFC 5020.

MergeAttributeEntryHandler

Provides the ability to merge the values of one or more attributes into a single attribute. The merged attribute may or may not already exist int the entry. If it does exist its existing values will remain intact.

RecursiveEntryHandler

Performs a recursive search based on a supplied attribute and merges the results of the recursive search into the original entry. This handler can be used to provide convenient access to nested structures like groups.