Uses of Class
org.opends.server.api.Backend

Packages that use Backend

Package	Description
org.opends.guitools.controlpanel.util	Contains some utilities used in the Control Panel.
org.opends.server.api	Contains a number of API declarations for use throughout the Directory Server.
org.opends.server.authorization.dseecompat	Contains the Directory Server Sun Java System Directory Server Enterprise Edition (dseecompat) compatability access control handler implementation.
org.opends.server.backends	Contains various Directory Server backend implementations.
org.opends.server.backends.jeb	Contains the code for the Directory Server backend that uses the Berkeley DB Java Edition as the repository for storing entry and index information.
org.opends.server.backends.pdb	Contains the code for the Directory Server backend that uses Persistit as the repository for storing entry and index information.
org.opends.server.backends.pluggable	Contains the code for implementing Directory Server pluggable storage backends.
org.opends.server.backends.task	Contains the code for the Directory Server backend that provides an interface for executing administrative tasks.
org.opends.server.core	Contains various classes that comprise the core of the Directory Server codebase.
org.opends.server.crypto	This package implements the Directory Server cryptographic framework, which is described in the CrytpoManager design document.
org.opends.server.extensions	Contains various implementations of Directory Server APIs that are not appropriate for other packages.
org.opends.server.monitors	Contains various Directory Server monitor provider implementations.
org.opends.server.plugins	Contains the implementation for various Directory Server plugins.
org.opends.server.replication.plugin	This package contains the part of the Multi-master replication code that works on the Directory Server side.
org.opends.server.tasks	Contains implementations for various Directory Server tasks.
org.opends.server.tools	Contains various Directory Server tool implementations.
org.opends.server.workflowelement.localbackend	This package contains source for the local backend workflow element, which are used to process operations against data stored in local backend databases and other repositories that are considered "local".

Uses of Backend in org.opends.guitools.controlpanel.util

Subclasses of Backend in org.opends.guitools.controlpanel.util

Modifier and Type	Class and Description
class	ReadOnlyConfigFileHandler A class used to read the configuration from a file.

Uses of Backend in org.opends.server.api

Subclasses of Backend in org.opends.server.api

Modifier and Type	Class and Description
class	ConfigHandler<C extends BackendCfg> This class defines the set of methods and structures that must be implemented by a Directory Server configuration handler.

Methods in org.opends.server.api that return Backend

Modifier and Type	Method and Description
Backend<?>	Backend.getParentBackend() Retrieves the parent backend for this backend.
Backend<?>[]	Backend.getSubordinateBackends() Retrieves the set of subordinate backends for this backend.

Methods in org.opends.server.api with parameters of type Backend

Modifier and Type	Method and Description
void	Backend.addSubordinateBackend(Backend<?> subordinateBackend) Adds the provided backend to the set of subordinate backends for this backend.
void	BackendInitializationListener.performBackendPostFinalizationProcessing(Backend<?> backend) Performs any processing that may be required whenever a backend is finalized.
void	BackendInitializationListener.performBackendPostInitializationProcessing(Backend<?> backend) Performs any processing that may be required after the Initialisation cycle has been completed, that is all listeners have received the initialisation event, and the backend has been put into service,.
void	BackendInitializationListener.performBackendPreFinalizationProcessing(Backend<?> backend) Performs any processing that may be required before starting the finalisation cycle, that is invoked before any listener receive the Finalization event.
void	BackendInitializationListener.performBackendPreInitializationProcessing(Backend<?> backend) Performs any processing that may be required whenever a backend is initialized for use in the Directory Server.
void	BackupTaskListener.processBackupBegin(Backend backend, BackupConfig config) Performs any processing that might be necessary just before the server begins processing on a backup task.
void	BackupTaskListener.processBackupEnd(Backend backend, BackupConfig config, boolean successful) Performs any processing that might be necessary after the server has completed processing on a backup task.
void	ExportTaskListener.processExportBegin(Backend backend, LDIFExportConfig config) Performs any processing that might be necessary just before the server begins processing on an LDIF export task.
void	ExportTaskListener.processExportEnd(Backend backend, LDIFExportConfig config, boolean successful) Performs any processing that might be necessary after the server has completed processing on an LDIF export task.
void	ImportTaskListener.processImportBegin(Backend backend, LDIFImportConfig config) Performs any processing that might be necessary just before the server begins processing on an LDIF import task.
void	ImportTaskListener.processImportEnd(Backend backend, LDIFImportConfig config, boolean successful) Performs any processing that might be necessary after the server has completed processing on an LDIF import task.
void	RestoreTaskListener.processRestoreBegin(Backend backend, RestoreConfig config) Performs any processing that might be necessary just before the server begins processing on a restore task.
void	RestoreTaskListener.processRestoreEnd(Backend backend, RestoreConfig config, boolean successful) Performs any processing that might be necessary after the server has completed processing on a restore task.
void	Backend.removeSubordinateBackend(Backend<?> subordinateBackend) Removes the provided backend from the set of subordinate backends for this backend.
void	Backend.setParentBackend(Backend<?> parentBackend) Specifies the parent backend for this backend.

Uses of Backend in org.opends.server.authorization.dseecompat

Methods in org.opends.server.authorization.dseecompat with parameters of type Backend

Modifier and Type	Method and Description
void	AciListenerManager.performBackendPostFinalizationProcessing(Backend<?> backend) Performs any processing that may be required whenever a backend is finalized.
void	AciListenerManager.performBackendPostInitializationProcessing(Backend<?> backend)
void	AciListenerManager.performBackendPreFinalizationProcessing(Backend<?> backend)
void	AciListenerManager.performBackendPreInitializationProcessing(Backend<?> backend) Performs any processing that may be required whenever a backend is initialized for use in the Directory Server.
void	AciList.removeAci(Backend<?> backend) Remove all ACIs related to a backend.

Uses of Backend in org.opends.server.backends

Subclasses of Backend in org.opends.server.backends

Modifier and Type	Class and Description
class	BackupBackend This class defines a backend used to present information about Directory Server backups.
class	ChangelogBackend A backend that provides access to the changelog, i.e.
class	LDIFBackend This class provides a backend implementation that stores the underlying data in an LDIF file.
class	MemoryBackend This class defines a very simple backend that stores its information in memory.
class	MonitorBackend This class defines a backend to hold Directory Server monitor entries.
class	NullBackend This class implements /dev/null like backend for development and testing.
class	RootDSEBackend This class defines a backend to hold the Directory Server root DSE.
class	SchemaBackend This class defines a backend to hold the Directory Server schema information.
class	TrustStoreBackend This class defines a backend used to provide an LDAP view of public keys stored in a key store.

Methods in org.opends.server.backends that return types with arguments of type Backend

Modifier and Type	Method and Description
Map<DN,Backend<?>>	RootDSEBackend.getSubordinateBaseDNs() Returns the subordinate base DNs of the root DSE.

Uses of Backend in org.opends.server.backends.jeb

Subclasses of Backend in org.opends.server.backends.jeb

Modifier and Type	Class and Description
class	JEBackend Class defined in the configuration for this backend type.

Uses of Backend in org.opends.server.backends.pdb

Subclasses of Backend in org.opends.server.backends.pdb

Modifier and Type	Class and Description
class	PDBBackend Class defined in the configuration for this backend type.

Uses of Backend in org.opends.server.backends.pluggable

Subclasses of Backend in org.opends.server.backends.pluggable

Modifier and Type	Class and Description
class	BackendImpl<C extends PluggableBackendCfg> This is an implementation of a Directory Server Backend which stores entries locally in a pluggable storage.

Uses of Backend in org.opends.server.backends.task

Subclasses of Backend in org.opends.server.backends.task

Modifier and Type	Class and Description
class	TaskBackend This class provides an implementation of a Directory Server backend that may be used to execute various kinds of administrative tasks on a one-time or recurring basis.

Uses of Backend in org.opends.server.core

Methods in org.opends.server.core that return Backend

Modifier and Type	Method and Description
static Backend<?>	DirectoryServer.getBackend(DN entryDN) Retrieves the backend that should be used to handle operations on the specified entry.
static Backend<?>	DirectoryServer.getBackend(String backendID) Retrieves the backend with the specified backend ID.
static Backend<?>	DirectoryServer.getBackendWithBaseDN(DN baseDN) Retrieves the backend with the specified base DN.

Methods in org.opends.server.core that return types with arguments of type Backend

Modifier and Type	Method and Description
static Map<String,Backend>	DirectoryServer.getBackends() Retrieves the set of backends that have been registered with the Directory Server, as a mapping between the backend ID and the corresponding backend.
static Map<DN,Backend>	DirectoryServer.getBaseDNs() Retrieves the entire set of base DNs registered with the Directory Server, mapped from the base DN to the backend responsible for that base DN.
static Map<DN,Backend>	DirectoryServer.getPrivateNamingContexts() Retrieves the set of private naming contexts defined in the Directory Server, mapped from the naming context DN to the corresponding backend.
static Map<DN,Backend>	DirectoryServer.getPublicNamingContexts() Retrieves the set of public naming contexts defined in the Directory Server, mapped from the naming context DN to the corresponding backend.

