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

java.lang.Object
  com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
      com.unboundid.ldap.sdk.unboundidds.monitors.LDAPStatisticsMonitorEntry

All Implemented Interfaces:

java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class LDAPStatisticsMonitorEntry
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 information about the types of LDAP operations processed through an LDAP connection handler. Information available through this monitor entry includes:

• The total number of requests for each type of operation received by the connection handler.
• The total number of responses of each type of operation returned by the connection handler.
• The total number of search result entries returned by the connection handler.
• The total number of search result references returned by the connection handler.
• The total number of LDAP messages read from clients.
• The total number of LDAP messages written to clients.
• The total number of request bytes read from clients.
• The total number of response bytes written to clients.
• The number of connections accepted by the connection handler.
• The number of connections closed by the connection handler.
• The number of operations initiated by the connection handler.
• The number of operations completed by the connection handler.
• The number of operations abandoned by the connection handler.

The LDAP statistics monitor entries provided by the server can be retrieved using the MonitorManager.getLDAPStatisticsMonitorEntries(com.unboundid.ldap.sdk.LDAPConnection) method. These entries provide specific methods for accessing information about the LDAP connection handler (e.g., the getAbandonRequests() method can be used to retrieve the number of abandon requests received). Alternately, this 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

Constructor Summary

LDAPStatisticsMonitorEntry(Entry entry)
Creates a new LDAP statistics monitor entry from the provided entry.

Method Summary

java.lang.Long	getAbandonRequests() Retrieves the number of abandon requests from clients since the associated connection handler was started.
java.lang.Long	getAddRequests() Retrieves the number of add requests from clients since the associated connection handler was started.
java.lang.Long	getAddResponses() Retrieves the number of add responses to clients since the associated connection handler was started.
java.lang.Long	getBindRequests() Retrieves the number of bind requests from clients since the associated connection handler was started.
java.lang.Long	getBindResponses() Retrieves the number of bind responses to clients since the associated connection handler was started.
java.lang.Long	getBytesRead() Retrieves the number of bytes read from clients since the associated connection handler was started.
java.lang.Long	getBytesWritten() Retrieves the number of bytes written to clients since the associated connection handler was started.
java.lang.Long	getCompareRequests() Retrieves the number of compare requests from clients since the associated connection handler was started.
java.lang.Long	getCompareResponses() Retrieves the number of compare responses to clients since the associated connection handler was started.
java.lang.Long	getConnectionsClosed() Retrieves the number of connections closed since the associated connection handler was started.
java.lang.Long	getConnectionsEstablished() Retrieves the number of connections established since the associated connection handler was started.
java.lang.Long	getDeleteRequests() Retrieves the number of delete requests from clients since the associated connection handler was started.
java.lang.Long	getDeleteResponses() Retrieves the number of delete responses to clients since the associated connection handler was started.
java.lang.Long	getExtendedRequests() Retrieves the number of extended requests from clients since the associated connection handler was started.
java.lang.Long	getExtendedResponses() Retrieves the number of extended responses to clients since the associated connection handler was started.
java.lang.Long	getLDAPMessagesRead() Retrieves the number of LDAP messages read from clients since the associated connection handler was started.
java.lang.Long	getLDAPMessagesWritten() Retrieves the number of LDAP messages written to clients since the associated connection handler was started.
java.lang.Long	getModifyDNRequests() Retrieves the number of modify DN requests from clients since the associated connection handler was started.
java.lang.Long	getModifyDNResponses() Retrieves the number of modify DN responses to clients since the associated connection handler was started.
java.lang.Long	getModifyRequests() Retrieves the number of modify requests from clients since the associated connection handler was started.
java.lang.Long	getModifyResponses() Retrieves the number of modify responses to clients since the associated connection handler was started.
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	getOperationsAbandoned() Retrieves the number of operations abandoned since the associated connection handler was started.
java.lang.Long	getOperationsCompleted() Retrieves the number of operations completed since the associated connection handler was started.
java.lang.Long	getOperationsInitiated() Retrieves the number of operations initiated since the associated connection handler was started.
java.lang.Long	getSearchDoneResponses() Retrieves the number of search result done responses to clients since the associated connection handler was started.
java.lang.Long	getSearchRequests() Retrieves the number of search requests from clients since the associated connection handler was started.
java.lang.Long	getSearchResultEntries() Retrieves the number of search result entries sent to clients since the associated connection handler was started.
java.lang.Long	getSearchResultReferences() Retrieves the number of search result references sent to clients since the associated connection handler was started.
java.lang.Long	getUnbindRequests() Retrieves the number of unbind requests from clients since the associated connection handler was started.

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

Constructor Detail

LDAPStatisticsMonitorEntry

public LDAPStatisticsMonitorEntry(Entry entry)

Creates a new LDAP statistics monitor entry from the provided entry.

Parameters:

entry - The entry to be parsed as an LDAP statistics monitor entry. It must not be null.

Method Detail

getConnectionsEstablished

public java.lang.Long getConnectionsEstablished()

Retrieves the number of connections established since the associated connection handler was started.

Returns:

The number of connections established since the associated connection handler was started, or null if it was not included in the monitor entry.

getConnectionsClosed

public java.lang.Long getConnectionsClosed()

