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

Class TraditionalWorkQueueCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<TraditionalWorkQueueCfgClient,TraditionalWorkQueueCfg>

org.forgerock.opendj.server.config.meta.TraditionalWorkQueueCfgDefn

public final class TraditionalWorkQueueCfgDefn
extends ManagedObjectDefinition<TraditionalWorkQueueCfgClient,TraditionalWorkQueueCfg>

An interface for querying the Traditional Work Queue managed object definition meta information.

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
TraditionalWorkQueueCfgClient	createClientConfiguration(ManagedObject<? extends TraditionalWorkQueueCfgClient> impl)	Creates a client configuration view of the provided managed object.
TraditionalWorkQueueCfg	createServerConfiguration(ServerManagedObject<? extends TraditionalWorkQueueCfg> impl)	Creates a server configuration view of the provided server managed object.
static TraditionalWorkQueueCfgDefn	getInstance()	Get the Traditional Work Queue configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
IntegerPropertyDefinition	getMaxWorkQueueCapacityPropertyDefinition()	Get the "max-work-queue-capacity" property definition.
IntegerPropertyDefinition	getNumWorkerThreadsPropertyDefinition()	Get the "num-worker-threads" property definition.
Class<TraditionalWorkQueueCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static TraditionalWorkQueueCfgDefn getInstance()

Get the Traditional Work Queue configuration definition singleton.

Returns:

Returns the Traditional Work Queue configuration definition singleton.

createClientConfiguration

public TraditionalWorkQueueCfgClient createClientConfiguration(ManagedObject<? extends TraditionalWorkQueueCfgClient> impl)

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<TraditionalWorkQueueCfgClient,TraditionalWorkQueueCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public TraditionalWorkQueueCfg createServerConfiguration(ServerManagedObject<? extends TraditionalWorkQueueCfg> impl)

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<TraditionalWorkQueueCfgClient,TraditionalWorkQueueCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<TraditionalWorkQueueCfg> getServerConfigurationClass()

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<TraditionalWorkQueueCfgClient,TraditionalWorkQueueCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.

getMaxWorkQueueCapacityPropertyDefinition

public IntegerPropertyDefinition getMaxWorkQueueCapacityPropertyDefinition()

Get the "max-work-queue-capacity" property definition.

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, then the server front end, and possibly the client, will be blocked until the work queue has available capacity.

Returns:

Returns the "max-work-queue-capacity" property definition.

getNumWorkerThreadsPropertyDefinition

public IntegerPropertyDefinition getNumWorkerThreadsPropertyDefinition()

Get the "num-worker-threads" property definition.

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 "num-worker-threads" property definition.