@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ReportBindResultLDAPConnectionPoolHealthCheck extends LDAPConnectionPoolHealthCheck
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundiddspackage 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.
|Constructor and Description|
Creates a new instance of this health check with the provided information.
|Modifier and Type||Method and Description|
Performs any desired processing to determine whether the provided connection is valid after processing a bind operation with the provided result.
Appends a string representation of this LDAP connection pool health check to the provided buffer.
ensureConnectionValidAfterException, ensureConnectionValidForCheckout, ensureConnectionValidForContinuedUse, ensureConnectionValidForRelease, ensureNewConnectionValid, performPoolMaintenance, toString
public ReportBindResultLDAPConnectionPoolHealthCheck(@NotNull CommandLineTool tool, boolean displaySuccessResultWithControls, boolean displaySuccessResultWithoutControls)
tool- The tool with which this health check is associated. Any success messages written will be sent to the tool's standard output stream. Any failure messages written will be sent to the tool's standard error stream.
displaySuccessResultWithControls- Indicates whether to display information about a bind result with a result code of
SUCCESSthat has one or more response controls.
displaySuccessResultWithoutControls- Indicates whether to display information about a bind result with a result code of
SUCCESSthat has no response controls.
public void ensureConnectionValidAfterAuthentication(@NotNull LDAPConnection connection, @NotNull BindResult bindResult) throws LDAPException
ServerSetand a non-
BindRequest, then this health check method will be invoked for every new connection created by the pool after processing that
BindRequeston the connection. If you create a connection pool with a
BindRequest, then no authentication will be attempted (and therefore this health check method will not be invoked for) newly-created connections.
LDAPConnectionafter having performed a bind operation on that connection, then every new connection created by the pool will attempt to perform the same type of bind operation and this health check method will be invoked after that bind attempt has completed. If you create a connection pool with an
LDAPConnectionthat has not been authenticated, then no authentication will be attempted (and therefore this health check method will not be invoked for) newly-created connections.
bindAndRevertAuthenticationmethod, then this health check method will be called after the second bind operation (the one used to revert authentication) has completed. In this case, this health check method will be called even if the connection pool was created with a
BindRequestor with an unauthenticated
LDAPConnection. In that case, the bind operation used to revert authentication will be a
SimpleBindRequestwith an empty DN and password.
releaseAndReAuthenticateConnectionmethod, then this health check method will be called after the bind operation has completed. As with
bindAndRevertAuthentication, this health check method will be called even if the connection pool was created with a
BindRequestor with an unauthenticated
BindResultthat has a result code other than
ResultCode.SUCCESS, if this method throws an exception then that exception will be propagated to the caller. If this method does not throw an exception when provided with a non-
SUCCESSresult, then the connection pool itself will throw an exception using the information in the bind result.
connection- The connection to be examined.
bindResult- The bind result obtained from the authentication process.
LDAPException- If a problem is detected that suggests that the provided connection is not suitable for use.