com.unboundid.ldap.sdk

Class LDAPConnectionPoolHealthCheckResult

java.lang.Object

com.unboundid.ldap.sdk.LDAPConnectionPoolHealthCheckResult

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class LDAPConnectionPoolHealthCheckResult
extends java.lang.Object
implements java.io.Serializable

This class provides a data structure that holds information about the result of an LDAP connection pool health check.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
int	getNumDefunct() Retrieves the number of connections found to be invalid (e.g., because they were no longer established, or because they failed the health check) and were attempted to be replaced as defunct.
int	getNumExamined() Retrieves the number of connections that were examined during the health check.
int	getNumExpired() Retrieves the number of connections found to have been established for longer than the pool's maximum connection age and were attempted to be replaced as expired.
java.lang.String	toString() Retrieves a string representation of this connection pool health check result.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this connection pool health check result to the provided buffer.

Methods inherited from class java.lang.Object

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

Method Detail

getNumExamined

public int getNumExamined()

Retrieves the number of connections that were examined during the health check.

Returns:

The number of connections that were examined during the health check.

getNumExpired

public int getNumExpired()

Retrieves the number of connections found to have been established for longer than the pool's maximum connection age and were attempted to be replaced as expired.

Returns:

The number of connections found to have been established for longer than the pool's maximum connection age and were attempted to be replaced as expired.

getNumDefunct

public int getNumDefunct()

Retrieves the number of connections found to be invalid (e.g., because they were no longer established, or because they failed the health check) and were attempted to be replaced as defunct.

Returns:

The number of connections found to be invalid and were attempted to be replaced as defunct.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this connection pool health check result.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this connection pool health check result.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer)

Appends a string representation of this connection pool health check result to the provided buffer.

Parameters:

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