|
|||||||||
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.UnboundIDWorkQueueMonitorEntry
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class UnboundIDWorkQueueMonitorEntry
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 state of the UnboundID work queue. This has replaced the traditional work queue as the default work queue implementation used by the UnboundID Directory Server, and the monitor information that it may make available includes:
MonitorManager.getUnboundIDWorkQueueMonitorEntry(com.unboundid.ldap.sdk.LDAPConnection)
method. This entry
provides specific methods for accessing information about the state of
the work queue (e.g., the
getCurrentSize()
method may be used
to retrieve the number of operations currently held in the work queue).
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 | |
---|---|
UnboundIDWorkQueueMonitorEntry(Entry entry)
Creates a new UnboundID work queue monitor entry from the provided entry. |
Method Summary | |
---|---|
java.lang.Long |
getAverageOperationQueueTimeMillis()
Retrieves the average length of time in milliseconds that operations have been required to wait on the work queue before being picked up by a worker thread. |
java.lang.Long |
getAverageSize()
Retrieves the average number of operations observed in the work queue. |
java.lang.Long |
getAverageWorkerThreadPercentBusy()
Retrieves the average percentage of the time since startup that worker threads have spent busy processing operations. |
java.lang.Long |
getCurrentAdministrativeSessionQueueSize()
Retrieves the number of operations that are currently waiting to be processed in the portion of the work queue reserved for operations that are part of an administrative session. |
java.lang.Long |
getCurrentSize()
Retrieves the number of operations that are currently in the work queue waiting to be processed. |
java.lang.Long |
getCurrentWorkerThreadPercentBusy()
Retrieves the percentage of worker threads that are currently busy processing an operation. |
java.lang.Long |
getMaxAdministrativeSessionQueueSize()
Retrieves the maximum number of operations observed in the dedicated administrative session queue at any given time. |
java.lang.Long |
getMaxSize()
Retrieves the maximum number of operations observed in the work queue at any given time. |
java.lang.Long |
getMaxWorkerThreadPercentBusy()
Retrieves the maximum percentage of the time over any interval that worker threads have spent busy processing operations. |
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 |
getNumAdministrativeSessionWorkerThreads()
Retrieves the number of worker threads that have been reserved for processing operations that are part of an administrative session. |
java.lang.Long |
getNumBusyAdministrativeSessionWorkerThreads()
Retrieves the number of worker threads that are currently busy processing an operation which is part of an administrative session. |
java.lang.Long |
getNumBusyWorkerThreads()
Retrieves the number of worker threads that are currently busy processing an operation. |
java.lang.Long |
getNumWorkerThreads()
Retrieves the number of worker threads configured for the work queue. |
java.lang.Long |
getRecentAverageSize()
Retrieves the average number of operations observed in the work queue over a recent interval. |
java.lang.Long |
getRecentOperationQueueTimeMillis()
Retrieves the average length of time in milliseconds that recently-processed operations have been required to wait on the work queue before being picked up by a worker thread. |
java.lang.Long |
getRecentWorkerThreadPercentBusy()
Retrieves the percentage of the time over a recent interval that worker threads have spent busy processing operations. |
java.lang.Long |
getRequestsRejectedDueToQueueFull()
Retrieves the total number of operation requests that were rejected because the work queue was at its maximum capacity. |
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 UnboundIDWorkQueueMonitorEntry(Entry entry)
entry
- The entry to be parsed as a traditional work queue monitor
entry. It must not be null
.Method Detail |
---|
public java.lang.Long getAverageSize()
null
if that information was not included in the monitor
entry.public java.lang.Long getRecentAverageSize()
null
if that information was not
included in the monitor entry.public java.lang.Long getCurrentSize()
null
if that information was
not included in the monitor entry.public java.lang.Long getMaxSize()
null
if that information was not included
in the monitor entry.public java.lang.Long getRequestsRejectedDueToQueueFull()
null
if that
information was not included in the monitor entry.public java.lang.Long getNumWorkerThreads()
null
if that information was not included in the monitor
entry.public java.lang.Long getNumBusyWorkerThreads()
null
if that information was not included in
the monitor entry.public java.lang.Long getCurrentWorkerThreadPercentBusy()
null
if that information was
not included in the monitor entry.public java.lang.Long getAverageWorkerThreadPercentBusy()
null
if
that information was not included in the monitor entry.public java.lang.Long getRecentWorkerThreadPercentBusy()
null
if
that information was not included in the monitor entry.public java.lang.Long getMaxWorkerThreadPercentBusy()
null
if
that information was not included in the monitor entry.public java.lang.Long getAverageOperationQueueTimeMillis()
null
if that
information was not included in the monitor entry.public java.lang.Long getRecentOperationQueueTimeMillis()
null
if that information was not included in the monitor
entry.public java.lang.Long getCurrentAdministrativeSessionQueueSize()
null
if
that information was not included in the monitor entry.public java.lang.Long getMaxAdministrativeSessionQueueSize()
null
if
that information was not included in the monitor entry.public java.lang.Long getNumAdministrativeSessionWorkerThreads()
null
if that information was not included in the
monitor entry.public java.lang.Long getNumBusyAdministrativeSessionWorkerThreads()
null
if that information 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 |