org.mule.extension.file.common.api.command

Class FileCommand<F extends FileSystem>

java.lang.Object

org.mule.extension.file.common.api.command.AbstractFileCommand<F,Path>

org.mule.extension.file.common.api.command.FileCommand<F>

Type Parameters:

F - the generic type of the FileSystem on which the operation is performed

public abstract class FileCommand<F extends FileSystem>
extends AbstractFileCommand<F,Path>

Extension of AbstractFileCommand for local file systems which use Path to identify and manage files and directories.

Since:

1.0

Field Summary

Fields inherited from class org.mule.extension.file.common.api.command.AbstractFileCommand

fileSystem

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileCommand(F fileSystem) Creates a new instance

Method Summary

Modifier and Type	Method and Description
FileAlreadyExistsException	alreadyExistsException(Path path) Returns a IllegalPathException explaining that an operation is trying to write to the given path but it already exists and no overwrite instruction was provided.
protected void	assureParentFolderExists(Path path, boolean createParentFolder) Method that, given a path, checks if its parent folder exists.
protected IllegalPathException	cannotListFileException(Path path) Returns a IllegalPathException explaining that a FileSystem.list(FileConnectorConfig, String, boolean, Predicate) operation was attempted on a path pointing to a file.
protected IllegalPathException	cannotReadDirectoryException(Path path) Returns an IllegalPathException explaining that a FileSystem.read(FileConnectorConfig, String, boolean) operation was attempted on a path pointing to a directory
protected abstract void	doMkDirs(Path directoryPath) Creates the directory pointed by directoryPath.
protected abstract boolean	exists(Path path) Returns true if the given path exists
protected Path	getAbsolutePath(Path path) Returns an object representing the absolute path for the given path.
protected abstract Path	getBasePath(FileSystem fileSystem) Returns a path to which all non absolute paths are relative to
protected Path	getParent(Path path) Returns the parent path, or null if this path does not have a parent.
protected void	mkdirs(Path directoryPath) Creates the directory pointed by directoryPath also creating any missing parent directories
protected IllegalPathException	pathNotFoundException(Path path) Returns a IllegalPathException explaining that a FileSystem.list(FileConnectorConfig, String, boolean, Predicate) operation was attempted on a path pointing to a file.
protected String	pathToString(Path path)
protected Path	resolveExistingPath(String filePath) Similar to AbstractFileCommand.resolvePath(String) only that it throws a IllegalArgumentException if the given path doesn't exist.
protected Path	resolvePath(Path basePath, String filePath) Resolve the given basePath against the filePath.
protected Path	resolvePath(String filePath) Returns an absolute path for the given filePath

Methods inherited from class org.mule.extension.file.common.api.command.AbstractFileCommand

exception, exception, isVirtualDirectory

Methods inherited from class java.lang.Object

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

Constructor Detail

FileCommand

protected FileCommand(F fileSystem)

Creates a new instance

Parameters:

fileSystem - the FileSystem on which the operation is performed

Method Detail

pathToString

protected String pathToString(Path path)

Specified by:

pathToString in class AbstractFileCommand<F extends FileSystem,Path>

Returns:

the path identified by <I> as a String.

getAbsolutePath

protected Path getAbsolutePath(Path path)

Returns an object representing the absolute path for the given path.

If the given path is already absolute then this method simply returns it. Otherwise, this method resolves the path in an implementation dependent manner, typically by resolving the path against a file system default directory. Depending on the implementation, this method may throw an I/O error if the file system is not accessible.

Specified by:

getAbsolutePath in class AbstractFileCommand<F extends FileSystem,Path>

Parameters:

path - the given path

Returns:

an absolute Path

getParent

protected Path getParent(Path path)

Returns the parent path, or null if this path does not have a parent.

The parent of this path object consists of this path's root component, if any, and each element in the path except for the farthest from the root in the directory hierarchy. This method does not access the file system; the path or its parent may not exist. Furthermore, this method does not eliminate special names such as "." and ".." that may be used in some implementations. On UNIX for example, the parent of "/a/b/c" is "/a/b", and the parent of "x/y/." is "x/y".

Specified by:

getParent in class AbstractFileCommand<F extends FileSystem,Path>

Returns:

the parent Path

resolvePath

protected Path resolvePath(Path basePath,
                           String filePath)

Resolve the given basePath against the filePath.

