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

Class TaskBackendCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<TaskBackendCfgClient,TaskBackendCfg>

org.forgerock.opendj.server.config.meta.TaskBackendCfgDefn

public final class TaskBackendCfgDefn
extends ManagedObjectDefinition<TaskBackendCfgClient,TaskBackendCfg>

An interface for querying the Task Backend managed object definition meta information.

The Task Backend provides a mechanism for scheduling tasks in the OpenDJ directory server. Tasks are intended to provide access to certain types of administrative functions in the server that may not be convenient to perform remotely.

Method Summary

Modifier and Type	Method	Description
TaskBackendCfgClient	createClientConfiguration(ManagedObject<? extends TaskBackendCfgClient> impl)	Creates a client configuration view of the provided managed object.
TaskBackendCfg	createServerConfiguration(ServerManagedObject<? extends TaskBackendCfg> impl)	Creates a server configuration view of the provided server managed object.
StringPropertyDefinition	getBackendIdPropertyDefinition()	Get the "backend-id" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static TaskBackendCfgDefn	getInstance()	Get the Task Backend configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
StringPropertyDefinition	getNotificationSenderAddressPropertyDefinition()	Get the "notification-sender-address" property definition.
Class<TaskBackendCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
StringPropertyDefinition	getTaskBackingFilePropertyDefinition()	Get the "task-backing-file" property definition.
DurationPropertyDefinition	getTaskRetentionTimePropertyDefinition()	Get the "task-retention-time" property definition.
EnumPropertyDefinition<LocalBackendCfgDefn.WritabilityMode>	getWritabilityModePropertyDefinition()	Get the "writability-mode" property 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 TaskBackendCfgDefn getInstance()

Get the Task Backend configuration definition singleton.

Returns:

Returns the Task Backend configuration definition singleton.

createClientConfiguration

public TaskBackendCfgClient createClientConfiguration(ManagedObject<? extends TaskBackendCfgClient> 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<TaskBackendCfgClient,TaskBackendCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<TaskBackendCfgClient,TaskBackendCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<TaskBackendCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<TaskBackendCfgClient,TaskBackendCfg>

Returns:

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

getBackendIdPropertyDefinition

public StringPropertyDefinition getBackendIdPropertyDefinition()

Get the "backend-id" property definition.

Specifies a name to identify the associated backend.

The name must be unique among all backends in the server. The backend ID may not be altered after the backend is created in the server.

Returns:

Returns the "backend-id" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the backend is enabled in the server.

If a backend is not enabled, then its contents are not accessible when processing operations.

Returns:

Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

Specifies the fully-qualified name of the Java class that provides the backend implementation.

Returns:

Returns the "java-class" property definition.

getNotificationSenderAddressPropertyDefinition

public StringPropertyDefinition getNotificationSenderAddressPropertyDefinition()

Get the "notification-sender-address" property definition.

Specifies the email address to use as the sender (that is, the "From:" address) address for notification mail messages generated when a task completes execution.

Returns:

Returns the "notification-sender-address" property definition.

getTaskBackingFilePropertyDefinition

public StringPropertyDefinition getTaskBackingFilePropertyDefinition()

Get the "task-backing-file" property definition.

Specifies the path to the backing file for storing information about the tasks configured in the server.

It may be either an absolute path or a relative path to the base of the OpenDJ directory server instance.

Returns:

Returns the "task-backing-file" property definition.

getTaskRetentionTimePropertyDefinition

public DurationPropertyDefinition getTaskRetentionTimePropertyDefinition()

Get the "task-retention-time" property definition.

Specifies the length of time that task entries should be retained after processing on the associated task has been completed.

Returns:

Returns the "task-retention-time" property definition.

getWritabilityModePropertyDefinition

public EnumPropertyDefinition<LocalBackendCfgDefn.WritabilityMode> getWritabilityModePropertyDefinition()

Get the "writability-mode" property definition.

Specifies the behavior that the backend should use when processing write operations.

Returns:

Returns the "writability-mode" property definition.