org.forgerock.opendj.server.config.server

Interface MemoryBackendCfg

All Superinterfaces:

BackendCfg, Configuration, LocalBackendCfg

public interface MemoryBackendCfg
extends LocalBackendCfg

A server-side interface for querying Memory Backend settings.

The Memory Backend provides a directory server backend implementation that stores entries in memory, for development and testing.

Method Summary

Modifier and Type	Method and Description
void	addMemoryChangeListener(ConfigurationChangeListener<MemoryBackendCfg> listener) Register to be notified when this Memory Backend is changed.
Class<? extends MemoryBackendCfg>	configurationClass() Gets the configuration class associated with this Memory Backend.
SortedSet<Dn>	getBaseDn() Gets the "base-dn" property.
String	getJavaClass() Gets the "java-class" property.
LocalBackendCfgDefn.WritabilityMode	getWritabilityMode() Gets the "writability-mode" property.
void	removeMemoryChangeListener(ConfigurationChangeListener<MemoryBackendCfg> listener) Deregister an existing Memory Backend configuration change listener.

Methods inherited from interface org.forgerock.opendj.server.config.server.LocalBackendCfg

addLocalChangeListener, removeLocalChangeListener

Methods inherited from interface org.forgerock.opendj.server.config.server.BackendCfg

addChangeListener, getBackendId, isEnabled, removeChangeListener

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

dn, name

Method Detail

configurationClass

Class<? extends MemoryBackendCfg> configurationClass()

Gets the configuration class associated with this Memory Backend.

Specified by:

configurationClass in interface BackendCfg

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface LocalBackendCfg

Returns:

Returns the configuration class associated with this Memory Backend.

addMemoryChangeListener

void addMemoryChangeListener(ConfigurationChangeListener<MemoryBackendCfg> listener)

Register to be notified when this Memory Backend is changed.

Parameters:

listener - The Memory Backend configuration change listener.

removeMemoryChangeListener

void removeMemoryChangeListener(ConfigurationChangeListener<MemoryBackendCfg> listener)

Deregister an existing Memory Backend configuration change listener.

Parameters:

listener - The Memory Backend configuration change listener.

getBaseDn

SortedSet<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.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

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

Specified by:

getJavaClass in interface BackendCfg

Returns:

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

getWritabilityMode

LocalBackendCfgDefn.WritabilityMode getWritabilityMode()

Gets the "writability-mode" property.

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

Specified by:

getWritabilityMode in interface LocalBackendCfg

Returns:

Returns the value of the "writability-mode" property.