|
|||||||||
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.BackendMonitorEntry
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class BackendMonitorEntry
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 a Directory Server backend. Information that may be available in a backend monitor entry includes:
MonitorManager.getBackendMonitorEntries(com.unboundid.ldap.sdk.LDAPConnection)
method.
Specific methods are available for accessing the associated monitor data
(e.g., getBackendID()
to retrieve the backend ID),
and there are also methods for accessing this information in a generic manner
(e.g., getMonitorAttributes()
to retrieve all of
the monitor attributes). See the MonitorManager
class documentation
for an example that demonstrates the use of the generic API for accessing
monitor data.
Constructor Summary | |
---|---|
BackendMonitorEntry(Entry entry)
Creates a new backend monitor entry from the provided entry. |
Method Summary | |
---|---|
java.lang.String |
getBackendID()
Retrieves the backend ID for the associated backend. |
java.util.List<java.lang.String> |
getBaseDNs()
Retrieves the base DNs for the associated backend. |
java.util.Map<java.lang.String,java.lang.Long> |
getEntriesPerBaseDN()
Retrieves a count of the number of entries per base DN in the associated backend. |
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 |
getSoftDeleteCount()
Retrieves the number of soft delete operations processed in the backend since the backend was started. |
java.lang.Long |
getTotalEntries()
Retrieves the total number of entries in the associated backend. |
java.lang.Long |
getUndeleteCount()
Retrieves the number of undelete operations processed in the backend since the backend was started. |
java.lang.String |
getWritabilityMode()
Retrieves the writability mode for the associated backend. |
java.lang.Boolean |
isPrivate()
Indicates whether the associated backend is a private backend. |
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 BackendMonitorEntry(Entry entry)
entry
- The entry to be parsed as a backend monitor entry. It must
not be null
.Method Detail |
---|
public java.lang.String getBackendID()
null
if it
was not included in the monitor entry.public java.util.List<java.lang.String> getBaseDNs()
public java.lang.Boolean isPrivate()
Boolean.TRUE
if the backend is a private backend,
Boolean.FALSE
if it is not a private backend, or
null
if it was not included in the monitor entry.public java.lang.String getWritabilityMode()
null
if it was not included in the monitor entry.public java.lang.Long getTotalEntries()
null
if it was not included in the monitor entry.public java.util.Map<java.lang.String,java.lang.Long> getEntriesPerBaseDN()
public java.lang.Long getSoftDeleteCount()
null
if it was not
included in the monitor entry.public java.lang.Long getUndeleteCount()
null
if it was not included in
the monitor entry.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 |