org.opends.server.protocols.ldap

Class LDAPClientConnection

java.lang.Object

org.opends.server.api.ClientConnection

org.opends.server.protocols.ldap.LDAPClientConnection

All Implemented Interfaces:

TLSCapableConnection

public final class LDAPClientConnection
extends ClientConnection
implements TLSCapableConnection

This class defines an LDAP client connection, which is a type of client connection that will be accepted by an instance of the LDAP connection handler and have its requests decoded by an LDAP request handler.

Field Summary

Fields inherited from class org.opends.server.api.ClientConnection

authenticationInfo, bindInProgress, saslBindInProgress, startTLSInProgress

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelAllOperations(CancelRequest cancelRequest) Attempts to cancel all operations in progress on this connection.
void	cancelAllOperationsExcept(CancelRequest cancelRequest, int messageID) Attempts to cancel all operations in progress on this connection except the operation with the specified message ID.
CancelResult	cancelOperation(int messageID, CancelRequest cancelRequest) Attempts to cancel the specified operation.
void	disconnect(DisconnectReason disconnectReason, boolean sendNotification, LocalizableMessage message) Closes the connection to the client, optionally sending it a message indicating the reason for the closure.
void	finishBind() Indicates a bind or start TLS request processing is finished and the client connection may start processing data read from the socket again.
void	finishStartTLS() Indicates a bind or start TLS request processing is finished and the client connection may start processing data read from the socket again.
ByteChannel	getChannel() Retrieves the TLS redirecting byte channel used in a LDAP client connection.
String	getClientAddress() Retrieves a string representation of the address of the client.
Certificate[]	getClientCertificateChain() Return the certificate chain array associated with a connection.
int	getClientPort() Retrieves the port number for this connection on the client system.
ConnectionHandler<?>	getConnectionHandler() Retrieves the connection handler that accepted this client connection.
long	getConnectionID() Retrieves the connection ID assigned to this connection.
long	getIdleTime() Retrieves the length of time in milliseconds that this client connection has been idle.
InetAddress	getLocalAddress() Retrieves the java.net.InetAddress for the Directory Server system to which the client has established the connection.
long	getMaxBlockedWriteTimeLimit() Retrieves the maximum length of time in milliseconds that attempts to write data to the client should be allowed to block.
String	getMonitorSummary() Retrieves a one-line summary of this client connection in a form that is suitable for including in the monitor entry for the associated connection handler.
long	getNumberOfOperations() Returns the total number of operations initiated on this connection.
Operation	getOperationInProgress(int messageID) Retrieves the operation in progress with the specified message ID.
Collection<Operation>	getOperationsInProgress() Retrieves the set of operations in progress for this client connection.
String	getProtocol() Retrieves the protocol that the client is using to communicate with the Directory Server.
InetAddress	getRemoteAddress() Retrieves the java.net.InetAddress associated with the remote client system.
String	getServerAddress() Retrieves a string representation of the address on the server to which the client connected.
int	getServerPort() Retrieves the port number for this connection on the server system.
SocketChannel	getSocketChannel() Retrieves the socket channel that can be used to communicate with the client.
int	getSSF() Return the Security Strength Factor of a client connection.
Selector	getWriteSelector() Retrieves a Selector that may be used to ensure that write operations complete in a timely manner, or terminate the connection in the event that they fail to do so.
boolean	isConnectionValid() Returns whether the Directory Server believes this connection to be valid and available for communication.
boolean	isSecure() Indicates whether this client connection is currently using a secure mechanism to communicate with the server.
boolean	prepareTLS(LocalizableMessageBuilder unavailableReason) Prepares this connection for using TLS and returns whether TLS protection is actually available for the underlying client connection.
boolean	removeOperationInProgress(int messageID) Removes the provided operation from the set of operations in progress for this client connection.
protected boolean	sendIntermediateResponseMessage(IntermediateResponse intermediateResponse) Sends the provided intermediate response message to the client.
void	sendResponse(Operation operation) Sends a response to the client based on the information in the provided operation.
void	sendSearchEntry(SearchOperation searchOperation, SearchResultEntry searchEntry) Sends the provided search result entry to the client.
boolean	sendSearchReference(SearchOperation searchOperation, SearchResultReference searchReference) Sends the provided search result reference to the client.
void	setSASLPendingProvider(ConnectionSecurityProvider provider) Set the connection provider that is not in use.
void	setTLSPendingProvider(ConnectionSecurityProvider provider) Set the connection provider that is not in use yet.
void	toString(StringBuilder buffer) Appends a string representation of this client connection to the provided buffer.

