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

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

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class EntryCacheMonitorEntry
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 general information about the state of the Directory Server entry cache. The information that may be available in the entry cache monitor entry includes: 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:
Serialized Form

Constructor Summary
EntryCacheMonitorEntry(Entry entry)
          Creates a new entry cache monitor entry from the provided entry.
 
Method Summary
 java.lang.Double getCacheHitRatio()
          Retrieves the ratio of the time a requested entry was found in the cache.
 java.lang.Long getCacheHits()
          Retrieves the number of attempts to find an entry in the cache in which the entry was found.
 java.lang.Long getCacheMisses()
          Retrieves the number of attempts to find an entry in the cache in which the entry was not found.
 java.lang.Long getCacheTries()
          Retrieves the number of attempts to find an entry in the cache.
 java.lang.Long getCurrentCacheSize()
          Retrieves the current amount of memory (in bytes) consumed by the entry cache.
 java.lang.Long getCurrentCount()
          Retrieves the number of entries currently held in the entry cache.
 java.lang.Long getMaxCacheSize()
          Retrieves the maximum amount of memory (in bytes) that may be consumed by the entry cache.
 java.lang.Long getMaxCount()
          Retrieves the maximum number of entries that may be held in the entry cache.
 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.
 
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

EntryCacheMonitorEntry

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

getCacheTries

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

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

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

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

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

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

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

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

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.