com.unboundid.ldap.sdk.unboundidds.monitors

Class ClientConnectionMonitorEntry

java.lang.Object

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

com.unboundid.ldap.sdk.unboundidds.monitors.ClientConnectionMonitorEntry

All Implemented Interfaces:

java.io.Serializable

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

This class defines a monitor entry that provides general information about the client connections currently established. Note that the information available for each client connection may vary based on the type of connection handler with which that connection is associated.

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.

The server should present at most one client connection monitor entry. It can be retrieved using the MonitorManager.getClientConnectionMonitorEntry(com.unboundid.ldap.sdk.LDAPConnection) method. The getConnections() method may be used to retrieve information for each connection. 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
ClientConnectionMonitorEntry(Entry entry) Creates a new client connection 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 Directory 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.

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

ClientConnectionMonitorEntry

public ClientConnectionMonitorEntry(@NotNull
                                    Entry entry)

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

Parameters:

entry - The entry to be parsed as a client connection 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 Directory Server. 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 Directory Server, or an empty list if it was not included in the monitor entry or there are no established connections.

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.