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

Interface FileSystemService

All Known Implementing Classes:

DefaultFileSystemService

public interface FileSystemService

A service for file system operations required for the upgrade.

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) Check 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> paths, List<Path> excludedPaths, boolean isDryRunMode) Recursively copy all the files and directories determined by the given relative paths 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
boolean	isWindowsOs() Checks whether the underlying OS is Windows.

Method Detail

checkIsADirectory

void checkIsADirectory(Path path)
                throws NotDirectoryException

Checks whether a given path corresponds to a directory.

Parameters:

path - the path to an expected directory.

Throws:

NotDirectoryException - if given path is not a directory.

checkWritingAccess

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

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

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

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.

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

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.

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

boolean isWindowsOs()

Checks whether the underlying OS is Windows.

Returns:

true if this is Windows.

copyFiles

void copyFiles(Path srcDir,
               Path destDir,
               List<Path> paths,
               List<Path> excludedPaths,
               boolean isDryRunMode)
        throws IOException

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

Parameters:

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

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

paths - the relative paths that will be resolved against the source dir for copying them to the destination directory.

excludedPaths - the relative paths that will be resolved against the source dir which are going to be excluded when copying them to the destination directory.

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

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

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.

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.

copyFilesInsideADistro

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.

Parameters:

sourceMuleDistroPath - New Mule Runtime Distribution.

destMuleDistroPath - Old Mule Runtime Distribution.

fileNamesList - List of files names.

isDryRunMode - Dry Run Mode flag.

Throws:

IOException - IOException.

deleteFilesInsideADistro

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

Deletes a list of files from a Mule Runtime Distribution.

Parameters:

distroPath - Current Mule Runtime Distribution.

fileNamesList - List of files names.

isDryRunMode - Dry Run Mode flag.

Throws:

IOException - IOException.

areHashesBetweenFilesEqual

boolean areHashesBetweenFilesEqual(Path fileA,
                                   Path fileB)
                            throws IOException

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

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

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.

deleteUpgradeFolderIfEmpty

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

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.