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

Class BackendMonitorEntry

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
com.unboundid.ldap.sdk.unboundidds.monitors.BackendMonitorEntry
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class BackendMonitorEntry extends MonitorEntry
This class defines a monitor entry that provides general information about a Directory Server backend.
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.

Information that may be available in a backend monitor entry includes:
  • The backend ID for the backend.
  • The set of base DNs for the backend.
  • The total number of entries in the backend.
  • The number of entries in the backend per base DN.
  • The writability mode for the backend, which indicates whether it will accept write operations.
  • An indication about whether the backend is public (intended to hold user data) or private (intended to hold operational data).
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:

  • Constructor Details

    • BackendMonitorEntry

      public BackendMonitorEntry(@NotNull 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 Details

    • getBackendID

      @Nullable public 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

      @NotNull public List<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

      @Nullable public 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

      @Nullable public 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

      @Nullable public 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

      @NotNull public Map<String,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

      @Nullable public 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

      @Nullable public 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

      @NotNull public 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

      @NotNull public 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

      @NotNull public Map<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.