Class CICSConnection

java.lang.Object
com.ibm.jakarta.connector2.cics.CICSConnection
All Implemented Interfaces:
jakarta.resource.cci.Connection
Direct Known Subclasses:
ECIConnection, EPIConnection

public abstract class CICSConnection extends Object implements jakarta.resource.cci.Connection
This abstract class provides the general CICS connection class. It provides support for the connection metadata and the log writer.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Closes this connection if it is not already closed.
    jakarta.resource.cci.ConnectionMetaData
    Returns the metadata for this connection.
    jakarta.resource.cci.ResultSetInfo
    Returns the resultSetInfo object.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface jakarta.resource.cci.Connection

    createInteraction, getLocalTransaction
  • Field Details

  • Method Details

    • getResultSetInfo

      public jakarta.resource.cci.ResultSetInfo getResultSetInfo() throws jakarta.resource.ResourceException
      Returns the resultSetInfo object. This is not supported by CICS resource adapters, so a NotSupportedException is always thrown.
      Specified by:
      getResultSetInfo in interface jakarta.resource.cci.Connection
      Returns:
      ResultSetInfo.
      Throws:
      jakarta.resource.NotSupportedException - If feature not supported.
      jakarta.resource.ResourceException
    • getMetaData

      public jakarta.resource.cci.ConnectionMetaData getMetaData() throws jakarta.resource.ResourceException
      Returns the metadata for this connection.
      Specified by:
      getMetaData in interface jakarta.resource.cci.Connection
      Returns:
      ConnectionMetaData.
      Throws:
      jakarta.resource.ResourceException
    • close

      public void close() throws jakarta.resource.ResourceException
      Closes this connection if it is not already closed. Any subclass that overrides this method must call the method on the superclass. The managed connection is asked to remove this connection and an event is fired to say the connection is closed. The connection is flagged as being in the closed state and cannot be used any more.

      Attempting to close an already closed connection results in a ResourceException being thrown.

      Any method providing a subclass close now cannot throw explicit exceptions. This facility can be provided under a different method name and the subclass will inherit and invoke this method rather than super().close();

      Specified by:
      close in interface jakarta.resource.cci.Connection
      Throws:
      jakarta.resource.ResourceException - If the connection is already closed.