java.lang.Object | +----com.ibm.connector2.ims.ico.IMSConnection
public class IMSConnection
extends Object
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();
Constructor | Description |
IMSConnection(ManagedConnection) | 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 | Description |
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). |
public IMSConnection(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.
- Parameters
- aManagedConnection - The instance representing the physical connection to IMS Connect.
public void close() throws ResourceExceptionReleases an allocated connection handle.
- Throws
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 ResourceExceptionCreates an IMSInteraction instance to use to interact with IMS OTMA via IMS Connect. For example, an application that uses the Common Client Interface (CCI) can use an IMSInteraction instance to submit an IMS transaction using the associated IMSConnection instance.
- Returns
- An IMSInteraction object.
- Throws
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.
- See Also
public javax.resource.cci.LocalTransaction getLocalTransaction() throws ResourceExceptionReturns a LocalTransaction instance that enables a component to demarcate resource manager local transactions (not supported).
Note: IMS Connector for Java currently does not have local transaction support.
- Returns
- A LocalTransaction instance.
- Throws
javax.resource.ResourceException
Note: The derived exception javax.resource.NotSupportedException is thrown by getLocalTransaction().
public javax.resource.cci.ConnectionMetaData getMetaData() throws ResourceExceptionReturns information about the IMS Connect and IMS instances connected by an IMSConnection instance.
- Returns
- The IMSConnectionMetaData instance.
public javax.resource.cci.ResultSetInfo getResultSetInfo() throws ResourceExceptionReturns a ResultSetInfo object (not supported).
Note: ResultSetInfo is not supported by IMS Connector for Java.
- Returns
- A ResultSetInfo instance.
- Throws
javax.resource.ResourceException
Note: The derived exception javax.resource.NotSupportedException is thrown by getResultSetInfo(). .