com.mulesoft.runtime.upgrade.tool.service.api

Interface BackupService

All Known Implementing Classes:

DefaultBackupService

public interface BackupService

A service for backup related operations.

Method Summary

Modifier and Type	Method and Description
boolean	checkIntegrity(Path muleDistributionHome) Checks the integrity of a backup checking the backup descriptor entries match with the current files in the backup folder
void	create(MuleDistribution muleDistribution, boolean force, boolean isDryRunMode) Creates a backup copy of the given file paths within the Mule distribution directory that will be undergoing the upgrade.
Path	getBackupDestDir(Path muleDistroHome) Gets the back destination dir where the backup files are going to be placed
void	printBackUpDescriptor(Optional<BackupDescriptor> backupDescriptor) Prints a BackUp Descriptor with a pretty format .
Optional<BackupDescriptor>	readBackupDescriptor(Path muleDistribution) Retrieves the backup creation metadata stored in the YAML file within the backup directory location if any has been previously generated as part of an upgrade process.

Method Detail

readBackupDescriptor

Optional<BackupDescriptor> readBackupDescriptor(Path muleDistribution)
                                         throws IOException

Retrieves the backup creation metadata stored in the YAML file within the backup directory location if any has been previously generated as part of an upgrade process.

Parameters:

muleDistribution - location of the Mule distribution where backup could reside.

Returns:

a Optional of a BackupDescriptor.

Throws:

IOException - In case of any I/O related error while reading the info from the metadata file.

create

void create(MuleDistribution muleDistribution,
            boolean force,
            boolean isDryRunMode)
     throws IOException

Creates a backup copy of the given file paths within the Mule distribution directory that will be undergoing the upgrade. Backup creation metadata is stored in a YAML file which is created within the backup directory. The purpose of creating this backup is to be later used in an upgrade rollback operation if needed.

Parameters:

muleDistribution - a MuleDistribution representing the Mule distro where the backup will be taken from.

isDryRunMode - if isDryRunMode is true, the method logs in debug level the files and directories that would be copied without actually copying them.

Throws:

IOException - In case of any I/O related error while creating the backup.

printBackUpDescriptor

void printBackUpDescriptor(Optional<BackupDescriptor> backupDescriptor)

Prints a BackUp Descriptor with a pretty format .

Parameters:

backupDescriptor - BackUp Descriptor selected.

checkIntegrity

boolean checkIntegrity(Path muleDistributionHome)
                throws IOException

Checks the integrity of a backup checking the backup descriptor entries match with the current files in the backup folder

Parameters:

muleDistributionHome - location of the Mule distribution where backup could reside.

Throws:

IOException - In case of any I/O related error while creating the backup.

getBackupDestDir

Path getBackupDestDir(Path muleDistroHome)

Gets the back destination dir where the backup files are going to be placed

Parameters:

muleDistroHome - Path with the mule distribution where is going to be resolved the backup folder path

Returns:

Path of the backup folder resolved inside the mule distro passed