Package org.forgerock.opendj.server.config.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

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends TraditionalWorkQueueCfgClient,? extends TraditionalWorkQueueCfg>	definition()	Get the configuration definition associated with this Traditional Work Queue.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<Integer>	getNumWorkerThreads()	Gets the "num-worker-threads" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setNumWorkerThreads(ValueOrExpression<Integer> value)	Sets the "num-worker-threads" property.

Methods inherited from interface org.forgerock.opendj.config.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

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Default value: org.opends.server.extensions.TraditionalWorkQueue

Specified by:

getJavaClass in interface WorkQueueCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

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:

PropertyException - If the new value is invalid.

getNumWorkerThreads

ValueOrExpression<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(ValueOrExpression<Integer> value)
                  throws PropertyException

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:

PropertyException - If the new value is invalid.