Methods in org.opends.server.core with parameters of type Backend

Modifier and Type	Method and Description
static void	DirectoryServer.deregisterBackend(Backend<?> backend) Deregisters the provided backend with the Directory Server.
static String	LockFileManager.getBackendLockFileName(Backend backend) Retrieves the filename that should be used for the lock file for the specified backend.
static void	DirectoryServer.notifyBackupBeginning(Backend<?> backend, BackupConfig config) Notifies the registered backup task listeners that the server will be beginning a backup task with the provided information.
static void	DirectoryServer.notifyBackupEnded(Backend<?> backend, BackupConfig config, boolean successful) Notifies the registered backup task listeners that the server has completed processing on a backup task with the provided information.
static void	DirectoryServer.notifyExportBeginning(Backend<?> backend, LDIFExportConfig config) Notifies the registered LDIF export task listeners that the server will be beginning an export task with the provided information.
static void	DirectoryServer.notifyExportEnded(Backend<?> backend, LDIFExportConfig config, boolean successful) Notifies the registered LDIF export task listeners that the server has completed processing on an export task with the provided information.
static void	DirectoryServer.notifyImportBeginning(Backend<?> backend, LDIFImportConfig config) Notifies the registered LDIF import task listeners that the server will be beginning an import task with the provided information.
static void	DirectoryServer.notifyImportEnded(Backend<?> backend, LDIFImportConfig config, boolean successful) Notifies the registered LDIF import task listeners that the server has completed processing on an import task with the provided information.
static void	DirectoryServer.notifyRestoreBeginning(Backend<?> backend, RestoreConfig config) Notifies the registered restore task listeners that the server will be beginning a restore task with the provided information.
static void	DirectoryServer.notifyRestoreEnded(Backend<?> backend, RestoreConfig config, boolean successful) Notifies the registered restore task listeners that the server has completed processing on a restore task with the provided information.
void	GroupManager.performBackendPostFinalizationProcessing(Backend<?> backend) Performs any processing that may be required whenever a backend is finalized.
void	SubentryManager.performBackendPostFinalizationProcessing(Backend<?> backend) Performs any processing that may be required whenever a backend is finalized.
void	GroupManager.performBackendPostInitializationProcessing(Backend<?> backend)
void	SubentryManager.performBackendPostInitializationProcessing(Backend<?> backend)
void	GroupManager.performBackendPreFinalizationProcessing(Backend<?> backend)
void	SubentryManager.performBackendPreFinalizationProcessing(Backend<?> backend)
void	GroupManager.performBackendPreInitializationProcessing(Backend<?> backend) Performs any processing that may be required whenever a backend is initialized for use in the Directory Server.
void	SubentryManager.performBackendPreInitializationProcessing(Backend<?> backend) Performs any processing that may be required whenever a backend is initialized for use in the Directory Server.
static void	DirectoryServer.registerBackend(Backend<?> backend) Registers the provided backend with the Directory Server.
List<LocalizableMessage>	BaseDnRegistry.registerBaseDN(DN baseDN, Backend<?> backend, boolean isPrivate) Registers a base DN with this registry.
static void	DirectoryServer.registerBaseDN(DN baseDN, Backend<?> backend, boolean isPrivate) Registers the provided base DN with the server.

Uses of Backend in org.opends.server.crypto

Methods in org.opends.server.crypto with parameters of type Backend

Modifier and Type	Method and Description
void	CryptoManagerSync.performBackendPostFinalizationProcessing(Backend<?> backend) Performs any processing that may be required whenever a backend is finalized.
void	CryptoManagerSync.performBackendPostInitializationProcessing(Backend<?> backend)
void	CryptoManagerSync.performBackendPreFinalizationProcessing(Backend<?> backend)
void	CryptoManagerSync.performBackendPreInitializationProcessing(Backend<?> backend) Performs any processing that may be required whenever a backend is initialized for use in the Directory Server.

Uses of Backend in org.opends.server.extensions

Subclasses of Backend in org.opends.server.extensions

Modifier and Type	Class and Description
class	ConfigFileHandler This class defines a simple configuration handler for the Directory Server that will read the server configuration from an LDIF file.

Methods in org.opends.server.extensions with parameters of type Backend

