public interface LdapSession
Modifier and Type | Method and Description |
---|---|
void |
addListener(LdapSessionCompletionListener listener)
Register a listener which will be notified when this
LdapSession changes state. |
void |
disconnect()
Disconnects the client without sending a disconnect notification.
|
void |
disconnect(ResultCode resultCode,
CharSequence diagnosticMessage)
Disconnects the client and sends a disconnect notification, containing the provided result code and diagnostic
message.
|
InetSocketAddress |
getLocalAddress()
Returns the
InetSocketAddress associated with the local system. |
InetSocketAddress |
getPeerAddress()
Returns the
InetSocketAddress associated with the remote system. |
SaslServer |
getSaslServer()
Returns the
SaslServer currently in use by the underlying connection, or
null if SASL integrity and/or privacy protection is not enabled. |
int |
getSecurityStrengthFactor()
Returns the cipher strength, in bits, currently in use by the underlying
connection.
|
SSLSession |
getSslSession()
Returns the SSL session currently in use by the underlying connection, or
null if SSL/TLS is not enabled. |
boolean |
isClosed()
Returns
true if the underlying connection has been closed as a result of a client disconnect,
a fatal connection error, or a server-side disconnect() . |
Completable |
sendUnsolicitedNotification(ExtendedResult notification)
Sends an unsolicited notification to the client.
|
void addListener(LdapSessionCompletionListener listener)
LdapSession
changes state.listener
- The LdapSessionCompletionListener
to register.void disconnect()
LdapSessionCompletionListener.handleConnectionDisconnected(LdapSession, ResultCode, String)
to be
called before this method returns.void disconnect(ResultCode resultCode, CharSequence diagnosticMessage)
LdapSessionCompletionListener.handleConnectionDisconnected(LdapSession, ResultCode, String)
to be
called before this method returns.resultCode
- The result code to include with the disconnect notificationdiagnosticMessage
- The diagnostic message to include with the disconnect notificationInetSocketAddress getLocalAddress()
InetSocketAddress
associated with the local system.InetSocketAddress
associated with the local system.InetSocketAddress getPeerAddress()
InetSocketAddress
associated with the remote system.InetSocketAddress
associated with the remote system.int getSecurityStrengthFactor()
javax.servlet.request.key_size
property defined in the Servlet
specification (section 3.8 "SSL Attributes"). It provides no indication
of the relative strength of different cipher algorithms, their known
weaknesses, nor the strength of other cryptographic information used
during SSL/TLS negotiation.SSLSession getSslSession()
null
if SSL/TLS is not enabled.null
if SSL/TLS is not enabled.SaslServer getSaslServer()
SaslServer
currently in use by the underlying connection, or
null
if SASL integrity and/or privacy protection is not enabled.SaslServer
currently in use by the underlying connection, or
null
if SASL integrity and/or privacy protection is not enabled.boolean isClosed()
true
if the underlying connection has been closed as a result of a client disconnect,
a fatal connection error, or a server-side disconnect()
.
This method provides a polling mechanism which can be used by synchronous request handler implementations to detect connection termination.
Server connections: this method will always return true
when called from within
handleConnectionClosed()
,
handleConnectionDisconnected()
, or
handleConnectionError()
.
true
if the underlying connection has been closed.Completable sendUnsolicitedNotification(ExtendedResult notification)
notification
- The notification to send.Completable
which will be completed once the notification has been sent.Copyright 2010-2022 ForgeRock AS.