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

Class EntryCacheMonitorEntry

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

The information that may be available in the entry cache monitor entry includes:
  • The number of cache tries, which are attempts to retrieve entries from the cache.
  • The number of cache hits, which are successful attempts to retrieve an entry from the cache.
  • The number of cache misses, which are unsuccessful attempts to retrieve an entry from the cache.
  • The cache hit ratio, which is the ratio of the time that a cache try is successful.
  • The number of entries currently held in the cache.
  • The maximum number of entries that may be held in the cache.
  • The approximate current amount of memory consumed by the cache.
  • The maximum amount of memory that may be consumed by the cache.
The server should present at most one client connection monitor entry. It can be retrieved using the MonitorManager.getEntryCacheMonitorEntry(com.unboundid.ldap.sdk.LDAPConnection) method. This entry provides specific methods for accessing information about the entry cache (e.g., the getCurrentCount() method can be used to retrieve the number of entries currently in the cache). Alternately, this information may be accessed using the generic API. See the MonitorManager class documentation for an example that demonstrates the use of the generic API for accessing monitor data.
See Also:

  • Constructor Details

    • EntryCacheMonitorEntry

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

  • Method Details

    • getCacheTries

      @Nullable public Long getCacheTries()
      Retrieves the number of attempts to find an entry in the cache.
      Returns:
      The number of attempts to find an entry in the cache, or null if it was not included in the monitor entry.

    • getCacheHits

      @Nullable public Long getCacheHits()
      Retrieves the number of attempts to find an entry in the cache in which the entry was found.
      Returns:
      The number of attempts to find an entry in the cache in which the entry was found, or null if it was not included in the monitor entry.

    • getCacheMisses

      @Nullable public Long getCacheMisses()
      Retrieves the number of attempts to find an entry in the cache in which the entry was not found.
      Returns:
      The number of attempts to find an entry in the cache in which the entry was not found, or null if it was not included in the monitor entry.

    • getCacheHitRatio

      @Nullable public Double getCacheHitRatio()
      Retrieves the ratio of the time a requested entry was found in the cache.
      Returns:
      The ratio of the time a requested entry was found in the cache, or null if it was not included in the monitor entry.

    • getCurrentCount

      @Nullable public Long getCurrentCount()
      Retrieves the number of entries currently held in the entry cache.
      Returns:
      The number of entries currently held in the entry cache, or null if it was not included in the monitor entry.

    • getMaxCount

      @Nullable public Long getMaxCount()
      Retrieves the maximum number of entries that may be held in the entry cache.
      Returns:
      The maximum number of entries that may be held in the entry cache, or null if it was not included in the monitor entry.

    • getCurrentCacheSize

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

    • getMaxCacheSize

      @Nullable public Long getMaxCacheSize()
      Retrieves the maximum amount of memory (in bytes) that may be consumed by the entry cache.
      Returns:
      The maximum amount of memory (in bytes) that may be consumed by the entry cache, 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.