IBM Support

CA5F: IBM CICS TG 'gateway' intercept plug-in support

Downloadable files


SupportPac CA5F allows integration test tools to intercept ECI calls to CICS Transaction Gateway (CICS TG) from Java applications before they are processed by CICS TG.

Download Description

This SupportPac, CA5F, allows integration test tools to intercept External Call Interface (ECI) calls to IBM CICS Transaction Gateway (CICS TG), originating from Java Standard Edition (Java SE) and Java Enterprise Edition (JEE) applications. This, therefore, allows such applications to be tested without requiring a running CICS TG or CICS Transaction Server.

This SupportPac provides updated versions of the CICS TG V8.0 Java base classes and non-extended architecture (non-XA) ECI resource adapter. These updated files support the use of a Gateway intercept plug-in that can intercept application calls made through the Java Application Programming Interfaces (APIs). Documentation for the APIs is also provided by this SupportPac.

When enabled, a Gateway intercept plug-in is notified before a connection to a Gateway daemon is opened or closed, and before a request is sent to the Gateway daemon. Before a connection is opened, the plug-in can change properties of the connection object, and can prevent the connection from opening. Before a request is sent over a connection, the plug-in can change properties of the request object, and can cause the request to be returned to the application without being sent. Before a connection is closed, the plug-in can prevent the connection from closing. This allows a variety of scenarios to be simulated for application testing.

Possible uses:
Allows CICS interactions to be simulated for the purposes of application testing, without requiring a running CICS server or CICS Transaction Gateway.

Skill level required:
Plug-in developers must be familiar with developing applications in Java.

What's new in this release (V1.2)?

  • Updated details in the supporting documentation, under heading "Enabling a Gateway Intercept Plug-in in a JEE environment", relating to the isolation of the installed resource adapters from each other, when installing both cicseci.rar and cicsepi.rar into the same WebSphere Application Server.
  • No changes are required to the SupportPac execution code.

Author: Andrew Smithson, CICS TG Development, IBM Hursley, UK.
Category: 3
Released: 10Dec12
Last updated: 24Oct14
Current Version: 1.2


IBM CICS Transaction Gateway for z/OS V8.0, or later.
IBM CICS Transaction Gateway for Multiplatforms V8.0, or later.

For Java SE applications, Java 1.5 or later is required.

For JEE applications, a J2EE 1.4 certified application server or a JEE 5 certified application server that successfully runs the JCA resource adapter Install Verification Test (IVT), provided with CICS TG, is required.

Usage is restricted to remote mode topologies for JEE or Java applications. Java applications using the Java base classes must ensure that the only CICS TG jar file on their classpath is the version of ctgclient.jar provided by this SupportPac.

CA5F.pdf (ReadMe) US English 137705

Download package

To download the SupportPac:

  1. Click on the link in the table below, under Download Options, and save the file to your local machine.
  2. Extract the saved file to a temporary directory on your target machine. This will create the necessary installation files.
  3. Follow the instructions in the included documentation to complete installation of this SupportPac.

Download RELEASE DATE LANGUAGE SIZE(Bytes) Download Options 24 Oct 2014 US English 14693888 HTTP

Technical support

SupportPacs in this category are available at no charge to all licensed users of the CICS family products on the platforms specified in the SupportPac description. They are supplied under the standard terms and conditions of the IBM International Program License Agreement (IPLA) and of the associated License Information and other documentation, and provide a defect correction entitlement for those licensed users entitled to service for CICS family products. Service is available for this SupportPac for as long as the CICS product with which the SupportPac is to be used is generally supported by IBM. In addition, IBM reserves the right to discontinue service on this SupportPac when it is withdrawn from marketing by IBM.

Please read the license file that accompanies the SupportPac, to determine if you want to use it.

Other CICS SupportPacs
To view the complete portfolio of CICS SupportPacs, go to the CICS SupportPacs Home Page

Product Alias/Synonym


Document information

More support for: CICS Transaction Gateway

Software version: 8.0, 8.1, 9.0

Operating system(s): AIX, HP-UX, Linux, Solaris, Windows, z/OS

Reference #: 4033968

Modified date: 31 October 2014