oracle.oud.plugin

Class DefaultSearchResultHandler

java.lang.Object

oracle.oud.plugin.DefaultSearchResultHandler

All Implemented Interfaces:

ResultHandler, SearchResultHandler

public class DefaultSearchResultHandler
extends java.lang.Object
implements SearchResultHandler

This class defines a search result handler wrapper that forwards all calls to the provided search result handler.

This class is provided for convenience only. Override the appropriate handle...() method to intercept the appropriate result.

Constructor Summary

Constructors

Constructor and Description
DefaultSearchResultHandler(SearchResultHandler resultHandler) Construct a new instance of this class.

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.
void	handleErrorResult(Result error) Invoked when the operation has failed.
boolean	handleReference(DN dn, SearchResultReference reference) Invoked each time a search result reference is returned from an asynchronous search operation.
void	handleResult(Result result) Invoked when the operation has completed successfully.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.oud.responses.ResultHandler

handleErrorResult, handleResult

Constructor Detail

DefaultSearchResultHandler

public DefaultSearchResultHandler(SearchResultHandler resultHandler)

Construct a new instance of this class.

Parameters:

resultHandler - the handler that will receive all calls defined by the SearchResultHandler interface.

Method Detail

handleEntry

public boolean handleEntry(SearchResultEntry entry)

Description copied from interface: SearchResultHandler

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

Specified by:

handleEntry in interface SearchResultHandler

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

public boolean handleReference(DN dn,
                               SearchResultReference reference)

Description copied from interface: SearchResultHandler

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

Specified by:

handleReference in interface SearchResultHandler

Parameters:

dn - The DN related to the provided search reference.

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).

handleErrorResult

public void handleErrorResult(Result error)

Description copied from interface: ResultHandler

Invoked when the operation has failed.

Specified by:

handleErrorResult in interface ResultHandler

Parameters:

error - The error result exception indicating why the operation has failed.

handleResult

public void handleResult(Result result)

Description copied from interface: ResultHandler

Invoked when the operation has completed successfully.

Specified by:

handleResult in interface ResultHandler

Parameters:

result - The result of the operation.