|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
com.unboundid.ldap.sdk.unboundidds.monitors.EntryCacheMonitorEntry
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class EntryCacheMonitorEntry
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:
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.
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 |
---|
public EntryCacheMonitorEntry(Entry entry)
entry
- The entry to be parsed as an entry cache monitor entry. It
must not be null
.Method Detail |
---|
public java.lang.Long getCacheTries()
null
if it was not included in the monitor entry.public java.lang.Long getCacheHits()
null
if it was not included in the
monitor entry.public java.lang.Long getCacheMisses()
null
if it was not included in the
monitor entry.public java.lang.Double getCacheHitRatio()
null
if it was not included in the monitor entry.public java.lang.Long getCurrentCount()
null
if it was not included in the monitor entry.public java.lang.Long getMaxCount()
null
if it was not included in the monitor entry.public java.lang.Long getCurrentCacheSize()
null
if it was not included in the monitor
entry.public java.lang.Long getMaxCacheSize()
null
if it was not included in the
monitor entry.public java.lang.String getMonitorDisplayName()
getMonitorDisplayName
in class MonitorEntry
public java.lang.String getMonitorDescription()
getMonitorDescription
in class MonitorEntry
public java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
getMonitorAttributes
in class MonitorEntry
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |