com.mulesoft.runtime.upgrade.tool.service

Class DefaultMuleDistroService

java.lang.Object

com.mulesoft.runtime.upgrade.tool.service.DefaultMuleDistroService

All Implemented Interfaces:

MuleDistroService

@Service
public class DefaultMuleDistroService
extends Object
implements MuleDistroService

A service for MuleDistribution operations.

Field Summary

Fields

Modifier and Type	Field and Description
static Path	CONFIG_FOLDER
static Path	LIB_MULE_JAR_DIRECTORY_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultMuleDistroService()

Method Summary

Modifier and Type	Method and Description
boolean	checkClusterModeIsActive(Path currentMuleDistroPropertiesFilePath) Checks if current mule distro is working on cluster mode.
boolean	checkFilesDescriptorsExistencesInsideBothDistributions(Path oldMulePath, Path newMulePath) Checks File Descriptor existence inside all mule distros involve in upgrade process and inside the tool.
boolean	checkMisleadingMuleDirName(Path currentMule) Check if the name of the Mule directory is misleading regarding its content
String	detectMuleVersion(Path muleHome) Detects Mule Runtime Distribution version.
Path	getConfigFolder() Gets a relative path to the conf dir where the Mule Runtime distro configs files are placed.
Path	getLibMuleJarDirectoryPath() Gets a relative path to the lib/mule dir where the mule jars are placed.
MuleDistribution	initMuleDistro(Path muleHome) Initializes a MuleDistribution object after validating that the given file path corresponds to a Mule Runtime distribution.
boolean	isClusterModeActive(File propertiesFile, String currentMuleDistroPropertiesFile) Checks if a clusterId exists in Mule distribution configuration.
void	looksLikeADistro(Path muleDistroLocation) Introspects the given directory to determine if it looks like a Mule Runtime distribution.

Methods inherited from class java.lang.Object

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

Field Detail

LIB_MULE_JAR_DIRECTORY_PATH

public static final Path LIB_MULE_JAR_DIRECTORY_PATH

CONFIG_FOLDER

public static final Path CONFIG_FOLDER

Constructor Detail

DefaultMuleDistroService

public DefaultMuleDistroService()

Method Detail

initMuleDistro

public MuleDistribution initMuleDistro(Path muleHome)
                                throws IOException

Initializes a MuleDistribution object after validating that the given file path corresponds to a Mule Runtime distribution.

Specified by:

initMuleDistro in interface MuleDistroService

Parameters:

muleHome - a path pointing to a Mule Runtime distribution.

Returns:

a MuleDistribution instance.

Throws:

NotDirectoryException - if given muleHome path is not a directory.

FileNotFoundException - if mule-core jar used for determining the Mule distro version is not found.

IOException

looksLikeADistro

public void looksLikeADistro(Path muleDistroLocation)
                      throws IOException

Introspects the given directory to determine if it looks like a Mule Runtime distribution.

Specified by:

looksLikeADistro in interface MuleDistroService

Parameters:

muleDistroLocation - a path pointing to a potential Mule Runtime distribution.

Throws:

IOException - if given muleHome path does not look like a distro.

checkClusterModeIsActive

public boolean checkClusterModeIsActive(Path currentMuleDistroPropertiesFilePath)
                                 throws IOException

Checks if current mule distro is working on cluster mode.

Specified by:

checkClusterModeIsActive in interface MuleDistroService

Parameters:

currentMuleDistroPropertiesFilePath - Current mule distro path.

Returns:

Throws:

IOException - I/O Exception.

isClusterModeActive

public boolean isClusterModeActive(File propertiesFile,
                                   String currentMuleDistroPropertiesFile)
                            throws IOException

Checks if a clusterId exists in Mule distribution configuration.

Parameters:

propertiesFile - a cluster properties file.

currentMuleDistroPropertiesFile - a path to the cluster properties file.

Returns:

true if cluster mode is active, false otherwise

Throws:

IOException

detectMuleVersion

public String detectMuleVersion(Path muleHome)
                         throws FileNotFoundException

Detects Mule Runtime Distribution version.

Specified by:

detectMuleVersion in interface MuleDistroService

Parameters:

muleHome - Mule Runtime Distribution path.

Returns:

Mule Runtime Distribution version.

Throws:

FileNotFoundException - if muleHome path is not found.

checkFilesDescriptorsExistencesInsideBothDistributions

public boolean checkFilesDescriptorsExistencesInsideBothDistributions(Path oldMulePath,
                                                                      Path newMulePath)
                                                               throws IOException

Checks File Descriptor existence inside all mule distros involve in upgrade process and inside the tool.

Specified by:

checkFilesDescriptorsExistencesInsideBothDistributions in interface MuleDistroService

Parameters:

oldMulePath - Current Mule Runtime Distribution path.

newMulePath - New Mule Runtime Distribution path.

Returns:

True if exist in both distros, false if doesn't exist in one of the distros.

Throws:

FileNotFoundException

IOException

getLibMuleJarDirectoryPath

public Path getLibMuleJarDirectoryPath()

Description copied from interface: MuleDistroService

Gets a relative path to the lib/mule dir where the mule jars are placed. The mule-assembly-content-descriptor-.jar and mule-configs-files-.jar are placed inside this folder.

Specified by:

getLibMuleJarDirectoryPath in interface MuleDistroService

Returns:

a relative $Path to the lib/mule folder

getConfigFolder

public Path getConfigFolder()

Description copied from interface: MuleDistroService

Gets a relative path to the conf dir where the Mule Runtime distro configs files are placed. The config files which are checked if there are changes in the new distro in method $ConfigFilesService.checkConflicts(Path, Path, boolean) are placed inside this folder.

Specified by:

getConfigFolder in interface MuleDistroService

Returns:

a relative $Path to the conf folder

checkMisleadingMuleDirName

public boolean checkMisleadingMuleDirName(Path currentMule)

Check if the name of the Mule directory is misleading regarding its content

Specified by:

checkMisleadingMuleDirName in interface MuleDistroService

Parameters:

currentMule - Mule Runtime Distribution path.

Returns:

A boolean