org.ikasan.connector.ftp.net

Class FileTransferProtocolClient

java.lang.Object

org.ikasan.connector.ftp.net.FileTransferProtocolClient

All Implemented Interfaces:

TransactionalResource, FileTransferClient, FileTransferProtocol

public class FileTransferProtocolClient
extends Object
implements FileTransferProtocol

This class provides the basic functionality of an FTP client based on Apache's commons-net library. Some of the basic functionality is wrapped to provide FileTransferProtocolClient specific exceptions, or to provide the functionality required by a framework component.

TODO This has a good deal of similar code to SFTP client, might be able to get some common code out of that

Author:

Ikasan Development Team

Constructor Summary

Constructors

Constructor and Description
FileTransferProtocolClient(boolean active, String remoteHostname, String localHost, Integer maxRetryAttempts, String password, Integer remotePort, String username, String systemKey, Integer connectionTimeout, Integer soTimeout, Integer dataTimeout) Constructor

Method Summary

Modifier and Type	Method and Description
void	cd(String targetPath)
void	connect() Connect to the FTP server
void	deleteRemoteDirectory(String directoryPath, boolean recurse)
void	deleteRemoteFile(String filename)
void	disconnect() Disconnect
void	echoConfig() Method used to log the configuration information used to initialise the client.
void	ensureConnection()
BaseFileTransferMappedRecord	get(ClientListEntry clientListEntry)
BaseFileTransferMappedRecord	get(String filePath)
void	get(String filePath, OutputStream outputStream) OutputStream is closed by the caller
void	get(String filePath, OutputStream outputStream, int resume, long offset)
InputStream	getAsInputStream(String filePath)
InputStream	getContentAsStream(ClientListEntry entry)
boolean	isConnected() Method that tests if the underlying library is valid and connected.
void	login() login to the FTP server
List<ClientListEntry>	ls(String path) Method used to get a list of all files and directories in the target path including the "." and ".." directories.
void	mkdir(String newPath) Utility method for mkdir(String newDirPath, boolean force) that defaults the force parameter to true.
void	put(String name, byte[] content)
void	putWithOutputStream(String fileName, InputStream inputStream) FTP Put using an output stream form an input stream.
String	pwd()
void	rename(String currentPath, String newPath)
void	validateConstructorArgs() All constructor arguments are essential, so use this method to validate them before attempting connection

Methods inherited from class java.lang.Object

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

Constructor Detail

FileTransferProtocolClient

public FileTransferProtocolClient(boolean active,
                                  String remoteHostname,
                                  String localHost,
                                  Integer maxRetryAttempts,
                                  String password,
                                  Integer remotePort,
                                  String username,
                                  String systemKey,
                                  Integer connectionTimeout,
                                  Integer soTimeout,
                                  Integer dataTimeout)

Constructor

Parameters:

active - Whether we are active or passive mode

remoteHostname - The remote hostname

localHost - the local host

maxRetryAttempts - The maximum amount of retries

password - The password to connect with

remotePort - The remote port to connect to

username - The username

systemKey - The system key

connectionTimeout - connection timeout

soTimeout - Socket timeout in ms after getting a connection

dataTimeout - Data connection timeout in ms after opening a socket

Method Detail

validateConstructorArgs

public void validateConstructorArgs()
                             throws ClientInitialisationException

All constructor arguments are essential, so use this method to validate them before attempting connection

Specified by:

validateConstructorArgs in interface FileTransferProtocol

Throws:

ClientInitialisationException - if any of the required parameters are invalid

connect

public void connect()
             throws ClientConnectionException

Connect to the FTP server

Specified by:

connect in interface FileTransferProtocol

Throws:

ClientConnectionException - Exception thrown when we can't connect

login

public void login()
           throws ClientConnectionException

login to the FTP server

Specified by:

login in interface FileTransferProtocol

Throws:

ClientConnectionException - Exception thrown when we can't connect

isConnected

public boolean isConnected()

Method that tests if the underlying library is valid and connected.

Specified by:

isConnected in interface FileTransferProtocol

Returns:

true if fully connected, false otherwise

disconnect

public void disconnect()

Disconnect

Specified by:

disconnect in interface FileTransferClient

echoConfig

