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

Interface ConfigFilesService

All Known Implementing Classes:

DefaultConfigFilesService

public interface ConfigFilesService

This service manages file descriptor's functionalities.

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 dryRun) 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	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.
Path	getResolvedConflictsFolder() Gets the folder where the config files to be used after the upgrade.
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.

Method Detail

checkConflicts

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

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 $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.

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

copyFinalConfigFiles

void copyFinalConfigFiles(Path oldMule,
                          boolean dryRun)
                   throws IOException

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

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.

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

Throws:

IOException

getResolvedConflictsFolder

Path getResolvedConflictsFolder()

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

Returns:

Path with the resolved conflicts folder

getSolveConflictsDocsPage

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.

Returns:

String with the complete docs page including the section.

Throws:

FileNotFoundException

getToReviewFolderInDistro

Path getToReviewFolderInDistro(Path muleHome)

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

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

getReadyFolderInDistro

Path getReadyFolderInDistro(Path muleHome)

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

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

getToReviewConfigFileDestination

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 .

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

getReadyConfigFileDestination

Path getReadyConfigFileDestination(Path muleHome,
                                   String configFilePath)

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

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