org.opends.server.protocols.internal
Interface InternalSearchListener

All Known Implementing Classes:

DynamicGroupSearchThread, InternalLDAPOutputStream, ReplicationBroker

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=true,
           mayInvoke=false)
public interface InternalSearchListener

This interface defines the methods that must be implemented by a class that wishes to perform an internal search operation and be notified of matching entries and referrals as they arrive rather than altogether when the search has completed.

Method Summary

void	handleInternalSearchEntry(InternalSearchOperation searchOperation, SearchResultEntry searchEntry) Performs any processing necessary for the provided search result entry.
void	handleInternalSearchReference(InternalSearchOperation searchOperation, SearchResultReference searchReference) Performs any processing necessary for the provided search result reference.

Method Detail

handleInternalSearchEntry

void handleInternalSearchEntry(InternalSearchOperation searchOperation,
                               SearchResultEntry searchEntry)
                               throws DirectoryException

Performs any processing necessary for the provided search result entry.

Parameters:

searchOperation - The internal search operation being processed.

searchEntry - The matching search result entry to be processed.

Throws:

DirectoryException - If a problem occurred while handling the provided entry. Search processing will be terminated, and the search operation will result will be set based on this exception.

handleInternalSearchReference

void handleInternalSearchReference(InternalSearchOperation searchOperation,
                                   SearchResultReference searchReference)
                                   throws DirectoryException

Performs any processing necessary for the provided search result reference.

Parameters:

searchOperation - The internal search operation being processed.

searchReference - The search result reference to be processed.

Throws:

DirectoryException - If a problem occurred while handling the provided entry. Search processing will be terminated, and the search operation will result will be set based on this exception.