com.unboundid.ldap.sdk.unboundidds.monitors
Class LDAPExternalServerMonitorEntry

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
      extended by com.unboundid.ldap.sdk.unboundidds.monitors.LDAPExternalServerMonitorEntry
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class LDAPExternalServerMonitorEntry
extends MonitorEntry

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class defines a monitor entry that provides general information about an LDAP external server used by the UnboundID Directory Proxy Server. Information that it may make available includes: The server should present an LDAP external server monitor entry for each server used by each load-balancing algorithm. These entries can be retrieved using the MonitorManager.getLDAPExternalServerMonitorEntries(com.unboundid.ldap.sdk.LDAPConnection) method. These entries provide specific methods for accessing this information. Alternately, the information may be accessed using the generic API. See the MonitorManager class documentation for an example that demonstrates the use of the generic API for accessing monitor data.

See Also:
Serialized Form

Field Summary
protected static java.lang.String LDAP_EXTERNAL_SERVER_MONITOR_OC
          The structural object class used in LDAP external server monitor entries.
 
Constructor Summary
LDAPExternalServerMonitorEntry(Entry entry)
          Creates a new LDAP external server monitor entry from the provided entry.
 
Method Summary
 java.lang.Long getAddAttempts()
          Retrieves the total number of add operations attempted against the LDAP external server.
 java.lang.Long getAddFailures()
          Retrieves the number of failed add attempts against the LDAP external server.
 java.lang.Long getAddSuccesses()
          Retrieves the number of successful add attempts against the LDAP external server.
 java.lang.Long getBindAttempts()
          Retrieves the total number of bind operations attempted against the LDAP external server.
 java.lang.Long getBindFailures()
          Retrieves the number of failed bind attempts against the LDAP external server.
 java.lang.Long getBindPoolAvailableConnections()
          Retrieves the number of currently available connections in the bind connection pool used by the LDAP external server.
 java.lang.Long getBindPoolMaxAvailableConnections()
          Retrieves the maximum number of connections that may be available in the bind connection pool used by the LDAP external server.
 java.lang.Long getBindPoolNumClosedDefunct()
          Retrieves the number of connections in the bind connection pool used by the LDAP external server that have been closed as defunct.
 java.lang.Long getBindPoolNumClosedExpired()
          Retrieves the number of connections in the bind connection pool used by the LDAP external server that have been closed as expired.
 java.lang.Long getBindPoolNumClosedUnneeded()
          Retrieves the number of connections in the bind connection pool used by the LDAP external server that have been closed as unneeded.
 java.lang.Long getBindPoolNumFailedCheckouts()
          Retrieves the number of failed checkout attempts from the bind connection pool used by the LDAP external server.
 java.lang.Long getBindPoolNumFailedConnectionAttempts()
          Retrieves the number of failed connection attempts in the bind connection pool used by the LDAP external server.
 java.lang.Long getBindPoolNumReleasedValid()
          Retrieves the number of connections released as valid back to the bind connection pool used by the LDAP external server.
 java.lang.Long getBindPoolNumSuccessfulCheckoutsAfterWaiting()
          Retrieves the number of successful checkouts from the bind connection pool used by the LDAP external server in which an existing connection was retrieved after waiting for the connection to become available.
 java.lang.Long getBindPoolNumSuccessfulCheckoutsNewConnection()
          Retrieves the number of successful checkouts from the bind connection pool used by the LDAP external server in which an existing connection was retrieved after creating a new connection.
 java.lang.Long getBindPoolNumSuccessfulCheckoutsWithoutWaiting()
          Retrieves the number of successful checkouts from the bind connection pool used by the LDAP external server in which an existing connection was retrieved without needing to wait.
 java.lang.Long getBindPoolNumSuccessfulConnectionAttempts()
          Retrieves the number of successful connection attempts in the bind connection pool used by the LDAP external server.
 java.lang.Long getBindPoolTotalSuccessfulCheckouts()
          Retrieves the total number of successful checkouts from the bind connection pool used by the LDAP external server.
 java.lang.Long getBindSuccesses()
          Retrieves the number of successful bind attempts against the LDAP external server.
 java.lang.Long getCommonPoolAvailableConnections()
          Retrieves the number of currently available connections in the common connection pool used by the LDAP external server used for both bind and non-bind operations.
 java.lang.Long getCommonPoolMaxAvailableConnections()
          Retrieves the maximum number of connections that may be available in the common connection pool used by the LDAP external server for both bind and non-bind operations.
 java.lang.Long getCommonPoolNumClosedDefunct()
          Retrieves the number of connections in the common connection pool used by the LDAP external server for both bind and non-bind operations that have been closed as defunct.
 java.lang.Long getCommonPoolNumClosedExpired()
          Retrieves the number of connections in the common connection pool used by the LDAP external server for processing both bind and non-bind operations that have been closed as expired.
 java.lang.Long getCommonPoolNumClosedUnneeded()
          Retrieves the number of connections in the common connection pool used by the LDAP external server for both bind and non-bind operations that have been closed as unneeded.
 java.lang.Long getCommonPoolNumFailedCheckouts()
          Retrieves the number of failed checkout attempts from the common connection pool used by the LDAP external server for both bind and non-bind operations.
 java.lang.Long getCommonPoolNumFailedConnectionAttempts()
          Retrieves the number of failed connection attempts in the common connection pool used by the LDAP external server for both bind and non-bind operations.
 java.lang.Long getCommonPoolNumReleasedValid()
          Retrieves the number of connections released as valid back to the common connection pool used by the LDAP external server for bind and non-bind operations.
 java.lang.Long getCommonPoolNumSuccessfulCheckoutsAfterWaiting()
          Retrieves the number of successful checkouts from the common connection pool used by the LDAP external server for both bind and non-bind operations in which an existing connection was retrieved after waiting for the connection to become available.
 java.lang.Long getCommonPoolNumSuccessfulCheckoutsNewConnection()
          Retrieves the number of successful checkouts from the common connection pool used by the LDAP external server for both bind and non-bind operations in which an existing connection was retrieved after creating a new connection.
 java.lang.Long getCommonPoolNumSuccessfulCheckoutsWithoutWaiting()
          Retrieves the number of successful checkouts from the common connection pool used by the LDAP external server for both bind and non-bind operations in which an existing connection was retrieved without needing to wait.
 java.lang.Long getCommonPoolNumSuccessfulConnectionAttempts()
          Retrieves the number of successful connection attempts in the common connection pool used by the LDAP external server for both bind and non-bind operations.
 java.lang.Long getCommonPoolTotalSuccessfulCheckouts()
          Retrieves the total number of successful checkouts from the common connection pool used by the LDAP external server for both bind and non-bind operations.
 java.lang.String getCommunicationSecurity()
          Retrieves the communication security mechanism used when communicating with the external server.
 java.lang.Long getCompareAttempts()
          Retrieves the total number of compare operations attempted against the LDAP external server.
 java.lang.Long getCompareFailures()
          Retrieves the number of failed compare attempts against the LDAP external server.
 java.lang.Long getCompareSuccesses()
          Retrieves the number of successful compare attempts against the LDAP external server.
 java.lang.Long getDeleteAttempts()
          Retrieves the total number of delete operations attempted against the LDAP external server.
 java.lang.Long getDeleteFailures()
          Retrieves the number of failed delete attempts against the LDAP external server.
 java.lang.Long getDeleteSuccesses()
          Retrieves the number of successful delete attempts against the LDAP external server.
 java.util.List<java.lang.String> getHealthCheckMessages()
          Retrieves the list of health check messages for the LDAP external server.
 java.lang.Long getHealthCheckScore()
          Retrieves the health check score for the LDAP external server.
 HealthCheckState getHealthCheckState()
          Retrieves the health check state for the LDAP external server.
 java.util.Date getHealthCheckUpdateTime()
          Retrieves the time the health check information was last updated for the LDAP external server.
 java.lang.String getLoadBalancingAlgorithmDN()
          Retrieves the DN of the configuration entry for the load-balancing algorithm that uses the LDAP external server.
 java.lang.Long getModifyAttempts()
          Retrieves the total number of modify operations attempted against the LDAP external server.
 java.lang.Long getModifyDNAttempts()
          Retrieves the total number of modify DN operations attempted against the LDAP external server.
 java.lang.Long getModifyDNFailures()
          Retrieves the number of failed modify DN attempts against the LDAP external server.
 java.lang.Long getModifyDNSuccesses()
          Retrieves the number of successful modify DN attempts against the LDAP external server.
 java.lang.Long getModifyFailures()
          Retrieves the number of failed modify attempts against the LDAP external server.
 java.lang.Long getModifySuccesses()
          Retrieves the number of successful modify attempts against the LDAP external server.
 java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
          Retrieves the set of parsed monitor attributes for this monitor entry, mapped from a unique identifier (in all lowercase characters) to the corresponding monitor attribute.
 java.lang.String getMonitorDescription()
          Retrieves a human-readable description name for this monitor entry.
 java.lang.String getMonitorDisplayName()
          Retrieves a human-readable display name for this monitor entry.
 java.lang.Long getNonBindPoolAvailableConnections()
          Retrieves the number of currently available connections in the non-bind connection pool used by the LDAP external server.
 java.lang.Long getNonBindPoolMaxAvailableConnections()
          Retrieves the maximum number of connections that may be available in the non-bind connection pool used by the LDAP external server.
 java.lang.Long getNonBindPoolNumClosedDefunct()
          Retrieves the number of connections in the non-bind connection pool used by the LDAP external server that have been closed as defunct.
 java.lang.Long getNonBindPoolNumClosedExpired()
          Retrieves the number of connections in the non-bind connection pool used by the LDAP external server that have been closed as expired.
 java.lang.Long getNonBindPoolNumClosedUnneeded()
          Retrieves the number of connections in the non-bind connection pool used by the LDAP external server that have been closed as unneeded.
 java.lang.Long getNonBindPoolNumFailedCheckouts()
          Retrieves the number of failed checkout attempts from the non-bind connection pool used by the LDAP external server.
 java.lang.Long getNonBindPoolNumFailedConnectionAttempts()
          Retrieves the number of failed connection attempts in the non-bind connection pool used by the LDAP external server.
 java.lang.Long getNonBindPoolNumReleasedValid()
          Retrieves the number of connections released as valid back to the non-bind connection pool used by the LDAP external server.
 java.lang.Long getNonBindPoolNumSuccessfulCheckoutsAfterWaiting()
          Retrieves the number of successful checkouts from the non-bind connection pool used by the LDAP external server in which an existing connection was retrieved after waiting for the connection to become available.
 java.lang.Long getNonBindPoolNumSuccessfulCheckoutsNewConnection()
          Retrieves the number of successful checkouts from the non-bind connection pool used by the LDAP external server in which an existing connection was retrieved after creating a new connection.
 java.lang.Long getNonBindPoolNumSuccessfulCheckoutsWithoutWaiting()
          Retrieves the number of successful checkouts from the non-bind connection pool used by the LDAP external server in which an existing connection was retrieved without needing to wait.
 java.lang.Long getNonBindPoolNumSuccessfulConnectionAttempts()
          Retrieves the number of successful connection attempts in the non-bind connection pool used by the LDAP external server.
 java.lang.Long getNonBindPoolTotalSuccessfulCheckouts()
          Retrieves the total number of successful checkouts from the non-bind connection pool used by the LDAP external server.
 java.lang.Long getSearchAttempts()
          Retrieves the total number of search operations attempted against the LDAP external server.
 java.lang.Long getSearchFailures()
          Retrieves the number of failed search attempts against the LDAP external server.
 java.lang.Long getSearchSuccesses()
          Retrieves the number of successful search attempts against the LDAP external server.
 java.lang.String getServerAddress()
          Retrieves the address of the LDAP external server.
 java.lang.Long getServerPort()
          Retrieves the port of the LDAP external server.
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, decode, getBoolean, getDate, getDN, getDouble, getEntry, getInteger, getLong, getMonitorClass, getMonitorName, getString, getStrings, toString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

