|
|||||||||
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.TraditionalWorkQueueMonitorEntry
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class TraditionalWorkQueueMonitorEntry
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 traditional work queue. For all practical purposes, the traditional work queue has been replaced by the UnboundID Work Queue, which is the new default work queue implementation (which exposes its own monitor information that can be accessed using the
UnboundIDWorkQueueMonitorEntry
).
However, in the event that the traditional work queue is configured for use
instead of the UnboundID work queue, then this monitor entry may be used to
access the information that it provides, which may include:
MonitorManager.getTraditionalWorkQueueMonitorEntry(com.unboundid.ldap.sdk.LDAPConnection)
method. This
entry provides specific methods for accessing information about the state of
the work queue (e.g., the
getCurrentBacklog()
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 | |
---|---|
TraditionalWorkQueueMonitorEntry(Entry entry)
Creates a new traditional work queue monitor entry from the provided entry. |
Method Summary | |
---|---|
java.lang.Long |
getAverageBacklog()
Retrieves the average number of operations observed in the work queue. |
java.lang.Long |
getCurrentBacklog()
Retrieves the number of operations that are currently in the work queue waiting to be processed. |
java.lang.Long |
getMaxBacklog()
Retrieves the maximum number of operations observed in the work queue at any given time. |
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 |
getRequestsRejectedDueToQueueFull()
Retrieves the total number of operation requests that were rejected because the work queue was at its maximum capacity. |
java.lang.Long |
getRequestsSubmitted()
Retrieves the total number of operation requests submitted to the work queue. |
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 TraditionalWorkQueueMonitorEntry(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 getAverageBacklog()
null
if that information was not included in the monitor
entry.public java.lang.Long getCurrentBacklog()
null
if that information was
not included in the monitor entry.public java.lang.Long getMaxBacklog()
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 getRequestsSubmitted()
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 |