Package org.infinispan.server.core.backup

Class BackupManagerImpl

java.lang.Object

org.infinispan.server.core.backup.BackupManagerImpl

All Implemented Interfaces:

BackupManager

public class BackupManagerImpl
extends Object
implements BackupManager

Since:

12.0

Author:

Ryan Emerson

Nested Class Summary

Nested classes/interfaces inherited from interface org.infinispan.server.core.BackupManager

BackupManager.Resources, BackupManager.Status

Constructor Summary

Constructors

Constructor	Description
BackupManagerImpl(BlockingManager blockingManager, DefaultCacheManager cm, Path dataRoot)

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.

Methods inherited from class java.lang.Object

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

Constructor Details

BackupManagerImpl

public BackupManagerImpl(BlockingManager blockingManager,
 DefaultCacheManager cm,
 Path dataRoot)

Method Details

init

public void init()
          throws IOException

Description copied from interface: BackupManager

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

Specified by:

init in interface BackupManager

Throws:

IOException

getBackupNames

public Set<String> getBackupNames()

Specified by:

getBackupNames in interface BackupManager

Returns:

the names of all backups.

getBackupStatus

public BackupManager.Status getBackupStatus(String name)

Description copied from interface: BackupManager

Return the current BackupManager.Status of a Backup request.

Specified by:

getBackupStatus in interface BackupManager

Parameters:

name - the name of the backup.

Returns:

the BackupManager.Status of the backup.

getBackupLocation

public Path getBackupLocation(String name)

Description copied from interface: BackupManager

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

Specified by:

getBackupLocation in interface BackupManager

Parameters:

name - the name of the backup.

Returns:

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

removeBackup

public CompletionStage<BackupManager.Status> removeBackup(String name)

Description copied from interface: BackupManager

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.

Specified by:

removeBackup in interface BackupManager

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

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

Description copied from interface: BackupManager

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

Specified by:

create in interface BackupManager

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

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

Description copied from interface: BackupManager

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

Specified by:

create in interface BackupManager

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.

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

Returns:

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

removeRestore

public CompletionStage<BackupManager.Status> removeRestore(String name)

Description copied from interface: BackupManager

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.

Specified by:

removeRestore in interface BackupManager

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

public BackupManager.Status getRestoreStatus(String name)

Description copied from interface: BackupManager

Return the current BackupManager.Status of a Restore request.

Specified by:

getRestoreStatus in interface BackupManager

Parameters:

name - a unique name to identify the restore request.

Returns:

the BackupManager.Status of the restore.

getRestoreNames

public Set<String> getRestoreNames()

Specified by:

getRestoreNames in interface BackupManager

Returns:

the names of all restores.

restore

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

Description copied from interface: BackupManager

Restore content from the provided backup file.

Specified by:

restore in interface BackupManager

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

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

Description copied from interface: BackupManager

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.

Specified by:

restore in interface BackupManager

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.