Package org.forgerock.opendj.ldap.spi

Interface LDAPConnectionImpl

All Superinterfaces:

AutoCloseable, Closeable

public interface LDAPConnectionImpl
extends Closeable

LDAP connection interface which implementations of LDAPConnectionFactoryImpl should implement.

Method Summary

Modifier and Type	Method	Description
LdapPromise<Void>	abandonAsync(AbandonRequest request)	Abandons the unfinished operation identified in the provided abandon request.
LdapPromise<Result>	addAsync(AddRequest request, IntermediateResponseHandler intermediateResponseHandler)	Asynchronously adds an entry to the Directory Server using the provided add request.
void	addConnectionEventListener(ConnectionEventListener listener)	Registers the provided connection event listener so that it will be notified when this connection is closed by the application, receives an unsolicited notification, or experiences a fatal error.
LdapPromise<BindResult>	bindAsync(BindRequest request, IntermediateResponseHandler intermediateResponseHandler)	Asynchronously authenticates to the Directory Server using the provided bind request.
void	close()	Releases any resources associated with this connection.
void	close(UnbindRequest request, String reason)	Releases any resources associated with this connection.
LdapPromise<CompareResult>	compareAsync(CompareRequest request, IntermediateResponseHandler intermediateResponseHandler)	Asynchronously compares an entry in the Directory Server using the provided compare request.
LdapPromise<Result>	deleteAsync(DeleteRequest request, IntermediateResponseHandler intermediateResponseHandler)	Asynchronously deletes an entry from the Directory Server using the provided delete request.
org.forgerock.util.promise.Promise<Void,LdapException>	enableTLS(SSLContext sslContext, List<String> protocols, List<String> suites)	Installs the TLS/SSL security layer on the underlying connection.
<R extends ExtendedResult> LdapPromise<R>	extendedRequestAsync(ExtendedRequest<R> request, IntermediateResponseHandler intermediateResponseHandler)	Asynchronously performs the provided extended request in the Directory Server.
boolean	isClosed()	Indicates whether this connection has been explicitly closed by calling close.
boolean	isValid()	Returns true if this connection has not been closed and no fatal errors have been detected.
LdapPromise<Result>	modifyAsync(ModifyRequest request, IntermediateResponseHandler intermediateResponseHandler)	Asynchronously modifies an entry in the Directory Server using the provided modify request.
LdapPromise<Result>	modifyDNAsync(ModifyDNRequest request, IntermediateResponseHandler intermediateResponseHandler)	Asynchronously renames an entry in the Directory Server using the provided modify DN request.
void	removeConnectionEventListener(ConnectionEventListener listener)	Removes the provided connection event listener from this connection so that it will no longer be notified when this connection is closed by the application, receives an unsolicited notification, or experiences a fatal error.
LdapPromise<Result>	searchAsync(SearchRequest request, IntermediateResponseHandler intermediateResponseHandler, SearchResultHandler entryHandler)	Asynchronously searches the Directory Server using the provided search request.

Method Details

abandonAsync

LdapPromise<Void> abandonAsync(AbandonRequest request)

Abandons the unfinished operation identified in the provided abandon request.

Parameters:

request - The request identifying the operation to be abandoned.

Returns:

A promise whose result is Void.

Throws:

UnsupportedOperationException - If this connection does not support abandon operations.

IllegalStateException - If this connection has already been closed, i.e. if isClosed() == true.

NullPointerException - If request was null.

See Also:

• Connection.abandonAsync(AbandonRequest)

addAsync

LdapPromise<Result> addAsync(AddRequest request,
 IntermediateResponseHandler intermediateResponseHandler)

Asynchronously adds an entry to the Directory Server using the provided add request.

Parameters:

request - The add request.

intermediateResponseHandler - An intermediate response handler which can be used to process any intermediate responses as they are received, may be null.

Returns:

A promise representing the result of the operation.

Throws:

UnsupportedOperationException - If this connection does not support add operations.