Retrieves the number of connections closed since the associated connection handler was started.

Returns:

The number of connections closed since the associated connection handler was started, or null if it was not included in the monitor entry.

getOperationsInitiated

public java.lang.Long getOperationsInitiated()

Retrieves the number of operations initiated since the associated connection handler was started.

Returns:

The number of operations initiated since the associated connection handler was started, or null if it was not included in the monitor entry.

getOperationsCompleted

public java.lang.Long getOperationsCompleted()

Retrieves the number of operations completed since the associated connection handler was started.

Returns:

The number of operations completed since the associated connection handler was started, or null if it was not included in the monitor entry.

getOperationsAbandoned

public java.lang.Long getOperationsAbandoned()

Retrieves the number of operations abandoned since the associated connection handler was started.

Returns:

The number of operations abandoned since the associated connection handler was started, or null if it was not included in the monitor entry.

getBytesRead

public java.lang.Long getBytesRead()

Retrieves the number of bytes read from clients since the associated connection handler was started.

Returns:

The number of bytes read from clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getBytesWritten

public java.lang.Long getBytesWritten()

Retrieves the number of bytes written to clients since the associated connection handler was started.

Returns:

The number of bytes written to clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getLDAPMessagesRead

public java.lang.Long getLDAPMessagesRead()

Retrieves the number of LDAP messages read from clients since the associated connection handler was started.

Returns:

The number of LDAP messages read from clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getLDAPMessagesWritten

public java.lang.Long getLDAPMessagesWritten()

Retrieves the number of LDAP messages written to clients since the associated connection handler was started.

Returns:

The number of LDAP messages written to clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getAbandonRequests

public java.lang.Long getAbandonRequests()

Retrieves the number of abandon requests from clients since the associated connection handler was started.

Returns:

The number of abandon requests from clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getAddRequests

public java.lang.Long getAddRequests()

Retrieves the number of add requests from clients since the associated connection handler was started.

Returns:

The number of add requests from clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getAddResponses

public java.lang.Long getAddResponses()

Retrieves the number of add responses to clients since the associated connection handler was started.

Returns:

The number of add responses to clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getBindRequests

public java.lang.Long getBindRequests()

Retrieves the number of bind requests from clients since the associated connection handler was started.

Returns:

The number of bind requests from clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getBindResponses

public java.lang.Long getBindResponses()

Retrieves the number of bind responses to clients since the associated connection handler was started.

Returns:

The number of bind responses to clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getCompareRequests

public java.lang.Long getCompareRequests()

Retrieves the number of compare requests from clients since the associated connection handler was started.

Returns:

The number of compare requests from clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getCompareResponses

public java.lang.Long getCompareResponses()

Retrieves the number of compare responses to clients since the associated connection handler was started.

Returns:

The number of compare responses to clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getDeleteRequests

public java.lang.Long getDeleteRequests()

Retrieves the number of delete requests from clients since the associated connection handler was started.

Returns:

The number of delete requests from clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getDeleteResponses

public java.lang.Long getDeleteResponses()

Retrieves the number of delete responses to clients since the associated connection handler was started.

Returns:

The number of delete responses to clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getExtendedRequests

public java.lang.Long getExtendedRequests()

Retrieves the number of extended requests from clients since the associated connection handler was started.

Returns:

The number of extended requests from clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getExtendedResponses

public java.lang.Long getExtendedResponses()

Retrieves the number of extended responses to clients since the associated connection handler was started.

Returns:

The number of extended responses to clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getModifyRequests

public java.lang.Long getModifyRequests()

Retrieves the number of modify requests from clients since the associated connection handler was started.

Returns:

The number of modify requests from clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getModifyResponses

public java.lang.Long getModifyResponses()

Retrieves the number of modify responses to clients since the associated connection handler was started.

Returns:

The number of modify responses to clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getModifyDNRequests

public java.lang.Long getModifyDNRequests()

Retrieves the number of modify DN requests from clients since the associated connection handler was started.

Returns:

The number of modify DN requests from clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getModifyDNResponses

public java.lang.Long getModifyDNResponses()

Retrieves the number of modify DN responses to clients since the associated connection handler was started.

Returns:

The number of modify DN responses to clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getSearchRequests

public java.lang.Long getSearchRequests()

Retrieves the number of search requests from clients since the associated connection handler was started.

Returns:

The number of search requests from clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getSearchResultEntries

public java.lang.Long getSearchResultEntries()

Retrieves the number of search result entries sent to clients since the associated connection handler was started.

Returns:

The number of search result entries sent to clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getSearchResultReferences

public java.lang.Long getSearchResultReferences()

Retrieves the number of search result references sent to clients since the associated connection handler was started.

Returns:

The number of search result references sent to clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getSearchDoneResponses

public java.lang.Long getSearchDoneResponses()

Retrieves the number of search result done responses to clients since the associated connection handler was started.

Returns:

The number of search result done responses to clients since the associated connection handler was started, or null if it was not included in the monitor entry.

getUnbindRequests

public java.lang.Long getUnbindRequests()

Retrieves the number of unbind requests from clients since the associated connection handler was started.

Returns:

The number of unbind requests from clients since the associated connection handler was started, or null if it was not included in the monitor entry.

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.