Package com.unboundid.ldap.sdk.unboundidds.monitors

Class MonitorEntry

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ActiveOperationsMonitorEntry, BackendMonitorEntry, ClientConnectionMonitorEntry, ConnectionHandlerMonitorEntry, DiskSpaceUsageMonitorEntry, EntryCacheMonitorEntry, FIFOEntryCacheMonitorEntry, GaugeMonitorEntry, GeneralMonitorEntry, GroupCacheMonitorEntry, HostSystemRecentCPUAndMemoryMonitorEntry, IndexMonitorEntry, JEEnvironmentMonitorEntry, LDAPExternalServerMonitorEntry, LDAPStatisticsMonitorEntry, LoadBalancingAlgorithmMonitorEntry, MemoryUsageMonitorEntry, ProcessingTimeHistogramMonitorEntry, ReplicaMonitorEntry, ReplicationServerMonitorEntry, ReplicationSummaryMonitorEntry, ResultCodeMonitorEntry, StackTraceMonitorEntry, SystemInfoMonitorEntry, TraditionalWorkQueueMonitorEntry, UnboundIDWorkQueueMonitorEntry, VersionMonitorEntry

@NotExtensible
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public class MonitorEntry
extends java.lang.Object
implements java.io.Serializable

This class defines a generic monitor entry that provides access to monitor information provided by a Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 server instance. Subclasses may provide specific methods for interpreting the information exposed by specific types of monitor entries.

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.

See the MonitorManager class for an example that demonstrates the process for retrieving all monitor entries available in the directory server and retrieving the information they provide using the generic API.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MonitorEntry(Entry entry)	Creates a new monitor entry from the information contained in the provided entry.

Method Summary

Modifier and Type	Method	Description
protected static void	addMonitorAttribute(java.util.Map<java.lang.String,MonitorAttribute> attrs, java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.Boolean value)	Adds a new monitor attribute to the specified map using the provided information.
protected static void	addMonitorAttribute(java.util.Map<java.lang.String,MonitorAttribute> attrs, java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.Double value)	Adds a new monitor attribute to the specified map using the provided information.
protected static void	addMonitorAttribute(java.util.Map<java.lang.String,MonitorAttribute> attrs, java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.Integer value)	Adds a new monitor attribute to the specified map using the provided information.
protected static void	addMonitorAttribute(java.util.Map<java.lang.String,MonitorAttribute> attrs, java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.Long value)	Adds a new monitor attribute to the specified map using the provided information.
protected static void	addMonitorAttribute(java.util.Map<java.lang.String,MonitorAttribute> attrs, java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.String value)	Adds a new monitor attribute to the specified map using the provided information.
protected static void	addMonitorAttribute(java.util.Map<java.lang.String,MonitorAttribute> attrs, java.lang.String name, java.lang.String displayName, java.lang.String description, java.util.Date value)	Adds a new monitor attribute to the specified map using the provided information.
protected static void	addMonitorAttribute(java.util.Map<java.lang.String,MonitorAttribute> attrs, java.lang.String name, java.lang.String displayName, java.lang.String description, java.util.List<java.lang.String> values)	Adds a new monitor attribute to the specified map using the provided information.
static MonitorEntry	decode(Entry entry)	Creates a monitor entry object from the provided entry.
protected java.lang.Boolean	getBoolean(java.lang.String attributeName)	Retrieves the value of the specified attribute as a Boolean object.
protected java.util.Date	getDate(java.lang.String attributeName)	Retrieves the value of the specified attribute as a Date object.
java.lang.String	getDN()	Retrieves the DN for this monitor entry.
protected java.lang.Double	getDouble(java.lang.String attributeName)	Retrieves the value of the specified attribute as a Double object.
ReadOnlyEntry	getEntry()	Retrieves the Entry used to create this monitor entry.
protected java.lang.Integer	getInteger(java.lang.String attributeName)	Retrieves the value of the specified attribute as an Integer object.
protected java.lang.Long	getLong(java.lang.String attributeName)	Retrieves the value of the specified attribute as a Long object.
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	getMonitorClass()	Retrieves the name of the structural object class for this monitor entry.
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.String	getMonitorName()	Retrieves the monitor name for this monitor entry.
protected java.lang.String	getString(java.lang.String attributeName)	Retrieves the value of the specified attribute as a string.
protected java.util.List<java.lang.String>	getStrings(java.lang.String attributeName)	Retrieves the set of values of the specified attribute as a string list.
java.lang.String	toString()	Retrieves a string representation of this monitor entry.
void	toString(java.lang.StringBuilder buffer)	Appends a string representation of this monitor entry to the provided buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

