com.unboundid.ldap.sdk

Interface SearchResultListener

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

AsyncSearchResultListener

All Known Implementing Classes:

BasicAsyncSearchResultListener, IdentifyReferencesToMissingEntries, IdentifyUniqueAttributeConflicts, LDAPEntrySource, LDAPSearch, LDAPSearchResults

@Extensible
 @ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface SearchResultListener
extends java.io.Serializable

This interface defines a set of methods that provide search result entries and references to a requester as they are returned from the server. It provides a memory-efficient mechanism for dealing with searches that match a large number of entries, as well as more timely processing for those that take a long time to complete and return entries sporadically over the duration of the search.

The LDAPEntrySource class implements this interface and may be used to provide access to the search results in an Iterator-like manner.

Method Summary

Modifier and Type	Method and Description
void	searchEntryReturned(SearchResultEntry searchEntry) Indicates that the provided search result entry has been returned by the server and may be processed by this search result listener.
void	searchReferenceReturned(SearchResultReference searchReference) Indicates that the provided search result reference has been returned by the server and may be processed by this search result listener.

Method Detail

searchEntryReturned

void searchEntryReturned(@NotNull
                         SearchResultEntry searchEntry)

Indicates that the provided search result entry has been returned by the server and may be processed by this search result listener.

Parameters:

searchEntry - The search result entry that has been returned by the server.

searchReferenceReturned

void searchReferenceReturned(@NotNull
                             SearchResultReference searchReference)

Indicates that the provided search result reference has been returned by the server and may be processed by this search result listener.

Parameters:

searchReference - The search result reference that has been returned by the server.