Package org.forgerock.opendj.ldap.spi

Class LdapPromises

java.lang.Object

org.forgerock.opendj.ldap.spi.LdapPromises

public final class LdapPromises
extends Object

Utility methods for creating and composing LdapPromises.

Method Summary

Modifier and Type	Method	Description
static <R> LdapPromise<R>	asPromise(org.forgerock.util.promise.Promise<R,LdapException> wrappedPromise)	Converts a Promise to a LdapPromise.
static BindResultLdapPromiseImpl	newBindLdapPromise(int requestID, BindRequest request, BindClient bindClient, IntermediateResponseHandler intermediateResponseHandler)	Creates a new bind BindResultLdapPromiseImpl.
static ResultLdapPromiseImpl<CompareRequest,CompareResult>	newCompareLdapPromise(int requestID, CompareRequest request, IntermediateResponseHandler intermediateResponseHandler, Connection connection)	Creates a new compare ResultLdapPromiseImpl.
static ResultLdapPromiseImpl<CompareRequest,CompareResult>	newCompareLdapPromise(int requestID, CompareRequest request, IntermediateResponseHandler intermediateResponseHandler, LDAPConnectionImpl connection)	Creates a new compare ResultLdapPromiseImpl.
static <S extends ExtendedResult> ExtendedResultLdapPromiseImpl<S>	newExtendedLdapPromise(int requestID, ExtendedRequest<S> request, IntermediateResponseHandler intermediateResponseHandler, Connection connection)	Creates a new extended ExtendedResultLdapPromiseImpl.
static <S extends ExtendedResult> ExtendedResultLdapPromiseImpl<S>	newExtendedLdapPromise(int requestID, ExtendedRequest<S> request, IntermediateResponseHandler intermediateResponseHandler, LDAPConnectionImpl connection)	Creates a new extended ExtendedResultLdapPromiseImpl.
static <R, E extends LdapException> LdapPromise<R>	newFailedLdapPromise(E error)	Returns a LdapPromise representing an asynchronous task which has already failed with the provided error.
static <R, E extends LdapException> LdapPromise<R>	newFailedLdapPromise(E error, int requestID)	Returns a LdapPromise representing an asynchronous task, identified by the provided requestID, which has already failed with the provided error.
static <R extends Request> ResultLdapPromiseImpl<R,Result>	newResultLdapPromise(int requestID, R request, IntermediateResponseHandler intermediateResponseHandler, Connection connection)	Creates a new ResultLdapPromiseImpl to handle a standard request (add, delete, modify and modidyDN).
static <R extends Request> ResultLdapPromiseImpl<R,Result>	newResultLdapPromise(int requestID, R request, IntermediateResponseHandler intermediateResponseHandler, LDAPConnectionImpl connection)	Creates a new ResultLdapPromiseImpl to handle a standard request (add, delete, modify and modidyDN).
static SearchResultLdapPromiseImpl	newSearchLdapPromise(int requestID, SearchRequest request, SearchResultHandler resultHandler, IntermediateResponseHandler intermediateResponseHandler, Connection connection)	Creates a new search SearchResultLdapPromiseImpl.
static SearchResultLdapPromiseImpl	newSearchLdapPromise(int requestID, SearchRequest request, SearchResultHandler resultHandler, IntermediateResponseHandler intermediateResponseHandler, LDAPConnectionImpl connection)	Creates a new search SearchResultLdapPromiseImpl.
static <R> LdapPromise<R>	newSuccessfulLdapPromise(R result)	Returns a LdapPromise representing an asynchronous task which has already succeeded with the provided result.
static <R> LdapPromise<R>	newSuccessfulLdapPromise(R result, int requestID)	Returns a LdapPromise representing an asynchronous task, identified by the provided requestID, which has already succeeded with the provided result.

Methods inherited from class java.lang.Object

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

Method Details

asPromise

public static <R> LdapPromise<R> asPromise(org.forgerock.util.promise.Promise<R,LdapException> wrappedPromise)

