org.opends.server.util

Class BackupManager

java.lang.Object

org.opends.server.util.BackupManager

public class BackupManager
extends Object

A backup manager for any entity that is backupable (backend, storage).

See Also:

Backupable

Constructor Summary

Constructors

Constructor and Description
BackupManager(String backendID) Construct a backup manager for a backend.

Method Summary

Modifier and Type	Method and Description
void	createBackup(Backupable backupable, BackupConfig backupConfig) Creates a backup of the provided backupable entity.
static void	createBackup(File directory, FileFilter fileFilter, BackupConfig backupConfig, String backendId) Performs a backup according to the provided BackupConfig.
static List<Path>	getFiles(File directory, FileFilter filter, String identifier) Helper method to build a list of files to backup, in the simple case where all files are located under the provided directory.
void	removeBackup(BackupDirectory backupDir, String backupID) Removes the specified backup if it is possible to do so.
void	restoreBackup(Backupable backupable, RestoreConfig restoreConfig) Restores a backupable entity from its backup, or verify the backup.
static void	restoreBackup(File targetDirectory, FileFilter fileFilter, RestoreConfig restoreConfig, String backendId) Performs a direct restore or verifies the backup according to the provided RestoreConfig.
static Path	saveCurrentFilesToDirectory(Backupable backupable, String identifier) Helper method to save all current files of the provided backupable entity, using default behavior.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackupManager

public BackupManager(String backendID)

Construct a backup manager for a backend.

Parameters:

backendID - The ID of the backend instance for which a backup manager is required.

Method Detail

createBackup

public static void createBackup(File directory,
                                FileFilter fileFilter,
                                BackupConfig backupConfig,
                                String backendId)
                         throws LdapException

Performs a backup according to the provided BackupConfig.

Parameters:

directory - The directory containing all the files to be backed-up.

fileFilter - The file filter for selecting the files to be backed-up within the directory.

backupConfig - The backup configuration.

backendId - The id of the backend being backed-up, only used for logging.

Throws:

LdapException - If a Directory Server error occurs.

restoreBackup

public static void restoreBackup(File targetDirectory,
                                 FileFilter fileFilter,
                                 RestoreConfig restoreConfig,
                                 String backendId)
                          throws LdapException

Performs a direct restore or verifies the backup according to the provided RestoreConfig.

Parameters:

targetDirectory - The directory where the backup should be restored.

fileFilter - The file filter for selecting the files that should be temporarilly backed-up within the targetDirectory during the restore process.

restoreConfig - The restore configuration

backendId - The id of the backend being restored, only used for logging.

Throws:

LdapException - If a Directory Server error occurs.

createBackup

public void createBackup(Backupable backupable,
                         BackupConfig backupConfig)
                  throws LdapException

Creates a backup of the provided backupable entity.

The backup is stored in a single zip file in the backup directory.

If the backup is incremental, then the first entry in the zip is a text file containing a list of all the log files that are unchanged since the previous backup. The remaining zip entries are the log files themselves, which, for an incremental, only include those files that have changed.

Parameters:

backupable - The underlying entity (storage, backend) to be backed up.

backupConfig - The configuration to use when performing the backup.

Throws:

LdapException - If a Directory Server error occurs.

restoreBackup

public void restoreBackup(Backupable backupable,
                          RestoreConfig restoreConfig)
                   throws LdapException

Restores a backupable entity from its backup, or verify the backup.

Parameters:

backupable - The underlying entity (storage, backend) to be backed up.

restoreConfig - The configuration to use when performing the restore.

Throws:

LdapException - If a Directory Server error occurs.

removeBackup

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

Removes the specified backup if it is possible to do so.

Parameters:

backupDir - 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 for some reason (e.g., no such backup exists or there are other backups that are dependent upon it).

getFiles

public static List<Path> getFiles(File directory,
                                  FileFilter filter,
                                  String identifier)
                           throws LdapException

Helper method to build a list of files to backup, in the simple case where all files are located under the provided directory.

Parameters:

directory - The directory containing files to backup.

filter - The filter to select files to backup.

identifier - Identifier of the backed-up entity

Returns:

the files to backup, which may be empty but never null

Throws:

LdapException - if an error occurs.

saveCurrentFilesToDirectory

public static Path saveCurrentFilesToDirectory(Backupable backupable,
                                               String identifier)
                                        throws LdapException

Helper method to save all current files of the provided backupable entity, using default behavior.

Parameters:

backupable - The entity to backup.

identifier - Identifier of the backup

Returns:

the directory where all files are saved.

Throws:

LdapException - If a problem occurs.