Package All Classes All Fields and Methods Deprecated
java.lang.Objectcom.ibm.connector2.ims.ico.IMSConnectionFactory
The IMSConnectionFactory class provides an interface for getting connections to IMS Connect and, in turn, IMS OTMA. Connections are represented by IMSConnection instances, and are application-level handles to underlying physical connections such as TCP/IP sockets or Local Option connections. An application that uses the Common Client Interface (CCI) can look up an IMSConnectionFactory instance from the JNDI namespace and then use it to get an IMSConnection instance. This method is typically used when running in the managed environment of an application server such as WebSphere. For example:
IMSConnectionFactory cf = null; Context ctx = null; // Create the initial context ctx = new InitialContext(); // Get an IMSConnectionFactory instance. cf = (IMSConnectionFactory) ctx.lookup("java:comp/env/myIMSTarget");
If JNDI is not configured, a CCI application can manually configure an IMSManagedConnectionFactory object and use it to obtain a connection factory. This method can be used in a non-managed environment such as running outside of an application server, in development mode, or when JNDI lookup fails.
IMSConnectionFactory cf = null; IMSManagedConnectionFactory mcf = new IMSManagedConnectionFactory(); mcf.setHostName("myHostName"); mcf.setPortNumber(new Integer(9999)); mcf.setDataStoreName("myIMS"); ... cf = (IMSConnectionFactory) mcf.createConnectionFactory();
IMSConnection
,
IMSManagedConnectionFactory
,
Serialized FormConstructor Summary | |
IMSConnectionFactory()
Creates an IMSConnectionFactory instance. |
|
IMSConnectionFactory(javax.resource.spi.ConnectionManager aConnectionManager)
This constructor is used by IMSManagedConnectionFactory to create an IMSConnectionFactory instance. |
Method Summary | |
javax.resource.cci.Connection |
getConnection()
Gets a connection to a particular IMS Connect instance and, in turn, to a particular IMS OTMA. |
javax.resource.cci.Connection |
getConnection(javax.resource.cci.ConnectionSpec aConnectionSpec)
Gets a connection to a particular IMS Connect instance and, in turn, to a particular IMS OTMA. |
javax.resource.cci.ResourceAdapterMetaData |
getMetaData()
Returns meta information about IMS Connector for Java, the resource adapter. |
javax.resource.cci.RecordFactory |
getRecordFactory()
Gets a RecordFactory (not supported). |
javax.naming.Reference |
getReference()
|
void |
setReference(javax.naming.Reference aRef)
Sets the reference instance. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public IMSConnectionFactory()
public IMSConnectionFactory(javax.resource.spi.ConnectionManager aConnectionManager)
aConnectionManager
- The connection manager to be used
to manage the connections created
by this IMSConnectionFactory instance.
The Connection Manager could be DefaultConnectionManager
for the non-managed case or
a connection manager provided by
the application server in the
managed case.Method Detail |
public javax.resource.cci.Connection getConnection() throws javax.resource.ResourceException
getConnection
in interface javax.resource.cci.ConnectionFactory
javax.resource.ResourceException
- Failed to get an IMSConnection
instance.IMSConnection
public javax.resource.cci.Connection getConnection(javax.resource.cci.ConnectionSpec aConnectionSpec) throws javax.resource.ResourceException
Both the security information and additional connection parameters are passed in an IMSConnectionSpec object.
Note: This will always be the version of getConnection used for component-managed sign-on.
getConnection
in interface javax.resource.cci.ConnectionFactory
aConnectionSpec
- An IMSConnectionSpec instance
containing security and/or
connection information
provided by the component.
javax.resource.ResourceException
- If failed to get an IMSConnection instance.
IMSConnection
public javax.resource.cci.ResourceAdapterMetaData getMetaData() throws javax.resource.ResourceException
getMetaData
in interface javax.resource.cci.ConnectionFactory
javax.resource.ResourceException
public javax.resource.cci.RecordFactory getRecordFactory() throws javax.resource.ResourceException
Note: RecordFactory is not supported by IMS Connector for Java.
getRecordFactory
in interface javax.resource.cci.ConnectionFactory
javax.resource.ResourceExecption
- Note: The derived exception javax.resource.NotSupportedExecption is thrown by getRecordFactory().
javax.resource.ResourceException
public final javax.naming.Reference getReference() throws javax.naming.NamingException
getReference
in interface javax.naming.Referenceable
javax.naming.NamingException
public final void setReference(javax.naming.Reference aRef)
setReference
in interface javax.resource.Referenceable
aRef
- The reference instance to set.