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

Class FtpReadCommand

java.lang.Object

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

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

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

All Implemented Interfaces:

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

public final class FtpReadCommand
extends FtpCommand<ClassicFtpFileSystem>
implements org.mule.extension.file.common.api.command.ReadCommand

A ClassicFtpCommand which implements the FtpReadCommand

Since:

4.0

Field Summary

Fields

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

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

fileSystem

Constructor Summary

Constructors

Constructor and Description
FtpReadCommand(ClassicFtpFileSystem fileSystem, org.apache.commons.net.ftp.FTPClient client)

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).
RuntimeException	exception(String message) Same as the super method but adding the FTP rely code
RuntimeException	exception(String message, Exception cause) Same as the super method but adding the FTP rely code
protected String	getCurrentWorkingDirectory()
protected FtpFileAttributes	getFile(String filePath, boolean requireExistence)
protected void	makeDirectory(String directoryName) Creates the directory of the given directoryName in the current working directory
org.mule.runtime.extension.api.runtime.operation.Result<InputStream,org.mule.extension.file.common.api.FileAttributes>	read(org.mule.extension.file.common.api.FileConnectorConfig config, String filePath, org.mule.runtime.api.metadata.MediaType mediaType, boolean lock)
protected boolean	tryChangeWorkingDirectory(String path) Attempts to change the current working directory of the FTP client.

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, 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 final org.apache.commons.net.ftp.FTPClient client

Constructor Detail

FtpReadCommand

public FtpReadCommand(ClassicFtpFileSystem fileSystem,
                      org.apache.commons.net.ftp.FTPClient client)

Method Detail

read

public org.mule.runtime.extension.api.runtime.operation.Result<InputStream,org.mule.extension.file.common.api.FileAttributes> read(org.mule.extension.file.common.api.FileConnectorConfig config,
                                                                                                                                   String filePath,
                                                                                                                                   org.mule.runtime.api.metadata.MediaType mediaType,
                                                                                                                                   boolean lock)

Specified by:

read in interface org.mule.extension.file.common.api.command.ReadCommand

getFile

protected FtpFileAttributes getFile(String filePath,
                                    boolean requireExistence)

Specified by:

getFile in class FtpCommand<ClassicFtpFileSystem>

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

Parameters:

directoryPath - the Path to the directory you want to create

tryChangeWorkingDirectory

protected boolean tryChangeWorkingDirectory(String path)

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

Specified by:

tryChangeWorkingDirectory in class FtpCommand<ClassicFtpFileSystem>

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

getCurrentWorkingDirectory

protected String getCurrentWorkingDirectory()

Specified by:

getCurrentWorkingDirectory in class FtpCommand<ClassicFtpFileSystem>

Returns:

the client's working directory

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

Parameters:

filePath - the path of the file to be renamed

newName - the new name

Throws:

Exception - if anything goes wrong

exception

public RuntimeException exception(String message)

Same as the super method but adding the FTP rely code

Overrides:

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

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