Methods inherited from class org.opends.server.api.ClientConnection

deregisterPersistentSearch, finalizeConnectionInternal, finishSaslBind, getAuthenticationInfo, getCertificateAlias, getClientHostPort, getConnectTime, getConnectTimeString, getGroups, getIdleTimeLimit, getKeyManagerProviderDN, getLookthroughLimit, getPersistentSearches, getSASLAuthStateInfo, getServerHostPort, getSizeLimit, getTimeLimit, getTrustManagerProviderDN, hasAllPrivileges, hasPrivilege, hasPrivilege, isInnerConnection, isMemberOf, mustChangePassword, registerPersistentSearch, sendIntermediateResponse, setAuthenticationInfo, setIdleTimeLimit, setLookthroughLimit, setMustChangePassword, setSASLAuthStateInfo, setSizeLimit, setTimeLimit, setUnauthenticated, toString, updateAuthenticationInfo, updatePrivileges

Methods inherited from class java.lang.Object

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

Method Detail

getConnectionID

public long getConnectionID()

Retrieves the connection ID assigned to this connection.

Specified by:

getConnectionID in class ClientConnection

Returns:

The connection ID assigned to this connection.

getConnectionHandler

public ConnectionHandler<?> getConnectionHandler()

Retrieves the connection handler that accepted this client connection.

Specified by:

getConnectionHandler in class ClientConnection

Returns:

The connection handler that accepted this client connection.

getSocketChannel

public SocketChannel getSocketChannel()

Retrieves the socket channel that can be used to communicate with the client.

Overrides:

getSocketChannel in class ClientConnection

Returns:

The socket channel that can be used to communicate with the client.

getProtocol

public String getProtocol()

Retrieves the protocol that the client is using to communicate with the Directory Server.

Specified by:

getProtocol in class ClientConnection

Returns:

The protocol that the client is using to communicate with the Directory Server.

getClientAddress

public String getClientAddress()

Retrieves a string representation of the address of the client.

Specified by:

getClientAddress in class ClientConnection

Returns:

A string representation of the address of the client.

getClientPort

public int getClientPort()

Retrieves the port number for this connection on the client system.

Specified by:

getClientPort in class ClientConnection

Returns:

The port number for this connection on the client system.

getServerAddress

public String getServerAddress()

Retrieves a string representation of the address on the server to which the client connected.

Specified by:

getServerAddress in class ClientConnection

Returns:

A string representation of the address on the server to which the client connected.

getServerPort

public int getServerPort()

Retrieves the port number for this connection on the server system.

Specified by:

getServerPort in class ClientConnection

Returns:

The port number for this connection on the server system.

getRemoteAddress

public InetAddress getRemoteAddress()

Retrieves the java.net.InetAddress associated with the remote client system.

Specified by:

getRemoteAddress in class ClientConnection

Returns:

The java.net.InetAddress associated with the remote client system. It may be null if the client is not connected over an IP-based connection.

getLocalAddress

public InetAddress getLocalAddress()

Retrieves the java.net.InetAddress for the Directory Server system to which the client has established the connection.

Specified by:

getLocalAddress in class ClientConnection

Returns:

The java.net.InetAddress for the Directory Server system to which the client has established the connection. It may be null if the client is not connected over an IP-based connection.

isConnectionValid

public boolean isConnectionValid()

Returns whether the Directory Server believes this connection to be valid and available for communication.

Specified by:

isConnectionValid in class ClientConnection

Returns:

true if the connection is valid, false otherwise

isSecure

public boolean isSecure()

Indicates whether this client connection is currently using a secure mechanism to communicate with the server. Note that this may change over time based on operations performed by the client or server (e.g., it may go from false to true if the client uses the StartTLS extended operation).

Specified by:

isSecure in class ClientConnection

Returns:

