com.unboundid.ldap.sdk.unboundidds.monitors
Class BackendMonitorEntry

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
      extended by com.unboundid.ldap.sdk.unboundidds.monitors.BackendMonitorEntry
All Implemented Interfaces:
java.io.Serializable

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

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: The set of backend monitor entries published by the directory server can be obtained using the 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.

See Also:
Serialized Form

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

BackendMonitorEntry

public BackendMonitorEntry(Entry entry)
Creates a new backend monitor entry from the provided entry.

Parameters:
entry - The entry to be parsed as a backend monitor entry. It must not be null.
Method Detail

getBackendID

public java.lang.String getBackendID()
Retrieves the backend ID for the associated backend.

Returns:
The backend ID for the associated backend, or null if it was not included in the monitor entry.

getBaseDNs

public java.util.List<java.lang.String> getBaseDNs()
Retrieves the base DNs for the associated backend.

Returns:
The base DNs for the associated backend, or an empty list if it was not included in the monitor entry.

isPrivate

public java.lang.Boolean isPrivate()
Indicates whether the associated backend is a private backend.

Returns:
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.

getWritabilityMode

public java.lang.String getWritabilityMode()
Retrieves the writability mode for the associated backend.

Returns:
The writability mode for the associated backend, or null if it was not included in the monitor entry.

getTotalEntries

public java.lang.Long getTotalEntries()
Retrieves the total number of entries in the associated backend.

Returns:
The total number of entries in the associated backend, or null if it was not included in the monitor entry.

getEntriesPerBaseDN

public 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.

Returns:
A count of the number of entries per base DN in the associated backend, or an empty map if it was not included in the monitor entry.

getSoftDeleteCount

public java.lang.Long getSoftDeleteCount()
Retrieves the number of soft delete operations processed in the backend since the backend was started.

Returns:
The number of soft delete operations processed in the backend since the backend was started, or null if it was not included in the monitor entry.

getUndeleteCount

public java.lang.Long getUndeleteCount()
Retrieves the number of undelete operations processed in the backend since the backend was started.

Returns:
The number of undelete operations processed in the backend since the backend was started, 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.

Overrides:
getMonitorDisplayName in class MonitorEntry
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.

Overrides:
getMonitorDescription in class MonitorEntry
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.

Overrides:
getMonitorAttributes in class MonitorEntry
Returns:
The set of parsed monitor attributes for this monitor entry.