Configuration files for JMS

When the correlator is started with the --jmsConfig configDir option (see also Starting the correlator), it will load all XML files matching *-spring.xml in the specified configuration directory, and also all *.properties files in the same directory. (Note, the correlator will not start unless the specified directory contains at least one configuration file.)

When the correlator is started, any properties that are specified with the --config file or -Dkey=value option take precedence and override the properties defined in a connectionId-spring.properties file. An INFO message is then logged for all Spring properties that are being ignored.

Global configuration that is shared across all a correlator's connections is stored in jms-global-spring.xml, the rules for mapping between JMS messages and Apama events are stored in jms-mapping-spring.xml, and the connectionId-spring.xml files contain the configuration for each JMS broker connection added to the configuration. Each XML file can contain ${...} property placeholders, whose values come from the *.properties files. This provides a way for the configuration to be defined once in the XML files, then customized for development, UAT, and different deployment scenarios by creating separate copies of the .properties files.

When using Apama in Software AG Designer, all these files are generated automatically. A new connectionId-spring.xml and connectionId-spring.properties file is created when the JMS Configuration Wizard is used to add a JMS connection, and the most commonly used settings can be changed at any time using the correlator-integrated messaging for JMS instance editor window (which rewrites the .properties file whenever the configuration is changed). Software AG Designer makes it easy to set and edit basic configuration options with the adapter editor. In addition, the jms-global-spring.xml and connectionId-spring.xml files can be edited manually in Software AG Designer to customize more advanced configuration aspects such as advanced sender/receiver settings, logging of messages, etc. To edit the XML, open the correlator-integrated messaging for JMS editor and click on the Advanced tab; the various configuration files can be accessed through the hyperlinks on this tab. Once the editor for an XML file has been opened, you can switch between the Design and Source views using the tabs at the bottom of the editor window.

Note that unlike the other XML files, Apama does not support manual editing of the jms-mapping-spring.xml file in this release, and the format of that file may change at any time without notice. We recommend using Software AG Designer for all mapping configuration tasks.