toolbox.services.socket
Class SocketClientService

java.lang.Object
  toolbox.services.BaseService
      toolbox.services.socket.SocketClientService

All Implemented Interfaces:

Service

Direct Known Subclasses:

SimpleSocketServiceImpl

public class SocketClientService
extends BaseService

Convenience service implementation that can be used to develop services that require interaction with client sockets using the toolbox.socket package.

Constructor Summary

protected

SocketClientService() 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 SocketClientManager in the provided environment.
void	destroy() Destroy this service by nulling the configuration properties.
protected SocketClient	getSocketClient() Return SocketClient for this service.
protected SocketClientManager	getSocketClientManager() Returns the SocketClientManager for this service.

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

SocketClientService

protected SocketClientService()

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 SocketClientManager 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.

getSocketClient

protected SocketClient getSocketClient()

Return SocketClient for this service.

Returns:

SocketClient instance.

getSocketClientManager

protected SocketClientManager getSocketClientManager()

Returns the SocketClientManager for this service.

Returns:

SocketClientManager 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