|
|||||||||
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.IndexMonitorEntry
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class IndexMonitorEntry
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 an index in a Directory Server backend. Note that the term "index" may refer to a number of different things, including attribute indexes (in which each individual index type will be considered a separate index, so if "cn" has equality and substring index types then that will be considered two separate indexes), VLV indexes, and system indexes (for databases that are maintained internally, like id2entry, dn2id, id2children, and id2subtree).
MonitorManager.getIndexMonitorEntries(com.unboundid.ldap.sdk.LDAPConnection)
method.
Specific methods are available for accessing the associated monitor data
(e.g., getBackendID()
to retrieve the backend ID),
and there are also methods for accessing this information in a generic manner
(e.g., getMonitorAttributes()
to retrieve all of
the monitor attributes). See the MonitorManager
class documentation
for an example that demonstrates the use of the generic API for accessing
monitor data.
Constructor Summary | |
---|---|
IndexMonitorEntry(Entry entry)
Creates a new index monitor entry from the provided entry. |
Method Summary | |
---|---|
java.lang.Boolean |
fullyPrimedWhenBroughtOnline()
Indicates whether this index was fully primed when it was brought online. |
java.lang.String |
getAttributeIndexType()
Retrieves the name of the attribute index type. |
java.lang.String |
getAttributeType()
Retrieves the name of the attribute type with which the index is associated. |
java.lang.String |
getBackendID()
Retrieves the backend ID for the associated backend. |
java.lang.String |
getBaseDN()
Retrieves the base DN for the data with which the index is associated. |
java.lang.Long |
getCursorsCreatedSinceComingOnline()
Retrieves the number of cursors created in the index for reading ranges of keys. |
java.lang.Long |
getEntryLimitExceededCountSinceComingOnline()
Retrieves the number of index keys which have stopped being maintained because the number of matching entries has exceeded the entry limit since the index was brought online. |
java.lang.Long |
getFilterInitiatedReadsSinceComingOnline()
Retrieves the number of index reads that have been initiated because the associated attribute type was included in the filter for a search operation with a non-base scope since the index was brought online. |
java.lang.Long |
getIndexEntryLimit()
Retrieves the index entry limit, which is the maximum number of entries that will be allowed to match a key before the ID list for that key will stop being maintained. |
java.lang.String |
getIndexFilter()
Retrieves the filter used for the index. |
java.lang.String |
getIndexName()
Retrieves the name of the index database. |
java.lang.Long |
getKeysDeletedSinceComingOnline()
Retrieves the number of index keys that have been deleted since the index was brought online. |
java.lang.Long |
getKeysPrimedWhenBroughtOnline()
Retrieves the number of index keys that were primed when the index was brought online. |
java.lang.Long |
getKeysReadSinceComingOnline()
Retrieves the number of index keys that have been read since the index was brought online. |
java.lang.Long |
getKeysWrittenSinceComingOnline()
Retrieves the number of index keys that have been inserted or replaced since the index was brought online. |
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.String |
getPrimeException()
Retrieves information about any exception caught during prime processing. |
java.lang.String |
getPrimeIncompleteReason()
Retrieves information about the reason that the index was not fully primed when the backend was brought online (e.g., the database cache became full, the prime took too long to complete, or an exception was caught during processing). |
java.lang.Boolean |
isIndexTrusted()
Indicates whether the index may be considered trusted. |
java.lang.Boolean |
maintainCountForExceededKeys()
Indicates whether the count of matching entries will be maintained for index keys that have exceeded the entry limit. |
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 IndexMonitorEntry(Entry entry)
entry
- The entry to be parsed as an index monitor entry. It must
not be null
.Method Detail |
---|
public java.lang.String getIndexName()
null
if it was not
included in the monitor entry.public java.lang.String getBackendID()
null
if it
was not included in the monitor entry.public java.lang.String getBaseDN()
null
if it was not included in the monitor entry.public java.lang.String getAttributeType()
null
if it was not included in the monitor entry.public java.lang.String getAttributeIndexType()
null
if it was
not included in the monitor entry.public java.lang.String getIndexFilter()
null
if it was not
included in the monitor entry.public java.lang.Boolean isIndexTrusted()
true
if the index may be considered trusted,
false
if it is not trusted, or null
if it was not
included in the monitor entry.public java.lang.Long getIndexEntryLimit()
null
if was not included in the
monitor entry.public java.lang.Long getEntryLimitExceededCountSinceComingOnline()
null
if it was not
included in the monitor entry.public java.lang.Boolean maintainCountForExceededKeys()
true
if the count of matching entries will be maintained
for index keys that have exceeded the entry limit, false
if not, or null
if it was not included in the monitor
entry.public java.lang.Boolean fullyPrimedWhenBroughtOnline()
true
if the index was fully primed when it was brought
online, false
if not, or null
if it was not
included in the monitor entry.public java.lang.String getPrimeIncompleteReason()
null
if it was not
included in the monitor entry.public java.lang.String getPrimeException()
null
if it was not included in the monitor entry.public java.lang.Long getKeysPrimedWhenBroughtOnline()
null
if it was not included in the
monitor entry.public java.lang.Long getKeysWrittenSinceComingOnline()
null
if it was not
included in the monitor entry.public java.lang.Long getKeysDeletedSinceComingOnline()
null
if it was not included in the
monitor entry.public java.lang.Long getKeysReadSinceComingOnline()
null
if it was not included in the
monitor entry.public java.lang.Long getFilterInitiatedReadsSinceComingOnline()
null
if it was not included in the
monitor entry.public java.lang.Long getCursorsCreatedSinceComingOnline()
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 |