com.mulesoft.runtime.upgrade.tool.service

Class DefaultPreconditionsValidatorService

java.lang.Object

com.mulesoft.runtime.upgrade.tool.service.DefaultPreconditionsValidatorService

All Implemented Interfaces:

PreconditionsValidatorService

@Service
public class DefaultPreconditionsValidatorService
extends Object
implements PreconditionsValidatorService

A preconditions validator for the tool's main processes.

Constructor Summary

Constructors

Constructor and Description
DefaultPreconditionsValidatorService()

Method Summary

Modifier and Type	Method and Description
List<String>	checkBackupExistence(Path muleDistroLocation) Checks existence of any BackUp.
List<String>	checkRollbackPreconditions(Path muleDistroLocation) Checks rollback pre-conditions for status command.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPreconditionsValidatorService

public DefaultPreconditionsValidatorService()

Method Detail

checkUpgradePreconditions

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

Checks that all preconditions for performing the upgrade are met.

Preconditions are:

• Distribution marked as new is, in fact, a newer version of the distribution being upgraded.
• Process has writing permissions under the old Mule distribution location.
• Process has reading permissions under the new Mule distribution location.
• Enough space is available in the file system for the upgrade.
• Old Mule Distribution is stopped.
• Consent for overriding backup has been provided, if any.
• Consent for removing applied patches has been provided, if any.

Specified by:

checkUpgradePreconditions in interface PreconditionsValidatorService

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

checkUpgradeStatusOffline

public List<String> checkUpgradeStatusOffline(MuleDistribution oldMule)
                                       throws IOException

Checks upgrade pre-conditions for status command.

Specified by:

checkUpgradeStatusOffline in interface PreconditionsValidatorService

Parameters:

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

Throws:

IOException - if an I/O error occurs

checkRollbackPreconditions

public List<String> checkRollbackPreconditions(Path muleDistroLocation)
                                        throws IOException

Checks rollback pre-conditions for status command.

Specified by:

checkRollbackPreconditions in interface PreconditionsValidatorService

Parameters:

muleDistroLocation - MuleDistribution representing the current Mule Runtime distribution location.

Throws:

IOException - if an I/O error occurs

getConsentForOverwritingBackup

public boolean getConsentForOverwritingBackup(boolean force)
                                       throws IOException

Asks consent for overwriting the current BackUp.

Specified by:

getConsentForOverwritingBackup in interface PreconditionsValidatorService

Parameters:

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

Returns:

User response.

Throws:

IOException - I/O Exception.

checkBackupExistence

public List<String> checkBackupExistence(Path muleDistroLocation)
                                  throws IOException

Checks existence of any BackUp.

Specified by:

checkBackupExistence in interface PreconditionsValidatorService

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.