How to Connect to Microsoft Azure Service Bus with the JMS Connector

Document created by brian_otoole Employee on May 3, 2016Last modified by Adam Arrowsmith on May 3, 2016
Version 4Show Document
  • View in full screen mode

This article outlines how to configure the JMS Connector using the Apache Qpid libraries to connect to Microsoft Azure Service Bus.

 

 

Use Case

Provide the ability to publish and or retrieve messages to and from a Microsoft Azure Service Bus Queue for the purpose of message exchange with Dell Boomi AtomSphere.

 

Approach

The approach is to use the standard JMS Connector with a custom connection factory referencing components from the Apache Qpid™ project to integrate with an Azure Service Bus Queue. The approach consists of the following:

  1. Use the JMS Connector within a Dell Boomi AtomSphere integration process to LISTEN, GET or SEND documents. This example uses LISTEN.
  2. Utilize a JMS Server type of Generic JNDI which allows for a choice of JMS providers. This solution uses client libraries from Qpid JMS - Apache Qpid™.
  3. Locally managed property file contains all necessary connection details for the Azure Message Bus.
  4. A local Atom must be used to import third party libraries required by the connector.

 

Additional Reference

 

Implementation

The following steps detail how to deploy the JMS Connector with Azure Service Bus Queues.

  1. Download and the required JAR files to your Local Atom and restart the Atom.
  2. Obtain Service Bus Queue connection details from Microsoft Azure.
  3. Create a local properties file containing connection details for the Azure Service Bus Queue.
  4. Add a JMS Connector shape to your process.
  5. Create a JMS Connection component defining your own connection factory by referencing an initial context and provider path.
  6. Create a JMS Operation component that references the queue name specified in the properties file.

 

1. Atom Setup and Required Jars

Download and add the following jars to your local Atom under ../<atom_install_root>/userlib/jms. Restart the Atom.

 

2. Obtain Service Bus Queue Details from Microsoft Azure

Navigate to the Service Bus menu item along the left of Microsoft Azure Portal:

 

 

Open your Queue and select Configure:

 

 

Note the Policy Name and Primary Key values under Shared Access Policies for use in the properties file configuration below.

 

The values will be concatenated together into an AMQPS connection string as such:

     amqps://sendpolicy:Y7f4gJbX1i4mYQbShhpFo0e8XuzPk1UHWEdLn9zHhPU%3D@dellboomibrian.servicebus.windows.net

 

3. Create Local Properties File

Create a file named servicebus.properties on your Atom server. Note the full path for use in the JMS Connection configuration below.

 

Configure:

  1. The connectionfactory.SERVICEBUSCONNECTIONFACTORY property with the AMQPS connection string from above
  2. Add and configure a queue.[jndiName = [physicalName] line for each Azure queue you wish to connect

 

# Register a ConnectionFactory in JNDI using the form:
# connectionfactory.[jndiName] = [ConnectionURL]
connectionfactory.SERVICEBUSCONNECTIONFACTORY = amqps://sendpolicy:Y7f4gJbX1i4mYQbShhpFo0e8XuzPk1UHWEdLn9zHhPU%3D@dellboomibrian.servicebus.windows.net

# Register some queues in JNDI using the form:
# queue.[jndiName] = [physicalName]
queue.QUEUE = samplequeue
# queue.QUEUE2 = samplequeue2
# ...

 

4. Add a Connector Shape

Available actions include: LISTEN, GET and SEND

 

 

5. Create the Connection

  • JMS Server Type = Generic JNDI
  • Connection Factory JNDI Lookup = SERVICEBUSCONNECTIONFACTORY (connectionfactory.[jndiName] from properties file)
  • Initial Context Factory =  org.apache.qpid.amqp_1_0.jms.jndi.PropertiesFileInitialContextFactory

  • Provider URL = C:\boomi\servicebus.properties (full path including file name to properties file)

 

 

6. Create the Operation

For Destination use the queue.[jndiName] from servicebus.properties file:

 

Queue.QUEUE = samplequeue

 

 

Usage Considerations

  1. Processes cannot be deployed to the hosted Dell Boomi Atom Cloud because of the required external jar files.
  2. The same servicebus.properties file can be use for multiple deployed Service Bus Queues. An Atom restart is NOT required if you need to modify the properties to add additional queues for example.
  3. JMS Connector Operation settings should be reviewed for environment specific requirements.
  4. The naming conventions for Connection Factory Name, property file, and queue names used above are arbitrary.
5 people found this helpful

Attachments

    Outcomes