org.mule.extension.ftp.internal.ftp.command

Class FtpCommand<C extends FtpFileSystem>

java.lang.Object

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

org.mule.extension.ftp.internal.ftp.command.FtpCommand<C>

Type Parameters:

C - the generic type of the connection object

Direct Known Subclasses:

FtpCopyCommand, FtpCreateDirectoryCommand, FtpDeleteCommand, FtpListCommand, FtpMoveCommand, FtpReadCommand, FtpRenameCommand, FtpWriteCommand, SftpCommand

public abstract class FtpCommand<C extends FtpFileSystem>
extends org.mule.extension.file.common.api.command.FileCommand<C>

Base class for FileCommand implementations that target a FTP/SFTP server

Since:

4.0

Field Summary

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

fileSystem

Constructor Summary

Constructors

Constructor and Description
FtpCommand(C fileSystem) Creates a new instance

Method Summary

Modifier and Type	Method and Description
protected void	changeWorkingDirectory(Path path) Changes the current working directory to the given path
protected void	changeWorkingDirectory(String path) Changes the current working directory to the given path
protected void	copy(org.mule.extension.file.common.api.FileConnectorConfig config, String source, String target, boolean overwrite, boolean createParentDirectory, FtpCopyDelegate delegate) Performs the base logic and delegates into FtpCopyDelegate.doCopy(FileConnectorConfig, FileAttributes, Path, boolean) to perform the actual copying logic
protected void	createDirectory(String directoryPath)
protected abstract void	doRename(String filePath, String newName) Template method which works in tandem with rename(String, String, boolean).
protected boolean	exists(Path path)
protected Path	getBasePath(org.mule.extension.file.common.api.FileSystem fileSystem)
protected abstract String	getCurrentWorkingDirectory()
protected FtpFileAttributes	getExistingFile(String filePath) Similar to getFile(String) but throwing an IllegalArgumentException if the filePath doesn't exists
FtpFileAttributes	getFile(String filePath) Obtains a FtpFileAttributes for the given filePath by using the FTPClient.mlistFile(String) FTP command
protected abstract FtpFileAttributes	getFile(String filePath, boolean requireExistence)
protected void	rename(String filePath, String newName, boolean overwrite) Template method that renames the file at filePath to newName.
protected abstract boolean	tryChangeWorkingDirectory(String path) Attempts to change the current working directory.

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

alreadyExistsException, assureParentFolderExists, cannotListFileException, cannotReadDirectoryException, doMkDirs, 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

FtpCommand

public FtpCommand(C fileSystem)

Creates a new instance

Parameters:

fileSystem - a FtpFileSystem used as the connection object

Method Detail

getExistingFile

protected FtpFileAttributes getExistingFile(String filePath)

Similar to getFile(String) but throwing an IllegalArgumentException if the filePath doesn't exists

Parameters:

filePath - the path to the file you want

Returns:

a FtpFileAttributes

Throws:

IllegalArgumentException - if the filePath doesn't exists

getFile

public FtpFileAttributes getFile(String filePath)

Obtains a FtpFileAttributes for the given filePath by using the FTPClient.mlistFile(String) FTP command

Parameters:

filePath - the path to the file you want

Returns:

a FtpFileAttributes or null if it doesn't exists

getFile

protected abstract FtpFileAttributes getFile(String filePath,
                                             boolean requireExistence)

exists

protected boolean exists(Path path)

Specified by:

exists in class org.mule.extension.file.common.api.command.FileCommand<C extends FtpFileSystem>

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<C extends FtpFileSystem>

changeWorkingDirectory

protected void changeWorkingDirectory(Path path)

Changes the current working directory to the given path

Parameters:

path - the Path to which you wish to move

Throws:

IllegalArgumentException - if the CWD could not be changed

changeWorkingDirectory

protected void changeWorkingDirectory(String path)

Changes the current working directory to the given path

Parameters:

path - the path to which you wish to move

Throws:

IllegalArgumentException - if the CWD could not be changed

tryChangeWorkingDirectory

protected abstract boolean tryChangeWorkingDirectory(String path)

Attempts to change the current working directory. If it was not possible (for example, because it doesn't exists), it returns false

Parameters:

path - the path to which you wish to move

Returns:

true if the CWD was changed. false otherwise

rename

protected void rename(String filePath,
                      String newName,
                      boolean overwrite)

Template method that renames the file at filePath to newName.

This method performs path resolution and validation and eventually delegates into doRename(String, String), in which the actual renaming implementation is.

Parameters:

filePath - the path of the file to be renamed

newName - the new name

overwrite - whether to overwrite the target file if it already exists

doRename

protected abstract void doRename(String filePath,
                                 String newName)
                          throws Exception

Template method which works in tandem with rename(String, String, boolean).

Implementations are to perform the actual renaming logic here

Parameters:

filePath - the path of the file to be renamed

newName - the new name

Throws:

Exception - if anything goes wrong

createDirectory

protected void createDirectory(String directoryPath)

copy

protected final void copy(org.mule.extension.file.common.api.FileConnectorConfig config,
                          String source,
                          String target,
                          boolean overwrite,
                          boolean createParentDirectory,
                          FtpCopyDelegate delegate)

Performs the base logic and delegates into FtpCopyDelegate.doCopy(FileConnectorConfig, FileAttributes, Path, boolean) to perform the actual copying logic

Parameters:

config - the config that is parameterizing this operation

source - 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

getCurrentWorkingDirectory

protected abstract String getCurrentWorkingDirectory()

Returns:

the path of the current working directory