LDAP_EXTERNAL_SERVER_MONITOR_OC

protected static final java.lang.String LDAP_EXTERNAL_SERVER_MONITOR_OC
The structural object class used in LDAP external server monitor entries.

See Also:
Constant Field Values
Constructor Detail

LDAPExternalServerMonitorEntry

public LDAPExternalServerMonitorEntry(Entry entry)
Creates a new LDAP external server monitor entry from the provided entry.

Parameters:
entry - The entry to be parsed as an LDAP external server monitor entry. It must not be null.
Method Detail

getServerAddress

public java.lang.String getServerAddress()
Retrieves the address of the LDAP external server.

Returns:
The address of the LDAP external server, or null if it was not included in the monitor entry.

getServerPort

public java.lang.Long getServerPort()
Retrieves the port of the LDAP external server.

Returns:
The port of the LDAP external server, or null if it was not included in the monitor entry.

getCommunicationSecurity

public java.lang.String getCommunicationSecurity()
Retrieves the communication security mechanism used when communicating with the external server.

Returns:
The communication security mechanism used when communicating with the external server, or null if it was not included in the monitor entry.

getLoadBalancingAlgorithmDN

public java.lang.String getLoadBalancingAlgorithmDN()
Retrieves the DN of the configuration entry for the load-balancing algorithm that uses the LDAP external server.

