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

Interface PreconditionsValidatorService

All Known Implementing Classes:

DefaultPreconditionsValidatorService

public interface PreconditionsValidatorService

A preconditions validator for the tool main processes.

Method Summary

Modifier and Type	Method and Description
List<String>	checkBackupExistence(Path muleDistroLocation) Checks existence of any BackUp.
List<String>	checkRollbackPreconditions(Path muleDistroLocation) Checks that all preconditions for performing the rollback are met.
void	checkUpgradePreconditions(MuleDistribution oldMule, MuleDistribution newMule, boolean force) Checks that all preconditions for performing the upgrade are met.
List<String>	checkUpgradeStatusOffline(MuleDistribution oldMule) Checks upgrade pre-conditions for status command.
boolean	getConsentForOverwritingBackup(boolean force) Asks consent for overwriting the current BackUp.

Method Detail

checkUpgradePreconditions

void checkUpgradePreconditions(MuleDistribution oldMule,
                               MuleDistribution newMule,
                               boolean force)
                        throws IOException

Checks that all preconditions for performing the upgrade are met.

Parameters:

oldMule - MuleDistribution representing the old Mule Runtime distribution being upgraded.

newMule - MuleDistribution representing the new Mule Runtime distribution used for the upgrade.

force - whether explicit consent has been provided for the override related preconditions like the ones for the backup and applied patches.

Throws:

IllegalStateException - if validations are not met.

IOException - if an I/O error occurs.

checkRollbackPreconditions

List<String> checkRollbackPreconditions(Path muleDistroLocation)
                                 throws IOException

Checks that all preconditions for performing the rollback are met.

Parameters:

muleDistroLocation - location of the Mule Runtime distribution being validated for rollback process.

Throws:

IllegalStateException - if validations are not met.

IOException - if an I/O error occurs.

checkUpgradeStatusOffline

List<String> checkUpgradeStatusOffline(MuleDistribution oldMule)
                                throws IOException

Checks upgrade pre-conditions for status command.

Parameters:

oldMule - MuleDistribution representing the old Mule Runtime distribution being upgraded.

Throws:

IOException - if an I/O error occurs

getConsentForOverwritingBackup

boolean getConsentForOverwritingBackup(boolean force)
                                throws IOException

Asks consent for overwriting the current BackUp.

Parameters:

force - If force is true, will not ask to the user.

Returns:

User response.

Throws:

IOException - I/O Exception.

checkBackupExistence

List<String> checkBackupExistence(Path muleDistroLocation)
                           throws IOException

Checks existence of any BackUp.

Parameters:

muleDistroLocation - Mule path to looking for the BackUp.

Returns:

A list of Strings, if the list is empty, the BackUp exists, otherwise not exists.

Throws:

IOException - I/O Exception.