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

Class SftpCommand

java.lang.Object

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

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

org.mule.extension.ftp.internal.sftp.command.SftpCommand

Direct Known Subclasses:

SftpCopyCommand, SftpCreateDirectoryCommand, SftpDeleteCommand, SftpListCommand, SftpMoveCommand, SftpReadCommand, SftpRenameCommand, SftpWriteCommand

public abstract class SftpCommand
extends FtpCommand<SftpFileSystem>

Base class for FtpCommand implementations that target a SFTP server

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected SftpClient	client

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

fileSystem

Constructor Summary

Constructors

Constructor and Description
SftpCommand(SftpFileSystem fileSystem, SftpClient client) Creates a new instance

Method Summary

Modifier and Type	Method and Description
protected void	doMkDirs(Path directoryPath) Creates the directory pointed by directoryPath also creating any missing parent directories
protected void	doRename(String filePath, String newName) Template method which works in tandem with FtpCommand.rename(String, String, boolean).
protected String	getCurrentWorkingDirectory()
protected FtpFileAttributes	getFile(String filePath, boolean requireExistence)
protected boolean	tryChangeWorkingDirectory(String path) Attempts to change the current working directory.

Methods inherited from class org.mule.extension.ftp.internal.ftp.command.FtpCommand

changeWorkingDirectory, changeWorkingDirectory, copy, createDirectory, exists, getBasePath, getExistingFile, getFile, rename

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

Field Detail

client

protected SftpClient client

Constructor Detail

SftpCommand

public SftpCommand(SftpFileSystem fileSystem,
                   SftpClient client)

Creates a new instance

Parameters:

fileSystem - a SftpFileSystem used as the connection object

client - a SftpClient

Method Detail

getFile

protected FtpFileAttributes getFile(String filePath,
                                    boolean requireExistence)

Specified by:

getFile in class FtpCommand<SftpFileSystem>

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

Parameters:

directoryPath - the Path to the directory you want to create

tryChangeWorkingDirectory

protected 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

Specified by:

tryChangeWorkingDirectory in class FtpCommand<SftpFileSystem>

Parameters:

path - the path to which you wish to move

Returns:

true if the CWD was changed. false otherwise

doRename

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

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

Implementations are to perform the actual renaming logic here

Specified by:

doRename in class FtpCommand<SftpFileSystem>

Parameters:

filePath - the path of the file to be renamed

newName - the new name

Throws:

Exception - if anything goes wrong

getCurrentWorkingDirectory

protected String getCurrentWorkingDirectory()

Specified by:

getCurrentWorkingDirectory in class FtpCommand<SftpFileSystem>

Returns:

the path of the current working directory