toolbox.ftp
Interface FTPManager

All Known Implementing Classes:

FTPManagerCommonsImpl

public interface FTPManager

Defines an interface for developing a FTP manager.

Implementations of this interface will provide the following services:

• Access to implementations of the FTPGetClient and FTPPutClient.

Method Summary

void	destroy() Destroy this manager.
FTPGetClient	getFTPGetClient(java.lang.String name) Return a reference to a named FTPGetClient
FTPPutClient	getFTPPutClient(java.lang.String name) Return a reference to a named FTPPutClient
java.lang.String	getName() Return the name of this manager.
void	init(java.lang.String name, XMLProperties xmlProps) Initialise the manager with XML configuration containing the FTP server and client configuration parameters.
void	setName(java.lang.String name) Set the name of this manager.

Method Detail

init

void init(java.lang.String name,
          XMLProperties xmlProps)
          throws FTPException

Initialise the manager with XML configuration containing the FTP server and client configuration parameters.

Parameters:

name - Sting containing the name of this manager.

xmlProps - XML configuration.

Throws:

FTPException - if the manager cannot be initialised.

setName

void setName(java.lang.String name)

Set the name of this manager.

Parameters:

name - String containing manager name.

getName

java.lang.String getName()

Return the name of this manager.

Returns:

String containing the name of this manager.

getFTPGetClient

FTPGetClient getFTPGetClient(java.lang.String name)

Return a reference to a named FTPGetClient

Parameters:

name - String containing the name of the client to return.

Returns:

FTPGetClient instance.

getFTPPutClient

FTPPutClient getFTPPutClient(java.lang.String name)

Return a reference to a named FTPPutClient

Parameters:

name - String containing the name of the client to return.

Returns:

FTPPutClient instance.

destroy

void destroy()
             throws FTPException

Destroy this manager.

Throws:

FTPException