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

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

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class GroupCacheMonitorEntry
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 information about the group cache and the number and types of groups available in the server.

See Also:
Serialized Form

Constructor Summary
GroupCacheMonitorEntry(Entry entry)
          Creates a new group cache monitor entry from the provided entry.
 
Method Summary
 java.lang.Integer getCurrentCacheUsedAsPercentOfMaxHeap()
          Retrieves the amount of memory used by the group cache as a percentage of the maximum heap size, if available.
 java.lang.Long getCurrentCacheUsedBytes()
          Retrieves the amount of memory in bytes used by the group cache, if available.
 java.lang.Double getCurrentCacheUsedUpdateDurationMillis()
          Retrieves the length of time in milliseconds required to compute the group cache size, if available.
 java.lang.Long getDynamicGroupEntries()
          Retrieves the number of dynamic group entries defined in the server, if available.
 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 getStaticGroupEntries()
          Retrieves the number of static group entries defined in the server, if available.
 java.lang.Long getTotalStaticGroupMembers()
          Retrieves the total number of static group members defined in the server, if available.
 java.lang.Long getUniqueStaticGroupMembers()
          Retrieves the number of unique static group members defined in the server, if available.
 java.lang.Long getVirtualStaticGroupEntries()
          Retrieves the number of virtual static group entries defined in the server, if available.
 
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

GroupCacheMonitorEntry

public GroupCacheMonitorEntry(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 Detail

getStaticGroupEntries

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

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

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

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

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

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

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

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

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.