Backend

This is an abstract object type that cannot be instantiated.

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

The data may be stored locally in an embedded database, remotely in an external system, or generated on the fly (for example, calculated from other information that is available).

Backends

The following Backends are available:

These Backends inherit the properties described below.

Properties

Use the --advanced option to access advanced properties.

Basic Properties

Advanced Properties

  • None

Basic Properties

backend-id

SynopsisSpecifies a name to identify the associated backend.
DescriptionThe 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.
Default ValueNone
Allowed ValuesA string.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyYes

enabled

SynopsisIndicates whether the backend is enabled in the server.
DescriptionIf a backend is not enabled, then its contents are not accessible when processing operations.
Default ValueNone
Allowed Valuestrue
false
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

java-class

SynopsisSpecifies the fully-qualified name of the Java class that provides the backend implementation.
Default ValueNone
Allowed ValuesA Java class that extends or implements:
org.opends.server.api.Backend
Multi-valuedNo
RequiredYes
Admin Action RequiredThe object must be disabled and re-enabled for changes to take effect.
AdvancedNo
Read-OnlyNo