Class StartAdministrativeSessionPostConnectProcessor
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.extensions.StartAdministrativeSessionPostConnectProcessor
-
- All Implemented Interfaces:
PostConnectProcessor
,java.io.Serializable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class StartAdministrativeSessionPostConnectProcessor extends java.lang.Object implements PostConnectProcessor, java.io.Serializable
This class provides an implementation of a post-connect processor that can be used to start an administrative session on a connection that is meant to be part of a connection pool. If this is to be used in conjunction with other post-connect processors (via theAggregatePostConnectProcessor
), then the start administrative session processor should generally be invoked first (even before theStartTLSPostConnectProcessor
) to ensure that any interaction with the server will be able to make use of the dedicated worker thread pool the server sets aside for operations using an administrative session.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description StartAdministrativeSessionPostConnectProcessor(StartAdministrativeSessionExtendedRequest request)
Creates a new start administrative session post-connect processor that will issue the provided extended request over a newly-established connection.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
processPostAuthenticatedConnection(LDAPConnection connection)
Performs any appropriate processing on the provided connection before making it available for use in a connection pool.void
processPreAuthenticatedConnection(LDAPConnection connection)
Performs any appropriate processing on the provided connection before making it available for use in a connection pool.
-
-
-
Constructor Detail
-
StartAdministrativeSessionPostConnectProcessor
public StartAdministrativeSessionPostConnectProcessor(@NotNull StartAdministrativeSessionExtendedRequest request)
Creates a new start administrative session post-connect processor that will issue the provided extended request over a newly-established connection.- Parameters:
request
- The start administrative session extended request to be invoked for newly-established connections.
-
-
Method Detail
-
processPreAuthenticatedConnection
public void processPreAuthenticatedConnection(@NotNull LDAPConnection connection) throws LDAPException
Performs any appropriate processing on the provided connection before making it available for use in a connection pool. This method will be invoked immediately after the connection has been established but before any attempt has been made to perform any authentication.- Specified by:
processPreAuthenticatedConnection
in interfacePostConnectProcessor
- Parameters:
connection
- The connection for which the processing is to be performed.- Throws:
LDAPException
- If a problem occurs during processing. If an exception is thrown, then the connection will be terminated and not used in the pool.
-
processPostAuthenticatedConnection
public void processPostAuthenticatedConnection(@NotNull LDAPConnection connection) throws LDAPException
Performs any appropriate processing on the provided connection before making it available for use in a connection pool. This method will be invoked immediately after any appropriate authentication has been performed on the connection.- Specified by:
processPostAuthenticatedConnection
in interfacePostConnectProcessor
- Parameters:
connection
- The connection for which the processing is to be performed.- Throws:
LDAPException
- If a problem occurs during processing. If an exception is thrown, then the connection will be terminated and not used in the pool.
-
-