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
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	copyFiles(Path srcDir, Path destDir, List<Path> paths) Recursively copy all the files and directories determined by the given relative paths from the given source directory to the given destination directory.
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> paths)
               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 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.

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

Throws:

IOException - if any I/O error occurs.