toolbox.services.socket
Class SocketClientServiceEnvironment

Package class diagram package SocketClientServiceEnvironment
java.lang.Object
  extended by toolbox.services.socket.SocketClientServiceEnvironment
All Implemented Interfaces:
ServiceEnvironment

public class SocketClientServiceEnvironment
extends java.lang.Object
implements ServiceEnvironment

ServiceEnvironment implementation to provide access to a toolbox.socket.SocketClientManager implementation.


Constructor Summary
SocketClientServiceEnvironment()
          Default constructor
 
Method Summary
 void create(java.lang.String name, java.lang.String config)
          Create and set the SocketClientManager for this environment.
 void destroy()
          Destroy this environment by destroying the member SocketClientManager.
 java.lang.String getName()
          Return the name of this environment.
 SocketClientManager getSocketClientManager()
          Return the member SocketClientManager.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SocketClientServiceEnvironment

public SocketClientServiceEnvironment()
Default constructor

Method Detail

create

public void create(java.lang.String name,
                   java.lang.String config)
            throws ServiceException
Create and set the SocketClientManager for this environment.

Specified by:
create in interface ServiceEnvironment
Parameters:
name - The name of the environment.
config - The location of the environment configuration.
Throws:
ServiceException - if the environment cannot be created.

getName

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

Specified by:
getName in interface ServiceEnvironment
Returns:
String containing the name of this environment.

getSocketClientManager

public SocketClientManager getSocketClientManager()
Return the member SocketClientManager.

Returns:
SocketClientManager instance of this environment.

destroy

public void destroy()
             throws ServiceException
Destroy this environment by destroying the member SocketClientManager.

Specified by:
destroy in interface ServiceEnvironment
Throws:
ServiceException - if this environment cannot be destroyed.