servicebus-integration

page_type	languages	products	description	urlFragment
sample	java	azure-service-bus	Azure Spring Cloud Sample project for Service Bus Integration client library	azure-spring-integration-sample-servicebus

Spring Cloud Azure Service Bus Integration Code Sample shared library for Java

Key concepts

This code sample demonstrates how to use Spring Integration for Azure Service Bus.

Getting started

Running this sample will be charged by Azure. You can check the usage and bill at this link.

Create Azure resources

1. Create Azure Service Bus namespace, queue and topic. Please see how to create.

2. [Optional] if you want to use service principal, please follow create service principal from Azure CLI to create one.

3. [Optional] if you want to use managed identity, please follow create managed identity to set up managed identity.

Examples

1. Update application.yaml. If you choose to use service principal or managed identity, update the application-sp.yaml or application-mi.yaml respectively.

   spring:
     cloud:
       azure:
         servicebus:
           connection-string: [servicebus-namespace-connection-string]

2. Update queue name in QueueReceiveController.java and QueueSendController.java, and update topic name and subscription in TopicReceiveController.java and TopicSendController.java.

3. Run the mvn spring-boot:run in the root of the code sample to get the app running.

4. Send a POST request to service bus queue

    $ curl -X POST http://localhost:8080/queues?message=hello
   

5. Verify in your app’s logs that a similar message was posted:

   New message received: 'hello'
   Message 'hello' successfully checkpointed
   

6. Send a POST request to service bus topic

    $ curl -X POST http://localhost:8080/topics?message=hello
   

7. Verify in your app’s logs that a similar message was posted:

   New message received: 'hello'
   Message 'hello' successfully checkpointed
   

8. Delete the resources on Azure Portal to avoid unexpected charges.

Enhancement

Set Service Bus message headers

The following table illustrates how Spring message headers are mapped to Service Bus message headers and properties. When creat a message, developers can specify the header or property of a Service Bus message by below constants.

@MessagingGateway(defaultRequestChannel = OUTPUT_CHANNEL, defaultHeaders = @GatewayHeader(name = SESSION_ID,
value="group"))
public interface QueueOutboundGateway {
    void send(String text);
}

For some Service Bus headers that can be mapped to multiple Spring header constants, the priority of different Spring headers is listed.

Service Bus Message Headers and Properties	Spring Message Header Constants	Type	Priority Number (Descending priority)
ContentType	org.springframework.messaging.MessageHeaders.CONTENT_TYPE	String	N/A
CorrelationId	com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders.CORRELATION_ID	String	N/A
MessageId	com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders.MESSAGE_ID	String	1
MessageId	com.azure.spring.integration.core.AzureHeaders.RAW_ID	String	2
MessageId	org.springframework.messaging.MessageHeaders.ID	UUID	3
PartitionKey	com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders.PARTITION_KEY	String	N/A
ReplyTo	org.springframework.messaging.MessageHeaders.REPLY_CHANNEL	String	N/A
ReplyToSessionId	com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders.REPLY_TO_SESSION_ID	String	N/A
ScheduledEnqueueTimeUtc	com.azure.spring.integration.core.AzureHeaders.SCHEDULED_ENQUEUE_MESSAGE	Integer	1
ScheduledEnqueueTimeUtc	com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders.SCHEDULED_ENQUEUE_TIME	Instant	2
SessionID	com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders.SESSION_ID	String	N/A
TimeToLive	com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders.TIME_TO_LIVE	Duration	N/A
To	com.azure.spring.integration.servicebus.converter.ServiceBusMessageHeaders.TO	String	N/A

Troubleshooting

Next steps

Contributing