com.softwareag.cis.plugin.extpt
Interface ConnectionHandler

All Superinterfaces:
ExtensionImplementation

public interface ConnectionHandler
extends ExtensionImplementation


Field Summary
static java.lang.String rcs_id
           
 
Method Summary
 void connect(com.softwareag.cst.util.security.Credentials c, CommonAdapter ca)
          Establish connection as required by the specific plugin implementing that extension point
 void disconnect(CommonAdapter ca)
          Close connection
 void init(CommonAdapter ca)
          Initialize ConnectionHandler at very startup
 boolean isConnected()
          Check whether the respective connection has been established
 void notifyConnected(CommonAdapter ca)
          ConnectionHandler is notified after all connections have been established.
 void prepareDisconnect(CommonAdapter ca)
          Check whether connection held by plugin may be closed
 
Methods inherited from interface com.softwareag.cis.plugin.registry.ExtensionImplementation
getExtension, getPlugIn, popContextClassLoader, pushContextClassLoader, setExtension
 

Field Detail

rcs_id

static final java.lang.String rcs_id
See Also:
Constant Field Values
Method Detail

init

void init(CommonAdapter ca)
Initialize ConnectionHandler at very startup

Parameters:
ca - the adapter being active

connect

void connect(com.softwareag.cst.util.security.Credentials c,
             CommonAdapter ca)
             throws java.lang.Exception
Establish connection as required by the specific plugin implementing that extension point

Parameters:
c - the credentials obtained from the login dialog
ca - the adapter being active while the connection is being established
Throws:
java.lang.Exception - if an error occured when attempting to establish the connection

notifyConnected

void notifyConnected(CommonAdapter ca)
ConnectionHandler is notified after all connections have been established. This method may be used by a ConnectionHandler to perform some specific actions after all connections have been established.

Parameters:
ca - the adapter being active while the connection is being established

isConnected

boolean isConnected()
Check whether the respective connection has been established

Returns:
true if connection established

prepareDisconnect

void prepareDisconnect(CommonAdapter ca)
                       throws java.lang.Exception
Check whether connection held by plugin may be closed

Parameters:
ca - the adapter being active while attempting to close connection
Throws:
java.lang.Exception - if connection may not be closed

disconnect

void disconnect(CommonAdapter ca)
Close connection

Parameters:
ca - the adapter being active while attempting to close connection