Modifier and Type	Method and Description
void	DefaultEntryCache.performBackendPostFinalizationProcessing(Backend<?> backend) Performs any processing that may be required whenever a backend is finalized.
void	DefaultEntryCache.performBackendPostInitializationProcessing(Backend<?> backend)
void	DefaultEntryCache.performBackendPreFinalizationProcessing(Backend<?> backend)
void	DefaultEntryCache.performBackendPreInitializationProcessing(Backend<?> backend) Performs any processing that may be required whenever a backend is initialized for use in the Directory Server.

Uses of Backend in org.opends.server.monitors

Constructors in org.opends.server.monitors with parameters of type Backend

Constructor and Description
BackendMonitor(Backend<?> backend) Creates a new instance of this backend monitor provider that will work with the provided backend.

Uses of Backend in org.opends.server.plugins

Methods in org.opends.server.plugins with parameters of type Backend

Modifier and Type	Method and Description
void	PasswordPolicyImportPlugin.processImportBegin(Backend backend, LDIFImportConfig config) Performs any processing that might be necessary just before the server begins processing on an LDIF import task.
void	PasswordPolicyImportPlugin.processImportEnd(Backend backend, LDIFImportConfig config, boolean successful) Performs any processing that might be necessary after the server has completed processing on an LDIF import task.

Uses of Backend in org.opends.server.replication.plugin

Methods in org.opends.server.replication.plugin with parameters of type Backend

Modifier and Type	Method and Description
void	LDAPReplicationDomain.performBackendPostFinalizationProcessing(Backend<?> backend)
void	LDAPReplicationDomain.performBackendPostInitializationProcessing(Backend<?> backend)
void	LDAPReplicationDomain.performBackendPreFinalizationProcessing(Backend<?> backend)
void	LDAPReplicationDomain.performBackendPreInitializationProcessing(Backend<?> backend)
void	MultimasterReplication.processBackupBegin(Backend backend, BackupConfig config) Performs any processing that might be necessary just before the server begins processing on a backup task.
void	MultimasterReplication.processBackupEnd(Backend backend, BackupConfig config, boolean successful) Performs any processing that might be necessary after the server has completed processing on a backup task.
void	MultimasterReplication.processExportBegin(Backend backend, LDIFExportConfig config) Performs any processing that might be necessary just before the server begins processing on an LDIF export task.
void	MultimasterReplication.processExportEnd(Backend backend, LDIFExportConfig config, boolean successful) Performs any processing that might be necessary after the server has completed processing on an LDIF export task.
void	MultimasterReplication.processImportBegin(Backend backend, LDIFImportConfig config) Performs any processing that might be necessary just before the server begins processing on an LDIF import task.
void	MultimasterReplication.processImportEnd(Backend backend, LDIFImportConfig config, boolean successful) Performs any processing that might be necessary after the server has completed processing on an LDIF import task.
void	MultimasterReplication.processRestoreBegin(Backend backend, RestoreConfig config) Performs any processing that might be necessary just before the server begins processing on a restore task.
void	MultimasterReplication.processRestoreEnd(Backend backend, RestoreConfig config, boolean successful) Performs any processing that might be necessary after the server has completed processing on a restore task.

Uses of Backend in org.opends.server.tasks

Methods in org.opends.server.tasks with parameters of type Backend

Modifier and Type	Method and Description
static BackendCfg	TaskUtils.getConfigEntry(Backend backend) Get the configuration entry for a given backend.

Uses of Backend in org.opends.server.tools

Methods in org.opends.server.tools that return Backend

Modifier and Type	Method and Description
Backend<?>	RebuildIndex.getCurrentBackend() Returns the current backend.

Methods in org.opends.server.tools with parameters of type Backend

Modifier and Type	Method and Description
void	RebuildIndex.setCurrentBackend(Backend<?> currentBackend) Sets the current backend.

Method parameters in org.opends.server.tools with type arguments of type Backend

Modifier and Type	Method and Description
static int	BackendToolUtils.getBackends(List<Backend> backendList, List<BackendCfg> entryList, List<List<DN>> dnList) Retrieves information about the backends defined in the Directory Server configuration.

Uses of Backend in org.opends.server.workflowelement.localbackend

Methods in org.opends.server.workflowelement.localbackend that return Backend

Modifier and Type	Method and Description
Backend<?>	LocalBackendWorkflowElement.getBackend() Gets the backend associated with this local backend workflow element.

Methods in org.opends.server.workflowelement.localbackend with parameters of type Backend

Modifier and Type	Method and Description
static LocalBackendWorkflowElement	LocalBackendWorkflowElement.createAndRegister(DN baseDN, Backend<?> backend) Creates and registers a local backend with the server.