Package org.opends.server.backends.pdb

Class PDBBackend

java.lang.Object

org.opends.server.api.Backend<C>

org.opends.server.api.LocalBackend<C>

org.opends.server.backends.pluggable.BackendImpl<PDBBackendCfg>

org.opends.server.backends.pdb.PDBBackend

All Implemented Interfaces:

ConfigurationChangeListener<PluggableBackendCfg>

public final class PDBBackend
extends BackendImpl<PDBBackendCfg>

Class defined in the configuration for this backend type.

Nested Class Summary

Nested classes/interfaces inherited from class org.opends.server.api.LocalBackend

LocalBackend.BackendOperation

Constructor Summary

Constructors

Constructor	Description
PDBBackend()

Method Summary

Modifier and Type	Method	Description
protected Storage	configureStorage(PDBBackendCfg cfg, ServerContext serverContext)	Creates the storage engine which will be used by this pluggable backend.
boolean	isConfigurationAcceptable(PDBBackendCfg cfg, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons, ServerContext serverContext)	Indicates whether the provided configuration is acceptable for this backend.

Methods inherited from class org.opends.server.backends.pluggable.BackendImpl

addEntry, applyConfigurationChange, closeBackend, configureBackend, createBackup, deleteEntry, entryExists, exportLDIF, getBaseDNs, getEntry, getEntryCount, getNumberOfChildren, getNumberOfEntriesInBaseDN, getRootContainer, getSupportedControls, getSupportedFeatures, hasSubordinates, importLDIF, isConfigurationChangeAcceptable, isIndexed, openBackend, rebuildBackend, removeBackup, renameEntry, replaceEntry, restoreBackup, search, supports, verifyBackend

Methods inherited from class org.opends.server.api.LocalBackend

finalizeBackend, getBackendMonitor, getPersistentSearches, getWritabilityMode, handlesEntry, handlesEntry, isDefaultRoute, isIndexed, isPrivateBackend, registerPersistentSearch, setBackendMonitor, setPrivateBackend, setWritabilityMode, supportsControl

Methods inherited from class org.opends.server.api.Backend

getBackendID, setBackendID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PDBBackend

public PDBBackend()

Method Detail

isConfigurationAcceptable

public boolean isConfigurationAcceptable(PDBBackendCfg cfg,
                                         List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons,
                                         ServerContext serverContext)

Description copied from class: Backend

Indicates whether the provided configuration is acceptable for this backend. It should be possible to call this method on an uninitialized backend instance in order to determine whether the backend would be able to use the provided configuration.

Note that implementations which use a subclass of the provided configuration class will likely need to cast the configuration to the appropriate subclass type.

Overrides:

isConfigurationAcceptable in class BackendImpl<PDBBackendCfg>

Parameters:

cfg - The backend configuration for which to make the determination.

unacceptableReasons - A list that may be used to hold the reasons that the provided configuration is not acceptable.

serverContext - this Directory Server instance's server context

Returns:

true if the provided configuration is acceptable for this backend, or false if not.

configureStorage

protected Storage configureStorage(PDBBackendCfg cfg,
                                   ServerContext serverContext)
                            throws ConfigException

Description copied from class: BackendImpl

Creates the storage engine which will be used by this pluggable backend. Implementations should create and configure a new storage engine but not open it.

Specified by:

configureStorage in class BackendImpl<PDBBackendCfg>

Parameters:

cfg - the configuration object

serverContext - this Directory Server intsance's server context

Returns:

The storage engine to be used by this pluggable backend.

Throws:

ConfigException - If there is an error in the configuration.