com.createtank.elemenope
Interface Connector

All Superinterfaces:
ElemenopeComponent, ElemenopeConnectionEntity
All Known Implementing Classes:
DirectCallConnector, JmsQueueConnector, SoapClientConnector, SynchronousJmsQueueConnector, XmlRpcClientConnector, XmlRpcEnterpriseConnector, XmlRpcServerConnector

public interface Connector
extends ElemenopeComponent, ElemenopeConnectionEntity

interface for all Connector classes.

Author:
John Joseph Roets [joe@createtank.com]

Method Summary
 void connect()
          makes initial connection to entity
 void disconnect()
          closes connection to entity
 java.lang.Object getConnection()
          Get connection implementation specific object.
 boolean isActive()
          May be used by DispatcherFailover [DFO] implementations to ascertain whether a connection is currently viable.
 void start()
          starts the connection to entity
 void stop()
          stops the connection to entity
 
Methods inherited from interface com.createtank.elemenope.ElemenopeComponent
releaseComponents, setComponents, setConfigurationAttributes
 
Methods inherited from interface com.createtank.elemenope.ElemenopeConnectionEntity
getConnectionAttributes, setConnectionAttributes
 

Method Detail

getConnection

java.lang.Object getConnection()
                               throws ElemenopeException
Get connection implementation specific object.

Used by some implementations to pass connection for use by Broker or Dispatcher.

Returns:
connection implementation specific object.
Throws:
ElemenopeException

connect

void connect()
             throws ElemenopeConnectionException
makes initial connection to entity

Throws:
java.lang.Exception - Exception thrown when problems occur connecting.
ElemenopeConnectionException

disconnect

void disconnect()
                throws ElemenopeConnectionException
closes connection to entity

Throws:
java.lang.Exception - Exception thrown when problems occur connecting.
ElemenopeConnectionException

start

void start()
           throws ElemenopeConnectionException
starts the connection to entity

Throws:
java.lang.Exception - Exception thrown when problems occur starting the connection.
ElemenopeConnectionException

stop

void stop()
          throws ElemenopeConnectionException
stops the connection to entity

Throws:
java.lang.Exception - Exception thrown when problems occur starting the connection.
ElemenopeConnectionException

isActive

boolean isActive()
May be used by DispatcherFailover [DFO] implementations to ascertain whether a connection is currently viable.

Returns:
Is connection active?