toolbox.services.ftp
Class FTPService

java.lang.Object
  toolbox.services.BaseService
      toolbox.services.ftp.FTPService

All Implemented Interfaces:

Service

public class FTPService
extends BaseService

Convenience service implementation that can be used to develop services that require interaction with FTP servers using the toolbox.ftp package.

Constructor Summary

protected

FTPService() Default constructor.

Method Summary

void	create(java.lang.String name, java.lang.String confHome, ServiceEnvironment env, XMLProperties xmlProps) Create the service by obtaining a refrence to the FTPManager in the provided environment.
void	destroy() Destroy this service by nulling the configuration properties.
protected FTPGetClient	getFTPGetClient(java.lang.String name) Return the named FTPGetClient instance.
protected FTPManager	getFTPManager() Returns the FTPManager for this service.
protected FTPPutClient	getFTPPutClient(java.lang.String name) Return the named FTPPutClient instance.

Methods inherited from class toolbox.services.BaseService

getConfigHome, getName, getProperties, getProperty, getXMLProperties, logConfig, logFine, logFiner, logFinest, logInfo, logSevere, logWarning

Methods inherited from class java.lang.Object

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

Constructor Detail

FTPService

protected FTPService()

Default constructor.

Method Detail

create

public void create(java.lang.String name,
                   java.lang.String confHome,
                   ServiceEnvironment env,
                   XMLProperties xmlProps)
            throws ServiceException

Create the service by obtaining a refrence to the FTPManager in the provided environment.

Specified by:

create in interface Service

Overrides:

create in class BaseService

Parameters:

name - The name of this service.

confHome - The path to the configuration home directory.

env - The service environment for this service.

xmlProps - XML configuration properties.

Throws:

ServiceException - if this service cannot be created.

getFTPGetClient

protected FTPGetClient getFTPGetClient(java.lang.String name)

Return the named FTPGetClient instance.

Parameters:

name - String containing the name of the client.

Returns:

FTPGetClient instance.

getFTPPutClient

protected FTPPutClient getFTPPutClient(java.lang.String name)

Return the named FTPPutClient instance.

Parameters:

name - String containing the name of the client.

Returns:

FTPPutClient instance.

getFTPManager

protected FTPManager getFTPManager()

Returns the FTPManager for this service.

Returns:

FTPManager instance.

destroy

public void destroy()

Description copied from class: BaseService

Destroy this service by nulling the configuration properties.

Specified by:

destroy in interface Service

Overrides:

destroy in class BaseService