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

Class LocalBackendCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<LocalBackendCfgClient,LocalBackendCfg>

org.forgerock.opendj.server.config.meta.LocalBackendCfgDefn

public final class LocalBackendCfgDefn
extends AbstractManagedObjectDefinition<LocalBackendCfgClient,LocalBackendCfg>

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

Local Backends are responsible for providing access to the underlying data presented by the server.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LocalBackendCfgDefn.WritabilityMode	Defines the set of permissible values for the "writability-mode" property.

Method Summary

Modifier and Type	Method	Description
StringPropertyDefinition	getBackendIdPropertyDefinition()	Get the "backend-id" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static LocalBackendCfgDefn	getInstance()	Get the Local Backend configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
EnumPropertyDefinition<LocalBackendCfgDefn.WritabilityMode>	getWritabilityModePropertyDefinition()	Get the "writability-mode" property definition.

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

getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, 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 Details

getInstance

public static LocalBackendCfgDefn getInstance()

Get the Local Backend configuration definition singleton.

Returns:

Returns the Local Backend configuration definition singleton.

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.

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.