MonitorEntry

public MonitorEntry(Entry entry)

Creates a new monitor entry from the information contained in the provided entry.

Parameters:

entry - The entry providing information to use for this monitor entry. It must not be null.

Method Detail

getDN

public final java.lang.String getDN()

Retrieves the DN for this monitor entry.

Returns:

The DN for this monitor entry.

getEntry

public final ReadOnlyEntry getEntry()

Retrieves the Entry used to create this monitor entry.

Returns:

The Entry used to create this monitor entry.

getMonitorClass

public final java.lang.String getMonitorClass()

Retrieves the name of the structural object class for this monitor entry.

Returns:

The name of the structural object class for this monitor entry, or the generic monitor object class if no appropriate subclass could be identified.

getMonitorName

public final java.lang.String getMonitorName()

Retrieves the monitor name for this monitor entry.

Returns:

The monitor name for this monitor entry, 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.

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.

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.

Returns:

The set of parsed monitor attributes for this monitor entry.

decode

public static MonitorEntry decode(Entry entry)

Creates a monitor entry object from the provided entry. An attempt will be made to decode the entry as an instance of the most appropriate subclass, but if that is not possible then it will be parsed as a generic monitor entry.

Parameters:

entry - The entry to be decoded as a monitor entry.

Returns:

The decoded monitor entry of the appropriate subtype, or a generic monitor entry if no appropriate subclass could be identified.

getBoolean

protected final java.lang.Boolean getBoolean(java.lang.String attributeName)

Retrieves the value of the specified attribute as a Boolean object.

Parameters:

attributeName - The name of the target attribute.

Returns:

The Boolean object parsed from the specified attribute, or null if the attribute does not exist in the entry or it cannot be parsed as a Boolean value.

getDate

protected final java.util.Date getDate(java.lang.String attributeName)

Retrieves the value of the specified attribute as a Date object.

Parameters:

attributeName - The name of the target attribute.

Returns:

The Date object parsed from the specified attribute, or null if the attribute does not exist in the entry or it cannot be parsed as a Date value.

getDouble

protected final java.lang.Double getDouble(java.lang.String attributeName)

Retrieves the value of the specified attribute as a Double object.

Parameters:

attributeName - The name of the target attribute.

Returns:

The Double object parsed from the specified attribute, or null if the attribute does not exist in the entry or it cannot be parsed as a Double value.

getInteger

protected final java.lang.Integer getInteger(java.lang.String attributeName)

Retrieves the value of the specified attribute as an Integer object.

Parameters:

attributeName - The name of the target attribute.

Returns:

The Integer object parsed from the specified attribute, or null if the attribute does not exist in the entry or it cannot be parsed as an Integer value.

getLong

protected final java.lang.Long getLong(java.lang.String attributeName)

Retrieves the value of the specified attribute as a Long object.

Parameters:

attributeName - The name of the target attribute.

Returns:

The Long object parsed from the specified attribute, or null if the attribute does not exist in the entry or it cannot be parsed as a Long value.

getString

protected final java.lang.String getString(java.lang.String attributeName)

Retrieves the value of the specified attribute as a string.

Parameters:

attributeName - The name of the target attribute.

Returns:

The string value of the specified attribute, or null if it does not exist in the entry.

getStrings

protected final java.util.List<java.lang.String> getStrings(java.lang.String attributeName)

Retrieves the set of values of the specified attribute as a string list.

Parameters:

attributeName - The name of the target attribute.

Returns:

The string values of the specified attribute, or an empty list if the specified attribute does not exist in the entry.

addMonitorAttribute

protected static void addMonitorAttribute(java.util.Map<java.lang.String,MonitorAttribute> attrs,
                                          java.lang.String name,
                                          java.lang.String displayName,
                                          java.lang.String description,
                                          java.lang.Boolean value)

Adds a new monitor attribute to the specified map using the provided information.

