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

Interface ParallelWorkQueueCfg

All Superinterfaces:

Configuration, WorkQueueCfg

public interface ParallelWorkQueueCfg
extends WorkQueueCfg

A server-side interface for querying 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
void	addParallelChangeListener(ConfigurationChangeListener<ParallelWorkQueueCfg> listener)	Register to be notified when this Parallel Work Queue is changed.
Class<? extends ParallelWorkQueueCfg>	configurationClass()	Gets the configuration class associated with this Parallel Work Queue.
String	getJavaClass()	Gets the "java-class" property.
Integer	getNumWorkerThreads()	Gets the "num-worker-threads" property.
void	removeParallelChangeListener(ConfigurationChangeListener<ParallelWorkQueueCfg> listener)	Deregister an existing Parallel Work Queue configuration change listener.

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

dn, name

Methods inherited from interface org.forgerock.opendj.server.config.server.WorkQueueCfg

addChangeListener, removeChangeListener

Method Detail

configurationClass

Class<? extends ParallelWorkQueueCfg> configurationClass()

Gets the configuration class associated with this Parallel Work Queue.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface WorkQueueCfg

Returns:

Returns the configuration class associated with this Parallel Work Queue.

addParallelChangeListener

void addParallelChangeListener(ConfigurationChangeListener<ParallelWorkQueueCfg> listener)

Register to be notified when this Parallel Work Queue is changed.

Parameters:

listener - The Parallel Work Queue configuration change listener.

removeParallelChangeListener

void removeParallelChangeListener(ConfigurationChangeListener<ParallelWorkQueueCfg> listener)

Deregister an existing Parallel Work Queue configuration change listener.

Parameters:

listener - The Parallel Work Queue configuration change listener.

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 WorkQueueCfg

Returns:

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

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.