org.forgerock.opendj.ldap

Interface SearchResultHandler

public interface SearchResultHandler

A completion handler for consuming the results of a Search operation.

Connection and Connection objects allow a search result completion handler to be specified when sending Search operation requests to a Directory Server. The handleEntry(org.forgerock.opendj.ldap.messages.SearchResultEntry) method is invoked each time a Search Result Entry is returned from the Directory Server. The handleReference(org.forgerock.opendj.ldap.messages.SearchResultReference) method is invoked for each Search Result Reference returned from the Directory Server.

Implementations of these methods should complete in a timely manner so as to avoid keeping the invoking thread from dispatching to other completion handlers.

Method Summary

Modifier and Type	Method and Description
boolean	handleEntry(SearchResultEntry entry) Invoked each time a search result entry is returned from an asynchronous search operation.
boolean	handleReference(SearchResultReference reference) Invoked each time a search result reference is returned from an asynchronous search operation.

Method Detail

handleEntry

boolean handleEntry(SearchResultEntry entry)

Invoked each time a search result entry is returned from an asynchronous search operation.

Parameters:

entry - The search result entry.

Returns:

true if this handler should continue to be notified of any remaining entries and references, or false if the remaining entries and references should be skipped for some reason (e.g. a client side size limit has been reached).

handleReference

boolean handleReference(SearchResultReference reference)

Invoked each time a search result reference is returned from an asynchronous search operation.

Parameters:

reference - The search result reference.

Returns:

true if this handler should continue to be notified of any remaining entries and references, or false if the remaining entries and references should be skipped for some reason (e.g. a client side size limit has been reached).