com.unboundid.ldap.sdk.unboundidds.monitors

Class TraditionalWorkQueueMonitorEntry

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry

com.unboundid.ldap.sdk.unboundidds.monitors.TraditionalWorkQueueMonitorEntry

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class TraditionalWorkQueueMonitorEntry
extends MonitorEntry

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 default work queue implementation (which exposes its own monitor information that can be accessed using the 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 Nokia/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.

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:

• The total number of requests submitted to the work queue.
• The number of requests that were rejected because the work queue was already at its maximum capacity.
• The number of operations currently held in the work queue waiting to be picked for processing by a worker thread.
• The average number of operations held in the work queue since startup as observed from periodic polling.
• The maximum number of operations held in the work queue at any time since startup as observed from periodic polling.

The server should present at most one traditional work queue monitor entry. It can be retrieved using the 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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TraditionalWorkQueueMonitorEntry(Entry entry) Creates a new traditional work queue monitor entry from the provided entry.

Method Summary

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.

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

TraditionalWorkQueueMonitorEntry

public TraditionalWorkQueueMonitorEntry(@NotNull
                                        Entry entry)

Creates a new traditional work queue monitor entry from the provided entry.

Parameters:

entry - The entry to be parsed as a traditional work queue monitor entry. It must not be null.

Method Detail

getAverageBacklog

@Nullable
public java.lang.Long getAverageBacklog()

Retrieves the average number of operations observed in the work queue.

Returns:

The average number of operations observed in the work queue, or null if that information was not included in the monitor entry.

getCurrentBacklog

@Nullable
public java.lang.Long getCurrentBacklog()

Retrieves the number of operations that are currently in the work queue waiting to be processed.

Returns:

The number of operations that are currently in the work queue waiting to be processed, or null if that information was not included in the monitor entry.

getMaxBacklog

@Nullable
public java.lang.Long getMaxBacklog()

Retrieves the maximum number of operations observed in the work queue at any given time.

Returns:

The total number of operations observed in the work queue at any given time, or null if that information was not included in the monitor entry.

getRequestsRejectedDueToQueueFull

@Nullable
public java.lang.Long getRequestsRejectedDueToQueueFull()

Retrieves the total number of operation requests that were rejected because the work queue was at its maximum capacity.

Returns:

The total number of operation requests rejected because the work queue was at its maximum capacity, or null if that information was not included in the monitor entry.

getRequestsSubmitted

@Nullable
public java.lang.Long getRequestsSubmitted()

Retrieves the total number of operation requests submitted to the work queue.

Returns:

The total number of operation requests submitted to the work queue, or null if that information was not included in the monitor entry.

getMonitorDisplayName

@NotNull
public java.lang.String getMonitorDisplayName()

Retrieves a human-readable display name for this monitor entry.

Overrides:

getMonitorDisplayName in class MonitorEntry

Returns:

A human-readable display name for this monitor entry.

getMonitorDescription

@NotNull
public java.lang.String getMonitorDescription()

Retrieves a human-readable description name for this monitor entry.

Overrides:

getMonitorDescription in class MonitorEntry

Returns:

A human-readable description name for this monitor entry.

getMonitorAttributes

@NotNull
public 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.

Overrides:

getMonitorAttributes in class MonitorEntry

Returns:

The set of parsed monitor attributes for this monitor entry.