com.metamatrix.common.comm.api
Interface ServerConnectionFactory

All Known Implementing Classes:
EmbeddedConnectionFactoryImpl, Server, SocketServerConnectionFactory

public interface ServerConnectionFactory


Method Summary
 ServerConnection createConnection(java.util.Properties connectionProperties)
          Establish a connection to the server.
 void initialize(java.util.Properties info)
           
 boolean isAlive()
          Is the connection factory alive
 void shutdown(boolean restart)
          Shutdown the connection factory, including the DQP and all its existing connections
 

Method Detail

initialize

void initialize(java.util.Properties info)
                throws MetaMatrixCoreException
Throws:
MetaMatrixCoreException

createConnection

ServerConnection createConnection(java.util.Properties connectionProperties)
                                  throws CommunicationException,
                                         ConnectionException
Establish a connection to the server.

Parameters:
connProps - The properties used by the transport to find a connection. These properties are typically specific to the transport.
Returns:
A connection, never null
Throws:
ConnectionException - If an error occurs communicating between client and server
CommunicationException - If an error occurs in connecting, typically due to problems with the connection properties (bad user name, bad password, bad host name, etc)

shutdown

void shutdown(boolean restart)
Shutdown the connection factory, including the DQP and all its existing connections


isAlive

boolean isAlive()
Is the connection factory alive

Returns:
true if alive; false otherwise.


Copyright © 2009. All Rights Reserved.