org.opends.server.backends.jeb

Class JEStorage

java.lang.Object

org.opends.server.backends.jeb.JEStorage

All Implemented Interfaces:

Closeable, AutoCloseable, ConfigurationChangeListener<JeBackendCfg>, Backupable, DiskSpaceMonitorHandler, Storage

public final class JEStorage
extends Object
implements Storage, Backupable, ConfigurationChangeListener<JeBackendCfg>, DiskSpaceMonitorHandler

Berkeley DB Java Edition (JE for short) database implementation of the Storage engine.

Constructor Summary

Constructors

Constructor and Description
JEStorage(JeBackendCfg cfg, ServerContext serverContext) Creates a new JE storage with the provided configuration.

Method Summary

Modifier and Type	Method and Description
void	afterRestore(Path restoreDirectory, Path saveDirectory) Called after the restore operation has finished successfully.
ConfigChangeResult	applyConfigurationChange(JeBackendCfg cfg) Applies the configuration changes to this change listener.
Path	beforeRestore() Called before the restore operation begins.
void	close()
void	createBackup(BackupConfig backupConfig) Creates a backup for this storage.
void	diskFullThresholdReached(File directory, long thresholdInBytes) Notifies that the registered "full" threshold have been reached.
void	diskLowThresholdReached(File directory, long thresholdInBytes) Notifies that the registered "low" threshold have been reached.
void	diskSpaceRestored(File directory, long lowThresholdInBytes, long fullThresholdInBytes) Notifies that the free disk space is now above both "low" and "full" thresholds.
File	getDirectory() Returns the directory which acts as the root of all files to backup and restore.
ListIterator<Path>	getFilesToBackup() Returns the files to backup.
StorageStatus	getStorageStatus() Returns the current status of the storage.
boolean	isConfigurationChangeAcceptable(JeBackendCfg newCfg, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed change to the configuration is acceptable to this change listener.
boolean	isDirectRestore() Indicates if restore is done directly in the restore directory.
Set<TreeName>	listTrees() Lists the trees that exist in this storage.
void	open(AccessMode accessMode) Opens the storage engine to allow executing operations on it.
<T> T	read(ReadOperation<T> operation) Executes a read operation.
void	removeBackup(BackupDirectory backupDirectory, String backupID) Removes a backup for this storage.
void	removeStorageFiles() Remove all files for a backend of this storage.
void	restoreBackup(RestoreConfig restoreConfig) Restores a backup for this storage.
Importer	startImport() Starts the import operation.
boolean	supportsBackupAndRestore() Returns true if this storage supports backup and restore.
void	write(WriteOperation operation) Executes a write operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

JEStorage

public JEStorage(JeBackendCfg cfg,
                 ServerContext serverContext)

Creates a new JE storage with the provided configuration.

Parameters:

cfg - The configuration.

serverContext - This server instance context

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Storage

open

public void open(AccessMode accessMode)
          throws ConfigException,
                 StorageRuntimeException

Description copied from interface: Storage

Opens the storage engine to allow executing operations on it.

Specified by:

open in interface Storage

Parameters:

accessMode - Specify the access mode to this storage.

Throws:

ConfigException

StorageRuntimeException

See Also:

to release all resources once import is finished

read

public <T> T read(ReadOperation<T> operation)
           throws Exception

Description copied from interface: Storage

Executes a read operation. In case of a read operation rollback, implementations must ensure the read operation is retried until it succeeds.

Specified by:

read in interface Storage

Type Parameters:

T - type of the value returned

Parameters:

operation - the read operation to execute

Returns:

the value read by the read operation

Throws:

Exception - if a problem occurs with the underlying storage engine

startImport

public Importer startImport()
                     throws ConfigException,
                            StorageRuntimeException

Description copied from interface: Storage

Starts the import operation.

Specified by:

startImport in interface Storage

Returns:

a new Importer object which must be closed to release all resources

Throws:

ConfigException - if there is a problem with the configuration

StorageRuntimeException - if a problem occurs with the underlying storage engine

See Also:

to release all resources once import is finished

write

public void write(WriteOperation operation)
           throws Exception

Description copied from interface: Storage

Executes a write operation. In case of a write operation rollback, implementations must ensure the write operation is retried until it succeeds.

Specified by:

write in interface Storage

Parameters:

operation - the write operation to execute

Throws:

Exception - if a problem occurs with the underlying storage engine

supportsBackupAndRestore

public boolean supportsBackupAndRestore()

Description copied from interface: Storage

Returns true if this storage supports backup and restore.

Specified by:

supportsBackupAndRestore in interface Storage

Returns:

true if this storage supports backup and restore.

getDirectory

public File getDirectory()

Description copied from interface: Backupable

Returns the directory which acts as the root of all files to backup and restore.

Specified by:

getDirectory in interface Backupable

Returns:

the root directory

getFilesToBackup

public ListIterator<Path> getFilesToBackup()
                                    throws LdapException

Description copied from interface: Backupable

Returns the files to backup.

Specified by:

getFilesToBackup in interface Backupable

Returns:

an iterator of files to backup, which may be empty but never null

Throws:

LdapException - If an error occurs.

beforeRestore

public Path beforeRestore()

Description copied from interface: Backupable

Called before the restore operation begins.

In case of direct restore, the backupable entity should take any action to save a copy of existing data before restore operation. Saving includes removing the existing data and copying it in a save directory.

Specified by:

beforeRestore in interface Backupable

Returns:

the directory where current files are saved. It may be null if not applicable.

isDirectRestore

public boolean isDirectRestore()

Description copied from interface: Backupable

Indicates if restore is done directly in the restore directory.

Specified by:

isDirectRestore in interface Backupable

Returns:

true if restore is done directly in the restore directory provided by getDirectory() method, or false if restore is done in a temporary directory.

afterRestore

public void afterRestore(Path restoreDirectory,
                         Path saveDirectory)
                  throws LdapException

Description copied from interface: Backupable

Called after the restore operation has finished successfully.

For direct restore, the backupable entity can safely discard the saved copy. For indirect restore, the backupable entity should switch the restored directory to the final restore directory.

Specified by:

afterRestore in interface Backupable

Parameters:

restoreDirectory - The directory in which files have actually been restored. It is never null.

saveDirectory - The directory in which current files have been saved. It may be null if beforeRestore() returned null.

Throws:

LdapException - If an error occurs.

createBackup

public void createBackup(BackupConfig backupConfig)
                  throws LdapException

Description copied from interface: Storage

Creates a backup for this storage.

Specified by:

createBackup in interface Storage

Parameters:

backupConfig - The configuration to use when performing the backup.

Throws:

LdapException - If a Directory Server error occurs.

removeBackup

public void removeBackup(BackupDirectory backupDirectory,
                         String backupID)
                  throws LdapException

Description copied from interface: Storage

Removes a backup for this storage.

Specified by:

removeBackup in interface Storage

Parameters:

backupDirectory - The backup directory structure with which the specified backup is associated.

backupID - The backup ID for the backup to be removed.

Throws:

LdapException - If it is not possible to remove the specified backup.

restoreBackup

public void restoreBackup(RestoreConfig restoreConfig)
                   throws LdapException

Description copied from interface: Storage

Restores a backup for this storage.

Specified by:

restoreBackup in interface Storage

Parameters:

restoreConfig - The configuration to use when performing the restore.

Throws:

LdapException - If a Directory Server error occurs.

listTrees

public Set<TreeName> listTrees()

Description copied from interface: Storage

Lists the trees that exist in this storage.

Specified by:

listTrees in interface Storage

Returns:

a set of TreeNames representing the trees that exist in this storage

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(JeBackendCfg newCfg,
                                               List<LocalizableMessage> unacceptableReasons)

Description copied from interface: ConfigurationChangeListener

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<JeBackendCfg>

Parameters:

newCfg - The new configuration containing the changes.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed change is acceptable, or false if it is not.

applyConfigurationChange

public ConfigChangeResult applyConfigurationChange(JeBackendCfg cfg)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<JeBackendCfg>

Parameters:

cfg - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

removeStorageFiles

public void removeStorageFiles()
                        throws StorageRuntimeException

Description copied from interface: Storage

Remove all files for a backend of this storage.

Specified by:

removeStorageFiles in interface Storage

Throws:

StorageRuntimeException - if removal fails

getStorageStatus

public StorageStatus getStorageStatus()

Description copied from interface: Storage

Returns the current status of the storage.

Specified by:

getStorageStatus in interface Storage

Returns:

the current status of the storage

diskFullThresholdReached

public void diskFullThresholdReached(File directory,
                                     long thresholdInBytes)

Description copied from interface: DiskSpaceMonitorHandler

Notifies that the registered "full" threshold have been reached.

Specified by:

diskFullThresholdReached in interface DiskSpaceMonitorHandler

Parameters:

directory - the directory for which the threshold has been triggered

thresholdInBytes - the threshold value in bytes

diskLowThresholdReached

public void diskLowThresholdReached(File directory,
                                    long thresholdInBytes)

Description copied from interface: DiskSpaceMonitorHandler

Notifies that the registered "low" threshold have been reached.

Specified by:

diskLowThresholdReached in interface DiskSpaceMonitorHandler

Parameters:

directory - the directory for which the threshold has been triggered

thresholdInBytes - the threshold value in bytes

diskSpaceRestored

public void diskSpaceRestored(File directory,
                              long lowThresholdInBytes,
                              long fullThresholdInBytes)

Description copied from interface: DiskSpaceMonitorHandler

Notifies that the free disk space is now above both "low" and "full" thresholds.

Specified by:

diskSpaceRestored in interface DiskSpaceMonitorHandler

Parameters:

directory - the directory for which the threshold has been triggeredTODO

lowThresholdInBytes - the low threshold value in bytes

fullThresholdInBytes - the full threshold value in bytes