MuleSoft Application Development With JMS Queue Explained: Part One

Introduction

This article has two parts. This is the first part. In this part, I will demonstrate how to setup the basic flow, which involves jms inbound and outpoint points. In the mule flow, JMS the outbound-endpoint is the message producer. On the other hand, the JMS inbound-endpoint is the message consumer. The key concepts covered in this article are the following:

• How to set JMS properties in Mule flow
• How to configure ActiveMQ connectors
• How to configure JMS inbound- and outbound-endpoints

For JMS, Mule support one-way and request-response exchange patterns. This part covers the one-way exchange pattern. The next part will cover the request response pattern.

ActiveMQ Connector Setup

In the Mule integration with JMS brokers like ActiveMQ, the first step is to configure the JMS connector as show the following figure.

The general tab as shown in the next figure has the connector name, brokerurl, and access to ActiveMQ credentials.

You should also pay attention to the Advanced tab. In this tab, you can configure JNDI, durable consumer, or define the PERSISTENT delivery mode, etc.. Mule has default values for all these advanced configuration.

If you want to change the delivery mode from NON-PERSISTENT to PERSISTENT, you will need to check the persistence delivery. By default, mule create 4 consumers for each queue, you may adjust that value as well accordingly.

Configure The Mule Flow With One-Way Exchange Pattern

The main purpose of this basic configuration is to demonstrate how to build mule flows to publish and consume jms message. Another point I want to make is that how Mule set the outpond properties to JMS properties.

The Use Case

• A client will invoke a RESTful service
• The client will send a JSON Payload
• ESB will perform the following:
1. transform the json to java LinkedHashMap
2. set JMS header source_id
3. publish the message to a queue
• A second flow: Process_Order_Flow listen on the order.queue
• log the payload
• send the payload to another queue: order.special.queue The json example is provided as the following:
  ?

  1 2 3 4 5 6 7 8 9 10 11 12 13 14

  { "name"   : "John Smith",   "sku"    : "20223",   "price"  : 23.95,   "shipTo" : { "name" : "Jane Smith",                "address" : "123 Maple Street",                "city" : "Pretendville",                "state" : "NY",                "zip"   : "12345" },   "billTo" : { "name" : "John Smith",                "address" : "123 Maple Street",                "city" : "Pretendville",                "state" : "NY",                "zip"   : "12345" } }

  Configure The Mule Flow For One-Way

  The Mule Flow Diagram is shown as the following:
  
  The xml configuration for the flow is listed as the following:
  ?

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

  <!--xml version="1.0" encoding="UTF-8"?-->   <mule xmlns:dw="http://www.mulesoft.org/schema/mule/ee/dw" xmlns:http="http://www.mulesoft.org/schema/mule/http" xmlns:jms="http://www.mulesoft.org/schema/mule/jms" xmlns:tracking="http://www.mulesoft.org/schema/mule/ee/tracking" xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemalocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-current.xsd http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd http://www.mulesoft.org/schema/mule/jms http://www.mulesoft.org/schema/mule/jms/current/mule-jms.xsd http://www.mulesoft.org/schema/mule/ee/tracking http://www.mulesoft.org/schema/mule/ee/tracking/current/mule-tracking-ee.xsd http://www.mulesoft.org/schema/mule/ee/dw http://www.mulesoft.org/schema/mule/ee/dw/current/dw.xsd">     <flow name="Simple-One-Way-Main_Flow">         <http:listener config-ref="HTTP_Listener_Configuration" path="/jms/oneway" doc:name="HTTP">         <dw:transform-message doc:name="Transform Message">             <dw:set-payload><!--[CDATA[%dw 1.0 %output application/java --- payload]]--></dw:set-payload>         </dw:transform-message>         <set-property propertyname="source_id" value="#[message.inboundProperties.source_id]" doc:name="Property">         <jms:outbound-endpoint queue="order.queue" connector-ref="Active_MQ" doc:name="Order Queue Producer">             <jms:selector expression="source_id='ATG'">         </jms:selector></jms:outbound-endpoint>               </set-property></http:listener></flow>           <flow name="Process_Order_Flow">         <jms:inbound-endpoint queue="order.queue" connector-ref="Active_MQ" doc:name="Order Queue Consumer">             <jms:selector expression="source_id='ATG'">         </jms:selector></jms:inbound-endpoint>         <logger message="Process_Order_Flow CID: #[message.correlationId]" level="INFO" doc:name="Logger">         <jms:outbound-endpoint queue="order.special.queue" connector-ref="Active_MQ" doc:name="Special Queue Producer">     </jms:outbound-endpoint></logger></flow> </mule>

  Message Selector

  We can add jms message selector to either jms inbound-endpoint or outbound-endpoint as shown below. However, it only takes effects on the inbound-endpoint.
  ?

  1 2 3

  <jms:outbound-endpoint queue="order.queue" connector-ref="Active_MQ" doc:name="Order Queue Producer">     <jms:selector expression="source_id='ATG'"> </jms:selector></jms:outbound-endpoint>

  Also, noted that source_id is a JMS message property. Mule copies all the outbound properties to the JMS message properties. The inbound properties are not automatically copied to the outbound properties when the flow crosses the transport boundary. You may be tempted to reply the ATG in the message selector configuration. Unfortunately, this cannot be done, because this is pre-defined in the ActiveMQ broker configuration.