Class ECIInteraction

java.lang.Object
com.ibm.jakarta.connector2.cics.CICSInteraction
com.ibm.jakarta.connector2.cics.ECIInteraction
All Implemented Interfaces:
jakarta.resource.cci.Interaction

public final class ECIInteraction extends CICSInteraction

The ECIInteraction class is used to control interaction with CICS via the ECIConnection object. The execute method on this class is used to pass input and output records to CICS, as well as passing an ECIInteractionSpec which is used to define details of the interaction with CICS.

Concurrent ASYNC calls are only possible using separate ECIInteractions. Only one ASYNC call can be in progress at any one time on an ECIInteraction. Also there cannot be any transaction context associated with the ECIInteraction for concurrent ASYNC calls to be possible.

  • Field Summary

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

    Modifier and Type
    Method
    Description
    void
    Close the interaction and disable any further communication with CICS.
    boolean
    execute(jakarta.resource.cci.InteractionSpec spec, jakarta.resource.cci.Record in, jakarta.resource.cci.Record out)
    In order to interact with CICS this method must be used to pass the definition of the call in an ECIInteractionSpec and the input and output records that carry the data used in the interaction.
    void
    Clean up any outstanding ASYNC replies if necessary.

    Methods inherited from class com.ibm.jakarta.connector2.cics.CICSInteraction

    clearWarnings, execute, getConnection, getWarnings

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

  • Method Details

    • close

      public void close() throws jakarta.resource.ResourceException
      Close the interaction and disable any further communication with CICS. If any outstanding SYNC_RECEIVE requests exist, they are cleaned up on close(). This may cause a delay on calling the close() method.
      Specified by:
      close in interface jakarta.resource.cci.Interaction
      Overrides:
      close in class CICSInteraction
      Throws:
      jakarta.resource.ResourceException
    • execute

      public boolean execute(jakarta.resource.cci.InteractionSpec spec, jakarta.resource.cci.Record in, jakarta.resource.cci.Record out) throws jakarta.resource.ResourceException

      In order to interact with CICS this method must be used to pass the definition of the call in an ECIInteractionSpec and the input and output records that carry the data used in the interaction.

      All SYNC_SEND requests made through an ECIInteraction must be followed by a SYNC_RECEIVE request. Any attempt to make a SYNC_SEND or SYNC_SEND_RECEIVE directly after a SYNC_SEND will result in an exception being thrown.

      Parameters:
      spec - An ECIInteractionSpec detailing the interaction to be made with CICS.
      in - The input data
      out - The output data
      Returns:
      Whether the call completed successfully or not.
      Throws:
      jakarta.resource.ResourceException - Thrown if there was a problem during the interaction with CICS.
    • finalize

      public void finalize()
      Clean up any outstanding ASYNC replies if necessary.