Returns:
The DN of the configuration entry for the load-balancing algorithm that uses the LDAP external server, or null if it was not included in the monitor entry.

getHealthCheckState

public HealthCheckState getHealthCheckState()
Retrieves the health check state for the LDAP external server.

Returns:
The health check state for the LDAP external server, or null if it was not included in the monitor entry.

getHealthCheckScore

public java.lang.Long getHealthCheckScore()
Retrieves the health check score for the LDAP external server.

Returns:
The health check score for the LDAP external server, or null if it was not included in the monitor entry.

getHealthCheckMessages

public java.util.List<java.lang.String> getHealthCheckMessages()
Retrieves the list of health check messages for the LDAP external server.

Returns:
The list of health check messages for the LDAP external server, or an empty list if it was not included in the monitor entry.

getHealthCheckUpdateTime

public java.util.Date getHealthCheckUpdateTime()
Retrieves the time the health check information was last updated for the LDAP external server.

Returns:
The time the health check information was last updated for the LDAP external server, or null if it was not included in the monitor entry.

getAddAttempts

public java.lang.Long getAddAttempts()
Retrieves the total number of add operations attempted against the LDAP external server.

Returns:
The total number of add operations attempted against the LDAP external server, or null if it was not included in the monitor entry.

getAddFailures

