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

Class GroupCacheMonitorEntry

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
com.unboundid.ldap.sdk.unboundidds.monitors.GroupCacheMonitorEntry
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GroupCacheMonitorEntry extends MonitorEntry
This class defines a monitor entry that provides information about the group cache and the number and types of groups available in the server.
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 Also:

  • Constructor Details

    • GroupCacheMonitorEntry

      public GroupCacheMonitorEntry(@NotNull Entry entry)
      Creates a new group cache monitor entry from the provided entry.
      Parameters:
      entry - The entry to be parsed as a group cache monitor entry. It must not be null.

  • Method Details

    • getStaticGroupEntries

      @Nullable public Long getStaticGroupEntries()
      Retrieves the number of static group entries defined in the server, if available.
      Returns:
      The number of static group entries defined in the server, or null if it was not included in the monitor entry.

    • getTotalStaticGroupMembers

      @Nullable public Long getTotalStaticGroupMembers()
      Retrieves the total number of static group members defined in the server, if available. Users that are members of multiple static groups will be counted multiple times.
      Returns:
      The total number of static group members defined in the server, or null if it was not included in the monitor entry.

    • getUniqueStaticGroupMembers

      @Nullable public Long getUniqueStaticGroupMembers()
      Retrieves the number of unique static group members defined in the server, if available. Users that are members of multiple static groups will only be counted once.
      Returns:
      The number of unique static group members defined in the server, or null if it was not included in the monitor entry.

    • getDynamicGroupEntries

      @Nullable public Long getDynamicGroupEntries()
      Retrieves the number of dynamic group entries defined in the server, if available.
      Returns:
      The number of dynamic group entries defined in the server, or null if it was not included in the monitor entry.

    • getVirtualStaticGroupEntries

      @Nullable public Long getVirtualStaticGroupEntries()
      Retrieves the number of virtual static group entries defined in the server, if available.
      Returns:
      The number of virtual static group entries defined in the server, or null if it was not included in the monitor entry.

    • getCurrentCacheUsedBytes

      @Nullable public Long getCurrentCacheUsedBytes()
      Retrieves the amount of memory in bytes used by the group cache, if available.
      Returns:
      The amount of memory in bytes used by the group cache, or null if it was not included in the monitor entry.

    • getCurrentCacheUsedAsPercentOfMaxHeap

      @Nullable public Integer getCurrentCacheUsedAsPercentOfMaxHeap()
      Retrieves the amount of memory used by the group cache as a percentage of the maximum heap size, if available.
      Returns:
      The amount of memory in bytes used by the group cache, or null if it was not included in the monitor entry.

    • getCurrentCacheUsedUpdateDurationMillis

      @Nullable public Double getCurrentCacheUsedUpdateDurationMillis()
      Retrieves the length of time in milliseconds required to compute the group cache size, if available.
      Returns:
      The length of time in milliseconds required to compute the group cache size, 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.