public void echoConfig()

Method used to log the configuration information used to initialise the client.

Specified by:

echoConfig in interface FileTransferProtocol

Parameters:

logLevel - The log level at which to log the information

ensureConnection

public void ensureConnection()
                      throws javax.resource.ResourceException

Specified by:

ensureConnection in interface TransactionalResource

Throws:

javax.resource.ResourceException

cd

public void cd(String targetPath)
        throws ClientCommandCdException

Specified by:

cd in interface FileTransferClient

Throws:

ClientCommandCdException

deleteRemoteDirectory

public void deleteRemoteDirectory(String directoryPath,
                                  boolean recurse)
                           throws ClientException,
                                  ClientCommandLsException

Specified by:

deleteRemoteDirectory in interface FileTransferClient

Throws:

ClientException

ClientCommandLsException

deleteRemoteFile

public void deleteRemoteFile(String filename)
                      throws ClientException

Specified by:

deleteRemoteFile in interface FileTransferClient

Throws:

ClientException

get

public BaseFileTransferMappedRecord get(ClientListEntry clientListEntry)
                                 throws ClientCommandGetException

Specified by:

get in interface FileTransferClient

Throws:

ClientCommandGetException

get

public BaseFileTransferMappedRecord get(String filePath)
                                 throws ClientCommandGetException

Specified by:

get in interface FileTransferClient

Throws:

ClientCommandGetException

get

public void get(String filePath,
                OutputStream outputStream)
         throws ClientCommandGetException

OutputStream is closed by the caller

Specified by:

get in interface FileTransferClient

Parameters:

filePath - The path to the file that we're getting

outputStream - The stream we're getting the file with

Throws:

ClientCommandGetException - Exception if we could not get the file

get

public void get(String filePath,
                OutputStream outputStream,
                int resume,
                long offset)
         throws ClientCommandGetException

Specified by:

get in interface FileTransferClient

Throws:

ClientCommandGetException

getAsInputStream

public InputStream getAsInputStream(String filePath)
                             throws ClientCommandGetException

Specified by:

getAsInputStream in interface FileTransferClient

Throws:

ClientCommandGetException

getContentAsStream

public InputStream getContentAsStream(ClientListEntry entry)
                               throws ClientCommandGetException

Specified by:

getContentAsStream in interface FileTransferClient

Throws:

ClientCommandGetException

ls

public List<ClientListEntry> ls(String path)
                         throws ClientCommandLsException,
                                URISyntaxException

Method used to get a list of all files and directories in the target path including the "." and ".." directories.

Specified by:

ls in interface FileTransferClient

Parameters:

path - The (directory) path to list.

Returns:

A ClientListEntry typed List

Throws:

URISyntaxException - If a malformed URI is created

ClientCommandLsException - If the directory listing fails (i.e. path not a directory or path not found)

put

public void put(String name,
                byte[] content)
         throws ClientCommandPutException

Specified by:

put in interface FileTransferClient

Throws:

ClientCommandPutException

putWithOutputStream

public void putWithOutputStream(String fileName,
                                InputStream inputStream)
                         throws ClientCommandPutException,
                                ClientCommandLsException,
                                ClientCommandMkdirException

FTP Put using an output stream form an input stream.

Specified by:

putWithOutputStream in interface FileTransferClient

Parameters:

fileName - Name of the file we're putting

inputStream - Stream we're putting the file with

Throws:

ClientCommandPutException - Exception if we can't put

ClientCommandLsException - Exception if we can't lista directory

ClientCommandMkdirException - Exception if we can't make a directory

pwd

public String pwd()
           throws ClientCommandPwdException

Specified by:

pwd in interface FileTransferClient

Throws:

ClientCommandPwdException

rename

public void rename(String currentPath,
                   String newPath)
            throws ClientCommandRenameException

Specified by:

rename in interface FileTransferClient

Throws:

ClientCommandRenameException

mkdir

public void mkdir(String newPath)
           throws ClientCommandMkdirException

Utility method for mkdir(String newDirPath, boolean force) that defaults the force parameter to true.

Specified by:

mkdir in interface FileTransferClient

Parameters:

newPath - The new path to create

Throws:

ClientCommandMkdirException - Exception if we can't make a directory