public java.lang.Long getAddFailures()
Retrieves the number of failed add attempts against the LDAP external server.

Returns:
The number of failed add attempts against the LDAP external server, or null if it was not included in the monitor entry.

getAddSuccesses

public java.lang.Long getAddSuccesses()
Retrieves the number of successful add attempts against the LDAP external server.

Returns:
The number of successful add attempts against the LDAP external server, or null if it was not included in the monitor entry.

getBindAttempts

public java.lang.Long getBindAttempts()
Retrieves the total number of bind operations attempted against the LDAP external server.

Returns:
The total number of bind operations attempted against the LDAP external server, or null if it was not included in the monitor entry.

getBindFailures

public java.lang.Long getBindFailures()
Retrieves the number of failed bind attempts against the LDAP external server.

Returns:
The number of failed bind attempts against the LDAP external server, or null if it was not included in the monitor entry.

getBindSuccesses

public java.lang.Long getBindSuccesses()
Retrieves the number of successful bind attempts against the LDAP external server.

Returns:
The number of successful bind attempts against the LDAP external server, or null if it was not included in the monitor entry.

getCompareAttempts

public java.lang.Long getCompareAttempts()
Retrieves the total number of compare operations attempted against the LDAP external server.

Returns:
The total number of compare operations attempted against the LDAP external server, or null if it was not included in the monitor entry.

getCompareFailures

public java.lang.Long getCompareFailures()
Retrieves the number of failed compare attempts against the LDAP external server.

Returns:
The number of failed compare attempts against the LDAP external server, or null if it was not included in the monitor entry.

getCompareSuccesses

public java.lang.Long getCompareSuccesses()
Retrieves the number of successful compare attempts against the LDAP external server.

Returns:
The number of successful compare attempts against the LDAP external server, or null if it was not included in the monitor entry.

getDeleteAttempts

public java.lang.Long getDeleteAttempts()
Retrieves the total number of delete operations attempted against the LDAP external server.

Returns:
The total number of delete operations attempted against the LDAP external server, or null if it was not included in the monitor entry.

getDeleteFailures

public java.lang.Long getDeleteFailures()
Retrieves the number of failed delete attempts against the LDAP external server.

Returns:
The number of failed delete attempts against the LDAP external server, or null if it was not included in the monitor entry.

getDeleteSuccesses

public java.lang.Long getDeleteSuccesses()
Retrieves the number of successful delete attempts against the LDAP external server.

Returns:
The number of successful delete attempts against the LDAP external server, or null if it was not included in the monitor entry.

getModifyAttempts

public java.lang.Long getModifyAttempts()
Retrieves the total number of modify operations attempted against the LDAP external server.