Converts a Promise to a LdapPromise.

Type Parameters:

R - The type of the task's result, or Void if the task does not return anything (i.e. it only has side-effects).

Parameters:

wrappedPromise - The Promise to wrap.

Returns:

A LdapPromise representing the same asynchronous task as the Promise provided.

newBindLdapPromise

public static BindResultLdapPromiseImpl newBindLdapPromise(int requestID,
 BindRequest request,
 BindClient bindClient,
 IntermediateResponseHandler intermediateResponseHandler)

Creates a new bind BindResultLdapPromiseImpl.

Parameters:

requestID - Identifier of the request.

request - The bind request sent to server.

bindClient - Client that binds to the server.

intermediateResponseHandler - Handler that consumes intermediate responses from extended operations.

Returns:

The new BindResultLdapPromiseImpl.

newCompareLdapPromise

public static ResultLdapPromiseImpl<CompareRequest,CompareResult> newCompareLdapPromise(int requestID,
 CompareRequest request,
 IntermediateResponseHandler intermediateResponseHandler,
 Connection connection)

Creates a new compare ResultLdapPromiseImpl.

Parameters:

requestID - Identifier of the request.

request - The compare request sent to the server.

intermediateResponseHandler - Handler that consumes intermediate responses from extended operations.

connection - The connection to directory server.

Returns:

The new ResultLdapPromiseImpl.

newCompareLdapPromise

public static ResultLdapPromiseImpl<CompareRequest,CompareResult> newCompareLdapPromise(int requestID,
 CompareRequest request,
 IntermediateResponseHandler intermediateResponseHandler,
 LDAPConnectionImpl connection)

Creates a new compare ResultLdapPromiseImpl.

Parameters:

requestID - Identifier of the request.

request - The compare request sent to the server.

intermediateResponseHandler - Handler that consumes intermediate responses from extended operations.

connection - The connection to directory server.

Returns:

The new ResultLdapPromiseImpl.

newExtendedLdapPromise

public static <S extends ExtendedResult>
ExtendedResultLdapPromiseImpl<S> newExtendedLdapPromise(int requestID,
 ExtendedRequest<S> request,
 IntermediateResponseHandler intermediateResponseHandler,
 Connection connection)

Creates a new extended ExtendedResultLdapPromiseImpl.

Type Parameters:

S - The type of result returned by this promise.

Parameters:

requestID - Identifier of the request.

request - The extended request sent to the server.

intermediateResponseHandler - Handler that consumes intermediate responses from extended operations.

connection - The connection to directory server.

Returns:

The new ExtendedResultLdapPromiseImpl.

newExtendedLdapPromise

public static <S extends ExtendedResult>
ExtendedResultLdapPromiseImpl<S> newExtendedLdapPromise(int requestID,
 ExtendedRequest<S> request,
 IntermediateResponseHandler intermediateResponseHandler,
 LDAPConnectionImpl connection)

Creates a new extended ExtendedResultLdapPromiseImpl.

Type Parameters:

S - The type of result returned by this promise.

Parameters:

requestID - Identifier of the request.

request - The extended request sent to the server.

intermediateResponseHandler - Handler that consumes intermediate responses from extended operations.

connection - The connection to directory server.

Returns:

The new ExtendedResultLdapPromiseImpl.

newResultLdapPromise

public static <R extends Request>
ResultLdapPromiseImpl<R,Result> newResultLdapPromise(int requestID,
 R request,
 IntermediateResponseHandler intermediateResponseHandler,
 Connection connection)

Creates a new ResultLdapPromiseImpl to handle a standard request (add, delete, modify and modidyDN).

Type Parameters:

R - The type of the task's request.

Parameters:

requestID - Identifier of the request.

request - The request sent to the server.

intermediateResponseHandler - Handler that consumes intermediate responses from extended operations.

connection - The connection to directory server.

Returns:

The new ResultLdapPromiseImpl.

newResultLdapPromise

