@NotExtensible @ThreadSafety(level=COMPLETELY_THREADSAFE) public class MonitorEntry extends java.lang.Object implements java.io.Serializable
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.
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.Constructor and Description |
---|
MonitorEntry(Entry entry)
Creates a new monitor entry from the information contained in the provided
entry.
|
Modifier and Type | Method and 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.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.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.util.List<java.lang.String> values)
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.
|
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.
|
public MonitorEntry(Entry entry)
entry
- The entry providing information to use for this monitor
entry. It must not be null
.public final java.lang.String getDN()
public final ReadOnlyEntry getEntry()
Entry
used to create this monitor entry.Entry
used to create this monitor entry.public final java.lang.String getMonitorClass()
public final java.lang.String getMonitorName()
null
if it was
not included in the monitor entry.public java.lang.String getMonitorDisplayName()
public java.lang.String getMonitorDescription()
public java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
public static MonitorEntry decode(Entry entry)
entry
- The entry to be decoded as a monitor entry.protected final java.lang.Boolean getBoolean(java.lang.String attributeName)
Boolean
object.attributeName
- The name of the target attribute.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.protected final java.util.Date getDate(java.lang.String attributeName)
Date
object.attributeName
- The name of the target attribute.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.protected final java.lang.Double getDouble(java.lang.String attributeName)
Double
object.attributeName
- The name of the target attribute.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.protected final java.lang.Integer getInteger(java.lang.String attributeName)
Integer
object.attributeName
- The name of the target attribute.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.protected final java.lang.Long getLong(java.lang.String attributeName)
Long
object.attributeName
- The name of the target attribute.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.protected final java.lang.String getString(java.lang.String attributeName)
attributeName
- The name of the target attribute.null
if it
does not exist in the entry.protected final java.util.List<java.lang.String> getStrings(java.lang.String attributeName)
attributeName
- The name of the target attribute.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)
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.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)
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.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)
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.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)
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.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)
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.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)
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.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)
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.public final java.lang.String toString()
toString
in class java.lang.Object
public final void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which the information should be appended.