org.mule.extension.ftp.internal.command

Class FtpCommand

java.lang.Object

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

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

Direct Known Subclasses:

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

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

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

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.net.ftp.FTPClient	client
protected static String	ROOT

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

fileSystem

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FtpCommand(FtpFileSystem fileSystem)
protected	FtpCommand(FtpFileSystem fileSystem, org.apache.commons.net.ftp.FTPClient client) 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, String renameTo, 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 void	doMkDirs(Path directoryPath) Creates the directory pointed by directoryPath also creating any missing parent directories
RuntimeException	exception(String message, Exception cause) Same as the super method but adding the FTP rely code
protected boolean	exists(Path path)
protected Path	getBasePath(org.mule.extension.file.common.api.FileSystem fileSystem)
protected String	getCurrentWorkingDirectory()
protected FtpFileAttributes	getExistingFile(String filePath) Similar to getFile(String) but throwing an IllegalArgumentException if the filePath doesn't exist
FtpFileAttributes	getFile(String filePath) Obtains a FtpFileAttributes for the given filePath by using the FTPClient.mlistFile(String) FTP command
protected FtpFileAttributes	getFile(String filePath, boolean requireExistence)
protected void	makeDirectory(String directoryName) Creates the directory of the given directoryName in the current working directory
protected void	rename(String filePath, String newName, boolean overwrite) Renames the file at filePath to newName.
protected Path	resolvePath(String filePath) Returns a Path relative to the basePath and the given filePath
protected 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, exception, isVirtualDirectory, mkdirs, pathNotFoundException, resolveExistingPath

Methods inherited from class java.lang.Object

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

Field Detail

ROOT

protected static final String ROOT

See Also:

Constant Field Values

client

protected final org.apache.commons.net.ftp.FTPClient client

Constructor Detail

FtpCommand

protected FtpCommand(FtpFileSystem fileSystem)

FtpCommand

protected FtpCommand(FtpFileSystem fileSystem,
                     org.apache.commons.net.ftp.FTPClient client)

Creates a new instance

Parameters:

fileSystem - the FileSystem on which the operation is performed

client - a ready to use FTPClient to perform the operations

Method Detail

getExistingFile

protected FtpFileAttributes getExistingFile(String filePath)

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

Parameters:

filePath - the path to the file you want

Returns:

a FtpFileAttributes

Throws:

IllegalArgumentException - if the filePath doesn't exist

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 exist

getFile

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

resolvePath

protected Path resolvePath(String filePath)

Returns a Path relative to the basePath and the given filePath

Overrides:

resolvePath in class org.mule.extension.file.common.api.command.FileCommand<FtpFileSystem>

Parameters:

filePath - the path to a file or directory

Returns:

a relative Path

tryChangeWorkingDirectory

protected boolean tryChangeWorkingDirectory(String path)

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

Parameters:

path - the path to which you wish to move

Returns:

true if the CWD was changed. false otherwise

makeDirectory

protected void makeDirectory(String directoryName)

Creates the directory of the given directoryName in the current working directory

Parameters:

directoryName - the name of the directory you want to create

rename

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

Renames the file at filePath to newName.

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

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,
                          String renameTo,
                          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 exist

getCurrentWorkingDirectory

protected String getCurrentWorkingDirectory()

Returns:

the path of the current working directory

doMkDirs

protected void doMkDirs(Path directoryPath)

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

Specified by:

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

Parameters:

directoryPath - the Path to the directory you want to create

exception

public RuntimeException exception(String message,
                                  Exception cause)

Same as the super method but adding the FTP rely code

Overrides:

exception in class org.mule.extension.file.common.api.command.FileCommand<FtpFileSystem>