true if the client connection is currently using a secure mechanism to communicate with the server, or false if not.

sendResponse

public void sendResponse(Operation operation)

Sends a response to the client based on the information in the provided operation.

Specified by:

sendResponse in class ClientConnection

Parameters:

operation - The operation for which to send the response.

sendSearchEntry

public void sendSearchEntry(SearchOperation searchOperation,
                   SearchResultEntry searchEntry)

Sends the provided search result entry to the client.

Specified by:

sendSearchEntry in class ClientConnection

Parameters:

searchOperation - The search operation with which the entry is associated.

searchEntry - The search result entry to be sent to the client.

sendSearchReference

public boolean sendSearchReference(SearchOperation searchOperation,
                          SearchResultReference searchReference)

Sends the provided search result reference to the client.

Specified by:

sendSearchReference in class ClientConnection

Parameters:

searchOperation - The search operation with which the reference is associated.

searchReference - The search result reference to be sent to the client.

Returns:

true if the client is able to accept referrals, or false if the client cannot handle referrals and no more attempts should be made to send them for the associated search operation.

sendIntermediateResponseMessage

protected boolean sendIntermediateResponseMessage(IntermediateResponse intermediateResponse)

Sends the provided intermediate response message to the client.

Specified by:

sendIntermediateResponseMessage in class ClientConnection

Parameters:

intermediateResponse - The intermediate response message to be sent.

Returns:

true if processing on the associated operation should continue, or false if not.

disconnect

public void disconnect(DisconnectReason disconnectReason,
              boolean sendNotification,
              LocalizableMessage message)

Closes the connection to the client, optionally sending it a message indicating the reason for the closure. Note that the ability to send a notice of disconnection may not be available for all protocols or under all circumstances.

Specified by:

disconnect in class ClientConnection

Parameters:

disconnectReason - The disconnect reason that provides the generic cause for the disconnect.

sendNotification - Indicates whether to try to provide notification to the client that the connection will be closed.

message - The message to include in the disconnect notification response. It may be null if no message is to be sent.

getOperationsInProgress

public Collection<Operation> getOperationsInProgress()

Retrieves the set of operations in progress for this client connection. This list must not be altered by any caller.

Specified by:

getOperationsInProgress in class ClientConnection

Returns:

The set of operations in progress for this client connection.

getOperationInProgress

public Operation getOperationInProgress(int messageID)

Retrieves the operation in progress with the specified message ID.

Specified by:

getOperationInProgress in class ClientConnection

Parameters:

messageID - The message ID for the operation to retrieve.

Returns:

The operation in progress with the specified message ID, or null if no such operation could be found.

removeOperationInProgress

public boolean removeOperationInProgress(int messageID)

Removes the provided operation from the set of operations in progress for this client connection. Note that this does not make any attempt to cancel any processing that may already be in progress for the operation.

Specified by:

removeOperationInProgress in class ClientConnection

Parameters:

messageID - The message ID of the operation to remove from the set of operations in progress.

Returns:

true if the operation was found and removed from the set of operations in progress, or false if not.

cancelOperation

public CancelResult cancelOperation(int messageID,
                           CancelRequest cancelRequest)

Attempts to cancel the specified operation.

Specified by:

cancelOperation in class ClientConnection

Parameters:

messageID - The message ID of the operation to cancel.

cancelRequest - An object providing additional information about how the cancel should be processed.

Returns:

A cancel result that either indicates that the cancel was successful or provides a reason that it was not.

cancelAllOperations

public void cancelAllOperations(CancelRequest cancelRequest)

Attempts to cancel all operations in progress on this connection.

Specified by:

cancelAllOperations in class ClientConnection

Parameters:

cancelRequest - An object providing additional information about how the cancel should be processed.

cancelAllOperationsExcept

public void cancelAllOperationsExcept(CancelRequest cancelRequest,
                             int messageID)

Attempts to cancel all operations in progress on this connection except the operation with the specified message ID.

Specified by:

cancelAllOperationsExcept in class ClientConnection

Parameters:

cancelRequest - An object providing additional information about how the cancel should be processed.

messageID - The message ID of the operation that should not be canceled.

getWriteSelector

public Selector getWriteSelector()

