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

Interface MuleDistroService

All Known Implementing Classes:

DefaultMuleDistroService

public interface MuleDistroService

A service for MuleDistribution operations.

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 distributions involve in the upgrade process and inside the tool.
boolean	checkMisleadingMuleDirName(Path mulePath) 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.
void	looksLikeADistro(Path muleDistroLocation) Introspects the given directory to determine if it looks like a Mule Runtime distribution.

Method Detail

initMuleDistro

MuleDistribution initMuleDistro(Path muleHome)
                         throws IOException

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

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

void looksLikeADistro(Path muleDistroLocation)
               throws IOException

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

Parameters:

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

Throws:

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

detectMuleVersion

String detectMuleVersion(Path muleHome)
                  throws FileNotFoundException

Detects Mule Runtime Distribution version.

Parameters:

muleHome - Mule Runtime Distribution path.

Returns:

Mule Runtime Distribution version.

Throws:

FileNotFoundException - if muleHome path is not found.

checkClusterModeIsActive

boolean checkClusterModeIsActive(Path currentMuleDistroPropertiesFilePath)
                          throws IOException

Checks if current mule distro is working on cluster mode.

Parameters:

currentMuleDistroPropertiesFilePath - Current mule distro path.

Returns:

Throws:

IOException - I/O Exception.

checkFilesDescriptorsExistencesInsideBothDistributions

boolean checkFilesDescriptorsExistencesInsideBothDistributions(Path oldMulePath,
                                                               Path newMulePath)
                                                        throws IOException

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

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

Path getLibMuleJarDirectoryPath()

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.

Returns:

a relative $Path to the lib/mule folder

getConfigFolder

Path getConfigFolder()

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.

Returns:

a relative $Path to the conf folder

checkMisleadingMuleDirName

boolean checkMisleadingMuleDirName(Path mulePath)

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

Parameters:

mulePath - A mule distro path.

Returns:

A boolean