org.opends.server.admin.std.client
Interface TraditionalWorkQueueCfgClient

All Superinterfaces:
ConfigurationClient, WorkQueueCfgClient

public interface TraditionalWorkQueueCfgClient
extends WorkQueueCfgClient

A client-side interface for reading and modifying 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
 ManagedObjectDefinition<? extends TraditionalWorkQueueCfgClient,? extends TraditionalWorkQueueCfg> definition()
          Get the configuration definition 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.
 java.lang.Integer getNumWorkerThreads()
          Gets the "num-worker-threads" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setMaxWorkQueueCapacity(java.lang.Integer value)
          Sets the "max-work-queue-capacity" property.
 void setNumWorkerThreads(int value)
          Sets the "num-worker-threads" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends TraditionalWorkQueueCfgClient,? extends TraditionalWorkQueueCfg> definition()
Get the configuration definition associated with this Traditional Work Queue.

Specified by:
definition in interface ConfigurationClient
Specified by:
definition in interface WorkQueueCfgClient
Returns:
Returns the configuration definition associated with this Traditional Work Queue.

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 WorkQueueCfgClient
Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

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

Specified by:
setJavaClass in interface WorkQueueCfgClient
Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setMaxWorkQueueCapacity

void setMaxWorkQueueCapacity(java.lang.Integer value)
                             throws IllegalPropertyValueException
Sets 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.

Parameters:
value - The value of the "max-work-queue-capacity" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getNumWorkerThreads

java.lang.Integer 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.

setNumWorkerThreads

void setNumWorkerThreads(int value)
                         throws IllegalPropertyValueException
Sets 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.

Parameters:
value - The value of the "num-worker-threads" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.