com.mulesoft.runtime.upgrade.tool.service

Class DefaultFileSystemService

java.lang.Object

com.mulesoft.runtime.upgrade.tool.service.DefaultFileSystemService

All Implemented Interfaces:

FileSystemService

@Service
public class DefaultFileSystemService
extends Object
implements FileSystemService

A service for file system operations required for the upgrade or backup.

Field Summary

Fields

Modifier and Type	Field and Description
static double	REQUIRED_DISK_SPACE_SLACK_MULTIPLIER

Constructor Summary

Constructors

Constructor and Description
DefaultFileSystemService()

Method Summary

Modifier and Type	Method and Description
boolean	areHashesBetweenFilesEqual(byte[] fileContentA, byte[] fileContentB)
boolean	areHashesBetweenFilesEqual(Path fileA, Path fileB)
void	checkEnoughUsableSpace(Path oldMule, Path newMule, List<Path> paths) Validates whether there is potentially enough writable space on the file system for the upgrade.
void	checkIsADirectory(Path path) Checks whether a given path corresponds to a directory.
void	checkReadingAccess(Path parentPath, List<Path> relativePaths) Checks whether the JVM has reading access to all file trees determined by the given relative paths when resolved against the given parent path.
void	checkWritingAccess(Path parentPath, List<Path> relativePaths) Checks whether the JVM has writing access to all file trees determined by the given relative paths when resolved against the given parent path.
void	copyFile(File source, File dest, boolean isDryRunMode) Copy the file from the given source file to the destination file.
void	copyFiles(Path srcDir, Path destDir, List<Path> includedPathsArg, List<Path> excludedPathsArg, boolean isDryRunMode) Recursively copy all the files and directories determined by the given relative includedPaths from the given source directory to the given destination directory.
void	copyFilesInsideADistro(Path sourceMuleDistroPath, Path destMuleDistroPath, List<String> fileNamesList, boolean isDryRunMode) Copies a list of files from a Mule Runtime Distribution to another.
void	deleteFilesInsideADistro(Path distroPath, List<String> fileNamesList, boolean isDryRunMode) Deletes a list of files from a Mule Runtime Distribution.
void	deleteUpgradeFolderIfEmpty(Path muleHome, boolean dryRun) Deletes the upgrade-tool folder inside a distro if the folder is empty to try to clean the environment after an upgrade or a backup
String	getSha256(byte[] content)
String	getSha256(InputStream stream)
String	getSha256(Path filePath)
boolean	isWindowsOs() Checks whether the underlying OS is Windows.

Methods inherited from class java.lang.Object

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

Field Detail

REQUIRED_DISK_SPACE_SLACK_MULTIPLIER

public static final double REQUIRED_DISK_SPACE_SLACK_MULTIPLIER

See Also:

Constant Field Values

Constructor Detail

DefaultFileSystemService

public DefaultFileSystemService()

Method Detail

checkIsADirectory

public void checkIsADirectory(Path path)
                       throws NotDirectoryException

Checks whether a given path corresponds to a directory.

Specified by:

checkIsADirectory in interface FileSystemService

Parameters:

path - the path to an expected directory.

Throws:

NotDirectoryException - if given path is not a directory.

checkWritingAccess

public void checkWritingAccess(Path parentPath,
                               List<Path> relativePaths)
                        throws IOException

Checks whether the JVM has writing access to all file trees determined by the given relative paths when resolved against the given parent path.

Specified by:

checkWritingAccess in interface FileSystemService

Parameters:

parentPath - the parent path which is used for resolving the relative paths.

relativePaths - list of all paths whose underlying tree will be validated for writing access.

Throws:

AccessDeniedException - if any path does not have writing accessibility.

IOException - if any I/O error occurs.

checkReadingAccess

public void checkReadingAccess(Path parentPath,
                               List<Path> relativePaths)
                        throws IOException

Checks whether the JVM has reading access to all file trees determined by the given relative paths when resolved against the given parent path.

Specified by:

checkReadingAccess in interface FileSystemService

Parameters:

parentPath - the parent path which is used for resolving the relative paths.

relativePaths - list of all paths whose underlying tree will be validated for reading access.

Throws:

AccessDeniedException - if any path does not have reading accessibility.

IOException - if any I/O error occurs.

checkEnoughUsableSpace

public void checkEnoughUsableSpace(Path oldMule,
                                   Path newMule,
                                   List<Path> paths)
                            throws IOException

Validates whether there is potentially enough writable space on the file system for the upgrade. The required space is determined either by the space required for the backup creation or the copy of the new files; whoever is the biggest rules. This validation does not guarantee that the process might not fail for lack of space since the conditions on the underlying file system could change in the glimpse of an eye.

Specified by:

checkEnoughUsableSpace in interface FileSystemService

Parameters:

