Package All Classes All Fields and Methods Deprecated
java.lang.Objectcom.ibm.connector2.ims.ico.IMSConnection
An IMSConnection instance is an application-level handle that is used by a component to access an underlying physical connection to IMS Connect. IMS Connect in turn uses the Cross System Coupling Facility (XCF) to access IMS OTMA. A physical connection, such as a TCP/IP socket or Local Option connection, is represented by an IMSManagedConnection instance. An application that uses the Common Client Interface (CCI) obtains an IMSConnection instance by invoking the getConnection() method of an IMSConnectionFactory instance.
The variant of the getConnection() method that is used depends on how the the application is configured. For example:
Connection connection = null; // Populate an IMSConnectionSpec object IMSConnectionSpec aCSpec = new IMSConnectionSpec(); aCSpec.setUserName("myUserName"); aCSpec.setPassword("myPassword"); aCSpec.setGroupName("myGroupName"); // Obtain a connection handle connection = connectionFactory.getConnection(aCSpec);
Connection connection = null; // Populate an IMSConnectionSpec object IMSConnectionSpec aCSpec = new IMSConnectionSpec(); aCSpec.setClientID("CLIENT01"); // Obtain a connection handle connection = connectionFactory.getConnection(aCSpec);
Connection connection = null; // Obtain a connection handle connection = connectionFactory.getConnection();
IMSConnectionSpec
,
IMSManagedConnectionFactory
Constructor Summary | |
IMSConnection(javax.resource.spi.ManagedConnection aManagedConnection)
Creates an IMSConnection instance as an application handle to an IMSManagedConnection instance representing a physical connection such as a TCP/IP socket or a Local Option connection. |
Method Summary | |
void |
close()
Releases an allocated connection handle. |
javax.resource.cci.Interaction |
createInteraction()
Creates an IMSInteraction instance to use to interact with IMS OTMA via IMS Connect. |
javax.resource.cci.LocalTransaction |
getLocalTransaction()
Returns a LocalTransaction instance that enables a component to demarcate resource manager local transactions (not supported). |
javax.resource.cci.ConnectionMetaData |
getMetaData()
Returns information about the IMS Connect and IMS instances connected by an IMSConnection instance. |
javax.resource.cci.ResultSetInfo |
getResultSetInfo()
Returns a ResultSetInfo object (not supported). |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public IMSConnection(javax.resource.spi.ManagedConnection aManagedConnection)
aManagedConnection
- The instance representing
the physical connection
to IMS Connect.Method Detail |
public void close() throws javax.resource.ResourceException
close
in interface javax.resource.cci.Connection
javax.resource.ResourceException
- Note: The derived exception javax.resource.spi.IllegalStateException is thrown by close() if the IMSConnection instance is already closed.
public javax.resource.cci.Interaction createInteraction() throws javax.resource.ResourceException
createInteraction
in interface javax.resource.cci.Connection
javax.resource.ResourceException
- Note: The derived exception javax.resource.spi.IllegalStateException is thrown by createInteraction() when an attempt to create an IMSInteraction instance is made when the IMSConnection instance is already closed.
IMSInteraction
public javax.resource.cci.LocalTransaction getLocalTransaction() throws javax.resource.ResourceException
Note: IMS Connector for Java currently does not have local transaction support.
getLocalTransaction
in interface javax.resource.cci.Connection
javax.resource.ResourceException
- Note: The derived exception javax.resource.NotSupportedException is thrown by getLocalTransaction().
public javax.resource.cci.ConnectionMetaData getMetaData() throws javax.resource.ResourceException
getMetaData
in interface javax.resource.cci.Connection
javax.resource.ResourceException
public javax.resource.cci.ResultSetInfo getResultSetInfo() throws javax.resource.ResourceException
Note: ResultSetInfo is not supported by IMS Connector for Java.
getResultSetInfo
in interface javax.resource.cci.Connection
javax.resource.ResourceException
- Note: The derived exception javax.resource.NotSupportedException is thrown by getResultSetInfo(). .