@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class TraditionalWorkQueueMonitorEntry extends MonitorEntry
UnboundIDWorkQueueMonitorEntry
).
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only
supported for use against Ping Identity, UnboundID, and Alcatel-Lucent 8661
server products. These classes provide support for proprietary
functionality or for external specifications that are not considered stable
or mature enough to be guaranteed to work in an interoperable way with
other types of LDAP servers.
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 and Description |
---|
TraditionalWorkQueueMonitorEntry(Entry entry)
Creates a new traditional work queue monitor entry from the provided entry.
|
Modifier and Type | Method and Description |
---|---|
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.
|
addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, decode, getBoolean, getDate, getDN, getDouble, getEntry, getInteger, getLong, getMonitorClass, getMonitorName, getString, getStrings, toString, toString
public TraditionalWorkQueueMonitorEntry(Entry entry)
entry
- The entry to be parsed as a traditional work queue monitor
entry. It must not be null
.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