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

Class WorkQueueCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<WorkQueueCfgClient,WorkQueueCfg>

org.forgerock.opendj.server.config.meta.WorkQueueCfgDefn

public final class WorkQueueCfgDefn
extends ManagedObjectDefinition<WorkQueueCfgClient,WorkQueueCfg>

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

The Work Queue provides the configuration for the server work queue and is responsible for ensuring that requests received from clients are processed in a timely manner.

Method Summary

Modifier and Type	Method	Description
WorkQueueCfgClient	createClientConfiguration(ManagedObject<? extends WorkQueueCfgClient> impl)	Creates a client configuration view of the provided managed object.
WorkQueueCfg	createServerConfiguration(ServerManagedObject<? extends WorkQueueCfg> impl)	Creates a server configuration view of the provided server managed object.
static WorkQueueCfgDefn	getInstance()	Get the Work Queue configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<WorkQueueCfg>	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 WorkQueueCfgDefn getInstance()

Get the Work Queue configuration definition singleton.

Returns:

Returns the Work Queue configuration definition singleton.

createClientConfiguration

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

Description copied from class: ManagedObjectDefinition

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<WorkQueueCfgClient,WorkQueueCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<WorkQueueCfgClient,WorkQueueCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<WorkQueueCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<WorkQueueCfgClient,WorkQueueCfg>

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 Work Queue implementation.

Returns:

Returns the "java-class" property definition.