Uses of Class org.opends.server.api.LocalBackend (OpenDJ Public API Javadoc 7.4.3-20241015115352-209ff3c0000cb208c40a9a5f707924f0af03b332 Documentation)

Packages that use LocalBackend
Package	Description
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.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.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.tools	Contains various Directory Server tool implementations.
org.opends.server.tools.dsbackup	Classes related to dsbackup tool.
org.opends.server.types	Contains implementations for a number of Directory Server data types.

Uses of LocalBackend in org.opends.server.api

Methods in org.opends.server.api with parameters of type LocalBackend
Modifier and Type	Method	Description
`default void`	LocalBackendInitializationListener.`performBackendPostInitializationProcessing(LocalBackend<?> 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,.
`default void`	LocalBackendInitializationListener.`performBackendPreFinalizationProcessing(LocalBackend<?> backend)`	Performs any processing that may be required before starting the finalisation cycle, that is invoked before any listener receive the Finalization event.
`default void`	LocalBackendInitializationListener.`performBackendPreInitializationProcessing(LocalBackend<?> backend)`	Performs any processing that may be required whenever a backend is initialized for use in the Directory Server.
`void`	BackupTaskListener.`processBackupBegin(LocalBackend<?> backend)`	Performs any processing that might be necessary just before the server begins processing on a backup task.
`void`	BackupTaskListener.`processBackupEnd(LocalBackend<?> backend)`	Performs any processing that might be necessary after the server has completed processing on a backup task.
`void`	ExportTaskListener.`processExportBegin(LocalBackend<?> backend, LDIFExportConfig config)`	Performs any processing that might be necessary just before the server begins processing on an LDIF export task.
`void`	ExportTaskListener.`processExportEnd(LocalBackend<?> 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(LocalBackend<?> backend, LDIFImportConfig config)`	Performs any processing that might be necessary just before the server begins processing on an LDIF import task.
`void`	ImportTaskListener.`processImportEnd(LocalBackend<?> 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(LocalBackend<?> backend)`	Performs any processing that might be necessary just before the server begins processing on a restore task.
`void`	RestoreTaskListener.`processRestoreEnd(LocalBackend<?> backend)`	Performs any processing that might be necessary after the server has completed processing on a restore task.

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

Methods in org.opends.server.authorization.dseecompat with parameters of type LocalBackend
Modifier and Type	Method	Description
`void`	AciListenerManager.`performBackendPreInitializationProcessing(LocalBackend<?> backend)`	Performs any processing that may be required whenever a backend is initialized for use in the Directory Server.

Uses of LocalBackend in org.opends.server.backends

Subclasses of LocalBackend in org.opends.server.backends
Modifier and Type	Class	Description
`class`	`ChangelogBackend`	A backend that provides access to the changelog, i.e.
`class`	`ConfigurationBackend`	Back-end responsible for management of configuration entries.
`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.

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

Subclasses of LocalBackend in org.opends.server.backends.jeb
Modifier and Type Class Description

class JEBackend
Class defined in the configuration for this backend type.

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

Subclasses of LocalBackend in org.opends.server.backends.pluggable
Modifier and Type	Class	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 LocalBackend in org.opends.server.backends.task

Subclasses of LocalBackend in org.opends.server.backends.task
Modifier and Type	Class	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 LocalBackend in org.opends.server.core

Methods in org.opends.server.core that return LocalBackend
Modifier and Type	Method	Description
`LocalBackend<?>`	BackendConfigManager.`findLocalBackendForEntry(Dn entryDn)`	Retrieves the local backend and the corresponding baseDN that should be used to handle operations on the specified entry.
`LocalBackend<?>`	BackendConfigManager.`getLocalBackendById(String backendId)`	Retrieves a local backend provided its identifier.
`LocalBackend<?>`	BackendConfigManager.`getLocalBackendWithBaseDN(Dn baseDn)`	Retrieves the local backend with the specified base DN.

Methods in org.opends.server.core with parameters of type LocalBackend
Modifier and Type	Method	Description
`void`	DirectoryServer.`notifyBackupBeginning(LocalBackend<?> backend)`	Notifies the registered backup task listeners that the server will be beginning a backup task with the provided information.
`void`	ServerContext.`notifyBackupBeginning(LocalBackend<?> backend)`	Notifies the registered backup task listeners that the server will be beginning a backup task with the provided information.
`void`	DirectoryServer.`notifyBackupEnded(LocalBackend<?> backend)`	Notifies the registered backup task listeners that the server has completed processing on a backup task with the provided information.
`void`	ServerContext.`notifyBackupEnded(LocalBackend<?> backend)`	Notifies the registered backup task listeners that the server has completed processing on a backup task with the provided information.
`void`	DirectoryServer.`notifyExportBeginning(LocalBackend<?> backend, LDIFExportConfig config)`	Notifies the registered LDIF export task listeners that the server will be beginning an export task with the provided information.
`void`	ServerContext.`notifyExportBeginning(LocalBackend<?> backend, LDIFExportConfig config)`	Notifies the registered LDIF export task listeners that the server will be beginning an export task with the provided information.
`void`	DirectoryServer.`notifyExportEnded(LocalBackend<?> 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.
`void`	ServerContext.`notifyExportEnded(LocalBackend<?> 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.
`void`	DirectoryServer.`notifyImportBeginning(LocalBackend<?> backend, LDIFImportConfig config)`	Notifies the registered LDIF import task listeners that the server will be beginning an import task with the provided information.
`void`	ServerContext.`notifyImportBeginning(LocalBackend<?> backend, LDIFImportConfig config)`	Notifies the registered LDIF import task listeners that the server will be beginning an import task with the provided information.
`void`	DirectoryServer.`notifyImportEnded(LocalBackend<?> 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.
`void`	ServerContext.`notifyImportEnded(LocalBackend<?> 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.
`void`	DirectoryServer.`notifyRestoreBeginning(LocalBackend<?> backend)`	Notifies the registered restore task listeners that the server will be beginning a restore task with the provided information.
`void`	ServerContext.`notifyRestoreBeginning(LocalBackend<?> backend)`	Notifies the registered restore task listeners that the server will be beginning a restore task with the provided information.
`void`	DirectoryServer.`notifyRestoreEnded(LocalBackend<?> backend)`	Notifies the registered restore task listeners that the server has completed processing on a restore task with the provided information.
`void`	ServerContext.`notifyRestoreEnded(LocalBackend<?> backend)`	Notifies the registered restore task listeners that the server has completed processing on a restore task with the provided information.
`void`	GroupManager.`performBackendPreInitializationProcessing(LocalBackend<?> backend)`	Performs any processing that may be required whenever a backend is initialized for use in the Directory Server.
`void`	SubentryManager.`performBackendPreInitializationProcessing(LocalBackend<?> backend)`	Performs any processing that may be required whenever a backend is initialized for use in the Directory Server.

Uses of LocalBackend in org.opends.server.crypto

Methods in org.opends.server.crypto with parameters of type LocalBackend
Modifier and Type	Method	Description
`void`	CryptoManagerSync.`performBackendPostInitializationProcessing(LocalBackend<?> backend)`
`void`	CryptoManagerSync.`performBackendPreFinalizationProcessing(LocalBackend<?> backend)`

Uses of LocalBackend in org.opends.server.monitors

Classes in org.opends.server.monitors with type parameters of type LocalBackend
Modifier and Type	Class	Description
`class`	`LocalBackendMonitor<B extends LocalBackend<?>>`	This class implements a monitor provider that will report generic information for an enabled Directory Server backend, including its backend ID, base DNs, writability mode, and the number of entries it contains.

Uses of LocalBackend in org.opends.server.plugins

Methods in org.opends.server.plugins with parameters of type LocalBackend
Modifier and Type	Method	Description
`void`	PasswordPolicyImportPlugin.`processImportBegin(LocalBackend<?> backend, LDIFImportConfig config)`
`void`	PasswordPolicyImportPlugin.`processImportEnd(LocalBackend<?> backend, LDIFImportConfig config, boolean successful)`

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

Methods in org.opends.server.replication.plugin with parameters of type LocalBackend
Modifier and Type	Method	Description
`void`	LDAPReplicationDomain.`performBackendPostInitializationProcessing(LocalBackend<?> backend)`
`void`	LDAPReplicationDomain.`performBackendPreFinalizationProcessing(LocalBackend<?> backend)`
`void`	MultimasterReplication.`processBackupBegin(LocalBackend<?> backend)`
`void`	MultimasterReplication.`processBackupEnd(LocalBackend<?> backend)`
`void`	MultimasterReplication.`processExportBegin(LocalBackend<?> backend, LDIFExportConfig config)`
`void`	MultimasterReplication.`processExportEnd(LocalBackend<?> backend, LDIFExportConfig config, boolean successful)`
`void`	MultimasterReplication.`processImportBegin(LocalBackend<?> backend, LDIFImportConfig config)`
`void`	MultimasterReplication.`processImportEnd(LocalBackend<?> backend, LDIFImportConfig config, boolean successful)`
`void`	MultimasterReplication.`processRestoreBegin(LocalBackend<?> backend)`
`void`	MultimasterReplication.`processRestoreEnd(LocalBackend<?> backend)`

Uses of LocalBackend in org.opends.server.tools

Methods in org.opends.server.tools that return LocalBackend
Modifier and Type	Method	Description
`LocalBackend<?>`	BackendToolUtils.BackendInfo.`getLocalBackend()`	Returns the local backend.

Methods in org.opends.server.tools that return types with arguments of type LocalBackend
Modifier and Type	Method	Description
`static Collection<LocalBackend<?>>`	BackendToolUtils.`getEnabledLocalBackends(ServerContext serverContext)`	Returns a collection of the enabled local backends found in the Directory Server configuration.

Uses of LocalBackend in org.opends.server.tools.dsbackup

Method parameters in org.opends.server.tools.dsbackup with type arguments of type LocalBackend
Modifier and Type	Method	Description
`BackupRunner`	BackupRunner.`enabledBackends(Collection<LocalBackend<?>> enabledBackends)`	Sets the collection of backends that are currently enabled in the Directory Server.
`RestoreRunner`	RestoreRunner.`enabledBackends(Collection<LocalBackend<?>> enabledBackends)`	Sets the collection of backends that are currently enabled in the Directory Server.
`BackupRunner`	BackupRunner.`listeners(Consumer<LocalBackend<?>> backupStartListener, Consumer<LocalBackend<?>> backupEndListener)`	Sets the listeners that should be called before and after each backend is backed up.
`RestoreRunner`	RestoreRunner.`listeners(Consumer<LocalBackend<?>> restoreStartListener, Consumer<LocalBackend<?>> restoreEndListener)`	Sets the listeners that should be called before and after each backend has been restored.

Uses of LocalBackend in org.opends.server.types

Methods in org.opends.server.types that return LocalBackend
Modifier and Type	Method	Description
`protected LocalBackend<?>`	Operation.`getLocalBackend()`	Returns the local backend targeted by the provided operation.

Methods in org.opends.server.types with parameters of type LocalBackend
Modifier and Type	Method	Description
`protected static void`	Operation.`checkIfBackendIsWritable(LocalBackend<?> backend, Operation op, Dn entryDN, LocalizableMessageDescriptor.Arg1<Object> serverMsg, LocalizableMessageDescriptor.Arg1<Object> backendMsg)`	Checks if an update operation can be performed against a backend.