Parameters:

attrs - The attribute map to which the information should be added.

name - The name to use for this monitor attribute. It must be unique among all other monitor attribute names for the associated monitor entry.

displayName - The human-readable display name for the monitor attribute.

description - The human-readable description for the monitor attribute.

value - The value for the monitor attribute.

addMonitorAttribute

protected static void addMonitorAttribute(java.util.Map<java.lang.String,MonitorAttribute> attrs,
                                          java.lang.String name,
                                          java.lang.String displayName,
                                          java.lang.String description,
                                          java.util.Date value)

Adds a new monitor attribute to the specified map using the provided information.

Parameters:

attrs - The attribute map to which the information should be added.

name - The name to use for this monitor attribute. It must be unique among all other monitor attribute names for the associated monitor entry.

displayName - The human-readable display name for the monitor attribute.

description - The human-readable description for the monitor attribute.

value - The value for the monitor attribute.

addMonitorAttribute

protected static void addMonitorAttribute(java.util.Map<java.lang.String,MonitorAttribute> attrs,
                                          java.lang.String name,
                                          java.lang.String displayName,
                                          java.lang.String description,
                                          java.lang.Double value)

Adds a new monitor attribute to the specified map using the provided information.

Parameters:

attrs - The attribute map to which the information should be added.

name - The name to use for this monitor attribute. It must be unique among all other monitor attribute names for the associated monitor entry.

displayName - The human-readable display name for the monitor attribute.

description - The human-readable description for the monitor attribute.

value - The value for the monitor attribute.

addMonitorAttribute

protected static void addMonitorAttribute(java.util.Map<java.lang.String,MonitorAttribute> attrs,
                                          java.lang.String name,
                                          java.lang.String displayName,
                                          java.lang.String description,
                                          java.lang.Integer value)

Adds a new monitor attribute to the specified map using the provided information.

Parameters:

attrs - The attribute map to which the information should be added.

name - The name to use for this monitor attribute. It must be unique among all other monitor attribute names for the associated monitor entry.

displayName - The human-readable display name for the monitor attribute.

description - The human-readable description for the monitor attribute.

value - The value for the monitor attribute.

addMonitorAttribute

protected static void addMonitorAttribute(java.util.Map<java.lang.String,MonitorAttribute> attrs,
                                          java.lang.String name,
                                          java.lang.String displayName,
                                          java.lang.String description,
                                          java.lang.Long value)

Adds a new monitor attribute to the specified map using the provided information.

Parameters:

attrs - The attribute map to which the information should be added.

name - The name to use for this monitor attribute. It must be unique among all other monitor attribute names for the associated monitor entry.

displayName - The human-readable display name for the monitor attribute.

description - The human-readable description for the monitor attribute.

value - The value for the monitor attribute.

addMonitorAttribute

protected static void addMonitorAttribute(java.util.Map<java.lang.String,MonitorAttribute> attrs,
                                          java.lang.String name,
                                          java.lang.String displayName,
                                          java.lang.String description,
                                          java.lang.String value)

Adds a new monitor attribute to the specified map using the provided information.

Parameters:

attrs - The attribute map to which the information should be added.

name - The name to use for this monitor attribute. It must be unique among all other monitor attribute names for the associated monitor entry.

displayName - The human-readable display name for the monitor attribute.

description - The human-readable description for the monitor attribute.

value - The value for the monitor attribute.

addMonitorAttribute

protected static void addMonitorAttribute(java.util.Map<java.lang.String,MonitorAttribute> attrs,
                                          java.lang.String name,
                                          java.lang.String displayName,
                                          java.lang.String description,
                                          java.util.List<java.lang.String> values)

Adds a new monitor attribute to the specified map using the provided information.

Parameters:

attrs - The attribute map to which the information should be added.

name - The name to use for this monitor attribute. It must be unique among all other monitor attribute names for the associated monitor entry.

displayName - The human-readable display name for the monitor attribute.

description - The human-readable description for the monitor attribute.

values - The set of values for the monitor attribute.

toString

public final java.lang.String toString()

Retrieves a string representation of this monitor entry.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this monitor entry.

toString

public final void toString(java.lang.StringBuilder buffer)

Appends a string representation of this monitor entry to the provided buffer.

Parameters:

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