Retrieves a Selector that may be used to ensure that write operations complete in a timely manner, or terminate the connection in the event that they fail to do so. This is an optional method for client connections, and the default implementation returns null to indicate that the maximum blocked write time limit is not supported for this connection. Subclasses that do wish to support this functionality should return a valid Selector object.

Overrides:

getWriteSelector in class ClientConnection

Returns:

The Selector that may be used to ensure that write operations complete in a timely manner, or null if this client connection does not support maximum blocked write time limit functionality.

getMaxBlockedWriteTimeLimit

public long getMaxBlockedWriteTimeLimit()

Retrieves the maximum length of time in milliseconds that attempts to write data to the client should be allowed to block. A value of zero indicates there should be no limit.

Overrides:

getMaxBlockedWriteTimeLimit in class ClientConnection

Returns:

The maximum length of time in milliseconds that attempts to write data to the client should be allowed to block, or zero if there should be no limit.

getNumberOfOperations

public long getNumberOfOperations()

Returns the total number of operations initiated on this connection.

Specified by:

getNumberOfOperations in class ClientConnection

Returns:

the total number of operations on this connection

getMonitorSummary

public String getMonitorSummary()

Retrieves a one-line summary of this client connection in a form that is suitable for including in the monitor entry for the associated connection handler. It should be in a format that is both humand readable and machine parseable (e.g., a space-delimited name-value list, with quotes around the values).

Specified by:

getMonitorSummary in class ClientConnection

Returns:

A one-line summary of this client connection in a form that is suitable for including in the monitor entry for the associated connection handler.

toString

public void toString(StringBuilder buffer)

Appends a string representation of this client connection to the provided buffer.

Specified by:

toString in class ClientConnection

Parameters:

buffer - The buffer to which the information should be appended.

prepareTLS

public boolean prepareTLS(LocalizableMessageBuilder unavailableReason)

Prepares this connection for using TLS and returns whether TLS protection is actually available for the underlying client connection. If there is any reason that TLS protection cannot be enabled on this client connection, then it should be appended to the provided buffer.

Specified by:

prepareTLS in interface TLSCapableConnection

Parameters:

unavailableReason - The buffer used to hold the reason that TLS is not available on the underlying client connection.

Returns:

true if TLS is available on the underlying client connection, or false if it is not.

getIdleTime

public long getIdleTime()

Retrieves the length of time in milliseconds that this client connection has been idle.

Note that the default implementation will always return zero. Subclasses associated with connection handlers should override this method if they wish to provided idle time limit functionality.

Overrides:

getIdleTime in class ClientConnection

Returns:

The length of time in milliseconds that this client connection has been idle.

setTLSPendingProvider

public void setTLSPendingProvider(ConnectionSecurityProvider provider)

Set the connection provider that is not in use yet. Used in TLS negotiation when a clear response is needed before the connection provider is active.

Parameters:

provider - The provider that needs to be activated.

setSASLPendingProvider

public void setSASLPendingProvider(ConnectionSecurityProvider provider)

Set the connection provider that is not in use. Used in SASL negotiation when a clear response is needed before the connection provider is active.

Parameters:

provider - The provider that needs to be activated.

getClientCertificateChain

public Certificate[] getClientCertificateChain()

Return the certificate chain array associated with a connection.

Returns:

The array of certificates associated with a connection.

getChannel

public ByteChannel getChannel()

Retrieves the TLS redirecting byte channel used in a LDAP client connection.

Overrides:

getChannel in class ClientConnection

Returns:

The TLS redirecting byte channel.

getSSF

public int getSSF()

Return the Security Strength Factor of a client connection.

Specified by:

getSSF in class ClientConnection

Returns:

An integer representing the SSF value of a connection.

finishBind

public void finishBind()

Indicates a bind or start TLS request processing is finished and the client connection may start processing data read from the socket again. This must be called after processing each bind request in a multistage SASL bind.

Overrides:

finishBind in class ClientConnection

finishStartTLS

public void finishStartTLS()

Indicates a bind or start TLS request processing is finished and the client connection may start processing data read from the socket again. This must be called after processing each bind request in a multistage SASL bind.

Overrides:

finishStartTLS in class ClientConnection