The CCI Connector for CICS® TS provides implementations of the input/output classes. Use
these CICS-specific classes (ECIConnectionSpec and ECIInteractionSpec) rather than the standard ConnectionSpec and InteractionSpec classes.
For guidance information about programming the CICS-specific classes, see
the
CICS Transaction Gateway: Programming
Guide. For reference information,
see the CICS Javadoc generated from the
ECIConnectionSpec and
ECIInteractionSpec classes in the
CCI Connector for CICS TS: Class Reference. Special considerations that
apply to the CCI Connector for CICS TS are listed below.
Note: Specifying a property
or value described as “not supported by CICS TS” results in an exception.
Specifying a property or value described as “ignored by CICS TS” has
no effect.
- ECIConnectionSpec
- This class allows the J2EE component to pass security credentials different
from those defined for the connection factory. Properties
include:
- Password
- The password for the userid specified in UserName.
Ignored by CICS TS.
- UserName
- The userid to be used to access CICS. Ignored by CICS TS.
- ECIInteractionSpec
- This class holds all the interaction-relevant attributes (for example,
the name of the target program and the mode of the interaction—synchronous
or asynchronous) necessary for an interaction with CICS. It is a required
parameter on each Interaction.execute() method call.
Its properties are:
- InteractionVerb
- The mode of the call to CICS—synchronous or asynchronous. The CCI Connector for CICS TS supports
only the following:
- SYNC_SEND_RECEIVE
- A synchronous call. This is used to link to a CICS program.
- FunctionName
- The name of the program to execute on CICS. The CCI Connector for CICS TS requires you to specify FunctionName.
Note: FunctionName can refer to either a local or a remote program. The PROGRAM definition
in the local region should specify the location of the server program (local
or remote) and, if it's remote, whether or not dynamic routing should
occur.
- ExecuteTimeout
- The timeout value for interactions with CICS.
- 0
- No timeout. This is the default value, and the only value supported
by CICS TS.
- A positive integer
- The length of time in milliseconds. Ignored by CICS TS.
- CommareaLength
- The length of the communications area (COMMAREA) being passed to CICS
inside your input record. If this is not supplied, the default used by the CCI Connector for CICS TS is
the length of the input record data.
- ReplyLength
- The amount of data you want back from CICS. Where only a small amount
of a large returned COMMAREA is required by your enterprise bean or Java component,
you can use this setting to cut down on network bandwidth. If not supplied,
the default is to receive all data in the COMMAREA.
Note: You are
recommended not to set ReplyLength. Because the CCI Connector for CICS TS always
runs in local mode—that is, the enterprise bean or Java component that
calls the connector executes on the same CICS region as the connector itself—there
is no network flow to consider and therefore no need to receive less than
the whole reply.
- Record
- For input and output, the CCI Connector for CICS TS supports only Record classes that implement the javax.resource.cci.Streamable interface. This allows the connector to read and write the streams
of bytes that make up CICS COMMAREAs directly to and from the Record objects supplied to the execute() method
of ECIInteraction.
For further information about
using the javax.resource.cci.Streamable interface to build input
records and retrieve byte arrays from output records, see the CICS Transaction Gateway: Programming Guide.