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

Class FtpFileSystem

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ClassicFtpFileSystem, SftpFileSystem

public abstract class FtpFileSystem
extends org.mule.extension.file.common.api.AbstractFileSystem

Specialization of the AbstractFileSystem contract for file systems mounted on FTP/SFTP servers

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
FtpFileSystem(String basePath)

Method Summary

Modifier and Type	Method and Description
abstract void	disconnect() Severs the underlying connection to the remote server
protected abstract boolean	isConnected()
abstract InputStream	retrieveFileContent(org.mule.extension.file.common.api.FileAttributes filePayload) Returns an InputStream which obtains the content for the file of the given filePayload.
org.mule.runtime.api.connection.ConnectionValidationResult	validateConnection() Validates the underlying connection to the remote server

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

copy, createDirectory, createLock, createMuleLock, delete, getBasePath, getCopyCommand, getCreateDirectoryCommand, getDeleteCommand, getFileMessageMediaType, getListCommand, getMoveCommand, getReadCommand, getRenameCommand, getWriteCommand, 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

Methods inherited from interface org.mule.extension.file.common.api.FileSystem

changeToBaseDir, getAttributesType

Constructor Detail

FtpFileSystem

public FtpFileSystem(String basePath)

Method Detail

disconnect

public abstract void disconnect()

Severs the underlying connection to the remote server

retrieveFileContent

public abstract 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.

Parameters:

filePayload - a FileAttributes referencing to a FTP file

Returns:

an InputStream

validateConnection

public org.mule.runtime.api.connection.ConnectionValidationResult validateConnection()

Validates the underlying connection to the remote server

Returns:

a ConnectionValidationResult

isConnected

protected abstract boolean isConnected()