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

Interface BackendCfg

All Superinterfaces:

Configuration

All Known Subinterfaces:

BackupBackendCfg, JEBackendCfg, LDIFBackendCfg, LocalBackendCfg, MemoryBackendCfg, MonitorBackendCfg, NullBackendCfg, PDBBackendCfg, PluggableBackendCfg, SchemaBackendCfg, TaskBackendCfg, TrustStoreBackendCfg

public interface BackendCfg
extends Configuration

A server-side interface for querying Backend settings.

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

Method Summary

Modifier and Type	Method	Description
void	addChangeListener(ConfigurationChangeListener<BackendCfg> listener)	Register to be notified when this Backend is changed.
Class<? extends BackendCfg>	configurationClass()	Gets the configuration class associated with this Backend.
String	getBackendId()	Gets the "backend-id" property.
SortedSet<org.forgerock.opendj.ldap.DN>	getBaseDN()	Gets the "base-dn" property.
String	getJavaClass()	Gets the "java-class" property.
boolean	isEnabled()	Gets the "enabled" property.
void	removeChangeListener(ConfigurationChangeListener<BackendCfg> listener)	Deregister an existing Backend configuration change listener.

Methods inherited from interface org.forgerock.opendj.config.Configuration

dn, name

Method Detail

configurationClass

Class<? extends BackendCfg> configurationClass()

Gets the configuration class associated with this Backend.

Specified by:

configurationClass in interface Configuration

Returns:

Returns the configuration class associated with this Backend.

addChangeListener

void addChangeListener(ConfigurationChangeListener<BackendCfg> listener)

Register to be notified when this Backend is changed.

Parameters:

listener - The Backend configuration change listener.

removeChangeListener

void removeChangeListener(ConfigurationChangeListener<BackendCfg> listener)

Deregister an existing Backend configuration change listener.

Parameters:

listener - The Backend configuration change listener.

getBackendId

String getBackendId()

Gets the "backend-id" property.

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 value of the "backend-id" property.

getBaseDN

SortedSet<org.forgerock.opendj.ldap.DN> getBaseDN()

Gets the "base-dn" property.

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

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.

Returns:

Returns an unmodifiable set containing the values of the "base-dn" property.

isEnabled

boolean isEnabled()

Gets the "enabled" property.

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 value of the "enabled" property.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

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

Returns:

Returns the value of the "java-class" property.