Package org.forgerock.opendj.ldap.spi

Class BindResultLdapPromiseImpl

java.lang.Object

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

org.forgerock.opendj.ldap.spi.ResultLdapPromiseImpl<BindRequest,BindResult>

org.forgerock.opendj.ldap.spi.BindResultLdapPromiseImpl

All Implemented Interfaces:

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

public final class BindResultLdapPromiseImpl
extends ResultLdapPromiseImpl<BindRequest,BindResult>

Bind result promise implementation.

Method Summary

Modifier and Type	Method	Description
boolean	cancel(boolean mayInterruptIfRunning)
BindResult	get()
BindResult	get(long timeout, TimeUnit unit)
BindClient	getBindClient()	Returns the bind client.
BindResult	getOrThrow()
BindResult	getOrThrow(long timeout, TimeUnit unit)
BindResult	getOrThrowUninterruptibly()
BindResult	getOrThrowUninterruptibly(long timeout, TimeUnit unit)
int	getRequestID()	Returns the request ID of the request if appropriate.
org.forgerock.util.promise.PromiseImpl<BindResult,LdapException>	getWrappedPromise()
boolean	isBindOrStartTLS()	Returns true if this promise represents the result of a bind or StartTLS request.
boolean	isCancelled()
boolean	isDone()
<VOUT, EOUT extends Exception> org.forgerock.util.promise.Promise<VOUT,EOUT>	then(org.forgerock.util.Function<? super BindResult,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 BindResult,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 BindResult,VOUT,LdapException> onResult)
LdapPromise<BindResult>	thenAlways(Runnable onResultOrException)
<VOUT, EOUT extends Exception> org.forgerock.util.promise.Promise<VOUT,EOUT>	thenAsync(org.forgerock.util.AsyncFunction<? super BindResult,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 BindResult,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 BindResult,VOUT,LdapException> onResult)
<EOUT extends Exception> org.forgerock.util.promise.Promise<BindResult,EOUT>	thenCatch(org.forgerock.util.Function<? super LdapException,BindResult,EOUT> onException)
<EOUT extends Exception> org.forgerock.util.promise.Promise<BindResult,EOUT>	thenCatchAsync(org.forgerock.util.AsyncFunction<? super LdapException,BindResult,EOUT> onException)
org.forgerock.util.promise.Promise<BindResult,LdapException>	thenCatchRuntimeException(org.forgerock.util.Function<? super RuntimeException,BindResult,LdapException> onRuntimeException)
org.forgerock.util.promise.Promise<BindResult,LdapException>	thenCatchRuntimeExceptionAsync(org.forgerock.util.AsyncFunction<? super RuntimeException,BindResult,LdapException> onRuntimeException)
LdapPromise<BindResult>	thenFinally(Runnable onResultOrException)
LdapPromise<BindResult>	thenOnException(org.forgerock.util.promise.ExceptionHandler<? super LdapException> onException)
LdapPromise<BindResult>	thenOnResult(org.forgerock.util.promise.ResultHandler<? super BindResult> onResult)
LdapPromise<BindResult>	thenOnResultOrException(Runnable onResultOrException)
LdapPromise<BindResult>	thenOnResultOrException(org.forgerock.util.promise.ResultHandler<? super BindResult> onResult, org.forgerock.util.promise.ExceptionHandler<? super LdapException> onException)
LdapPromise<BindResult>	thenOnRuntimeException(org.forgerock.util.promise.RuntimeExceptionHandler onRuntimeException)

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

adaptErrorResult, checkForTimeout, getRequest, getTimestamp, handleIntermediateResponse, 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 Details

getBindClient

public BindClient getBindClient()

Returns the bind client.

Returns:

The bind client.

isBindOrStartTLS

public boolean isBindOrStartTLS()

Description copied from class: ResultLdapPromiseImpl

Returns true if this promise represents the result of a bind or StartTLS request. The default implementation is to return false.

Overrides:

isBindOrStartTLS in class ResultLdapPromiseImpl<BindRequest,BindResult>

Returns:

true if this promise represents the result of a bind or StartTLS request.

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,P extends org.forgerock.util.promise.Promise<R,LdapException>>

get

public BindResult get()
               throws ExecutionException,
InterruptedException

Specified by:

get in interface Future<R>

Specified by:

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

Throws:

ExecutionException

InterruptedException

get

public BindResult 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,P extends org.forgerock.util.promise.Promise<R,LdapException>>

Throws:

ExecutionException

TimeoutException

InterruptedException

getOrThrow

public BindResult getOrThrow()
                      throws InterruptedException,
LdapException

Specified by:

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

Throws:

InterruptedException

LdapException

getOrThrow

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

Specified by:

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

Throws:

InterruptedException

LdapException

TimeoutException

getOrThrowUninterruptibly

public BindResult getOrThrowUninterruptibly()
                                     throws LdapException

Specified by:

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

Throws:

LdapException

getOrThrowUninterruptibly

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

Specified by:

getOrThrowUninterruptibly in interface org.forgerock.util.promise.Promise<R,P extends 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,P extends 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,P extends org.forgerock.util.promise.Promise<R,LdapException>>

thenOnException

public LdapPromise<BindResult> 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,P extends org.forgerock.util.promise.Promise<R,LdapException>>

thenOnRuntimeException

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

Specified by:

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

thenOnResult

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

Specified by:

thenOnResult in interface LdapPromise<R>

Specified by:

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

thenOnResultOrException

public LdapPromise<BindResult> thenOnResultOrException(Runnable onResultOrException)

Specified by:

thenOnResultOrException in interface LdapPromise<R>

Specified by:

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

then

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

Specified by:

then in interface LdapPromise<R>

Specified by:

then in interface org.forgerock.util.promise.Promise<R,P extends 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 BindResult,VOUT,EOUT> onResult,
 org.forgerock.util.Function<? super LdapException,VOUT,EOUT> onException)

Specified by:

then in interface org.forgerock.util.promise.Promise<R,P extends 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 BindResult,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,P extends org.forgerock.util.promise.Promise<R,LdapException>>

thenOnResultOrException

public LdapPromise<BindResult> thenOnResultOrException(org.forgerock.util.promise.ResultHandler<? super BindResult> 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,P extends org.forgerock.util.promise.Promise<R,LdapException>>

thenAlways

public LdapPromise<BindResult> thenAlways(Runnable onResultOrException)

Specified by:

thenAlways in interface LdapPromise<R>

Specified by:

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

thenAsync

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

Specified by:

thenAsync in interface LdapPromise<R>

Specified by:

thenAsync in interface org.forgerock.util.promise.Promise<R,P extends 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 BindResult,VOUT,EOUT> onResult,
 org.forgerock.util.AsyncFunction<? super LdapException,VOUT,EOUT> onException)

Specified by:

thenAsync in interface org.forgerock.util.promise.Promise<R,P extends 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 BindResult,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,P extends org.forgerock.util.promise.Promise<R,LdapException>>

thenCatch

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

Specified by:

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

thenCatchRuntimeException

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

Specified by:

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

thenCatchRuntimeExceptionAsync

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

Specified by:

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

thenFinally

public LdapPromise<BindResult> thenFinally(Runnable onResultOrException)

Specified by:

thenFinally in interface LdapPromise<R>

Specified by:

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

thenCatchAsync

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

Specified by:

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

getWrappedPromise

public org.forgerock.util.promise.PromiseImpl<BindResult,LdapException> getWrappedPromise()