Azure ServiceBus
Send and receive messages to/from Azure Service Bus.
What’s inside
-
Azure ServiceBus component, URI syntax:
azure-servicebus:topicOrQueueName
Please refer to the above links for usage and configuration details.
Maven coordinates
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-azure-servicebus-starter</artifactId>
</dependency>Spring Boot Auto-Configuration
The starter supports 30 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 AMQP. | 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.binary | Set binary mode. If true, message body will be sent as byte. By default, it is false. | false | Boolean |
camel.component.azure-servicebus.bridge-error-handler | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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. 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.credential-type | Determines the credential strategy to adopt | connection-string | CredentialType |
camel.component.azure-servicebus.enable-dead-lettering | Enable application level deadlettering to the subscription deadletter subqueue if deadletter related headers are set. | 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.fully-qualified-namespace | Fully Qualified Namespace of the service bus | String | |
camel.component.azure-servicebus.header-filter-strategy | To use a custom HeaderFilterStrategy to filter Service Bus application properties to and from Camel message headers. The option is a org.apache.camel.spi.HeaderFilterStrategy type. | HeaderFilterStrategy | |
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 (millis) to continue auto-renewing the lock. Setting ZERO disables auto-renewal. For ServiceBus receive mode (RECEIVE_AND_DELETE RECEIVE_AND_DELETE), auto-renewal is disabled. The option is a long type. | 300000 | Long |
camel.component.azure-servicebus.max-concurrent-calls | Sets maximum number of concurrent calls | 1 | Integer |
camel.component.azure-servicebus.prefetch-count | Sets the prefetch count of the receiver. For both PEEK_LOCK PEEK_LOCK and RECEIVE_AND_DELETE RECEIVE_AND_DELETE receive 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 receive message. Setting a non-zero value will prefetch that number of messages. Setting the value to zero turns prefetch off. | Integer | |
camel.component.azure-servicebus.processor-client | Sets the processorClient in order to consume messages by the consumer. The option is a com.azure.messaging.servicebus.ServiceBusProcessorClient type. | ServiceBusProcessorClient | |
camel.component.azure-servicebus.producer-operation | Sets the desired operation to be used in the producer | sendmessages | ServiceBusProducerOperationDefinition |
camel.component.azure-servicebus.proxy-options | Sets the proxy configuration to use for ServiceBusSenderClient. When a proxy is configured, 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.scheduled-enqueue-time | Sets OffsetDateTime at which the message should appear in the Service Bus queue or topic. | OffsetDateTime | |
camel.component.azure-servicebus.sender-client | Sets senderClient to be used in the producer. The option is a com.azure.messaging.servicebus.ServiceBusSenderClient type. | ServiceBusSenderClient | |
camel.component.azure-servicebus.service-bus-receive-mode | Sets the receive mode for the receiver. | peek-lock | 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. | queue | ServiceBusType |
camel.component.azure-servicebus.session-enabled | Enable session support | false | Boolean |
camel.component.azure-servicebus.session-id | Session ID for session-enabled queues or topics. | String | |
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. This property is required if serviceBusType=topic and the consumer is in use. | String | |
camel.component.azure-servicebus.token-credential | A TokenCredential for Azure AD authentication. The option is a com.azure.core.credential.TokenCredential type. | TokenCredential |