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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_FILES_CONFLICTS_WERE_FOUND_PREFIX
static String	NOT_ALL_PRECONDITIONS_WERE_MET_PREFIX
static String	ROLLBACK_EXCEPTION_MESSAGE_NOT_ALL_PRECONDITIONS_WERE_MET
static String	UNSUPPORTED_MULE_VERSION_FOR_UPGRADE_MESSAGE
static String	UPGRADE_EXCEPTION_MESSAGE_NOT_ALL_PRECONDITIONS_WERE_MET
static String	UPGRADE_EXCEPTION_MESSAGE_USER_DISAGREE

Constructor Summary

Constructors

Constructor and Description
DefaultPreconditionsValidatorService()

Method Summary

Modifier and Type	Method and Description
boolean	checkBackupExistence(Path muleDistroLocation) Checks existence of any BackUp.
boolean	checkBackupIntegrity(Path muleDistroLocation)
List<String>	checkBackupIntegrityAndGetErrorMessage(Path muleDistroLocation)
boolean	checkMuleUpgradeIsSupported(SemVer currentMule, SemVer newMule) Verify if the version of the current mule is supported for an upgrade.
void	checkRollbackReadiness(Path muleDistroLocation) Checks that all preconditions for performing the rollback are met.
void	checkUpgradeReadiness(MuleDistribution oldMule, MuleDistribution newMule, boolean force, boolean isDryRun) Checks that all preconditions for performing the upgrade are met.
List<String>	getBackupIntegrityErrorMessages(Path muleDistroLocation)
boolean	getConsentForOverwritingBackup(Path distroLocation, 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

Field Detail

NOT_ALL_PRECONDITIONS_WERE_MET_PREFIX

public static final String NOT_ALL_PRECONDITIONS_WERE_MET_PREFIX

See Also:

Constant Field Values

UPGRADE_EXCEPTION_MESSAGE_NOT_ALL_PRECONDITIONS_WERE_MET

public static final String UPGRADE_EXCEPTION_MESSAGE_NOT_ALL_PRECONDITIONS_WERE_MET

See Also:

Constant Field Values

ROLLBACK_EXCEPTION_MESSAGE_NOT_ALL_PRECONDITIONS_WERE_MET

public static final String ROLLBACK_EXCEPTION_MESSAGE_NOT_ALL_PRECONDITIONS_WERE_MET

See Also:

Constant Field Values

CONFIG_FILES_CONFLICTS_WERE_FOUND_PREFIX

public static final String CONFIG_FILES_CONFLICTS_WERE_FOUND_PREFIX

See Also:

Constant Field Values

UPGRADE_EXCEPTION_MESSAGE_USER_DISAGREE

public static final String UPGRADE_EXCEPTION_MESSAGE_USER_DISAGREE

See Also:

Constant Field Values

UNSUPPORTED_MULE_VERSION_FOR_UPGRADE_MESSAGE

public static final String UNSUPPORTED_MULE_VERSION_FOR_UPGRADE_MESSAGE

See Also:

Constant Field Values

Constructor Detail

DefaultPreconditionsValidatorService

public DefaultPreconditionsValidatorService()

Method Detail

checkUpgradeReadiness

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

Checks that all preconditions for performing the upgrade are met.

Preconditions are:

• Check valid versions for an upgrade
• 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:

checkUpgradeReadiness 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

checkRollbackReadiness

public void checkRollbackReadiness(Path muleDistroLocation)
                            throws IOException

Checks that all preconditions for performing the rollback are met.

Preconditions are:

• The existence of a backup
• Process has writing permissions under the old Mule distribution location.
• Mule Distribution is stopped.

Specified by:

checkRollbackReadiness in interface PreconditionsValidatorService

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.

getConsentForOverwritingBackup

public boolean getConsentForOverwritingBackup(Path distroLocation,
                                              boolean force)
                                       throws IOException

Asks consent for overwriting the current BackUp.

Specified by:

getConsentForOverwritingBackup in interface PreconditionsValidatorService

Parameters:

distroLocation - Mule Runtime Distribution Path.

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

Returns:

Yes if user answered yes or is running in force mode, No in other case.

Throws:

IOException

checkBackupExistence

public boolean 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.

checkBackupIntegrityAndGetErrorMessage

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

Throws:

IOException

getBackupIntegrityErrorMessages

public List<String> getBackupIntegrityErrorMessages(Path muleDistroLocation)

checkBackupIntegrity

public boolean checkBackupIntegrity(Path muleDistroLocation)
                             throws IOException

Throws:

IOException

checkMuleUpgradeIsSupported

public boolean checkMuleUpgradeIsSupported(SemVer currentMule,
                                           SemVer newMule)

Verify if the version of the current mule is supported for an upgrade.

Parameters:

currentMule - MuleDistribution representing the old Mule Runtime distribution being upgraded

Returns:

True if version is supported, False otherwise.