The CICS-WebSphere MQ API-crossing exit

CICS® provides an API-crossing exit for use with the CICS-WebSphere MQ adapter. You can use this exit to intercept WebSphere® MQ calls as they are being run, for monitoring, testing, maintenance, or security purposes. The exit runs in the CICS address space.

This section contains product-sensitive programming interface information.

You can use the CICS-WebSphere MQ API-crossing exit for these purposes:
  • Operate additional security checks by examining the contents of each message before and after each MQI call
  • Replace the queue name supplied in the message with another queue name
  • Cancel the call and either issue a return code of 0 to simulate a successful call or another value to indicate that the call was not performed
  • Monitor the use of MQI calls in an application
  • Gather statistics
  • Modify input parameters on specific calls
  • Modify the results of specific calls
Using the CICS-WebSphere MQ API-crossing exit degrades WebSphere MQ performance. Plan your use of it carefully.

The CICS-WebSphere MQ API exit program is called CSQCAPX. CICS supplies a sample exit program, and a program definition for CSQCAPX in group DFHMQ. To use the exit, this program must be in the DFHRPL concatenation, it must be defined in the CICS system definition file (CSD), and it must be enabled. You can write your own exit program in place of the supplied sample, and you must call your program CSQCAPX as well.

When CSQCAPX is loaded, a confirmation message is written to the CICS-WebSphere MQ adapter control panel, CKQC, or the console. If it cannot be loaded, a diagnostic message is displayed, but otherwise the application program runs normally.

Note: The supplied definition of CSQCAPX specifies the parameter CONCURRENCY(THREADSAFE). If you write your own exit program, specify CONCURRENCY(THREADSAFE) when you define it, and use only threadsafe CICS commands in the exit. Also specify this setting, and use only threadsafe CICS commands, for any programs that your exit program calls. Examine any API-crossing exits written in earlier CICS releases to ensure that their logic is threadsafe.


zs11390_.html | Timestamp icon Last updated: Monday, 5 June 2017