org.mule.extension.file.internal.command

Class LocalCopyCommand

java.lang.Object

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

org.mule.extension.file.internal.command.LocalCopyCommand

All Implemented Interfaces:

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

public final class LocalCopyCommand
extends org.mule.extension.file.common.api.command.FileCommand<LocalFileSystem>
implements org.mule.extension.file.common.api.command.CopyCommand

A AbstractLocalCopyCommand which implements the CopyCommand contract

Since:

4.0

Field Summary

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

fileSystem

Constructor Summary

Constructors

Constructor and Description
LocalCopyCommand(LocalFileSystem fileSystem)

Method Summary

Modifier and Type	Method and Description
void	copy(org.mule.extension.file.common.api.FileConnectorConfig config, String sourcePath, String targetDirectory, boolean overwrite, boolean createParentDirectories)
protected void	doExecute(Path source, Path targetPath, boolean overwrite, CopyOption[] options) Implements recursive copy
protected void	doMkDirs(Path directoryPath) Transforms the directoryPath to a File and invokes File.mkdirs() on it
protected void	execute(String sourcePath, String target, boolean overwrite, boolean createParentDirectory) Performs the base logic and delegates into doExecute(Path, Path, boolean, CopyOption[]) to perform the actual copying logic
protected boolean	exists(Path path)
protected String	getAction()
protected Path	getBasePath(org.mule.extension.file.common.api.FileSystem fileSystem)

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

alreadyExistsException, assureParentFolderExists, cannotListFileException, cannotReadDirectoryException, exception, exception, isVirtualDirectory, mkdirs, pathNotFoundException, resolveExistingPath, resolvePath

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalCopyCommand

public LocalCopyCommand(LocalFileSystem fileSystem)

Method Detail

copy

public void copy(org.mule.extension.file.common.api.FileConnectorConfig config,
                 String sourcePath,
                 String targetDirectory,
                 boolean overwrite,
                 boolean createParentDirectories)

Specified by:

copy in interface org.mule.extension.file.common.api.command.CopyCommand

doExecute

protected void doExecute(Path source,
                         Path targetPath,
                         boolean overwrite,
                         CopyOption[] options)
                  throws Exception

Implements recursive copy

Parameters:

source - the path to be copied

targetPath - the path to the target destination

overwrite - whether to overwrite existing target paths

options - an array of CopyOption which configure the copying operation

Throws:

Exception

getAction

protected String getAction()

Returns:

The name of the action that the implementation is actually doing. Useful for logging and exception messages

execute

protected final void execute(String sourcePath,
                             String target,
                             boolean overwrite,
                             boolean createParentDirectory)

Performs the base logic and delegates into doExecute(Path, Path, boolean, CopyOption[]) to perform the actual copying logic

Parameters:

sourcePath - the path to be copied

target - the path to the target destination

overwrite - whether to overwrite existing target paths

createParentDirectory - whether to create the target's parent directory if it doesn't exists

getBasePath

protected Path getBasePath(org.mule.extension.file.common.api.FileSystem fileSystem)

Specified by:

getBasePath in class org.mule.extension.file.common.api.command.FileCommand<LocalFileSystem>

exists

protected boolean exists(Path path)

Specified by:

exists in class org.mule.extension.file.common.api.command.FileCommand<LocalFileSystem>

doMkDirs

protected void doMkDirs(Path directoryPath)

Transforms the directoryPath to a File and invokes File.mkdirs() on it

Specified by:

doMkDirs in class org.mule.extension.file.common.api.command.FileCommand<LocalFileSystem>

Parameters:

directoryPath - a Path pointing to the directory you want to create