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

Class MonitorEntry

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ActiveOperationsMonitorEntry, BackendMonitorEntry, ClientConnectionMonitorEntry, ConnectionHandlerMonitorEntry, DiskSpaceUsageMonitorEntry, EntryCacheMonitorEntry, FIFOEntryCacheMonitorEntry, GaugeMonitorEntry, GeneralMonitorEntry, GroupCacheMonitorEntry, HostSystemRecentCPUAndMemoryMonitorEntry, IndexMonitorEntry, JEEnvironmentMonitorEntry, LDAPExternalServerMonitorEntry, LDAPStatisticsMonitorEntry, LoadBalancingAlgorithmMonitorEntry, MemoryUsageMonitorEntry, ProcessingTimeHistogramMonitorEntry, ReplicaMonitorEntry, ReplicationServerMonitorEntry, ReplicationSummaryMonitorEntry, ResultCodeMonitorEntry, StackTraceMonitorEntry, SystemInfoMonitorEntry, TraditionalWorkQueueMonitorEntry, UnboundIDWorkQueueMonitorEntry, VersionMonitorEntry, X509CertificateMonitorEntry
@NotExtensible @ThreadSafety(level=COMPLETELY_THREADSAFE) public class MonitorEntry extends Object implements Serializable
This class defines a generic monitor entry that provides access to monitor information provided by a Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 server instance. Subclasses may provide specific methods for interpreting the information exposed by specific types of monitor entries.
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.

See the 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.
See Also:

  • Constructor Details

    • MonitorEntry

      public MonitorEntry(@NotNull Entry entry)
      Creates a new monitor entry from the information contained in the provided entry.
      Parameters:
      entry - The entry providing information to use for this monitor entry. It must not be null.

  • Method Details

    • getDN

      @NotNull public final String getDN()
      Retrieves the DN for this monitor entry.
      Returns:
      The DN for this monitor entry.

    • getEntry

      @NotNull public final ReadOnlyEntry getEntry()
      Retrieves the Entry used to create this monitor entry.
      Returns:
      The Entry used to create this monitor entry.

    • getMonitorClass

      @NotNull public final String getMonitorClass()
      Retrieves the name of the structural object class for this monitor entry.
      Returns:
      The name of the structural object class for this monitor entry, or the generic monitor object class if no appropriate subclass could be identified.

    • getMonitorName

      @Nullable public final String getMonitorName()
      Retrieves the monitor name for this monitor entry.
      Returns:
      The monitor name for this monitor entry, 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.
      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.
      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.
      Returns:
      The set of parsed monitor attributes for this monitor entry.

    • decode

      @NotNull public static MonitorEntry decode(@NotNull Entry entry)
      Creates a monitor entry object from the provided entry. An attempt will be made to decode the entry as an instance of the most appropriate subclass, but if that is not possible then it will be parsed as a generic monitor entry.
      Parameters:
      entry - The entry to be decoded as a monitor entry.
      Returns:
      The decoded monitor entry of the appropriate subtype, or a generic monitor entry if no appropriate subclass could be identified.

    • getBoolean

      @Nullable protected final Boolean getBoolean(@NotNull String attributeName)
      Retrieves the value of the specified attribute as a Boolean object.
      Parameters:
      attributeName - The name of the target attribute.
      Returns:
      The 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.

    • getDate

      @Nullable protected final Date getDate(@NotNull String attributeName)
      Retrieves the value of the specified attribute as a Date object.
      Parameters:
      attributeName - The name of the target attribute.
      Returns:
      The 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.

    • getDouble

      @Nullable protected final Double getDouble(@NotNull String attributeName)
      Retrieves the value of the specified attribute as a Double object.
      Parameters:
      attributeName - The name of the target attribute.
      Returns:
      The 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.

    • getInteger

      @Nullable protected final Integer getInteger(@NotNull String attributeName)
      Retrieves the value of the specified attribute as an Integer object.
      Parameters:
      attributeName - The name of the target attribute.
      Returns:
      The 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.

    • getLong

      @Nullable protected final Long getLong(@NotNull String attributeName)
      Retrieves the value of the specified attribute as a Long object.
      Parameters:
      attributeName - The name of the target attribute.
      Returns:
      The 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.

    • getString

      @Nullable protected final String getString(@NotNull String attributeName)
      Retrieves the value of the specified attribute as a string.
      Parameters:
      attributeName - The name of the target attribute.
      Returns:
      The string value of the specified attribute, or null if it does not exist in the entry.

    • getStrings

      @NotNull protected final List<String> getStrings(@NotNull String attributeName)
      Retrieves the set of values of the specified attribute as a string list.
      Parameters:
      attributeName - The name of the target attribute.
      Returns:
      The string values of the specified attribute, or an empty list if the specified attribute does not exist in the entry.

    • addMonitorAttribute

      protected static void addMonitorAttribute(@NotNull Map<String,MonitorAttribute> attrs, @NotNull String name, @NotNull String displayName, @Nullable String description, @NotNull Boolean value)
      Adds a new monitor attribute to the specified map using the provided information.
      Parameters:
      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.

    • addMonitorAttribute

      protected static void addMonitorAttribute(@NotNull Map<String,MonitorAttribute> attrs, @NotNull String name, @NotNull String displayName, @Nullable String description, @NotNull Date value)
      Adds a new monitor attribute to the specified map using the provided information.
      Parameters:
      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.

    • addMonitorAttribute

      protected static void addMonitorAttribute(@NotNull Map<String,MonitorAttribute> attrs, @NotNull String name, @NotNull String displayName, @Nullable String description, @NotNull Double value)
      Adds a new monitor attribute to the specified map using the provided information.
      Parameters:
      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.

    • addMonitorAttribute

      protected static void addMonitorAttribute(@NotNull Map<String,MonitorAttribute> attrs, @NotNull String name, @NotNull String displayName, @Nullable String description, @NotNull Integer value)
      Adds a new monitor attribute to the specified map using the provided information.
      Parameters:
      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.

    • addMonitorAttribute

      protected static void addMonitorAttribute(@NotNull Map<String,MonitorAttribute> attrs, @NotNull String name, @NotNull String displayName, @Nullable String description, @NotNull Long value)
      Adds a new monitor attribute to the specified map using the provided information.
      Parameters:
      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.

    • addMonitorAttribute

      protected static void addMonitorAttribute(@NotNull Map<String,MonitorAttribute> attrs, @NotNull String name, @NotNull String displayName, @Nullable String description, @NotNull String value)
      Adds a new monitor attribute to the specified map using the provided information.
      Parameters:
      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.

    • addMonitorAttribute

      protected static void addMonitorAttribute(@NotNull Map<String,MonitorAttribute> attrs, @NotNull String name, @NotNull String displayName, @Nullable String description, @NotNull List<String> values)
      Adds a new monitor attribute to the specified map using the provided information.
      Parameters:
      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.

    • toString

      @NotNull public final String toString()
      Retrieves a string representation of this monitor entry.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this monitor entry.

    • toString

      public final void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this monitor entry to the provided buffer.
      Parameters:
      buffer - The buffer to which the information should be appended.