Package org.forgerock.opendj.server.config.client

Interface ParallelWorkQueueCfgClient

All Superinterfaces:

ConfigurationClient, WorkQueueCfgClient

public interface ParallelWorkQueueCfgClient
extends WorkQueueCfgClient

A client-side interface for reading and modifying Parallel Work Queue settings.

The Parallel 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 ParallelWorkQueueCfgClient,? extends ParallelWorkQueueCfg>	definition()	Get the configuration definition associated with this Parallel Work Queue.
String	getJavaClass()	Gets the "java-class" property.
Integer	getNumWorkerThreads()	Gets the "num-worker-threads" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setNumWorkerThreads(Integer value)	Sets the "num-worker-threads" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends ParallelWorkQueueCfgClient,? extends ParallelWorkQueueCfg> definition()

Get the configuration definition associated with this Parallel Work Queue.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface WorkQueueCfgClient

Returns:

Returns the configuration definition associated with this Parallel Work Queue.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

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

Specified by:

getJavaClass in interface WorkQueueCfgClient

Returns:

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

setJavaClass

void setJavaClass(String value)
           throws PropertyException

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Parallel 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

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(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.