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

Class SftpFileSystem

java.lang.Object

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

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

org.mule.extension.ftp.internal.sftp.connection.SftpFileSystem

All Implemented Interfaces:

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

public class SftpFileSystem
extends FtpFileSystem

Implementation of FtpFileSystem for files residing on a SFTP server

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected SftpClient	client
protected org.mule.extension.file.common.api.command.CopyCommand	copyCommand
protected org.mule.extension.file.common.api.command.CreateDirectoryCommand	createDirectoryCommand
protected org.mule.extension.file.common.api.command.DeleteCommand	deleteCommand
protected org.mule.extension.file.common.api.command.ListCommand	listCommand
protected org.mule.extension.file.common.api.command.MoveCommand	moveCommand
protected org.mule.extension.file.common.api.command.ReadCommand	readCommand
protected org.mule.extension.file.common.api.command.RenameCommand	renameCommand
protected org.mule.extension.file.common.api.command.WriteCommand	writeCommand

Constructor Summary

Constructors

Constructor and Description
SftpFileSystem(SftpClient client, String basePath, MuleContext muleContext) Creates a new instance

Method Summary

Modifier and Type	Method and Description
void	changeToBaseDir()
protected org.mule.extension.file.common.api.lock.PathLock	createLock(Path path, Object... params)
void	disconnect() Severs the underlying connection to the remote server
Class<? extends org.mule.extension.file.common.api.FileAttributes>	getAttributesType()
org.mule.extension.file.common.api.command.CopyCommand	getCopyCommand()
org.mule.extension.file.common.api.command.CreateDirectoryCommand	getCreateDirectoryCommand()
org.mule.extension.file.common.api.command.DeleteCommand	getDeleteCommand()
org.mule.extension.file.common.api.command.ListCommand	getListCommand()
org.mule.extension.file.common.api.command.MoveCommand	getMoveCommand()
org.mule.extension.file.common.api.command.ReadCommand	getReadCommand()
org.mule.extension.file.common.api.command.RenameCommand	getRenameCommand()
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.

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

Field Detail

client

protected final SftpClient client

copyCommand

protected final org.mule.extension.file.common.api.command.CopyCommand copyCommand

createDirectoryCommand

protected final org.mule.extension.file.common.api.command.CreateDirectoryCommand createDirectoryCommand

deleteCommand

protected final org.mule.extension.file.common.api.command.DeleteCommand deleteCommand

listCommand

protected final org.mule.extension.file.common.api.command.ListCommand listCommand

moveCommand

protected final org.mule.extension.file.common.api.command.MoveCommand moveCommand

readCommand

protected final org.mule.extension.file.common.api.command.ReadCommand readCommand

renameCommand

protected final org.mule.extension.file.common.api.command.RenameCommand renameCommand

writeCommand

protected final org.mule.extension.file.common.api.command.WriteCommand writeCommand

Constructor Detail

SftpFileSystem

public SftpFileSystem(SftpClient client,
                      String basePath,
                      MuleContext muleContext)

Creates a new instance

Parameters:

client - a ready to use FTPClient

Method Detail

disconnect

public void disconnect()

Severs the underlying connection to the remote server

Specified by:

disconnect in class FtpFileSystem

changeToBaseDir

public void changeToBaseDir()

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

isConnected

protected boolean isConnected()

Specified by:

isConnected in class FtpFileSystem

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

getCopyCommand

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

Specified by:

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

getCreateDirectoryCommand

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

Specified by:

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

getDeleteCommand

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

Specified by:

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

getListCommand

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

Specified by:

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

getMoveCommand

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

Specified by:

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

getReadCommand

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

Specified by:

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

getRenameCommand

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

Specified by:

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

getWriteCommand

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

Specified by:

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

getAttributesType

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