Azure ServiceBus

Since Camel 3.12

Both producer and consumer are supported

The azure-servicebus component that integrates Azure ServiceBus. Azure ServiceBus is a fully managed enterprise integration message broker. Service Bus can decouple applications and services. Service Bus offers a reliable and secure platform for asynchronous transfer of data and state. Data is transferred between different applications and services using messages.

Prerequisites

You must have a valid Windows Azure Storage account. More information is available at Azure Documentation Portal.

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-azure-servicebus</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

URI Options

The Azure ServiceBus endpoint is configured using URI syntax:

azure-servicebus:queueNameOrTopicName

with the following path and query parameters:

Path Parameters (1 parameters):

Name Description Default Type

topicOrQueueName

Selected topic name or the queue name, that is depending on serviceBusType config. For example if serviceBusType=queue, then this will be the queue name and if serviceBusType=topic, this will be the topic name.

String

Query Parameters (23 parameters):

Name Description Default Type

amqpRetryOptions (common)

Sets the retry options for Service Bus clients. If not specified, the default retry options are used.

AmqpRetryOptions

amqpTransportType (common)

Sets the transport type by which all the communication with Azure Service Bus occurs. Default value is AmqpTransportType#AMQP. There are 2 enums and the value can be one of: Amqp, AmqpWebSockets

AMQP

AmqpTransportType

clientOptions (common)

Sets the ClientOptions to be sent from the client built from this builder, enabling customization of certain properties, as well as support the addition of custom header information. Refer to the ClientOptions documentation for more information.

ClientOptions

proxyOptions (common)

Sets the proxy configuration to use for ServiceBusSenderAsyncClient. When a proxy is configured, AmqpTransportType#AMQP_WEB_SOCKETS must be used for the transport type.

ProxyOptions

serviceBusType (common)

Required The service bus type of connection to execute. Queue is for typical queue option and topic for subscription based model. There are 2 enums and the value can be one of: queue, topic

queue

ServiceBusType

bridgeErrorHandler (consumer)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

boolean

consumerOperation (consumer)

Sets the desired operation to be used in the consumer. There are 2 enums and the value can be one of: receiveMessages, peekMessages

receiveMessages

ServiceBusConsumerOperationDefinition

disableAutoComplete (consumer)

