Configuring the JMS monitor adapter

Adapter type: ro-adapter-jms-monitor[version]

The following table describes the configuration elements of the JMS monitor adapter.

Note

The JMS monitor adapter does not support form based adapter configuration at all. You would have to configure this adapter using the XML view. To configure the adapter, see Configuring base adapters.

JMS monitor adapter configuration node elements

Element	Description	Required
`<jndi>`	Contains JNDI properties that need to be set for a name lookup You can define multiple properties.	Yes
`<connection-factory>`	Specifies the lookup name for ConnectionFactory	Yes
`<user-name>`	Specifies the user name for JMS provider's authentication. Your environment determines whether the `<user-name>` element is required.	Conditional
`<password>`	Specifies the password that corresponds to the `<user-name>` The requirements of the user's environment determine whether the `<password>` element is required.	Conditional
`<number-of-retries>`	Specifies the number of times the JMS adapter retries to reconnect to the JMS server after the connection is lost Default value: 3	No
`<retry-wait>`	Specifies the time (in milliseconds) the adapter waits before it retries for a connection Default value: 5000 milliseconds (5 seconds)	No
`<client-id>`	Specifies the client ID to use for a durable subscription This element is required if your environment uses durable subscriptions.	Conditional
`<queues>`	Contains the list of queues to be monitored	No
`<queue>`	Contains the details of a queue	No
`<destination-context-name>`	Contains the JNDI lookup name for a queue This element is required only when a `<queue>` element is defined.	Conditional
`<maximum-messages-per-second>`	Stops flooding the message queue This parameter throttles and stops swamping BMC Atrium Orchestrator with multiple threads when a large number of messages queue up.	No
`<message-class>`	Specifies the fully qualified Java classname to be used for processing messages from a specific topic Default value: com.realops.adapter.jms. message.TextMessageprocessor Note: The `<message-class>` element and TextMessageProcesssor support the following class names: com.realops.adapter.jms.message.MapMessageProcessor: supports MapMessage com.realops.adapter.jms.message.ByteMessageProcessor: supports ByteMessage com.realops.adapter.jms.message.GenericMessageProcessor: supports TextMessage, MapMessage, and ByteMessage	No
`<topics>`	Contains the list of topics to be monitored	No
`<topic>`	Contains the details of a topic	No
`<destination-context-name>`	Contains the JNDI lookup name for a topic This element is required only when a `<topic>` element is defined. In the absence of a `<topic>` element, this element is not required.	Conditional
`<message-class>`	Specifies the fully qualified (absolute) Java classname used for processing messages from a specific topic Default value: com.realops.adapter.jms. message.TextMessageprocessor]] Note: The `<message-class>` element and TextMessageProcesssor support the following class names: com.realops.adapter.jms.message.MapMessageProcessor: supports MapMessage com.realops.adapter.jms.message.ByteMessageProcessor: supports ByteMessage com.realops.adapter.jms.message.GenericMessageProcessor: supports TextMessage, MapMessage, and ByteMessage	No
`<durable-subscriber-name>`	Specifies the durable subscription name (used to preserve messages published on a topic) for a topic This element is required only when the `<client-id>` element is defined.	Conditional
`<character-set>`	Specifies the name of the Character set used to encode or decode the characters This input applies to a dynamic target and is required if a dynamic target is used. For example, Shift_JIS supports the Japanese character set and Big5 supports the traditional Chinese character set. Default value: ISO-8859-2	No

The following figure shows an XML template for the JMS monitor adapter configuration.

XML template of the JMS monitor adapter configuration

<config>
  <jndi>
    <property name 1></property name 1>
    <property name 2></property name 2>
      ...
  </jndi>
  <connection-factory></connection-factory>
  <user-name></user-name>
  <password></password>
  <number-of-retries></number-of-retries>
  <retry-wait></retry-wait>
  <client-id></client-id>
  <queues>
    <queue> 
      <destination-context-name></destination-context-name>
      <maximum-messages-per-second></maximum-messages-per-second>
      <message-class></message-class>
    </queue>
      ...
  </queues>
  <topics>
    <topic>
      <destination-context-name></destination-context-name>
      <message-class></message-class>
      <durable-subscriber-name></durable-subscriber-name>
    </topic> 
      ...
  </topics>
  <character-set></character-set>
</config>

The following figure shows an XML sample of the JMS monitor adapter configuration.

XML sample of the JMS monitor adapter configuration

<config>
 <jndi>
  <java.naming.factory.initial>org.apache.activemq.jndi.ActiveMQInitialContextFactory
  </java.naming.factory.initial>
  <java.naming.provider.url>tcp://10.254.1.113:61616
  </java.naming.provider.url>
 </jndi>
  <connection-factory>ConnectionFactory</connection-factory>
  <number-of-retries>3</number-of-retries>
  <retry-wait>2000</retry-wait>
  <queues>
    <queue>
      <destination-context-name>dynamicQueues/queue1.activemq.queue
      </destination-context-name>
      <maximum-messages-per-second>10</maximum-messages-per-second>
      <message-class>com.realops.adapter.jms.message.ByteMessageProcessor
      </message-class>
    </queue>
  </queues>
  <topics>
    <topic>
      <destination-context-name>dynamicTopics/topicnew
      </destination-context-name>
      <message-class>com.realops.adapter.jms.message.GenericMessageProcessor
      </message-class>
    </topic>
    <topic>
      <destination-context-name>dynamicTopics/topicnewnew
      </destination-context-name>
      <message-class>com.realops.adapter.jms.message.GenericMessageProcessor
      </message-class>
    </topic>
  </topics>
      <character-set>Shift_JIS</character-set>
</config>

Page tree

Configuring the JMS monitor adapter