CICS® Transaction Gateway Programming Reference v7.1.0.5

com.ibm.connector2.cics
Class ECIConnection

java.lang.Object
  extended by com.ibm.connector2.cics.CICSConnection
      extended by com.ibm.connector2.cics.ECIConnection
All Implemented Interfaces:
javax.resource.cci.Connection

public final class ECIConnection
extends CICSConnection

The ECIConnection class represents an applications handle to an underlying ECIManagedConnection. It is through the ECIConnection that ECIInteractions are created for communicating with a CICS server. An ECIConnection also provides an interface for an application to control its transaction state. You obtain a transaction controller object LocalTransaction using the getLocalTransaction method on this connection.


Method Summary
 void close()
          Closes the ECI connection, disabling it from further use.
 javax.resource.cci.Interaction createInteraction()
          Get a new ECIInteraction object with which to flow requests to CICS.
 javax.resource.cci.LocalTransaction getLocalTransaction()
          Return a CCI local transaction handle for use in controlling the ECIConnections transaction state.
 java.lang.String toString()
          Returns a string representation of this instance for use in tracing.
 
Methods inherited from class com.ibm.connector2.cics.CICSConnection
getMetaData, getResultSetInfo
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

close

public void close()
           throws javax.resource.ResourceException
Closes the ECI connection, disabling it from further use.

Specified by:
close in interface javax.resource.cci.Connection
Overrides:
close in class CICSConnection
Throws:
javax.resource.ResourceException - If an error occurs.

createInteraction

public javax.resource.cci.Interaction createInteraction()
                                                 throws javax.resource.ResourceException
Get a new ECIInteraction object with which to flow requests to CICS.

Returns:
Interaction The new ECIInteraction object to be used.
Throws:
javax.resource.ResourceException - Thrown if the connection is closed.

getLocalTransaction

public javax.resource.cci.LocalTransaction getLocalTransaction()
                                                        throws javax.resource.ResourceException
Return a CCI local transaction handle for use in controlling the ECIConnections transaction state.

Returns:
The CCILocalTransaction object.
Throws:
javax.resource.ResourceException - Thrown if the connection is closed.

toString

public java.lang.String toString()
Returns a string representation of this instance for use in tracing.

Overrides:
toString in class java.lang.Object
Returns:
The string representation.

©Copyright IBM Corp. 1994, 2011
Legal