public static <R extends Request>
ResultLdapPromiseImpl<R,Result> newResultLdapPromise(int requestID,
 R request,
 IntermediateResponseHandler intermediateResponseHandler,
 LDAPConnectionImpl connection)

Creates a new ResultLdapPromiseImpl to handle a standard request (add, delete, modify and modidyDN).

Type Parameters:

R - The type of the task's request.

Parameters:

requestID - Identifier of the request.

request - The request sent to the server.

intermediateResponseHandler - Handler that consumes intermediate responses from extended operations.

connection - The connection to directory server.

Returns:

The new ResultLdapPromiseImpl.

newSearchLdapPromise

public static SearchResultLdapPromiseImpl newSearchLdapPromise(int requestID,
 SearchRequest request,
 SearchResultHandler resultHandler,
 IntermediateResponseHandler intermediateResponseHandler,
 Connection connection)

Creates a new search SearchResultLdapPromiseImpl.

Parameters:

requestID - Identifier of the request.

request - The search request sent to the server.

resultHandler - Handler that consumes search result.

intermediateResponseHandler - Handler that consumes intermediate responses from extended operations.

connection - The connection to directory server.

Returns:

The new SearchResultLdapPromiseImpl.

newSearchLdapPromise

public static SearchResultLdapPromiseImpl newSearchLdapPromise(int requestID,
 SearchRequest request,
 SearchResultHandler resultHandler,
 IntermediateResponseHandler intermediateResponseHandler,
 LDAPConnectionImpl connection)

Creates a new search SearchResultLdapPromiseImpl.

Parameters:

requestID - Identifier of the request.

request - The search request sent to the server.

resultHandler - Handler that consumes search result.

intermediateResponseHandler - Handler that consumes intermediate responses from extended operations.

connection - The connection to directory server.

Returns:

The new SearchResultLdapPromiseImpl.

newFailedLdapPromise

public static <R,
E extends LdapException>
LdapPromise<R> newFailedLdapPromise(E error)

Returns a LdapPromise representing an asynchronous task which has already failed with the provided error.

Type Parameters:

R - The type of the task's result, or Void if the task does not return anything (i.e. it only has side-effects).

E - The type of the exception thrown by the task if it fails.

Parameters:

error - The exception indicating why the asynchronous task has failed.

Returns:

A LdapPromise representing an asynchronous task which has already failed with the provided error.

newFailedLdapPromise

public static <R,
E extends LdapException>
LdapPromise<R> newFailedLdapPromise(E error,
 int requestID)

Returns a LdapPromise representing an asynchronous task, identified by the provided requestID, which has already failed with the provided error.

Type Parameters:

R - The type of the task's result, or Void if the task does not return anything (i.e. it only has side-effects).

E - The type of the exception thrown by the task if it fails.

Parameters:

error - The exception indicating why the asynchronous task has failed.

requestID - The request ID of the failed task.

Returns:

A LdapPromise representing an asynchronous task which has already failed with the provided error.

newSuccessfulLdapPromise

public static <R> LdapPromise<R> newSuccessfulLdapPromise(R result)

Returns a LdapPromise representing an asynchronous task which has already succeeded with the provided result. Attempts to get the result will immediately return the result.

Type Parameters:

R - The type of the task's result, or Void if the task does not return anything (i.e. it only has side-effects).

Parameters:

result - The result of the asynchronous task.

Returns:

A LdapPromise representing an asynchronous task which has already succeeded with the provided result.

newSuccessfulLdapPromise

public static <R> LdapPromise<R> newSuccessfulLdapPromise(R result,
 int requestID)

Returns a LdapPromise representing an asynchronous task, identified by the provided requestID, which has already succeeded with the provided result. Attempts to get the result will immediately return the result.

Type Parameters:

R - The type of the task's result, or Void if the task does not return anything (i.e. it only has side-effects).

Parameters:

result - The result of the asynchronous task.

requestID - The request ID of the succeeded task.

Returns:

A LdapPromise representing an asynchronous task which has already succeeded with the provided result.