If the filePath parameter is an absolute path then this method trivially returns filePath. If filePath is an empty path then this method trivially returns basePath. Otherwise this method considers the basePath to be a directory and resolves the given filePath against the basePath. In the simplest case, the given filePath does not have a root component, in which case this method joins both paths and returns a resulting path that ends with the given filePath. Where the given filePath has a root component then resolution is highly implementation dependent and therefore unspecified.

Specified by:

resolvePath in class AbstractFileCommand<F extends FileSystem,Path>

Parameters:

basePath - the base path considered as a directory

filePath - the path to resolve against the basePath

Returns:

the resolved Path

exists

protected abstract boolean exists(Path path)

Returns true if the given path exists

Specified by:

exists in class AbstractFileCommand<F extends FileSystem,Path>

Parameters:

path - the path to test

Returns:

whether the Path exists

getBasePath

protected abstract Path getBasePath(FileSystem fileSystem)

Returns a path to which all non absolute paths are relative to

Specified by:

getBasePath in class AbstractFileCommand<F extends FileSystem,Path>

Parameters:

fileSystem - the file system that we're connecting to

Returns:

whether the Path exists

doMkDirs

protected abstract void doMkDirs(Path directoryPath)

Creates the directory pointed by directoryPath.

Specified by:

doMkDirs in class AbstractFileCommand<F extends FileSystem,Path>

Parameters:

directoryPath - the path to the directory you want to create

assureParentFolderExists

protected void assureParentFolderExists(Path path,
                                        boolean createParentFolder)

Method that, given a path, checks if its parent folder exists. If it exists, this method returns void. Otherwise, this method allows to create such parent by setting the the createParentFolder parameter to true. If it is set to false and the parent folder does not exist, this method throws IllegalPathException.

Overrides:

assureParentFolderExists in class AbstractFileCommand<F extends FileSystem,Path>

Parameters:

path - the path to test

createParentFolder - indicates whether to create the parent folder or not.

mkdirs

protected void mkdirs(Path directoryPath)

Creates the directory pointed by directoryPath also creating any missing parent directories

Overrides:

mkdirs in class AbstractFileCommand<F extends FileSystem,Path>

Parameters:

directoryPath - the path to the directory you want to create

resolvePath

protected Path resolvePath(String filePath)

Returns an absolute path for the given filePath

Overrides:

resolvePath in class AbstractFileCommand<F extends FileSystem,Path>

Parameters:

filePath - the relative path to a file or directory

Returns:

whether the Path exists

resolveExistingPath

protected Path resolveExistingPath(String filePath)

Similar to AbstractFileCommand.resolvePath(String) only that it throws a IllegalArgumentException if the given path doesn't exist.

The existence of the obtained path is verified by delegating into #exists(I)

Overrides:

resolveExistingPath in class AbstractFileCommand<F extends FileSystem,Path>

Parameters:

filePath - the path to a file or directory

Returns:

an absolute Path

cannotReadDirectoryException

protected IllegalPathException cannotReadDirectoryException(Path path)

Returns an IllegalPathException explaining that a FileSystem.read(FileConnectorConfig, String, boolean) operation was attempted on a path pointing to a directory

Overrides:

cannotReadDirectoryException in class AbstractFileCommand<F extends FileSystem,Path>

Parameters:

path - the path on which a read was attempted

Returns:

IllegalPathException

cannotListFileException

protected IllegalPathException cannotListFileException(Path path)

Returns a IllegalPathException explaining that a FileSystem.list(FileConnectorConfig, String, boolean, Predicate) operation was attempted on a path pointing to a file.

Overrides:

cannotListFileException in class AbstractFileCommand<F extends FileSystem,Path>

Parameters:

path - the path on which a list was attempted

Returns:

IllegalPathException

pathNotFoundException

protected IllegalPathException pathNotFoundException(Path path)

Returns a IllegalPathException explaining that a FileSystem.list(FileConnectorConfig, String, boolean, Predicate) operation was attempted on a path pointing to a file.

Overrides:

pathNotFoundException in class AbstractFileCommand<F extends FileSystem,Path>

Parameters:

path - the on which a list was attempted

Returns:

IllegalPathException

alreadyExistsException

public FileAlreadyExistsException alreadyExistsException(Path path)

Returns a IllegalPathException explaining that an operation is trying to write to the given path but it already exists and no overwrite instruction was provided.

Overrides:

alreadyExistsException in class AbstractFileCommand<F extends FileSystem,Path>

Parameters:

path - the that the operation tried to modify

Returns:

IllegalPathException