|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
com.unboundid.ldap.sdk.unboundidds.monitors.GeneralMonitorEntry
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GeneralMonitorEntry
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 general information about the state of the Directory Server. The general monitor entry is the top-level monitor entry that is generated by the monitor backend and is the parent of all monitor entries generated by the registered monitor providers. Information that may be included in the general monitor entry includes:
MonitorManager.getGeneralMonitorEntry(com.unboundid.ldap.sdk.LDAPConnection)
method.
This entry provides specific methods for accessing information about the
server (e.g., the
getCurrentConnections()
method can be used
to retrieve the number of connections currently 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.
Constructor Summary | |
---|---|
GeneralMonitorEntry(Entry entry)
Creates a new general monitor entry from the provided entry. |
Method Summary | |
---|---|
java.lang.Long |
getCurrentConnections()
Retrieves the number of connections currently established. |
java.util.Date |
getCurrentTime()
Retrieves the current time as reported by the Directory Server. |
java.util.List<java.lang.String> |
getDegradedAlertTypes()
Retrieves the names of any alert types which may have caused the server to be currently classified as "degraded". |
java.lang.String |
getInstanceName()
Retrieves the name assigned to the Directory Server instance. |
java.lang.Long |
getMaxConnections()
Retrieves the maximum number of concurrent connections established at any time since startup. |
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.String |
getProductName()
Retrieves the Directory Server product name. |
java.util.Date |
getStartTime()
Retrieves the time that the Directory Server was started. |
java.lang.String |
getStartupID()
Retrieves a relatively compact identifier generated at the time the Directory Server was started. |
java.lang.String |
getStartupUUID()
Retrieves the UUID that was generated when the Directory Server was started. |
java.util.List<java.lang.String> |
getThirdPartyExtensionDNs()
Retrieves the DNs of the configuration entries for any third-party extensions currently loaded in the server. |
java.lang.Long |
getTotalConnections()
Retrieves the total number of connections established since startup. |
java.util.List<java.lang.String> |
getUnavailableAlertTypes()
Retrieves the names of any alert types which may have caused the server to be currently classified as "unavailable". |
java.lang.Long |
getUptimeMillis()
Retrieves the Directory Server uptime in milliseconds. |
java.lang.String |
getUptimeString()
Retrieves the human-readable string representation of the Directory Server uptime. |
java.lang.String |
getVendorName()
Retrieves the Directory Server vendor name string. |
java.lang.String |
getVersionString()
Retrieves the Directory Server version string. |
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 |
---|
public GeneralMonitorEntry(Entry entry)
entry
- The entry to be parsed as a general monitor entry. It must
not be null
.Method Detail |
---|
public java.lang.Long getCurrentConnections()
null
if it was not included in the monitor entry.public java.lang.Long getMaxConnections()
null
if it was not included in the
monitor entry.public java.lang.Long getTotalConnections()
null
if it was not included in the monitor entry.public java.util.Date getCurrentTime()
null
if it was not included in the monitor entry.public java.util.Date getStartTime()
null
if
it was not included in the monitor entry.public java.lang.String getInstanceName()
null
if it was not included in the monitor entry.public java.lang.String getStartupID()
null
if it was not
included in the monitor entry.public java.lang.String getStartupUUID()
null
if it was not included in the monitor entry.public java.lang.Long getUptimeMillis()
null
if
either the current time or the start time was not available.public java.lang.String getUptimeString()
null
if it was not included in the monitor
entry.public java.lang.String getProductName()
null
if it was not
included in the monitor entry.public java.lang.String getVendorName()
null
if it
was not included in the monitor entry.public java.lang.String getVersionString()
null
if it was not
included in the monitor entry.public java.util.List<java.lang.String> getDegradedAlertTypes()
public java.util.List<java.lang.String> getUnavailableAlertTypes()
public java.util.List<java.lang.String> getThirdPartyExtensionDNs()
public java.lang.String getMonitorDisplayName()
getMonitorDisplayName
in class MonitorEntry
public java.lang.String getMonitorDescription()
getMonitorDescription
in class MonitorEntry
public java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
getMonitorAttributes
in class MonitorEntry
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |