StreamBase JMS Configuration File Editor

The Connection Type defaults to JNDI (Java Naming and Directory Interface), as shown below.

The following table describes how the JNDI Connection Type options correspond to <jms-server> attributes and the default values provided.

The Advanced JNDI Options, sometimes needed to establish the proper InitialContext for JNDI lookups, Are shown below. They have no defaults.

The following table describes how the Advanced JNDI Options correspond to <jms-server> attributes.

When you select a Direct Connection Type, the editor shows the following options:

The following table describes how the Direct Connection Type options correspond to <jms-server> attributes and the default values provided.

You must provide a connection factory class name to instantiate. It is assumed that this class implements a constructor taking one String parameter that represents the URL of the JMS broker, which you must also specify if it is not localhost.

The following table describes the how the Connection Options properties correspond to <jms-server> attributes and gives their interpretations.They are all strings. Specifying any of these settings is optional.

As mentioned in Server and Destinations Settings: Server above, each server and each destination within it must have a unique name. After you add a server in the upper left part of the Servers/Destinations view and provide a name for it in the Server Overview section, configure the options common to all destinations on that server in the Destination Options area on the lower left corner of the Servers/Destinations view. These options are illustrated below, showing their defaults.

The following table describes the how the Destination options settings correspond to <jms-server> or <destinations> attributes and gives their interpretations. All have default values.

For JMS and EMS input adapters, the settings you can make for each destination are shown below, for a destination that has been named Input_destination1. Defaults are shown except for the Name Map (see Field Map Settings, below).

The following table describes the how the Destination options correspond to <destination> attributes and gives their interpretations. Only Message Converter and Timestamp Format have default values.

The three types of field maps are discussed in the following sections. For additional information on conversions between JMS and EMS messages and StreamBase tuples, see Message Translation.

For JMS and EMS output adapters, the settings you can make for each destination are shown below for a destination that has been named Output_destination1. Defaults are shown except for the Name Map (see Field Map Settings, below).

The settings (Name, Message Converter, Custom Converter Settings, and Timestamp Format) mimic those described above in Destination Settings for Input Adapters. The other options differ. The following table describes all the output destination options.

For information on conversions between JMS and EMS messages and StreamBase tuples, see Message Translation.

You can map a field on a MapMessage to a field on a StreamBase schema that has a different name. A set of such mappings is called a Name Map. Name Maps are bi-directional and can contain any number of fields. You can define as many name maps as you need, but only one can be in effect per destination.

Create a new Name Map by clicking the Plus button on the left under Name Maps and entering a name to identify the map. Then, on the field grid to the right, add a row for each mapping. Enter the JMS Field name in the first entry and the corresponding StreamBase field name in the second entry. The following illustration shows a name map with three equivalences.

This particular mapping defines a name map called ambrosia that maps three different JMS fields into the same StreamBase field, called Sweetener. When you save the .jmsconf file, name maps you defined are added as <name-map> elements. The ambrosia name map from the above example adds the following XML, which you see in the Source view:

  <name-maps>
    <name-map name="ambrosia">
      <mapping jms-name="Honey" sb-name="Sweetener"/>
      <mapping jms-name="MapleSyrup" sb-name="Sweetener"/>
      <mapping jms-name="Sugar" sb-name="Sweetener"/>
    </name-map>
  </name-maps>

You select mappings to use in the Field Maps - Destination area of the Destination view, as shown below.

To delete a name map, select its name and click the X button above the field grid. This action cannot be undone.

A JMS message is delivered with a set of standard JMS header fields. Header fields can be mapped to StreamBase fields using a named <jms-header-map> element. You define header maps as you do name maps, by adding a name for each one on the Header Map field grid on the left and providing one or more field equivalences on the right-hand field grid. Each destination you configure can use a different header map.

To delete a name map, select its name and click the X button above the field grid. This action cannot be undone.

Either a JMS provider or a message creator can add properties to a JMS message. Properties can be thought of as provider- or user-defined headers. You can define maps to associate one or more properties with StreamBase fields. Esch mapped JMS property causes the value of the property to be written to the StreamBase field. Each configured destination can use a different property map. In a configuration file, property maps are named <jms-property-map> elements.

Add and remove property maps in the Property Maps area of the Field Maps view, in the same manner as name and header maps.