What happens when an API exit runs?

 

The API exit routines to run are specified in stanzas in .ini files or in the Windows registry. We can specify an exit routine in three ways:

  1. ApiExitCommon, in the mqs.ini file, identifies routines, for the whole of WebSphere MQ, applied when queue managers start up. These can be overridden by routines defined for individual queue managers (see item 3 in this list).

  2. ApiExitTemplate, in the mqs.ini file, identifies routines, for the whole of WebSphere MQ, copied to the ApiExitLocal set (see item 3 in this list) when a new queue manager is created.

  3. ApiExitLocal, in the qm.ini file, identifies routines that apply to a particular queue manager.

When a new queue manager is created, the ApiExitTemplate definitions in mqs.ini are copied to the ApiExitLocal definitions in qm.ini for the new queue manager. When a queue manager is started, both the ApiExitCommon and ApiExitLocal definitions are used. The ApiExitLocal definitions replace the ApiExitCommon definitions if both identify a routine of the same name. The Sequence attribute, described in the WebSphere MQ System Administration Guide determines the order in which the routines defined in the stanzas run.

 

Parent topic:

Introducing API exits


fg14150_