IllegalStateException - If this connection has already been closed, i.e. if isClosed() == true.

NullPointerException - If request was null.

See Also:

• Connection.addAsync(AddRequest, IntermediateResponseHandler)

addConnectionEventListener

void addConnectionEventListener(ConnectionEventListener listener)

Registers the provided connection event listener so that it will be notified when this connection is closed by the application, receives an unsolicited notification, or experiences a fatal error.

Parameters:

listener - The listener which wants to be notified when events occur on this connection.

Throws:

IllegalStateException - If this connection has already been closed, i.e. if isClosed() == true.

NullPointerException - If the listener was null.

See Also:

• Connection.addConnectionEventListener(ConnectionEventListener)

bindAsync

LdapPromise<BindResult> bindAsync(BindRequest request,
 IntermediateResponseHandler intermediateResponseHandler)

Asynchronously authenticates to the Directory Server using the provided bind request.

Parameters:

request - The bind request.

intermediateResponseHandler - An intermediate response handler which can be used to process any intermediate responses as they are received, may be null.

Returns:

A promise representing the result of the operation.

Throws:

UnsupportedOperationException - If this connection does not support bind operations.

IllegalStateException - If this connection has already been closed, i.e. if isClosed() == true.

NullPointerException - If request was null.

See Also:

• Connection.bindAsync(BindRequest, IntermediateResponseHandler)

close

void close()

Releases any resources associated with this connection.

Calling close on a connection that is already closed has no effect.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

See Also:

• Connection.close()

close

void close(UnbindRequest request,
 String reason)

Releases any resources associated with this connection.

Calling close on a connection that is already closed has no effect.

Parameters:

request - The unbind request to use in the case where a physical connection is closed.

reason - A reason describing why the connection was closed.

Throws:

NullPointerException - If request was null.

See Also:

• Connection.close(UnbindRequest, String)

compareAsync

LdapPromise<CompareResult> compareAsync(CompareRequest request,
 IntermediateResponseHandler intermediateResponseHandler)

Asynchronously compares an entry in the Directory Server using the provided compare request.

Parameters:

request - The compare request.

intermediateResponseHandler - An intermediate response handler which can be used to process any intermediate responses as they are received, may be null.

Returns:

A promise representing the result of the operation.

Throws:

UnsupportedOperationException - If this connection does not support compare operations.

IllegalStateException - If this connection has already been closed, i.e. if isClosed() == true.

NullPointerException - If request was null.

See Also:

• Connection.compareAsync(CompareRequest, IntermediateResponseHandler)

deleteAsync

LdapPromise<Result> deleteAsync(DeleteRequest request,
 IntermediateResponseHandler intermediateResponseHandler)

Asynchronously deletes an entry from the Directory Server using the provided delete request.

Parameters:

request - The delete request.

intermediateResponseHandler - An intermediate response handler which can be used to process any intermediate responses as they are received, may be null.

Returns:

A promise representing the result of the operation.

Throws:

UnsupportedOperationException - If this connection does not support delete operations.

IllegalStateException - If this connection has already been closed, i.e. if isClosed() == true.

NullPointerException - If request was null.

See Also:

• Connection.deleteAsync(DeleteRequest, IntermediateResponseHandler)

enableTLS

org.forgerock.util.promise.Promise<Void,LdapException> enableTLS(SSLContext sslContext,
 List<String> protocols,
 List<String> suites)

Installs the TLS/SSL security layer on the underlying connection. The TLS/SSL security layer will be installed beneath any existing connection security layers and can only be installed at most once.

Parameters:

sslContext - The SSLContext which should be used to secure the

protocols - Names of all the protocols to enable or null to use the default protocols.

suites - Names of all the suites to enable or null to use the default cipher suites.

Returns:

A promise which will complete once the SSL handshake has completed.

Throws:

IllegalStateException - If the TLS/SSL security layer has already been installed.

extendedRequestAsync