oldMule - the directory where the old Mule distro is located.

newMule - the directory where the new Mule distro is located.

paths - the relative paths of files involved in the upgrade process.

Throws:

{@link - IOException} In case of not finding enough usable space.

IOException

isWindowsOs

public boolean isWindowsOs()

Checks whether the underlying OS is Windows.

Specified by:

isWindowsOs in interface FileSystemService

Returns:

true if this is Windows.

copyFiles

public void copyFiles(Path srcDir,
                      Path destDir,
                      List<Path> includedPathsArg,
                      List<Path> excludedPathsArg,
                      boolean isDryRunMode)
               throws IOException

Recursively copy all the files and directories determined by the given relative includedPaths from the given source directory to the given destination directory. If files to be copied already exist on the destination, then they are deleted prior to its copy.

Specified by:

copyFiles in interface FileSystemService

Parameters:

srcDir - the directory where the files will be copied from.

destDir - the directory where the files will be copied to.

includedPathsArg - the relative includedPaths that will be resolved against the source dir for copying them to the destination directory. In case it is empty all the paths inside the srcDir are going to be copied.

excludedPathsArg - the relative excluded includedPaths that will be resolved against the source dir for avoid copying them to the destination directory. In case it is empty no paths from the srdDir will be excluded.

isDryRunMode - if isDryRunMode is true, the method logs in debug level the files and directories that would be copied without actually copying them.

Throws:

IOException - if any I/O error occurs.

copyFile

public void copyFile(File source,
                     File dest,
                     boolean isDryRunMode)
              throws IOException

Description copied from interface: FileSystemService

Copy the file from the given source file to the destination file. If file to be copied already exists the on destination, then it is deleted prior to its copy.

Specified by:

copyFile in interface FileSystemService

Parameters:

source - the source file.

dest - the destination file where it will be copied to.

isDryRunMode - if isDryRunMode is true, the method logs in trace level the files and directories that would be copied without actually copying them.

Throws:

IOException - if any I/O error occurs.

deleteFilesInsideADistro

public void deleteFilesInsideADistro(Path distroPath,
                                     List<String> fileNamesList,
                                     boolean isDryRunMode)
                              throws IOException

Deletes a list of files from a Mule Runtime Distribution.

Specified by:

deleteFilesInsideADistro in interface FileSystemService

Parameters:

distroPath - Current Mule Runtime Distribution.

fileNamesList - List of files names.

isDryRunMode - Dry Run Mode flag.

Throws:

IOException - if an I/O exception error occurs different that a file not found exception.

copyFilesInsideADistro

public void copyFilesInsideADistro(Path sourceMuleDistroPath,
                                   Path destMuleDistroPath,
                                   List<String> fileNamesList,
                                   boolean isDryRunMode)
                            throws IOException

Copies a list of files from a Mule Runtime Distribution to another.

Specified by:

copyFilesInsideADistro in interface FileSystemService

Parameters:

sourceMuleDistroPath - New Mule Runtime Distribution.

destMuleDistroPath - Old Mule Runtime Distribution.

fileNamesList - List of files names.

isDryRunMode - Dry Run Mode flag.

Throws:

IOException - IOException.

deleteUpgradeFolderIfEmpty

public void deleteUpgradeFolderIfEmpty(Path muleHome,
                                       boolean dryRun)
                                throws IOException

Deletes the upgrade-tool folder inside a distro if the folder is empty to try to clean the environment after an upgrade or a backup

Specified by:

deleteUpgradeFolderIfEmpty in interface FileSystemService

Parameters:

muleHome - Mule Home path where it is going to try to delete the empty upgrade-tool folder

dryRun - Dry Run flag, if is in true don't delete the folder and only do the logging

Throws:

IOException - IOException.

areHashesBetweenFilesEqual

public boolean areHashesBetweenFilesEqual(Path fileA,
                                          Path fileB)
                                   throws IOException

Specified by:

areHashesBetweenFilesEqual in interface FileSystemService

Parameters:

fileA - First file to compare the sha256

fileB - Second file to compare the sha256

Returns:

true if the hashes of the files matches and false if it doesn't.

Throws:

IOException - IOException.

areHashesBetweenFilesEqual

public boolean areHashesBetweenFilesEqual(byte[] fileContentA,
                                          byte[] fileContentB)
                                   throws IOException

Specified by:

areHashesBetweenFilesEqual in interface FileSystemService

Parameters:

fileContentA - First byte[] to compare the sha256

fileContentB - Second byte[] to compare the sha256

Returns:

true if the hashes of the files matches and false if it doesn't.

Throws:

IOException - IOException.

getSha256

public String getSha256(Path filePath)
                 throws IOException

Throws:

IOException

getSha256

public String getSha256(InputStream stream)
                 throws IOException

Throws:

IOException

getSha256

public String getSha256(byte[] content)