Package com.ibm.connector2.cics

Provides classes for developing JEE applications.

See: Description

  • Interface Summary 
    Interface Description
    CICSLogTraceLevels
    This interface contains the trace level enumerations.
    EPIFieldRecord
    This interface provides access to information about a specific field retrieved from the EPI screen record.
    EPIScreenRecord
    This interface represents a screen, and provides methods for querying information about the screen and for retrieving fields from the screen.
  • Class Summary 
    Class Description
    AIDKey
    This class represents an AID character to be sent to CICS.
    CCILocalTransaction
    A CCILocalTransaction object is used to control the Transaction state of the ECI Connector.
    CICSConnection
    This abstract class provides the general CICS connection class.
    CICSConnectionFactory
    This abstract class provides the framework for CICS connection factories.
    CICSConnectionMetaData
    This class contains the connection metadata as defined in the JEE Connector specification.
    CICSConnectionSpec
    Framework class for the connection spec.
    CICSInteraction
    Framework abstract class for Interaction.
    CICSInteractionSpec
    This abstract class allows you to set the values for a general CICS request.
    CICSManagedConnectionFactory
    Abstract class that provides the managed connection factory framework for CICS resource adapters.
    CICSResourceAdapterMetaData
    This class provides information about the specific CICS resource adapter.
    ECIChannelRecord
    ECIChannelRecord is part of the API for Channels and Containers support for the CICS ECI Resource Adapter.
    ECIConnection
    The ECIConnection class represents a connection to CICS.
    ECIConnectionFactory
    The ECIConnectionFactory allows a client component to request a connection to CICS.
    ECIConnectionSpec
    When a client component wants an ECIConnection with specific properties to be returned by an ECIConnectionFactory.getConnection(javax.resource.cci.ConnectionSpec) call then an ECIConnectionSpec is used to wrap these properties.
    ECIInteraction
    The ECIInteraction class is used to control interaction with CICS via the ECIConnection object.
    ECIInteractionSpec
    The ECIInteractionSpec class is used to define some details of the interaction with CICS, including the COMMAREA length and execute timeout.
    ECIManagedConnectionFactory
    An ECIManagedConnectionFactory is used to create physical ECI connections to the CICS Transaction Gateway.
    ECIResourceAdapterRc
    This class contains all the return code enumerations from all the exceptions that could be thrown within the ECI Resource Adapter.
    EPIConnection
    EPIConnection represents the application level connection to a CICS Terminal.
    EPIConnectionFactory
    Use an instance of this class to request EPI Connections.
    EPIConnectionSpec
    The EPI connection spec allows you to specify extra or different properties on the connection you require.
    EPIInteraction
    An EPIInteraction is used to interact with the terminal requested from the connection factory.
    EPIInteractionSpec
    This class allows you to set the values for a CICS EPI request.
    EPIManagedConnectionFactory
    An EPIManagedConnectionFactory is used to create physical EPI connections to the CICS Transaction Gateway.
    EPIResourceAdapterRc
    This class contains all the return code enumerations from all the exceptions that could be thrown within the EPI Resource Adapter.
  • Exception Summary 
    Exception Description
    CICSTxnAbendException
    This exception is thrown if the CICS transaction has ended abnormally (abended).
    CICSUserInputException Deprecated
    since CICS TG v6.0, replaced by InvalidPropertyException
    EPITranFailedException
    This exception can be thrown by the EPI classes when an error occurs.
    LocalTransactionNotStartedException
    This exception is thrown when the ECIManagedConnection attempts to end a transaction which has not been started

Package com.ibm.connector2.cics Description

Provides classes for developing JEE applications.

A typical JEE application first obtains a connection factory from the JEE application server, and uses the connection factory to acquire a connection, either an ECIConnection or an EPIConnection. Once the connection has been acquired, an Interaction object can be obtained from the connection. Depending on the connection type, this Interaction will be an instance of ECIInteraction or EPIInteraction and will provide an execute method which sends data to CICS and receives the returned data from CICS. Custom properties can be set on this Interaction via the creation of an appropriate InteractionSpec (ECIInteractionSpec or EPIInteractionSpec).

(These classes are not available in the CICS Transaction Gateway Desktop Edition).

(The EPI resource adapter is not available in CICS Transaction Gateway for z/OS).

©Copyright IBM Corp. 1994, 2013
Legal