Disables auto-complete and auto-abandon of received messages. By default, a successfully processed message is {link ServiceBusReceiverAsyncClient#complete(ServiceBusReceivedMessage) completed}. If an error happens when the message is processed, it is {link ServiceBusReceiverAsyncClient#abandon(ServiceBusReceivedMessage) abandoned}.

false

boolean

maxAutoLockRenewDuration (consumer)

Sets the amount of time to continue auto-renewing the lock. Setting Duration#ZERO or null disables auto-renewal. For {link ServiceBusReceiveMode#RECEIVE_AND_DELETE RECEIVE_AND_DELETE} mode, auto-renewal is disabled.

5min

Duration

peekNumMaxMessages (consumer)

Set the max number of messages to be peeked during the peek operation.

Integer

prefetchCount (consumer)

Sets the prefetch count of the receiver. For both {link ServiceBusReceiveMode#PEEK_LOCK PEEK_LOCK} and {link ServiceBusReceiveMode#RECEIVE_AND_DELETE RECEIVE_AND_DELETE} modes the default value is 1. Prefetch speeds up the message flow by aiming to have a message readily available for local retrieval when and before the application asks for one using ServiceBusReceiverAsyncClient#receiveMessages(). Setting a non-zero value will prefetch that number of messages. Setting the value to zero turns prefetch off.

0

int

receiverAsyncClient (consumer)

Autowired Sets the receiverAsyncClient in order to consume messages in the Consumer

ServiceBusReceiverAsyncClient

serviceBusReceiveMode (consumer)

Sets the receive mode for the receiver. There are 2 enums and the value can be one of: PEEK_LOCK, RECEIVE_AND_DELETE

PEEK_LOCK

ServiceBusReceiveMode

subQueue (consumer)

Sets the type of the SubQueue to connect to. There are 3 enums and the value can be one of: NONE, DEAD_LETTER_QUEUE, TRANSFER_DEAD_LETTER_QUEUE

SubQueue

subscriptionName (consumer)

Sets the name of the subscription in the topic to listen to. topicOrQueueName and serviceBusType=topic must also be set.

String

exceptionHandler (consumer)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

ExceptionHandler

exchangePattern (consumer)

Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut

ExchangePattern

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

producerOperation (producer)

Sets the desired operation to be used in the producer. There are 2 enums and the value can be one of: sendMessages, scheduleMessages

sendMessages

ServiceBusProducerOperationDefinition

scheduledEnqueueTime (producer)

Sets OffsetDateTime at which the message should appear in the Service Bus queue or topic.

OffsetDateTime

senderAsyncClient (producer)

Autowired Sets SenderAsyncClient to be used in the producer.

ServiceBusSenderAsyncClient

serviceBusTransactionContext (producer)

Represents transaction in service. This object just contains transaction id.

ServiceBusTransactionContext

connectionString (security)

Required Sets the connection string for a Service Bus namespace or a specific Service Bus resource.

String

Component Options

The Azure ServiceBus component supports 23 options, which are listed below.

Name Description Default Type

amqpRetryOptions (common)

Sets the retry options for Service Bus clients. If not specified, the default retry options are used.

AmqpRetryOptions

amqpTransportType (common)

Sets the transport type by which all the communication with Azure Service Bus occurs. Default value is AmqpTransportType#AMQP. There are 2 enums and the value can be one of: Amqp, AmqpWebSockets

AMQP

AmqpTransportType

clientOptions (common)

Sets the ClientOptions to be sent from the client built from this builder, enabling customization of certain properties, as well as support the addition of custom header information. Refer to the ClientOptions documentation for more information.

ClientOptions

configuration (common)

The component configurations

ServiceBusConfiguration

proxyOptions (common)

Sets the proxy configuration to use for ServiceBusSenderAsyncClient. When a proxy is configured, AmqpTransportType#AMQP_WEB_SOCKETS must be used for the transport type.

ProxyOptions

serviceBusType (common)

Required The service bus type of connection to execute. Queue is for typical queue option and topic for subscription based model. There are 2 enums and the value can be one of: queue, topic

queue

ServiceBusType

bridgeErrorHandler (consumer)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

boolean

consumerOperation (consumer)

Sets the desired operation to be used in the consumer. There are 2 enums and the value can be one of: receiveMessages, peekMessages

receiveMessages

ServiceBusConsumerOperationDefinition

disableAutoComplete (consumer)

Disables auto-complete and auto-abandon of received messages. By default, a successfully processed message is {link ServiceBusReceiverAsyncClient#complete(ServiceBusReceivedMessage) completed}. If an error happens when the message is processed, it is {link ServiceBusReceiverAsyncClient#abandon(ServiceBusReceivedMessage) abandoned}.

false

boolean

maxAutoLockRenewDuration (consumer)

Sets the amount of time to continue auto-renewing the lock. Setting Duration#ZERO or null disables auto-renewal. For {link ServiceBusReceiveMode#RECEIVE_AND_DELETE RECEIVE_AND_DELETE} mode, auto-renewal is disabled.

5min

Duration

peekNumMaxMessages (consumer)

Set the max number of messages to be peeked during the peek operation.

Integer

prefetchCount (consumer)

Sets the prefetch count of the receiver. For both {link ServiceBusReceiveMode#PEEK_LOCK PEEK_LOCK} and {link ServiceBusReceiveMode#RECEIVE_AND_DELETE RECEIVE_AND_DELETE} modes the default value is 1. Prefetch speeds up the message flow by aiming to have a message readily available for local retrieval when and before the application asks for one using ServiceBusReceiverAsyncClient#receiveMessages(). Setting a non-zero value will prefetch that number of messages. Setting the value to zero turns prefetch off.

0

int

receiverAsyncClient (consumer)

Autowired Sets the receiverAsyncClient in order to consume messages in the Consumer

ServiceBusReceiverAsyncClient

serviceBusReceiveMode (consumer)

Sets the receive mode for the receiver. There are 2 enums and the value can be one of: PEEK_LOCK, RECEIVE_AND_DELETE

PEEK_LOCK

ServiceBusReceiveMode

subQueue (consumer)

Sets the type of the SubQueue to connect to. There are 3 enums and the value can be one of: NONE, DEAD_LETTER_QUEUE, TRANSFER_DEAD_LETTER_QUEUE

SubQueue

subscriptionName (consumer)

Sets the name of the subscription in the topic to listen to. topicOrQueueName and serviceBusType=topic must also be set.

String

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

producerOperation (producer)

Sets the desired operation to be used in the producer. There are 2 enums and the value can be one of: sendMessages, scheduleMessages

sendMessages

ServiceBusProducerOperationDefinition

scheduledEnqueueTime (producer)

Sets OffsetDateTime at which the message should appear in the Service Bus queue or topic.

OffsetDateTime

senderAsyncClient (producer)

Autowired Sets SenderAsyncClient to be used in the producer.

ServiceBusSenderAsyncClient

serviceBusTransactionContext (producer)

Represents transaction in service. This object just contains transaction id.

ServiceBusTransactionContext

autowiredEnabled (advanced)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

boolean

connectionString (security)

Required Sets the connection string for a Service Bus namespace or a specific Service Bus resource.

String

Async Consumer and Producer

This component implements the async Consumer and producer.

This allows camel route to consume and produce events asynchronously without blocking any threads.

Usage

Message headers evaluated by the component producer

Header Variable Name Type Description

CamelAzureServiceBusScheduledEnqueueTime

ServiceBusConstants.SCHEDULED_ENQUEUE_TIME

OffsetDateTime

Overrides the OffsetDateTime at which the message should appear in the Service Bus queue or topic.

CamelAzureServiceBusServiceBusTransactionContext

ServiceBusConstants.SERVICE_BUS_TRANSACTION_CONTEXT

ServiceBusTransactionContext

Overrides the transaction in service. This object just contains transaction id.

CamelAzureServiceBusProducerOperation

ServiceBusConstants.PRODUCER_OPERATION

ServiceBusProducerOperationDefinition

Overrides the desired operation to be used in the producer.

Message headers set by the component consumer

Header Variable Name Type Description

CamelAzureServiceBusApplicationProperties

ServiceBusConstants.APPLICATION_PROPERTIES

Map<String, Object>

Gets the set of free-form {@link ServiceBusReceivedMessage} properties which may be used for passing metadata associated with the {@link ServiceBusReceivedMessage} during Service Bus operations.

CamelAzureServiceBusContentType

ServiceBusConstants.CONTENT_TYPE

String

Gets the content type of the message.

CamelAzureServiceBusMessageId

ServiceBusConstants.MESSAGE_ID

String

Gets the identifier for the message.

CamelAzureServiceBusCorrelationId

ServiceBusConstants.CORRELATION_ID

String

Gets a correlation identifier.

CamelAzureServiceBusDeadLetterErrorDescription

ServiceBusConstants.DEAD_LETTER_ERROR_DESCRIPTION

String

Gets the description for a message that has been dead-lettered.

CamelAzureServiceBusDeadLetterReason

ServiceBusConstants.DEAD_LETTER_REASON

String

Gets the reason a message was dead-lettered.

CamelAzureServiceBusDeadLetterSource

ServiceBusConstants.DEAD_LETTER_SOURCE

String

Gets the name of the queue or subscription that this message was enqueued on, before it was dead-lettered.

CamelAzureServiceBusDeliveryCount

ServiceBusConstants.DELIVERY_COUNT

long

Gets the number of the times this message was delivered to clients.

CamelAzureServiceBusScheduledEnqueueTime

ServiceBusConstants.SCHEDULED_ENQUEUE_TIME

OffsetDateTime

Gets the scheduled enqueue time of this message.

CamelAzureServiceBusEnqueuedSequenceNumber

ServiceBusConstants.ENQUEUED_SEQUENCE_NUMBER

long

Gets the enqueued sequence number assigned to a message by Service Bus.

CamelAzureServiceBusEnqueuedTime

ServiceBusConstants.ENQUEUED_TIME

OffsetDateTime

Gets the datetime at which this message was enqueued in Azure Service Bus.

CamelAzureServiceBusExpiresAt

ServiceBusConstants.EXPIRES_AT

OffsetDateTime

Gets the datetime at which this message will expire.

CamelAzureServiceBusLockToken

ServiceBusConstants.LOCK_TOKEN

String

Gets the lock token for the current message.

CamelAzureServiceBusLockedUntil

ServiceBusConstants.LOCKED_UNTIL

OffsetDateTime

Gets the datetime at which the lock of this message expires.

CamelAzureServiceBusPartitionKey

ServiceBusConstants.PARTITION_KEY

String

Gets the partition key for sending a message to a partitioned entity.

CamelAzureServiceBusRawAmqpMessage

ServiceBusConstants.RAW_AMQP_MESSAGE

AmqpAnnotatedMessage

The representation of message as defined by AMQP protocol.

CamelAzureServiceBusReplyTo

ServiceBusConstants.REPLY_TO

String

Gets the address of an entity to send replies to.

CamelAzureServiceBusReplyToSessionId

ServiceBusConstants.REPLY_TO_SESSION_ID

String

Gets or sets a session identifier augmenting the {@link #getReplyTo() ReplyTo} address.

CamelAzureServiceBusSequenceNumber

ServiceBusConstants.SEQUENCE_NUMBER

long

Gets the unique number assigned to a message by Service Bus.

CamelAzureServiceBusSessionId

ServiceBusConstants.SESSION_ID

String

Gets the session id of the message.

CamelAzureServiceBusSubject

ServiceBusConstants.SUBJECT

String

Gets the subject for the message.

CamelAzureServiceBusTimeToLive

ServiceBusConstants.TIME_TO_LIVE

Duration

Gets the duration before this message expires.

CamelAzureServiceBusTimeTo

ServiceBusConstants.TO

String

Gets the "to" address.

Message Body

In the producer, this component accepts message body of String type or List<String> to send batch messages.

In the consumer, the returned message body will be of type `String.

Azure ServiceBus Producer operations

Operation Description

sendMessages

Sends a set of messages to a Service Bus queue or topic using a batched approach.

scheduleMessages

Sends a scheduled message to the Azure Service Bus entity this sender is connected to. A scheduled message is enqueued and made available to receivers only at the scheduled enqueue time.

Azure ServiceBus Consumer operations

Operation Description

receiveMessages

Receives an <b>infinite</b> stream of messages from the Service Bus entity.

peekMessages

Reads the next batch of active messages without changing the state of the receiver or the message source.

Examples

  • sendMessages

from("direct:start")
  .process(exchange -> {
         final List<Object> inputBatch = new LinkedList<>();
            inputBatch.add("test batch 1");
            inputBatch.add("test batch 2");
            inputBatch.add("test batch 3");
            inputBatch.add(123456);

            exchange.getIn().setBody(inputBatch);
       })
  .to("azure-servicebus:test//?connectionString=test")
  .to("mock:result");
  • scheduleMessages

from("direct:start")
  .process(exchange -> {
         final List<Object> inputBatch = new LinkedList<>();
            inputBatch.add("test batch 1");
            inputBatch.add("test batch 2");
            inputBatch.add("test batch 3");
            inputBatch.add(123456);

            exchange.getIn().setHeader(ServiceBusConstants.SCHEDULED_ENQUEUE_TIME, OffsetDateTime.now());
            exchange.getIn().setBody(inputBatch);
       })
  .to("azure-servicebus:test//?connectionString=test&producerOperation=scheduleMessages")
  .to("mock:result");
  • receiveMessages

from("azure-servicebus:test//?connectionString=test")
  .log("${body}")
  .to("mock:result");
  • peekMessages

from("azure-servicebus:test//?connectionString=test&consumerOperation=peekMessages&peekNumMaxMessages=3")
  .log("${body}")
  .to("mock:result");

Spring Boot Auto-Configuration

When using azure-servicebus with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-azure-servicebus-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 24 options, which are listed below.

Name Description Default Type

camel.component.azure-servicebus.amqp-retry-options

Sets the retry options for Service Bus clients. If not specified, the default retry options are used. The option is a com.azure.core.amqp.AmqpRetryOptions type.

AmqpRetryOptions

camel.component.azure-servicebus.amqp-transport-type

Sets the transport type by which all the communication with Azure Service Bus occurs. Default value is AmqpTransportType#AMQP.

AmqpTransportType

camel.component.azure-servicebus.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.azure-servicebus.bridge-error-handler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

Boolean

camel.component.azure-servicebus.client-options

Sets the ClientOptions to be sent from the client built from this builder, enabling customization of certain properties, as well as support the addition of custom header information. Refer to the ClientOptions documentation for more information. The option is a com.azure.core.util.ClientOptions type.

ClientOptions

camel.component.azure-servicebus.configuration

The component configurations. The option is a org.apache.camel.component.azure.servicebus.ServiceBusConfiguration type.

ServiceBusConfiguration

camel.component.azure-servicebus.connection-string

Sets the connection string for a Service Bus namespace or a specific Service Bus resource.

String

camel.component.azure-servicebus.consumer-operation

Sets the desired operation to be used in the consumer

ServiceBusConsumerOperationDefinition

camel.component.azure-servicebus.disable-auto-complete

Disables auto-complete and auto-abandon of received messages. By default, a successfully processed message is {link ServiceBusReceiverAsyncClient#complete(ServiceBusReceivedMessage) completed}. If an error happens when the message is processed, it is {link ServiceBusReceiverAsyncClient#abandon(ServiceBusReceivedMessage) abandoned}.

false

Boolean

camel.component.azure-servicebus.enabled

Whether to enable auto configuration of the azure-servicebus component. This is enabled by default.

Boolean

camel.component.azure-servicebus.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.azure-servicebus.max-auto-lock-renew-duration

Sets the amount of time to continue auto-renewing the lock. Setting Duration#ZERO or null disables auto-renewal. For {link ServiceBusReceiveMode#RECEIVE_AND_DELETE RECEIVE_AND_DELETE} mode, auto-renewal is disabled. The option is a java.time.Duration type.

Duration

camel.component.azure-servicebus.peek-num-max-messages

Set the max number of messages to be peeked during the peek operation.

Integer

camel.component.azure-servicebus.prefetch-count

Sets the prefetch count of the receiver. For both {link ServiceBusReceiveMode#PEEK_LOCK PEEK_LOCK} and {link ServiceBusReceiveMode#RECEIVE_AND_DELETE RECEIVE_AND_DELETE} modes the default value is 1. Prefetch speeds up the message flow by aiming to have a message readily available for local retrieval when and before the application asks for one using ServiceBusReceiverAsyncClient#receiveMessages(). Setting a non-zero value will prefetch that number of messages. Setting the value to zero turns prefetch off.

0

Integer

camel.component.azure-servicebus.producer-operation

Sets the desired operation to be used in the producer

ServiceBusProducerOperationDefinition

camel.component.azure-servicebus.proxy-options

Sets the proxy configuration to use for ServiceBusSenderAsyncClient. When a proxy is configured, AmqpTransportType#AMQP_WEB_SOCKETS must be used for the transport type. The option is a com.azure.core.amqp.ProxyOptions type.

ProxyOptions

camel.component.azure-servicebus.receiver-async-client

Sets the receiverAsyncClient in order to consume messages in the Consumer. The option is a com.azure.messaging.servicebus.ServiceBusReceiverAsyncClient type.

ServiceBusReceiverAsyncClient

camel.component.azure-servicebus.scheduled-enqueue-time

Sets OffsetDateTime at which the message should appear in the Service Bus queue or topic. The option is a java.time.OffsetDateTime type.

OffsetDateTime

camel.component.azure-servicebus.sender-async-client

Sets SenderAsyncClient to be used in the producer. The option is a com.azure.messaging.servicebus.ServiceBusSenderAsyncClient type.

ServiceBusSenderAsyncClient

camel.component.azure-servicebus.service-bus-receive-mode

Sets the receive mode for the receiver.

ServiceBusReceiveMode

camel.component.azure-servicebus.service-bus-transaction-context

Represents transaction in service. This object just contains transaction id. The option is a com.azure.messaging.servicebus.ServiceBusTransactionContext type.

ServiceBusTransactionContext

camel.component.azure-servicebus.service-bus-type

The service bus type of connection to execute. Queue is for typical queue option and topic for subscription based model.

ServiceBusType

camel.component.azure-servicebus.sub-queue

Sets the type of the SubQueue to connect to.

SubQueue

camel.component.azure-servicebus.subscription-name

Sets the name of the subscription in the topic to listen to. topicOrQueueName and serviceBusType=topic must also be set.

String