com.ibm.carma
Class CARMASystemFactory

java.lang.Object
  extended by com.ibm.carma.CARMASystemFactory

public class CARMASystemFactory
extends java.lang.Object

Factory used for creating and configuring CARMA connection instances. The CARMA connection must be created from the CARMASystemFactory in order for the CARMA object to be considered valid.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 CARMA getCARMAInstance(java.lang.String identifier)
          Return a new CARMA connection object associated with the default transport layer using default connection properties.
 CARMA getCARMAInstance(java.lang.String identifier, java.util.Map<java.lang.String,?> connectionProperties)
          Return a new CARMA connection object associated with the default transport layer using the given connection properties.
 CARMA getCARMAInstance(java.lang.String identifier, java.lang.String backendId, java.util.Map<java.lang.String,?> connectionProperties)
          Return a new CARMA connection object associated with the transport layer identified by the given backendId and using the given connection properties.
static CARMASystemFactory getInstance()
          Obtain an instance of a CARMASystemFactory used to create CARMA connection instances to the Host.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

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

getInstance

public static CARMASystemFactory getInstance()
Obtain an instance of a CARMASystemFactory used to create CARMA connection instances to the Host.

Returns:
a CARMASystemFactory used to create CARMA connections

getCARMAInstance

public CARMA getCARMAInstance(java.lang.String identifier)
                       throws java.lang.Exception
Return a new CARMA connection object associated with the default transport layer using default connection properties. If there is not a default transport available or the default connection properties are not acceptible, an exception is thrown.

Parameters:
identifier - (unique) CARMA instance identifier to be associated with the returned instance
Returns:
CARMA connection instance associated with the given transport
Throws:
java.lang.Exception - A problem occured in creating the CARMA connection instance

getCARMAInstance

public CARMA getCARMAInstance(java.lang.String identifier,
                              java.util.Map<java.lang.String,?> connectionProperties)
                       throws java.lang.Exception
Return a new CARMA connection object associated with the default transport layer using the given connection properties. If there is not a default transport available or the given connection properties are not acceptible, an exception is thrown.

Parameters:
identifier - (unique) CARMA instance identifier to be associated with the returned instance
connectionProperties - Properties used to create the transport layer connection
Returns:
CARMA connection instance associated with the given transport
Throws:
java.lang.Exception - A problem occured in creating the CARMA connection instance

getCARMAInstance

public CARMA getCARMAInstance(java.lang.String identifier,
                              java.lang.String backendId,
                              java.util.Map<java.lang.String,?> connectionProperties)
                       throws java.lang.Exception
Return a new CARMA connection object associated with the transport layer identified by the given backendId and using the given connection properties. If the transport identified by the backendId is not available available or the given connection properties are not acceptible, an exception is thrown.

Parameters:
identifier - (unique) CARMA instance identifier to be associated with the returned instance
backendId - the identifier of the transport layer to use in communicating with the host over the CARMA connection
connectionProperties - Properties used to create the transport layer connection
Returns:
CARMA connection instance associated with the given transport
Throws:
java.lang.Exception - A problem occured in creating the CARMA connection instance