Returns:
The total number of modify operations attempted against the LDAP external server, or null if it was not included in the monitor entry.

getModifyFailures

public java.lang.Long getModifyFailures()
Retrieves the number of failed modify attempts against the LDAP external server.

Returns:
The number of failed modify attempts against the LDAP external server, or null if it was not included in the monitor entry.

getModifySuccesses

public java.lang.Long getModifySuccesses()
Retrieves the number of successful modify attempts against the LDAP external server.

Returns:
The number of successful modify attempts against the LDAP external server, or null if it was not included in the monitor entry.

getModifyDNAttempts

public java.lang.Long getModifyDNAttempts()
Retrieves the total number of modify DN operations attempted against the LDAP external server.

Returns:
The total number of modify DN operations attempted against the LDAP external server, or null if it was not included in the monitor entry.

getModifyDNFailures

public java.lang.Long getModifyDNFailures()
Retrieves the number of failed modify DN attempts against the LDAP external server.

Returns:
The number of failed modify DN attempts against the LDAP external server, or null if it was not included in the monitor entry.

getModifyDNSuccesses

public java.lang.Long getModifyDNSuccesses()
Retrieves the number of successful modify DN attempts against the LDAP external server.

Returns:
The number of successful modify DN attempts against the LDAP external server, or null if it was not included in the monitor entry.

getSearchAttempts

public java.lang.Long getSearchAttempts()
Retrieves the total number of search operations attempted against the LDAP external server.

Returns:
The total number of search operations attempted against the LDAP external server, or null if it was not included in the monitor entry.

getSearchFailures

public java.lang.Long getSearchFailures()
Retrieves the number of failed search attempts against the LDAP external server.

Returns:
The number of failed search attempts against the LDAP external server, or null if it was not included in the monitor entry.

getSearchSuccesses

public java.lang.Long getSearchSuccesses()
Retrieves the number of successful search attempts against the LDAP external server.

Returns:
The number of successful search attempts against the LDAP external server, or null if it was not included in the monitor entry.

getCommonPoolAvailableConnections

public java.lang.Long getCommonPoolAvailableConnections()
Retrieves the number of currently available connections in the common connection pool used by the LDAP external server used for both bind and non-bind operations.

Returns:
The number of currently available connections in the common connection pool used by the LDAP external server used for both bind and non-bind operations, or null if it was not included in the monitor entry or if the external server uses separate pools for bind and non-bind operations.

getCommonPoolMaxAvailableConnections

public java.lang.Long getCommonPoolMaxAvailableConnections()
Retrieves the maximum number of connections that may be available in the common connection pool used by the LDAP external server for both bind and non-bind operations.

Returns:
The maximum number of connections that may be available in the common connection pool used by the LDAP external server for both bind and non-bind operations, or null if it was not included in the monitor entry or if the external server uses separate pools for bind and non-bind operations.

getCommonPoolNumSuccessfulConnectionAttempts

public java.lang.Long getCommonPoolNumSuccessfulConnectionAttempts()
Retrieves the number of successful connection attempts in the common connection pool used by the LDAP external server for both bind and non-bind operations.

Returns:
The number of successful connection attempts in the common connection pool used by the LDAP external server for both bind and non-bind operations, or null if it was not included in the monitor entry or if the external server uses separate pools for bind and non-bind operations.

getCommonPoolNumFailedConnectionAttempts

public java.lang.Long getCommonPoolNumFailedConnectionAttempts()
Retrieves the number of failed connection attempts in the common connection pool used by the LDAP external server for both bind and non-bind operations.

Returns:
The number of failed connection attempts in the common connection pool used by the LDAP external server for both bind and non-bind operations, or null if it was not included in the monitor entry or if the external server uses separate pools for bind and non-bind operations.

getCommonPoolNumClosedDefunct

public java.lang.Long getCommonPoolNumClosedDefunct()
Retrieves the number of connections in the common connection pool used by the LDAP external server for both bind and non-bind operations that have been closed as defunct.

Returns:
The number of connections in the common connection pool used by the LDAP external server for both bind and non-bind operations that have been closed as defunct, or null if it was not included in the monitor entry or if the external server uses separate pools for bind and non-bind operations.

getCommonPoolNumClosedExpired

public java.lang.Long getCommonPoolNumClosedExpired()
Retrieves the number of connections in the common connection pool used by the LDAP external server for processing both bind and non-bind operations that have been closed as expired.

