org.forgerock.opendj.ldap.spi

Class SearchResultLdapPromiseImpl

java.lang.Object

org.forgerock.opendj.ldap.spi.LdapPromiseImpl<S>

org.forgerock.opendj.ldap.spi.ResultLdapPromiseImpl<SearchRequest,Result>

org.forgerock.opendj.ldap.spi.SearchResultLdapPromiseImpl

All Implemented Interfaces:

Future<Result>, IntermediateResponseHandler, LdapPromise<Result>, LdapResultHandler<Result>, SearchResultHandler, org.forgerock.util.promise.ExceptionHandler<LdapException>, org.forgerock.util.promise.Promise<Result,LdapException>, org.forgerock.util.promise.ResultHandler<Result>

public final class SearchResultLdapPromiseImpl
extends ResultLdapPromiseImpl<SearchRequest,Result>
implements SearchResultHandler

Search result promise implementation.

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning)
boolean	checkForTimeout() Returns true if this request should be canceled once the timeout period expires.
R	get()
R	get(long timeout, TimeUnit unit)
R	getOrThrow()
R	getOrThrow(long timeout, TimeUnit unit)
R	getOrThrowUninterruptibly()
R	getOrThrowUninterruptibly(long timeout, TimeUnit unit)
int	getRequestID() Returns the request ID of the request if appropriate.
P	getWrappedPromise()
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.
boolean	isCancelled()
boolean	isDone()
<VOUT,EOUT extends Exception> org.forgerock.util.promise.Promise<VOUT,EOUT>	then(org.forgerock.util.Function<? super R,VOUT,EOUT> onResult, org.forgerock.util.Function<? super LdapException,VOUT,EOUT> onException)
<VOUT,EOUT extends Exception> org.forgerock.util.promise.Promise<VOUT,EOUT>	then(org.forgerock.util.Function<? super R,VOUT,EOUT> onResult, org.forgerock.util.Function<? super LdapException,VOUT,EOUT> onException, org.forgerock.util.Function<? super RuntimeException,VOUT,EOUT> onRuntimeException)
<VOUT> LdapPromise<VOUT>	then(org.forgerock.util.Function<? super R,VOUT,LdapException> onResult)
LdapPromise<R>	thenAlways(Runnable onResultOrException)
<VOUT,EOUT extends Exception> org.forgerock.util.promise.Promise<VOUT,EOUT>	thenAsync(org.forgerock.util.AsyncFunction<? super R,VOUT,EOUT> onResult, org.forgerock.util.AsyncFunction<? super LdapException,VOUT,EOUT> onException)
<VOUT,EOUT extends Exception> org.forgerock.util.promise.Promise<VOUT,EOUT>	thenAsync(org.forgerock.util.AsyncFunction<? super R,VOUT,EOUT> onResult, org.forgerock.util.AsyncFunction<? super LdapException,VOUT,EOUT> onException, org.forgerock.util.AsyncFunction<? super RuntimeException,VOUT,EOUT> onRuntimeException)
<VOUT> LdapPromise<VOUT>	thenAsync(org.forgerock.util.AsyncFunction<? super R,VOUT,LdapException> onResult)
<EOUT extends Exception> org.forgerock.util.promise.Promise<R,EOUT>	thenCatch(org.forgerock.util.Function<? super LdapException,R,EOUT> onException)
<EOUT extends Exception> org.forgerock.util.promise.Promise<R,EOUT>	thenCatchAsync(org.forgerock.util.AsyncFunction<? super LdapException,R,EOUT> onException)
org.forgerock.util.promise.Promise<R,LdapException>	thenCatchRuntimeException(org.forgerock.util.Function<? super RuntimeException,R,LdapException> onRuntimeException)
org.forgerock.util.promise.Promise<R,LdapException>	thenCatchRuntimeExceptionAsync(org.forgerock.util.AsyncFunction<? super RuntimeException,R,LdapException> onRuntimeException)
LdapPromise<R>	thenFinally(Runnable onResultOrException)
LdapPromise<R>	thenOnException(org.forgerock.util.promise.ExceptionHandler<? super LdapException> onException)
LdapPromise<R>	thenOnResult(org.forgerock.util.promise.ResultHandler<? super R> onResult)
LdapPromise<R>	thenOnResultOrException(org.forgerock.util.promise.ResultHandler<? super R> onResult, org.forgerock.util.promise.ExceptionHandler<? super LdapException> onException)
LdapPromise<R>	thenOnResultOrException(Runnable onResultOrException)
LdapPromise<R>	thenOnRuntimeException(org.forgerock.util.promise.RuntimeExceptionHandler onRuntimeException)

Methods inherited from class org.forgerock.opendj.ldap.spi.ResultLdapPromiseImpl

