com.ibm.connector2.ims.ico

Class IMSConnection

  1. java.lang.Object
  2. extended bycom.ibm.connector2.ims.ico.IMSConnection

  1. public class IMSConnection
  2. extends java.lang.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:

See Also:
IMSConnectionSpec, IMSManagedConnectionFactory

Constructor Summary

Constructor and Description
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.

Method Summary

Modifier and Type Method and Description
  1. void
close()
Releases an allocated connection handle.
  1. javax.resource.cci.Interaction
createInteraction()
Creates an IMSInteraction instance to use to interact with IMS OTMA via IMS Connect.
  1. IMSConnectionFactory
getConnectionFactory()
  1. javax.resource.cci.LocalTransaction
getLocalTransaction()
Returns a LocalTransaction instance that enables a component to demarcate resource manager local transactions (not supported).
  1. javax.resource.cci.ConnectionMetaData
getMetaData()
Returns information about the IMS Connect and IMS instances connected by an IMSConnection instance.
  1. javax.resource.cci.ResultSetInfo
getResultSetInfo()
Returns a ResultSetInfo object (not supported).
  1. void
setConnectionFactory(IMSConnectionFactory connectionFactory)
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IMSConnection

  1. 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.

Method Detail

close

  1. public void close()
  2. throws javax.resource.ResourceException
Releases 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.


createInteraction

  1. public javax.resource.cci.Interaction createInteraction( )
  2. throws javax.resource.ResourceException
Creates 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:

getLocalTransaction

  1. public javax.resource.cci.LocalTransaction getLocalTransaction( )
  2. throws javax.resource.ResourceException
Returns a LocalTransaction instance that enables a component to demarcate resource manager local transactions (not supported).

Note: IMS TM Resource Adapter 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().


getMetaData

  1. public javax.resource.cci.ConnectionMetaData getMetaData( )
  2. throws javax.resource.ResourceException
Returns information about the IMS Connect and IMS instances connected by an IMSConnection instance.
Returns:
The IMSConnectionMetaData instance.
Throws:
javax.resource.ResourceException

getResultSetInfo

  1. public javax.resource.cci.ResultSetInfo getResultSetInfo( )
  2. throws javax.resource.ResourceException
Returns a ResultSetInfo object (not supported).

Note: ResultSetInfo is not supported by IMS TM Resource Adapter.

Returns:
A ResultSetInfo instance.
Throws:
javax.resource.ResourceException -

Note: The derived exception javax.resource.NotSupportedException is thrown by getResultSetInfo(). .


getConnectionFactory

  1. public IMSConnectionFactory getConnectionFactory( )
Returns:
Returns the connectionFactory.

setConnectionFactory

  1. public void setConnectionFactory( IMSConnectionFactory connectionFactory)
Parameters:
connectionFactory - The connectionFactory to set.