Table of Contents
Just a second...

JMSAdapter51.xml

This file specifies the schema for the configuration required by the JMS Adapter. Note that JMS topics and queues are referred to only as destinations. Topics refers exclusively to Diffusion topics.

jms-config

The following table lists the elements that an element of type jms-config can contain:
Name Type Description Min occurs Max occurs
binding binding   1 1
mapping mapping   1 1

binding

The following table lists the elements that an element of type binding can contain:
Name Type Description Min occurs Max occurs
env env   1 1
connection-factory connection-factory A collection of properties required to create an InitialContext to access the JNDI configuration of the JMS server. 1 1
root-topic push:string The JMS Adapter uses the topic name specified here as the top-level Diffusion topic, with all subtopics appearing as children beneath it. 1 1
priority priority Specify how JMS message priorties (in the range 0-9) map to Diffusion message priorities high, normal or low. 0 1
queue-distribution-mode push:jmsQueueDistributionMode Messages received from JMS queues are only sent to one Diffusion client. This element allows the distribution strategy to be chosen from RANDOM (choose any client) or SMALLEST_QUEUE (choose the client with the fewest pending messages in its queue from Diffusion). 1 1
topic-aliases topic-aliases This element is not currently used. 0 unbounded

mapping

The following table lists the elements that an element of type mapping can contain:
Name Type Description Min occurs Max occurs
artefact-names artefact-names Diffusion topic names and JMS destination names can both contain different reserved characters. The attributes on this element create a substitution table of characters. If a Diffusion topic name contains a character in the 'diffusion' attribute, it is replaced with the character in the same position of the 'jms' attribute when translating to a JMS topic or queue name (and vice-versa). 1 1
topic-map jms-artefact-map This element is not currently used. 0 unbounded
queue-map jms-artefact-map This element is not currently used. 0 unbounded

env

The following table lists the elements that an element of type env can contain:
Name Type Description Min occurs Max occurs
property property This element represents a property which is supplied when creating the JNDI object (InitialContext) from which JMS resources are obtained. 0 unbounded

connection-factory

Details for resolving the ConnectionFactory object from the nominated JNDI server.

The following table lists the attributes that an element of type connection-factory can have:
Name Type Description Required
name push:string   false
The following table lists the elements that an element of type connection-factory can contain:
Name Type Description Min occurs Max occurs
credentials credentials Username and password pair (optional), used when creating the JMS Connection from the ConnectionFactory. 0 1
reconnect reconnect This element is supplied to control the reconnection policy for the initial connection between Diffusion and the JMS server, and any subsequent reconnections that might be necessary. 0 1

jms-artefact-map

The following table lists the attributes that an element of type jms-artefact-map can have:
Name Type Description Required
jms push:string   true
descendants push:boolean   false

artefact-names

The following table lists the attributes that an element of type artefact-names can have:
Name Type Description Required
jms push:string   true
diffusion push:string   true

property

A named string property

The following table lists the attributes that an element of type property can have:
Name Type Description Required
name push:string The property value true

credentials

The following table lists the attributes that an element of type credentials can have:
Name Type Description Required
username push:string   false
password push:string   false

priority

The following table lists the attributes that an element of type priority can have:
Name Type Description Required
low push:jmsMessagePriority   false
high push:jmsMessagePriority   false

topic-aliases

The following table lists the elements that an element of type topic-aliases can contain:
Name Type Description Min occurs Max occurs
topic topic   0 unbounded

topic

The following table lists the attributes that an element of type topic can have:
Name Type Description Required
name push:string   true
alias push:string   true

reconnect

The following table lists the elements that an element of type reconnect can contain:
Name Type Description Min occurs Max occurs
max-reconnections push:int When attempting a connection between Diffusion and the JMS server, this parameter specifies how many attempts can be made before giving up. A value of -1 (the default) means to retry forever. 1 1
interval push:millis This parameter specifies how long to wait between reconnection attempts between Diffusion and the JMS server. 1 1