com.unboundid.ldap.sdk.unboundidds.monitors

Class ConnectionHandlerMonitorEntry

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry

com.unboundid.ldap.sdk.unboundidds.monitors.ConnectionHandlerMonitorEntry

All Implemented Interfaces:

java.io.Serializable

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

This class defines a monitor entry that provides general information about a Directory Server connection handler.

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.

Information that may be available in a connection handler monitor entry includes:

• The total number of connections that are established.
• The protocol that the connection handler uses to communicate with clients.
• A list of the listeners (addresses and ports on which the connection handler is listening for connections.
• Information about each of the connections established to the connection handler. The information available for these connections may vary by connection handler type.

The connection handler monitor entries provided by the server can be retrieved using the MonitorManager.getConnectionHandlerMonitorEntries(com.unboundid.ldap.sdk.LDAPConnection) method. These entries provide specific methods for accessing information about the connection handler (e.g., the getNumConnections() method can be used to retrieve the total number of connections established). 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

Constructors

Constructor and Description
ConnectionHandlerMonitorEntry(Entry entry) Creates a new connection handler monitor entry from the provided entry.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getConnections() Retrieves a list of the string representations of the connections established to the associated connection handler.
java.util.List<java.lang.String>	getListeners() Retrieves a list of the listeners for the associated connection handler.
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	getNumConnections() Retrieves the number of connections currently established to the associated connection handler.
java.lang.String	getProtocol() Retrieves the protocol for the associated connection handler.

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

ConnectionHandlerMonitorEntry

public ConnectionHandlerMonitorEntry(@NotNull
                                     Entry entry)

Creates a new connection handler monitor entry from the provided entry.

Parameters:

entry - The entry to be parsed as a connection handler monitor entry. It must not be null.

Method Detail

getConnections

@NotNull
public java.util.List<java.lang.String> getConnections()

Retrieves a list of the string representations of the connections established to the associated connection handler. Values should be space-delimited name-value pairs with the values surrounded by quotation marks.

Returns:

A list of the string representations of the connections established to the associated connection handler, or an empty list if it was not included in the monitor entry or there are no established connections.

getListeners

@NotNull
public java.util.List<java.lang.String> getListeners()

Retrieves a list of the listeners for the associated connection handler.

Returns:

A list of the listeners for the associated connection handler, or an empty list if it was not included in the monitor entry or the connection handler does not have any listeners.

getNumConnections

@Nullable
public java.lang.Long getNumConnections()

Retrieves the number of connections currently established to the associated connection handler.

Returns:

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

getProtocol

@Nullable
public java.lang.String getProtocol()

Retrieves the protocol for the associated connection handler.

Returns:

The protocol for the associated connection handler, or null if it was not included in the monitor entry.

getMonitorDisplayName

@NotNull
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

@NotNull
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

@NotNull
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.