com.mulesoft.runtime.upgrade.tool.service

Class DefaultConfigFilesService

java.lang.Object

com.mulesoft.runtime.upgrade.tool.service.DefaultConfigFilesService

All Implemented Interfaces:

ConfigFilesService

@Service
public class DefaultConfigFilesService
extends Object
implements ConfigFilesService

This service manages file descriptor's functionalities.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LIC_MULE_FILE
static String	ORIGINAL_FILES_NEW_DISTRO_FOLDER
static String	READY_FOLDER_NAME
static String	TO_REVIEW_FOLDER_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultConfigFilesService()

Method Summary

Modifier and Type	Method and Description
boolean	checkConflicts(Path oldMule, Path newMule, boolean isDryRunMode) This method runs as a precondition of the upgrade command.
void	copyFinalConfigFiles(Path oldMule, boolean isDryRunMode) Copy the config files from the resolved config files folder "ready" to the ${MULE_HOME}/conf during the upgrade command after no conflicts were found
Path	getConfConfigFileDestination(Path muleHome, String configFilePath)
Path	getConfFolderInDistro(Path muleHome)
Path	getReadyConfigFileDestination(Path muleHome, String configFilePath) Extracts the filename of the configFilePath passed as argument and resolves the destination path inside the "ready" folder.
Path	getReadyFolderInDistro(Path muleHome) Gets the corresponding path of the "ready" folder inside the distribution.
String	getReadyFolderName()
Path	getResolvedConflictsFolder() Gets the folder where the config files to be used after the upgrade.
Path	getResolvedConflictsFolderInDistro(Path muleHome)
String	getSolveConflictsDocsPage() Gets the documentation page section explaining in detail how to resolve the config files conflicts to be used in the ERROR messages logs.
Path	getToReviewConfigFileDestination(Path muleHome, String configFilePath) Extracts the filename of the configFilePath passed as argument and resolves the destination path inside the "to_review" folder .
Path	getToReviewFolderInDistro(Path muleHome) Gets the corresponding path of the "to_review" folder inside the distribution.
String	getToReviewFolderName()

Methods inherited from class java.lang.Object

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

Field Detail

TO_REVIEW_FOLDER_NAME

public static final String TO_REVIEW_FOLDER_NAME

See Also:

Constant Field Values

READY_FOLDER_NAME

public static final String READY_FOLDER_NAME

See Also:

Constant Field Values

ORIGINAL_FILES_NEW_DISTRO_FOLDER

public static final String ORIGINAL_FILES_NEW_DISTRO_FOLDER

See Also:

Constant Field Values

LIC_MULE_FILE

public static final String LIC_MULE_FILE

See Also:

Constant Field Values

Constructor Detail

DefaultConfigFilesService

public DefaultConfigFilesService()

Method Detail

getResolvedConflictsFolder

public Path getResolvedConflictsFolder()

Description copied from interface: ConfigFilesService

Gets the folder where the config files to be used after the upgrade. Also in this folder are placed the aux original old and new config files to be used to detect the new changes. This folder is deleted after the upgrade command finishes successfully

Specified by:

getResolvedConflictsFolder in interface ConfigFilesService

Returns:

Path with the resolved conflicts folder

getSolveConflictsDocsPage

public String getSolveConflictsDocsPage()

Description copied from interface: ConfigFilesService

Gets the documentation page section explaining in detail how to resolve the config files conflicts to be used in the ERROR messages logs.

Specified by:

getSolveConflictsDocsPage in interface ConfigFilesService

Returns:

String with the complete docs page including the section.

getResolvedConflictsFolderInDistro

public Path getResolvedConflictsFolderInDistro(Path muleHome)

checkConflicts

public boolean checkConflicts(Path oldMule,
                              Path newMule,
                              boolean isDryRunMode)
                       throws IOException

Description copied from interface: ConfigFilesService