adaptErrorResult, getRequest, getTimestamp, handleIntermediateResponse, isBindOrStartTLS, setResultOrError, toString

Methods inherited from class org.forgerock.opendj.ldap.spi.LdapPromiseImpl

handleException, handleResult, newLdapPromiseImpl, newLdapPromiseImpl

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.opendj.ldap.LdapPromise

getRequestID, then, thenAlways, thenAsync, thenFinally, thenOnException, thenOnResult, thenOnResultOrException, thenOnResultOrException

Methods inherited from interface org.forgerock.util.promise.Promise

cancel, get, get, getOrThrow, getOrThrow, getOrThrowUninterruptibly, getOrThrowUninterruptibly, isCancelled, isDone, then, then, thenAsync, thenAsync, thenCatch, thenCatchAsync, thenCatchRuntimeException, thenCatchRuntimeExceptionAsync, thenOnRuntimeException

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(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:

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

checkForTimeout

public boolean checkForTimeout()

Description copied from class: ResultLdapPromiseImpl

Returns true if this request should be canceled once the timeout period expires. The default implementation is to return true which will be appropriate for nearly all requests, the one obvious exception being persistent searches.

Overrides:

checkForTimeout in class ResultLdapPromiseImpl<SearchRequest,Result>

Returns:

true if this request should be canceled once the timeout period expires.

getRequestID

public int getRequestID()

Description copied from interface: LdapPromise

Returns the request ID of the request if appropriate.

Specified by:

getRequestID in interface LdapPromise<R>

Returns:

The request ID, or -1 if there is no request ID.

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<R>

Specified by:

cancel in interface org.forgerock.util.promise.Promise<R,LdapException>

get

public R get()
      throws ExecutionException,
             InterruptedException

Specified by:

get in interface Future<R>

Specified by:

get in interface org.forgerock.util.promise.Promise<R,LdapException>

Throws:

ExecutionException

InterruptedException

get

public R get(long timeout,
             TimeUnit unit)
      throws ExecutionException,
             TimeoutException,
             InterruptedException

Specified by:

get in interface Future<R>

Specified by:

get in interface org.forgerock.util.promise.Promise<R,LdapException>

Throws:

ExecutionException

TimeoutException

InterruptedException

getOrThrow

public R getOrThrow()
             throws InterruptedException,
                    LdapException

Specified by:

getOrThrow in interface org.forgerock.util.promise.Promise<R,LdapException>

Throws:

InterruptedException

LdapException

getOrThrow

public R getOrThrow(long timeout,
                    TimeUnit unit)
             throws InterruptedException,
                    LdapException,
                    TimeoutException

Specified by:

getOrThrow in interface org.forgerock.util.promise.Promise<R,LdapException>

Throws:

InterruptedException

LdapException

TimeoutException

getOrThrowUninterruptibly

public R getOrThrowUninterruptibly()
                            throws LdapException

Specified by:

getOrThrowUninterruptibly in interface org.forgerock.util.promise.Promise<R,LdapException>

Throws:

LdapException

getOrThrowUninterruptibly

public R getOrThrowUninterruptibly(long timeout,
                                   TimeUnit unit)
                            throws LdapException,
                                   TimeoutException

Specified by:

getOrThrowUninterruptibly in interface org.forgerock.util.promise.Promise<R,LdapException>

Throws:

LdapException

TimeoutException

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<R>

Specified by:

isCancelled in interface org.forgerock.util.promise.Promise<R,LdapException>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<R>

Specified by:

isDone in interface org.forgerock.util.promise.Promise<R,LdapException>

thenOnException

public LdapPromise<R> thenOnException(org.forgerock.util.promise.ExceptionHandler<? super LdapException> onException)

Specified by:

thenOnException in interface LdapPromise<R>

Specified by:

thenOnException in interface org.forgerock.util.promise.Promise<R,LdapException>

thenOnRuntimeException

public LdapPromise<R> thenOnRuntimeException(org.forgerock.util.promise.RuntimeExceptionHandler onRuntimeException)

Specified by:

thenOnRuntimeException in interface org.forgerock.util.promise.Promise<R,LdapException>

thenOnResult

public LdapPromise<R> thenOnResult(org.forgerock.util.promise.ResultHandler<? super R> onResult)

Specified by:

thenOnResult in interface LdapPromise<R>

Specified by:

thenOnResult in interface org.forgerock.util.promise.Promise<R,LdapException>

thenOnResultOrException

public LdapPromise<R> thenOnResultOrException(Runnable onResultOrException)

Specified by:

thenOnResultOrException in interface LdapPromise<R>

Specified by:

thenOnResultOrException in interface org.forgerock.util.promise.Promise<R,LdapException>

then

public <VOUT> LdapPromise<VOUT> then(org.forgerock.util.Function<? super R,VOUT,LdapException> onResult)

Specified by:

then in interface LdapPromise<R>

Specified by:

then in interface org.forgerock.util.promise.Promise<R,LdapException>

then

public <VOUT,EOUT extends Exception> org.forgerock.util.promise.Promise<VOUT,EOUT> then(org.forgerock.util.Function<? super R,VOUT,EOUT> onResult,
                                                                                        org.forgerock.util.Function<? super LdapException,VOUT,EOUT> onException)

Specified by:

then in interface org.forgerock.util.promise.Promise<R,LdapException>

then

public <VOUT,EOUT extends Exception> org.forgerock.util.promise.Promise<VOUT,EOUT> then(org.forgerock.util.Function<? super R,VOUT,EOUT> onResult,
                                                                                        org.forgerock.util.Function<? super LdapException,VOUT,EOUT> onException,
                                                                                        org.forgerock.util.Function<? super RuntimeException,VOUT,EOUT> onRuntimeException)

Specified by:

then in interface org.forgerock.util.promise.Promise<R,LdapException>

thenOnResultOrException

public LdapPromise<R> thenOnResultOrException(org.forgerock.util.promise.ResultHandler<? super R> onResult,
                                              org.forgerock.util.promise.ExceptionHandler<? super LdapException> onException)

Specified by:

thenOnResultOrException in interface LdapPromise<R>

Specified by:

thenOnResultOrException in interface org.forgerock.util.promise.Promise<R,LdapException>

thenAlways

public LdapPromise<R> thenAlways(Runnable onResultOrException)

Specified by:

thenAlways in interface LdapPromise<R>

Specified by:

thenAlways in interface org.forgerock.util.promise.Promise<R,LdapException>

thenAsync

public <VOUT> LdapPromise<VOUT> thenAsync(org.forgerock.util.AsyncFunction<? super R,VOUT,LdapException> onResult)

Specified by:

thenAsync in interface LdapPromise<R>

Specified by:

thenAsync in interface org.forgerock.util.promise.Promise<R,LdapException>

thenAsync

public <VOUT,EOUT extends Exception> org.forgerock.util.promise.Promise<VOUT,EOUT> thenAsync(org.forgerock.util.AsyncFunction<? super R,VOUT,EOUT> onResult,
                                                                                             org.forgerock.util.AsyncFunction<? super LdapException,VOUT,EOUT> onException)

Specified by:

thenAsync in interface org.forgerock.util.promise.Promise<R,LdapException>

thenAsync

public <VOUT,EOUT extends Exception> org.forgerock.util.promise.Promise<VOUT,EOUT> thenAsync(org.forgerock.util.AsyncFunction<? super R,VOUT,EOUT> onResult,
                                                                                             org.forgerock.util.AsyncFunction<? super LdapException,VOUT,EOUT> onException,
                                                                                             org.forgerock.util.AsyncFunction<? super RuntimeException,VOUT,EOUT> onRuntimeException)

Specified by:

thenAsync in interface org.forgerock.util.promise.Promise<R,LdapException>

thenCatch

public <EOUT extends Exception> org.forgerock.util.promise.Promise<R,EOUT> thenCatch(org.forgerock.util.Function<? super LdapException,R,EOUT> onException)

Specified by:

thenCatch in interface org.forgerock.util.promise.Promise<R,LdapException>

thenCatchRuntimeException

public org.forgerock.util.promise.Promise<R,LdapException> thenCatchRuntimeException(org.forgerock.util.Function<? super RuntimeException,R,LdapException> onRuntimeException)

Specified by:

thenCatchRuntimeException in interface org.forgerock.util.promise.Promise<R,LdapException>

thenCatchRuntimeExceptionAsync

public org.forgerock.util.promise.Promise<R,LdapException> thenCatchRuntimeExceptionAsync(org.forgerock.util.AsyncFunction<? super RuntimeException,R,LdapException> onRuntimeException)

Specified by:

thenCatchRuntimeExceptionAsync in interface org.forgerock.util.promise.Promise<R,LdapException>

thenFinally

public LdapPromise<R> thenFinally(Runnable onResultOrException)

Specified by:

thenFinally in interface LdapPromise<R>

Specified by:

thenFinally in interface org.forgerock.util.promise.Promise<R,LdapException>

thenCatchAsync

public <EOUT extends Exception> org.forgerock.util.promise.Promise<R,EOUT> thenCatchAsync(org.forgerock.util.AsyncFunction<? super LdapException,R,EOUT> onException)

Specified by:

thenCatchAsync in interface org.forgerock.util.promise.Promise<R,LdapException>

getWrappedPromise

public P getWrappedPromise()