Returns:
The number of connections in the common connection pool used by the LDAP external server for both bind and non-bind operations that have been closed as expired, or null if it was not included in the monitor entry or if the external server uses separate pools for bind and non-bind operations.

getCommonPoolNumClosedUnneeded

public java.lang.Long getCommonPoolNumClosedUnneeded()
Retrieves the number of connections in the common connection pool used by the LDAP external server for both bind and non-bind operations that have been closed as unneeded.

Returns:
The number of connections in the common connection pool used by the LDAP external server for both bind and non-bind operations that have been closed as unneeded, or null if it was not included in the monitor entry or if the external server uses separate pools for bind and non-bind operations.

getCommonPoolTotalSuccessfulCheckouts

public java.lang.Long getCommonPoolTotalSuccessfulCheckouts()
Retrieves the total number of successful checkouts from the common connection pool used by the LDAP external server for both bind and non-bind operations.

Returns:
The total number of successful checkouts from the common connection pool used by the LDAP external server for both bind and non-bind operations, or null if it was not included in the monitor entry or if the external server uses separate pools for bind and non-bind operations.

getCommonPoolNumSuccessfulCheckoutsWithoutWaiting

public java.lang.Long getCommonPoolNumSuccessfulCheckoutsWithoutWaiting()
Retrieves the number of successful checkouts from the common connection pool used by the LDAP external server for both bind and non-bind operations in which an existing connection was retrieved without needing to wait.

Returns:
The number of successful checkouts from the common connection pool used by the LDAP external server for both bind and non-bind operations in which an existing connection was retrieved without needing to wait, or null if it was not included in the monitor entry or if the external server uses separate pools for bind and non-bind operations.

getCommonPoolNumSuccessfulCheckoutsAfterWaiting

public java.lang.Long getCommonPoolNumSuccessfulCheckoutsAfterWaiting()
Retrieves the number of successful checkouts from the common connection pool used by the LDAP external server for both bind and non-bind operations in which an existing connection was retrieved after waiting for the connection to become available.

Returns:
The number of successful checkouts from the common connection pool used by the LDAP external server for both bind and non-bind operations in which an existing connection was retrieved after waiting for the connection to become available, or null if it was not included in the monitor entry or if the external server uses separate pools for bind and non-bind operations.

getCommonPoolNumSuccessfulCheckoutsNewConnection

public java.lang.Long getCommonPoolNumSuccessfulCheckoutsNewConnection()
Retrieves the number of successful checkouts from the common connection pool used by the LDAP external server for both bind and non-bind operations in which an existing connection was retrieved after creating a new connection.

Returns:
The number of successful checkouts from the common connection pool used by the LDAP external server for both bind and non-bind operations in which an existing connection was retrieved after creating a new connection, or null if it was not included in the monitor entry or if the external server uses separate pools for bind and non-bind operations.

getCommonPoolNumFailedCheckouts

public java.lang.Long getCommonPoolNumFailedCheckouts()
Retrieves the number of failed checkout attempts from the common connection pool used by the LDAP external server for both bind and non-bind operations.

Returns:
The number of failed checkout attempts from the common connection pool used by the LDAP external server for both bind and non-bind operations, or null if it was not included in the monitor entry or if the external server uses separate pools for bind and non-bind operations.

getCommonPoolNumReleasedValid

public java.lang.Long getCommonPoolNumReleasedValid()
Retrieves the number of connections released as valid back to the common connection pool used by the LDAP external server for bind and non-bind operations.

Returns:
The number of connections released as valid back to the common connection pool used by the LDAP external server used for bind and non-bind operations, or null if it was not included in the monitor entry or if the external server uses a separate pools for bind and non-bind operations.

getBindPoolAvailableConnections

public java.lang.Long getBindPoolAvailableConnections()
Retrieves the number of currently available connections in the bind connection pool used by the LDAP external server.

Returns:
The number of currently available connections in the bind connection pool used by the LDAP external server, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getBindPoolMaxAvailableConnections

public java.lang.Long getBindPoolMaxAvailableConnections()
Retrieves the maximum number of connections that may be available in the bind connection pool used by the LDAP external server.

Returns:
The maximum number of connections that may be available in the bind connection pool used by the LDAP external server, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getBindPoolNumSuccessfulConnectionAttempts

public java.lang.Long getBindPoolNumSuccessfulConnectionAttempts()
Retrieves the number of successful connection attempts in the bind connection pool used by the LDAP external server.

