Directory Services 7.4.3

Null Backend

The Null Backend provides a directory server backend that implements a /dev/null like behavior for development and testing.

The Null Backend behaves as follows: all search operations return success but no data; all write operations do nothing; bind operations fail with invalid credentials; compare operations are only possible on objectClass and return true for top, nullBackendObject, and extensibleObject. In addition controls are supported although this implementation does not provide any specific emulation for controls. Generally known request controls are accepted and default response controls returned where applicable. Searches within a Null Backend are always considered indexed. Null Backends are for development and testing only.

Parent

The Null Backend object inherits from Local Backend.

Null Backend properties

You can use configuration expressions to set property values at startup time. For details, see Property value substitution.

Basic Properties Advanced Properties

backend-id
base-dn
enabled
writability-mode

java-class

Basic properties

Use the --advanced option to access advanced properties.

backend-id

Synopsis

Specifies a name to identify the associated backend.

Description

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.

Default value

None

Allowed values

A string.

Multi-valued

No

Required

Yes

Admin action required

None

Advanced

No

Read-only

Yes

base-dn

Synopsis

Specifies the base DN(s) for the data that the backend handles.

Description

A single backend may be responsible for one or more base DNs. Note that no two backends may have the same base DN although one backend may have a base DN that is below a base DN provided by another backend (similar to the use of sub-suffixes in the Sun Java System Directory Server). If any of the base DNs is subordinate to a base DN for another backend, then all base DNs for that backend must be subordinate to that same base DN.

Default value

None

Allowed values

A valid DN.

Multi-valued

Yes

Required

Yes

Admin action required

None

No administrative action is required by default although some action may be required on a per-backend basis before the new base DN may be used.

Advanced

No

Read-only

No

enabled

Synopsis

Indicates whether the backend is enabled in the server.

Description

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

Default value

None

Allowed values

true

false

Multi-valued

No

Required

Yes

Admin action required

None

Advanced

No

Read-only

No

writability-mode

Synopsis

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

Default value

enabled

Allowed values

  • disabled: Causes all write attempts to fail.

  • enabled: Allows write operations to be performed in that backend (if the requested operation is valid, the user has permission to perform the operation, the backend supports that type of write operation, and the global writability-mode property is also enabled).

  • internal-only: Causes external write attempts to fail but allows writes by replication and internal operations.

Multi-valued

No

Required

Yes

Admin action required

None

Advanced

No

Read-only

No

Advanced properties

Use the --advanced option to access advanced properties.

java-class

Synopsis

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

Default value

org.opends.server.backends.NullBackend

Allowed values

A Java class that extends or implements:

  • org.opends.server.api.Backend

Multi-valued

No

Required

Yes

Admin action required

The object must be disabled and re-enabled for changes to take effect.

Advanced

Yes

Read-only

No