This method runs as a precondition of the upgrade command. It gets the config files in the original old and new distribution and compares each config file hash value to detect if any have changes in the new distro. If there are config files that have conflicts the precondition fail and those files are copied from the '${MULE_HOME}/conf' to the "to_review" conflict folder so the user can resolve them. The config files that don't have conflicts are copied from the '${MULE_HOME}/conf' to the "ready" conflict folder. After the user has resolved all the conflicts and moved them to the "ready" folder and runs the upgrade command again the config files present in the "ready" resolved conflict folder are going to be copied to the new distro copied in the method $ConfigFilesService.copyFinalConfigFiles(Path, boolean) Finally, the new config files are copied too in the "new" aux folder so the user can detect the new changes in an easy way.

Specified by:

checkConflicts in interface ConfigFilesService

Parameters:

oldMule - The Mule Runtime Distribution path of the old distro.

newMule - The Mule Runtime Distribution path of the new distro.

isDryRunMode - Flag which in case is in true it avoids copying the config files and deleting the resolved conflicts folder

Returns:

a boolean with true in case there are config files with conflicts or false otherwise

Throws:

IOException

getToReviewFolderName

public String getToReviewFolderName()

getReadyFolderName

public String getReadyFolderName()

getToReviewFolderInDistro

public Path getToReviewFolderInDistro(Path muleHome)

Description copied from interface: ConfigFilesService

Gets the corresponding path of the "to_review" folder inside the distribution. In this folder are placed the config files with conflicts

Specified by:

getToReviewFolderInDistro in interface ConfigFilesService

Parameters:

muleHome - Path of the mule distribution inside the 'to_review' path is going to be resolved

Returns:

Path with the 'to_review' conflicts folder resolved inside the muleHome

getToReviewConfigFileDestination

public Path getToReviewConfigFileDestination(Path muleHome,
                                             String configFilePath)

Description copied from interface: ConfigFilesService

Extracts the filename of the configFilePath passed as argument and resolves the destination path inside the "to_review" folder .

Specified by:

getToReviewConfigFileDestination in interface ConfigFilesService

Parameters:

muleHome - Path of the mule distribution against the 'to_review' path is going to be resolved

configFilePath - Path of the config file to extract its filename

Returns:

Config file path inside the "to_review" folder

getReadyFolderInDistro

public Path getReadyFolderInDistro(Path muleHome)

Description copied from interface: ConfigFilesService

Gets the corresponding path of the "ready" folder inside the distribution. In this folder are placed the config files without conflicts and the ones moved by the user from the "to_review" folder after resolving the conflicts

Specified by:

getReadyFolderInDistro in interface ConfigFilesService

Parameters:

muleHome - Path of the mule distribution inside the 'ready' path is going to be resolved

Returns:

Path with the 'ready' conflicts folder resolved inside the muleHome

getReadyConfigFileDestination

public Path getReadyConfigFileDestination(Path muleHome,
                                          String configFilePath)

Description copied from interface: ConfigFilesService

Extracts the filename of the configFilePath passed as argument and resolves the destination path inside the "ready" folder.

Specified by:

getReadyConfigFileDestination in interface ConfigFilesService

Parameters:

muleHome - Path of the mule distribution against the 'ready' path is going to be resolved

configFilePath - Path of the config file to extract its filename

Returns:

Config file path inside the "ready" folder

getConfFolderInDistro

public Path getConfFolderInDistro(Path muleHome)

getConfConfigFileDestination

public Path getConfConfigFileDestination(Path muleHome,
                                         String configFilePath)

copyFinalConfigFiles

public void copyFinalConfigFiles(Path oldMule,
                                 boolean isDryRunMode)
                          throws IOException

Description copied from interface: ConfigFilesService

Copy the config files from the resolved config files folder "ready" to the ${MULE_HOME}/conf during the upgrade command after no conflicts were found

Specified by:

copyFinalConfigFiles in interface ConfigFilesService

Parameters:

oldMule - The Mule Runtime Distribution path where the resolved config files folder is present to copy the config files from there during the upgrade.

isDryRunMode - Flag which in case is in true it avoids copying the config files and deleting the resolved conflicts folder

Throws:

IOException