The IAF configuration file

An IAF configuration file is an essential part of any adapter generated with the IAF.

The configuration file must be formatted in XML, and the Document Type Definition (DTD) for it is iaf_4_0.dtd, which is located in the etc directory of your installation. You may wish to use this DTD in conjunction with your XML editor to assist you in writing a correctly formatted configuration file.

The configuration file is loaded and processed when the adapter process starts. A running adapter can by signaled to reload and reprocess the configuration file at any time, by running the iaf_client tool with the –r or --reload option.

On UNIX platforms a SIGHUP signal sent to the IAF process re-opens the log file.

The root element in the configuration file is <adapter-config>. This must always be defined. Within it a single instance of the following elements must exist:

<transports> - This element defines the transport layer plug-in(s) to be loaded.

<mapping> - Defines the mapping rules for the Semantic Mapper layer, which are used in the conversion between codec layer normalized messages and correlator events.

Following those elements, there must be at least one of the following elements. It is also possible to specify one of each of these elements:

<apama> - Defines how the IAF connects to the Apama correlator(s).

<universal-messaging> - Defines how the IAF connects to Software AG's Universal Messaging message bus.

Use of Universal Messaging from the IAF is deprecated and will be removed in a future release.

There are also three optional elements that can appear before these required elements (in order):

<logging> - Defines the log file and logging level used by the IAF.

<plugin-logging> - Defines the log file and logging level used by the transport and codec layer plug-ins.

<java> - Defines the environment of the embedded Java Virtual Machine (JVM) in which any Java codec and transport plug-ins will run.

Each of these elements is discussed in more detail in the following sections.