<R extends ExtendedResult> LdapPromise<R> extendedRequestAsync(ExtendedRequest<R> request,
 IntermediateResponseHandler intermediateResponseHandler)

Asynchronously performs the provided extended request in the Directory Server.

Type Parameters:

R - The type of result returned by the extended request.

Parameters:

request - The extended request.

intermediateResponseHandler - An intermediate response handler which can be used to process any intermediate responses as they are received, may be null.

Returns:

A promise representing the result of the operation.

Throws:

UnsupportedOperationException - If this connection does not support extended operations.

IllegalStateException - If this connection has already been closed, i.e. if isClosed() == true.

NullPointerException - If request was null.

See Also:

• Connection.extendedRequestAsync(ExtendedRequest, IntermediateResponseHandler)

isClosed

boolean isClosed()

Indicates whether this connection has been explicitly closed by calling close. This method will not return true if a fatal error has occurred on the connection unless close has been called.

Returns:

true if this connection has been explicitly closed by calling close, or false otherwise.

See Also:

• Connection.isClosed()

isValid

boolean isValid()

Returns true if this connection has not been closed and no fatal errors have been detected. This method is guaranteed to return false only when it is called after the method close has been called.

Returns:

true if this connection is valid, false otherwise.

See Also:

• Connection.isValid()

modifyAsync

LdapPromise<Result> modifyAsync(ModifyRequest request,
 IntermediateResponseHandler intermediateResponseHandler)

Asynchronously modifies an entry in the Directory Server using the provided modify request.

Parameters:

request - The modify request.

intermediateResponseHandler - An intermediate response handler which can be used to process any intermediate responses as they are received, may be null.

Returns:

A promise representing the result of the operation.

Throws:

UnsupportedOperationException - If this connection does not support modify operations.

IllegalStateException - If this connection has already been closed, i.e. if isClosed() == true.

NullPointerException - If request was null.

See Also:

• Connection.modifyAsync(ModifyRequest, IntermediateResponseHandler)

modifyDNAsync

LdapPromise<Result> modifyDNAsync(ModifyDNRequest request,
 IntermediateResponseHandler intermediateResponseHandler)

Asynchronously renames an entry in the Directory Server using the provided modify DN request.

Parameters:

request - The modify DN request.

intermediateResponseHandler - An intermediate response handler which can be used to process any intermediate responses as they are received, may be null.

Returns:

A promise representing the result of the operation.

Throws:

UnsupportedOperationException - If this connection does not support modify DN operations.

IllegalStateException - If this connection has already been closed, i.e. if isClosed() == true.

NullPointerException - If request was null.

See Also:

• Connection.modifyDNAsync(ModifyDNRequest, IntermediateResponseHandler)

removeConnectionEventListener

void removeConnectionEventListener(ConnectionEventListener listener)

Removes the provided connection event listener from this connection so that it will no longer be notified when this connection is closed by the application, receives an unsolicited notification, or experiences a fatal error.

Parameters:

listener - The listener which no longer wants to be notified when events occur on this connection.

Throws:

NullPointerException - If the listener was null.

See Also:

• Connection.removeConnectionEventListener(ConnectionEventListener)

searchAsync

LdapPromise<Result> searchAsync(SearchRequest request,
 IntermediateResponseHandler intermediateResponseHandler,
 SearchResultHandler entryHandler)

Asynchronously searches the Directory Server using the provided search request.

Parameters:

request - The search request.

intermediateResponseHandler - An intermediate response handler which can be used to process any intermediate responses as they are received, may be null.

entryHandler - A search result handler which can be used to asynchronously process the search result entries and references as they are received, may be null.

Returns:

A promise representing the result of the operation.

Throws:

UnsupportedOperationException - If this connection does not support search operations.

IllegalStateException - If this connection has already been closed, i.e. if isClosed() == true.

NullPointerException - If request was null.

See Also:

• Connection.searchAsync(SearchRequest, IntermediateResponseHandler, SearchResultHandler)