org.mule.extension.ftp.internal.ftp.connection

Class ClassicFtpFileSystem

java.lang.Object

org.mule.extension.file.common.api.AbstractFileSystem

org.mule.extension.ftp.internal.ftp.connection.FtpFileSystem

org.mule.extension.ftp.internal.ftp.connection.ClassicFtpFileSystem

All Implemented Interfaces:

org.mule.extension.file.common.api.FileSystem

public final class ClassicFtpFileSystem
extends FtpFileSystem

Implementation of FtpFileSystem for files residing on a FTP server

Since:

4.0

Method Summary

Modifier and Type	Method and Description
void	awaitCommandCompletion() Awaits for the underlying client to complete any pending commands.
void	changeToBaseDir() Changes the client's current working directory to the base path
protected org.mule.extension.file.common.api.lock.PathLock	createLock(Path path, Object... params)
void	disconnect() Severs the connection by invoking FTPClient.logout() and FTPClient.disconnect() on the provided client.
Class<? extends org.mule.extension.file.common.api.FileAttributes>	getAttributesType()
protected org.mule.extension.file.common.api.command.CopyCommand	getCopyCommand()
protected org.mule.extension.file.common.api.command.CreateDirectoryCommand	getCreateDirectoryCommand()
protected org.mule.extension.file.common.api.command.DeleteCommand	getDeleteCommand()
protected org.mule.extension.file.common.api.command.ListCommand	getListCommand()
protected org.mule.extension.file.common.api.command.MoveCommand	getMoveCommand()
protected org.mule.extension.file.common.api.command.ReadCommand	getReadCommand()
protected org.mule.extension.file.common.api.command.RenameCommand	getRenameCommand()
protected org.mule.extension.file.common.api.command.WriteCommand	getWriteCommand()
protected boolean	isConnected()
InputStream	retrieveFileContent(org.mule.extension.file.common.api.FileAttributes filePayload) Returns an InputStream which obtains the content for the file of the given filePayload.
void	setPassiveMode(boolean passive) If passive is true then the client is set on passive mode.
void	setResponseTimeout(Integer timeout, TimeUnit timeUnit) Sets the data timeout property on the underlying client
void	setTransferMode(FtpTransferMode mode) Sets the transfer mode on the client

Methods inherited from class org.mule.extension.ftp.internal.ftp.connection.FtpFileSystem

validateConnection

Methods inherited from class org.mule.extension.file.common.api.AbstractFileSystem

copy, createDirectory, createMuleLock, delete, getBasePath, getFileMessageMediaType, isLocked, list, lock, move, read, rename, verifyNotLocked, write

Methods inherited from class java.lang.Object

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

Method Detail

disconnect

public void disconnect()

Severs the connection by invoking FTPClient.logout() and FTPClient.disconnect() on the provided client.

Notice that FTPClient.disconnect() will be invoked even if FTPClient.logout() fails. This method will never throw exception. Any errors will be logged.

Specified by:

disconnect in class FtpFileSystem

isConnected

protected boolean isConnected()

Specified by:

isConnected in class FtpFileSystem

setTransferMode

public void setTransferMode(FtpTransferMode mode)

Sets the transfer mode on the client

Parameters:

mode - a FtpTransferMode

setResponseTimeout

public void setResponseTimeout(Integer timeout,
                               TimeUnit timeUnit)

Sets the data timeout property on the underlying client

Parameters:

timeout - a timeout scalar

timeUnit - a TimeUnit which qualifies the timeout

setPassiveMode

public void setPassiveMode(boolean passive)

If passive is true then the client is set on passive mode. Otherwise is set on active mode.

Parameters:

passive - whether to go passive mode or not

retrieveFileContent

public InputStream retrieveFileContent(org.mule.extension.file.common.api.FileAttributes filePayload)

Returns an InputStream which obtains the content for the file of the given filePayload.

The invoked MUST make sure that the returned stream is closed in order for the underlying connection to be closed.

Specified by:

retrieveFileContent in class FtpFileSystem

Parameters:

filePayload - a FileAttributes referencing to a FTP file

Returns:

an InputStream

awaitCommandCompletion

public void awaitCommandCompletion()

Awaits for the underlying client to complete any pending commands. This is necessary for certain operations such as write. Using the client before tnhat can result in unexpected behavior

createLock

protected org.mule.extension.file.common.api.lock.PathLock createLock(Path path,
                                                                      Object... params)

Specified by:

createLock in class org.mule.extension.file.common.api.AbstractFileSystem

Returns:

a URLPathLock based on the client's connection information

changeToBaseDir

public void changeToBaseDir()

Changes the client's current working directory to the base path

getReadCommand

protected org.mule.extension.file.common.api.command.ReadCommand getReadCommand()

Specified by:

getReadCommand in class org.mule.extension.file.common.api.AbstractFileSystem

getListCommand

protected org.mule.extension.file.common.api.command.ListCommand getListCommand()

Specified by:

getListCommand in class org.mule.extension.file.common.api.AbstractFileSystem

getWriteCommand

protected org.mule.extension.file.common.api.command.WriteCommand getWriteCommand()

Specified by:

getWriteCommand in class org.mule.extension.file.common.api.AbstractFileSystem

getCopyCommand

protected org.mule.extension.file.common.api.command.CopyCommand getCopyCommand()

Specified by:

getCopyCommand in class org.mule.extension.file.common.api.AbstractFileSystem

getMoveCommand

protected org.mule.extension.file.common.api.command.MoveCommand getMoveCommand()

Specified by:

getMoveCommand in class org.mule.extension.file.common.api.AbstractFileSystem

getDeleteCommand

protected org.mule.extension.file.common.api.command.DeleteCommand getDeleteCommand()

Specified by:

getDeleteCommand in class org.mule.extension.file.common.api.AbstractFileSystem

getRenameCommand

protected org.mule.extension.file.common.api.command.RenameCommand getRenameCommand()

Specified by:

getRenameCommand in class org.mule.extension.file.common.api.AbstractFileSystem

getCreateDirectoryCommand

protected org.mule.extension.file.common.api.command.CreateDirectoryCommand getCreateDirectoryCommand()

Specified by:

getCreateDirectoryCommand in class org.mule.extension.file.common.api.AbstractFileSystem

getAttributesType

public Class<? extends org.mule.extension.file.common.api.FileAttributes> getAttributesType()