toolbox.ftp
Class FTPManagerCommonsImpl

Package class diagram package FTPManagerCommonsImpl
java.lang.Object
  extended by toolbox.ftp.FTPManagerCommonsImpl
All Implemented Interfaces:
FTPManager

public class FTPManagerCommonsImpl
extends java.lang.Object
implements FTPManager

This implementation of the FTPManager interface employs the Apache Commons Net FTP package.


Constructor Summary
FTPManagerCommonsImpl()
          Default constructor.
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FTPManagerCommonsImpl

public FTPManagerCommonsImpl()
Default constructor.

Method Detail

init

public void init(java.lang.String name,
                 XMLProperties xmlProps)
          throws FTPException
Initialise the manager with XML configuration containing the FTP server and client configuration parameters.

Specified by:
init in interface FTPManager
Parameters:
name - Sting containing the name of this manager.
xmlProps - XML configuration.
Throws:
FTPException - if the manager cannot be initialised.

setName

public void setName(java.lang.String name)
Set the name of this manager.

Specified by:
setName in interface FTPManager
Parameters:
name - String containing manager name.

getName

public java.lang.String getName()
Return the name of this manager.

Specified by:
getName in interface FTPManager
Returns:
String containing the name of this manager.

getFTPGetClient

public FTPGetClient getFTPGetClient(java.lang.String name)
Return a reference to a named FTPGetClient

Specified by:
getFTPGetClient in interface FTPManager
Parameters:
name - String containing the name of the client to return.
Returns:
FTPGetClient instance.

getFTPPutClient

public FTPPutClient getFTPPutClient(java.lang.String name)
Return a reference to a named FTPPutClient

Specified by:
getFTPPutClient in interface FTPManager
Parameters:
name - String containing the name of the client to return.
Returns:
FTPPutClient instance.

destroy

public void destroy()
             throws FTPException
Destroy this manager.

Specified by:
destroy in interface FTPManager
Throws:
FTPException