Package org.infinispan.server.core

Interface BackupManager

All Known Implementing Classes:

BackupManagerImpl

public interface BackupManager

Handles all tasks related to the creation/restoration of server backups.

Since:

12.0

Author:

Ryan Emerson

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BackupManager.Resources	An interface to encapsulate the various arguments required by the BackupManager in order to include/exclude resources from a backup/restore operation.
static enum	BackupManager.Status	An enum representing the current state of a Backup operation.

Method Summary

Modifier and Type	Method	Description
CompletionStage<Path>	create(String name, Path workingDir)	Create a backup of all containers configured on the server, including all available resources.
CompletionStage<Path>	create(String name, Path workingDir, Map<String,BackupManager.Resources> params)	Create a backup of the specified containers, including the resources defined in the provided BackupManager.Resources object.
Path	getBackupLocation(String name)	Returns the Path of a backup file if it is complete.
Set<String>	getBackupNames()
BackupManager.Status	getBackupStatus(String name)	Return the current BackupManager.Status of a Backup request.
Set<String>	getRestoreNames()
BackupManager.Status	getRestoreStatus(String name)	Return the current BackupManager.Status of a Restore request.
void	init()	Performs initialisation of all resources required by the implementation before backup files can be created or restored.
CompletionStage<BackupManager.Status>	removeBackup(String name)	Remove the created backup file from the server.
CompletionStage<BackupManager.Status>	removeRestore(String name)	Remove the meta information associated with a restoration.
CompletionStage<Void>	restore(String name, Path backup)	Restore content from the provided backup file.
CompletionStage<Void>	restore(String name, Path backup, Map<String,BackupManager.Resources> params)	Restore content from the provided backup file.

Method Details

init

void init()
   throws IOException

Performs initialisation of all resources required by the implementation before backup files can be created or restored.

Throws:

IOException

getBackupNames

Set<String> getBackupNames()

Returns:

the names of all backups.

getBackupStatus

BackupManager.Status getBackupStatus(String name)

Return the current BackupManager.Status of a Backup request.

Parameters:

name - the name of the backup.

Returns:

the BackupManager.Status of the backup.

getBackupLocation

Path getBackupLocation(String name)

Returns the Path of a backup file if it is complete.

Parameters:

name - the name of the backup.

Returns:

the Path of the created backup file if BackupManager.Status.COMPLETE, otherwise null.

removeBackup

CompletionStage<BackupManager.Status> removeBackup(String name)

Remove the created backup file from the server. When it's possible to remove a backup file immediately, then a BackupManager.Status.COMPLETE is returned. However, if a backup operation is currently in progress, then the removal is attempted once the backup has completed and BackupManager.Status.IN_PROGRESS is returned. Finally, BackupManager.Status.NOT_FOUND is returned if no backup exists with the specified name.

Parameters:

name - the name of the backup.

Returns:

a CompletionStage that returns a BackupManager.Status when complete to indicate what course of action was taken.

create

CompletionStage<Path> create(String name,
 Path workingDir)

Create a backup of all containers configured on the server, including all available resources.

Parameters:

name - the name of the backup.

workingDir - a path used as the working directory for creating the backup contents and storing the final backup. If null, then the default location is used.

Returns:

a CompletionStage that on completion returns the Path to the backup file that will be created.

create

CompletionStage<Path> create(String name,
 Path workingDir,
 Map<String,BackupManager.Resources> params)

Create a backup of the specified containers, including the resources defined in the provided BackupManager.Resources object.

Parameters:

name - the name of the backup.

params - a map of container names and an associated BackupManager.Resources instance.

workingDir - a path used as the working directory for creating the backup contents and storing the final * backup. If null, then the default location is used.

Returns:

a CompletionStage that on completion returns the Path to the backup file that will be created.

restore

CompletionStage<Void> restore(String name,
 Path backup)

Restore content from the provided backup file.

Parameters:

name - a unique name to identify the restore process

backup - a path to the backup file to be restored.

Returns:

a CompletionStage that completes when all of the entries in the backup have been restored.

restore

CompletionStage<Void> restore(String name,
 Path backup,
 Map<String,BackupManager.Resources> params)

Restore content from the provided backup file. The keyset of the provided Map determines which containers are restored from the backup file. Similarly, the BackupManager.Resources object determines which BackupManager.Resources.Types are restored.

Parameters:

name - a unique name to identify the restore request.

backup - a path to the backup file to be restored.

Returns:

a CompletionStage that completes when all of the entries in the backup have been restored.

removeRestore

CompletionStage<BackupManager.Status> removeRestore(String name)

Remove the meta information associated with a restoration. When a restoration is not currently in progress, then a BackupManager.Status.COMPLETE is returned. However, if a restore operation is currently in progress, then the removal is attempted once the restore has completed and BackupManager.Status.IN_PROGRESS is returned. Finally, BackupManager.Status.NOT_FOUND is returned if no restore exists with the specified name.

Parameters:

name - a unique name to identify the restore request.

Returns:

a CompletionStage that returns a BackupManager.Status when complete to indicate what course of action was taken.

getRestoreStatus

BackupManager.Status getRestoreStatus(String name)

Return the current BackupManager.Status of a Restore request.

Parameters:

name - a unique name to identify the restore request.

Returns:

the BackupManager.Status of the restore.

getRestoreNames

Set<String> getRestoreNames()

Returns:

the names of all restores.