org.opends.server.admin.std.server
Interface TraditionalWorkQueueCfg

All Superinterfaces:
Configuration, WorkQueueCfg

public interface TraditionalWorkQueueCfg
extends WorkQueueCfg

A server-side interface for querying Traditional Work Queue settings.

The Traditional Work Queue is a type of work queue that uses a number of worker threads that watch a queue and pick up an operation to process whenever one becomes available.


Method Summary
 void addTraditionalChangeListener(ConfigurationChangeListener<TraditionalWorkQueueCfg> listener)
          Register to be notified when this Traditional Work Queue is changed.
 java.lang.Class<? extends TraditionalWorkQueueCfg> configurationClass()
          Gets the configuration class associated with this Traditional Work Queue.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.Integer getMaxWorkQueueCapacity()
          Gets the "max-work-queue-capacity" property.
 int getNumWorkerThreads()
          Gets the "num-worker-threads" property.
 void removeTraditionalChangeListener(ConfigurationChangeListener<TraditionalWorkQueueCfg> listener)
          Deregister an existing Traditional Work Queue configuration change listener.
 
Methods inherited from interface org.opends.server.admin.std.server.WorkQueueCfg
addChangeListener, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends TraditionalWorkQueueCfg> configurationClass()
Gets the configuration class associated with this Traditional Work Queue.

Specified by:
configurationClass in interface Configuration
Specified by:
configurationClass in interface WorkQueueCfg
Returns:
Returns the configuration class associated with this Traditional Work Queue.

addTraditionalChangeListener

void addTraditionalChangeListener(ConfigurationChangeListener<TraditionalWorkQueueCfg> listener)
Register to be notified when this Traditional Work Queue is changed.

Parameters:
listener - The Traditional Work Queue configuration change listener.

removeTraditionalChangeListener

void removeTraditionalChangeListener(ConfigurationChangeListener<TraditionalWorkQueueCfg> listener)
Deregister an existing Traditional Work Queue configuration change listener.

Parameters:
listener - The Traditional Work Queue configuration change listener.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Traditional Work Queue implementation.

Specified by:
getJavaClass in interface WorkQueueCfg
Returns:
Returns the value of the "java-class" property.

getMaxWorkQueueCapacity

java.lang.Integer getMaxWorkQueueCapacity()
Gets the "max-work-queue-capacity" property.

Specifies the maximum number of queued operations that can be in the work queue at any given time.

If the work queue is already full and additional requests are received by the server, the requests are rejected. A value of zero indicates that there is no limit to the size of the queue.

Returns:
Returns the value of the "max-work-queue-capacity" property.

getNumWorkerThreads

int getNumWorkerThreads()
Gets the "num-worker-threads" property.

Specifies the number of worker threads to be used for processing operations placed in the queue.

If the value is increased, the additional worker threads are created immediately. If the value is reduced, the appropriate number of threads are destroyed as operations complete processing.

Returns:
Returns the value of the "num-worker-threads" property.