Returns:
The number of successful connection attempts in the bind connection pool used by the LDAP external server, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getBindPoolNumFailedConnectionAttempts

public java.lang.Long getBindPoolNumFailedConnectionAttempts()
Retrieves the number of failed connection attempts in the bind connection pool used by the LDAP external server.

Returns:
The number of failed connection attempts in the bind connection pool used by the LDAP external server, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getBindPoolNumClosedDefunct

public java.lang.Long getBindPoolNumClosedDefunct()
Retrieves the number of connections in the bind connection pool used by the LDAP external server that have been closed as defunct.

Returns:
The number of connections in the bind connection pool used by the LDAP external server that have been closed as defunct, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getBindPoolNumClosedExpired

public java.lang.Long getBindPoolNumClosedExpired()
Retrieves the number of connections in the bind connection pool used by the LDAP external server that have been closed as expired.

Returns:
The number of connections in the bind connection pool used by the LDAP external server that have been closed as expired, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getBindPoolNumClosedUnneeded

public java.lang.Long getBindPoolNumClosedUnneeded()
Retrieves the number of connections in the bind connection pool used by the LDAP external server that have been closed as unneeded.

Returns:
The number of connections in the bind connection pool used by the LDAP external server that have been closed as unneeded, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getBindPoolTotalSuccessfulCheckouts

public java.lang.Long getBindPoolTotalSuccessfulCheckouts()
Retrieves the total number of successful checkouts from the bind connection pool used by the LDAP external server.

Returns:
The total number of successful checkouts from the bind connection pool used by the LDAP external server, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getBindPoolNumSuccessfulCheckoutsWithoutWaiting

public java.lang.Long getBindPoolNumSuccessfulCheckoutsWithoutWaiting()
Retrieves the number of successful checkouts from the bind connection pool used by the LDAP external server in which an existing connection was retrieved without needing to wait.

Returns:
The number of successful checkouts from the bind connection pool used by the LDAP external server in which an existing connection was retrieved without needing to wait, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getBindPoolNumSuccessfulCheckoutsAfterWaiting

public java.lang.Long getBindPoolNumSuccessfulCheckoutsAfterWaiting()
Retrieves the number of successful checkouts from the bind connection pool used by the LDAP external server in which an existing connection was retrieved after waiting for the connection to become available.

Returns:
The number of successful checkouts from the bind connection pool used by the LDAP external server in which an existing connection was retrieved after waiting for the connection to become available, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getBindPoolNumSuccessfulCheckoutsNewConnection

public java.lang.Long getBindPoolNumSuccessfulCheckoutsNewConnection()
Retrieves the number of successful checkouts from the bind connection pool used by the LDAP external server in which an existing connection was retrieved after creating a new connection.

Returns:
The number of successful checkouts from the bind connection pool used by the LDAP external server in which an existing connection was retrieved after creating a new connection, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getBindPoolNumFailedCheckouts

public java.lang.Long getBindPoolNumFailedCheckouts()
Retrieves the number of failed checkout attempts from the bind connection pool used by the LDAP external server.

Returns:
The number of failed checkout attempts from the bind connection pool used by the LDAP external server, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getBindPoolNumReleasedValid

public java.lang.Long getBindPoolNumReleasedValid()
Retrieves the number of connections released as valid back to the bind connection pool used by the LDAP external server.

Returns:
The number of connections released as valid back to the bind connection pool used by the LDAP external server, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getNonBindPoolAvailableConnections

public java.lang.Long getNonBindPoolAvailableConnections()
Retrieves the number of currently available connections in the non-bind connection pool used by the LDAP external server.

Returns:
The number of currently available connections in the non-bind connection pool used by the LDAP external server, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getNonBindPoolMaxAvailableConnections

public java.lang.Long getNonBindPoolMaxAvailableConnections()
Retrieves the maximum number of connections that may be available in the non-bind connection pool used by the LDAP external server.

Returns:
The maximum number of connections that may be available in the non-bind connection pool used by the LDAP external server, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getNonBindPoolNumSuccessfulConnectionAttempts

public java.lang.Long getNonBindPoolNumSuccessfulConnectionAttempts()
Retrieves the number of successful connection attempts in the non-bind connection pool used by the LDAP external server.

Returns:
The number of successful connection attempts in the non-bind connection pool used by the LDAP external server, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getNonBindPoolNumFailedConnectionAttempts

public java.lang.Long getNonBindPoolNumFailedConnectionAttempts()
Retrieves the number of failed connection attempts in the non-bind connection pool used by the LDAP external server.

Returns:
The number of failed connection attempts in the non-bind connection pool used by the LDAP external server, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getNonBindPoolNumClosedDefunct

public java.lang.Long getNonBindPoolNumClosedDefunct()
Retrieves the number of connections in the non-bind connection pool used by the LDAP external server that have been closed as defunct.

Returns:
The number of connections in the non-bind connection pool used by the LDAP external server that have been closed as defunct, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getNonBindPoolNumClosedExpired

public java.lang.Long getNonBindPoolNumClosedExpired()
Retrieves the number of connections in the non-bind connection pool used by the LDAP external server that have been closed as expired.

Returns:
The number of connections in the non-bind connection pool used by the LDAP external server that have been closed as expired, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getNonBindPoolNumClosedUnneeded

public java.lang.Long getNonBindPoolNumClosedUnneeded()
Retrieves the number of connections in the non-bind connection pool used by the LDAP external server that have been closed as unneeded.

Returns:
The number of connections in the non-bind connection pool used by the LDAP external server that have been closed as unneeded, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getNonBindPoolTotalSuccessfulCheckouts

public java.lang.Long getNonBindPoolTotalSuccessfulCheckouts()
Retrieves the total number of successful checkouts from the non-bind connection pool used by the LDAP external server.

Returns:
The total number of successful checkouts from the non-bind connection pool used by the LDAP external server, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getNonBindPoolNumSuccessfulCheckoutsWithoutWaiting

public java.lang.Long getNonBindPoolNumSuccessfulCheckoutsWithoutWaiting()
Retrieves the number of successful checkouts from the non-bind connection pool used by the LDAP external server in which an existing connection was retrieved without needing to wait.

Returns:
The number of successful checkouts from the non-bind connection pool used by the LDAP external server in which an existing connection was retrieved without needing to wait, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getNonBindPoolNumSuccessfulCheckoutsAfterWaiting

public java.lang.Long getNonBindPoolNumSuccessfulCheckoutsAfterWaiting()
Retrieves the number of successful checkouts from the non-bind connection pool used by the LDAP external server in which an existing connection was retrieved after waiting for the connection to become available.

Returns:
The number of successful checkouts from the non-bind connection pool used by the LDAP external server in which an existing connection was retrieved after waiting for the connection to become available, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getNonBindPoolNumSuccessfulCheckoutsNewConnection

public java.lang.Long getNonBindPoolNumSuccessfulCheckoutsNewConnection()
Retrieves the number of successful checkouts from the non-bind connection pool used by the LDAP external server in which an existing connection was retrieved after creating a new connection.

Returns:
The number of successful checkouts from the non-bind connection pool used by the LDAP external server in which an existing connection was retrieved after creating a new connection, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getNonBindPoolNumFailedCheckouts

public java.lang.Long getNonBindPoolNumFailedCheckouts()
Retrieves the number of failed checkout attempts from the non-bind connection pool used by the LDAP external server.

Returns:
The number of failed checkout attempts from the non-bind connection pool used by the LDAP external server, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getNonBindPoolNumReleasedValid

public java.lang.Long getNonBindPoolNumReleasedValid()
Retrieves the number of connections released as valid back to the non-bind connection pool used by the LDAP external server.

Returns:
The number of connections released as valid back to the non-bind connection pool used by the LDAP external server, or null if it was not included in the monitor entry or if the external server uses a common pool for bind and non-bind operations.

getMonitorDisplayName

public java.lang.String getMonitorDisplayName()
Retrieves a human-readable display name for this monitor entry.

Overrides:
getMonitorDisplayName in class MonitorEntry
Returns:
A human-readable display name for this monitor entry.

getMonitorDescription

public java.lang.String getMonitorDescription()
Retrieves a human-readable description name for this monitor entry.

Overrides:
getMonitorDescription in class MonitorEntry
Returns:
A human-readable description name for this monitor entry.

getMonitorAttributes

public java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
Retrieves the set of parsed monitor attributes for this monitor entry, mapped from a unique identifier (in all lowercase characters) to the corresponding monitor attribute.

Overrides:
getMonitorAttributes in class MonitorEntry
Returns:
The set of parsed monitor attributes for this monitor entry.