Package org.opends.server.monitors

Class TraditionalWorkQueueMonitor

java.lang.Object

org.opends.server.api.MonitorProvider<MonitorProviderCfg>

org.opends.server.monitors.TraditionalWorkQueueMonitor

All Implemented Interfaces:

Runnable

public class TraditionalWorkQueueMonitor
extends MonitorProvider<MonitorProviderCfg>
implements Runnable

This class defines a Directory Server monitor that can be used to provide information about the state of the work queue.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_AVERAGE_BACKLOG	The name to use for the monitor attribute that provides the average request backlog.
static String	ATTR_CURRENT_BACKLOG	The name to use for the monitor attribute that provides the current request backlog.
static String	ATTR_MAX_BACKLOG	The name to use for the monitor attribute that provides the maximum observed request backlog.
static String	ATTR_OPS_REJECTED_QUEUE_FULL	The name to use for the monitor attribute that provides the total number of requests that have been rejected because the work queue was full.
static String	ATTR_OPS_SUBMITTED	The name to use for the monitor attribute that provides the total number of operations submitted.

Constructor Summary

Constructors

Constructor	Description
TraditionalWorkQueueMonitor(TraditionalWorkQueue workQueue)	Initializes this monitor provider.

Method Summary

Modifier and Type	Method	Description
MonitorData	getMonitorData()	Retrieves a set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested.
String	getMonitorInstanceName()	Retrieves the name of this monitor provider.
void	initializeMonitorProvider(MonitorProviderCfg configuration)	Initializes this monitor provider based on the information in the provided configuration entry.
void	run()

Methods inherited from class org.opends.server.api.MonitorProvider

finalizeMonitorProvider, getMonitorObjectClass, isConfigurationAcceptable, scheduleUpdate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ATTR_CURRENT_BACKLOG

public static final String ATTR_CURRENT_BACKLOG

The name to use for the monitor attribute that provides the current request backlog.

See Also:

Constant Field Values

ATTR_AVERAGE_BACKLOG

public static final String ATTR_AVERAGE_BACKLOG

The name to use for the monitor attribute that provides the average request backlog.

See Also:

Constant Field Values

ATTR_MAX_BACKLOG

public static final String ATTR_MAX_BACKLOG

The name to use for the monitor attribute that provides the maximum observed request backlog.

See Also:

Constant Field Values

ATTR_OPS_SUBMITTED

public static final String ATTR_OPS_SUBMITTED

The name to use for the monitor attribute that provides the total number of operations submitted.

See Also:

Constant Field Values

ATTR_OPS_REJECTED_QUEUE_FULL

public static final String ATTR_OPS_REJECTED_QUEUE_FULL

The name to use for the monitor attribute that provides the total number of requests that have been rejected because the work queue was full.

See Also:

Constant Field Values

Constructor Detail

TraditionalWorkQueueMonitor

public TraditionalWorkQueueMonitor(TraditionalWorkQueue workQueue)

Initializes this monitor provider. Note that no initialization should be done here, since it should be performed in the initializeMonitorProvider class.

Parameters:

workQueue - The work queue with which this monitor is associated.

Method Detail

initializeMonitorProvider

public void initializeMonitorProvider(MonitorProviderCfg configuration)
                               throws ConfigException,
                                      InitializationException

Initializes this monitor provider based on the information in the provided configuration entry.

Overrides:

initializeMonitorProvider in class MonitorProvider<MonitorProviderCfg>

Parameters:

configuration - The configuration to use to initialize this monitor provider.

Throws:

ConfigException - If an unrecoverable problem arises in the process of performing the initialization.

InitializationException - If a problem occurs during initialization that is not related to the server configuration.

getMonitorInstanceName

public String getMonitorInstanceName()

Retrieves the name of this monitor provider. It should be unique among all monitor providers, including all instances of the same monitor provider.

Specified by:

getMonitorInstanceName in class MonitorProvider<MonitorProviderCfg>

Returns:

The name of this monitor provider.

run

public void run()

Specified by:

run in interface Runnable

getMonitorData

public MonitorData getMonitorData()

Description copied from class: MonitorProvider

Retrieves a set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested.

Specified by:

getMonitorData in class MonitorProvider<MonitorProviderCfg>

Returns:

A set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested.