Use Azure Service Bus with JMS

This article applies to: ✔️ Version 4.17.0 ✔️ Version 5.11.0

This article describes how to use Azure Service Bus with the JMS API integrated into the Spring JMS framework.

You have to provide an Azure Service Bus connection string, which is parsed into the login username, password, and remote URI for the AMQP broker.

Dependency setup

Add the following dependencies if you want to migrate your Spring JMS application to use Azure Service Bus.

<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-starter-servicebus-jms</artifactId>
</dependency>

Configuration

The following table describes the configurable properties when using the Spring JMS support:

Property	Description
spring.jms.servicebus.connection-string	The Azure Service Bus connection string, for when you want to provide the connection string directly.
spring.jms.servicebus.topic-client-id	The JMS client ID. Only works for the topicJmsListenerContainerFactory bean.
spring.jms.servicebus.enabled	A value that indicates whether to enable Servive Bus JMS autoconfiguration. The default value is true.
spring.jms.servicebus.idle-timeout	The connection idle timeout duration that indicates how long the client expects Service Bus to keep a connection alive when no messages are delivered. The default value is 2m.
spring.jms.servicebus.pricing-tier	The Azure Service Bus Price Tier. Supported values are premium and standard. Premium tier uses Java Message Service (JMS) 2.0, while standard tier use JMS 1.1 to interact with Azure Service Bus.
spring.jms.servicebus.listener.reply-pub-sub-domain	A value that indicates whether the reply destination type is a topic. Only works for the topicJmsListenerContainerFactory bean.
spring.jms.servicebus.listener.phase	The phase in which this container should be started and stopped.
spring.jms.servicebus.listener.reply-qos-settings	Configures the QosSettings to use when sending a reply.
spring.jms.servicebus.listener.subscription-durable	A value that indicates whether to make the subscription durable. Only works for the topicJmsListenerContainerFactory bean. The default value is true.
spring.jms.servicebus.listener.subscription-shared	A value that indicates whether to make the subscription shared. Only works for the topicJmsListenerContainerFactory bean.
spring.jms.servicebus.pool.block-if-full	A value that indicates whether to block when a connection is requested and the pool is full. Set it to false to throw a JMSException instead.
spring.jms.servicebus.pool.block-if-full-timeout	The blocking period before throwing an exception if the pool is still full.
spring.jms.servicebus.pool.enabled	A value that indicates whether a JmsPoolConnectionFactory should be created, instead of a regular ConnectionFactory.
spring.jms.servicebus.pool.idle-timeout	The connection pool idle timeout.
spring.jms.servicebus.pool.max-connections	The maximum number of pooled connections.
spring.jms.servicebus.pool.max-sessions-per-connection	The maximum number of pooled sessions per connection in the pool.
spring.jms.servicebus.pool.time-between-expiration-check	The time to sleep between runs of the idle connection eviction thread. When negative, no idle connection eviction thread runs.
spring.jms.servicebus.pool.use-anonymous-producers	A value that indicates whether to use only one anonymous MessageProducer instance. Set it to false to create one MessageProducer every time one is required.
spring.jms.servicebus.prefetch-policy.all	The fallback value for the prefetch option in this Service Bus namespace. The default value is 0.
spring.jms.servicebus.prefetch-policy.durable-topic-prefetch	The number of prefetch for durable topic. The default value is 0.
spring.jms.servicebus.prefetch-policy.queue-browser-prefetch	The number of prefetch for queue browser. The default value is 0.
spring.jms.servicebus.prefetch-policy.queue-prefetch	The number of prefetch for queue. The default value is 0.
spring.jms.servicebus.prefetch-policy.topic-prefetch	The number of prefetch for topic. The default value is 0.

Note

Spring JMS general configuration is omitted for short.

For more information, see Spring JMS Document.

Basic usage

Use Service Bus connection String

The simplest way to connect to Service Bus for Spring JMS application is with the connection string.

Add the following properties and you're good to go.

spring:
  jms:
    servicebus:
      connection-string: ${AZURE_SERVICEBUS_CONNECTION_STRING}
      pricing-tier: ${PRICING_TIER}

Note

The default enabled ConnectionFactory is the CachingConnectionFactory, which adds Session caching as well as MessageProducer caching. If you want to activate the connection pooling feature of JmsPoolConnectionFactory, set spring.jms.servicebus.pool.enabled to true. You can find other pooling configuration options (properties with prefix spring.jms.servicebus.pool.) in the Configuration section.

Samples

For more information, see the azure-spring-boot-samples repository on GitHub.