Chapter 41. Azure Storage Queue Service Component
Available as of Camel version 2.19
The Azure Queue component supports storing and retrieving the messages to/from Azure Storage Queue service.
Prerequisites
You must have a valid Microsoft Azure account. More information is available at Azure Portal.
41.1. URI Format
azure-queue://accountName/queueName[?options]
The queue will be created if it does not already exist.
You can append query options to the URI in the following format, ?options=value&option2=value&…
For example in order to get a message content from the queue messageQueue in the camelazure storage account and, use the following snippet:
from("azure-queue:/camelazure/messageQueue").
to("file://queuedirectory");41.2. URI Options
The Azure Storage Queue Service component has no options.
The Azure Storage Queue Service endpoint is configured using URI syntax:
azure-queue:containerAndQueueUri
with the following path and query parameters:
41.2.1. Path Parameters (1 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| containerAndQueueUri | Required Container Queue compact Uri | String |
41.2.2. Query Parameters (10 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| azureQueueClient (common) | The queue service client | CloudQueue | |
| credentials (common) | Set the storage credentials, required in most cases | StorageCredentials | |
| 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 |
| 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. | ExchangePattern | |
| messageTimeToLive (producer) | Message Time To Live in seconds | int | |
| messageVisibilityDelay (producer) | Message Visibility Delay in seconds | int | |
| operation (producer) | The operation to do in case the user does not want to send only a message. There are three enums options and the value can be one of the following: sendBatchMessage, deleteMessage, listQueues | listQueues | QueueServiceOperations |
| queuePrefix (producer) | Set a prefix which can be used for listing the queues | String | |
| synchronous (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |
41.3. Spring Boot Auto-Configuration
The component supports 2 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| camel.component.azure-queue.enabled | Enable azure-queue component | true | Boolean |
| camel.component.azure-queue.resolve-property-placeholders | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean |
Required Azure Storage Queue Service component options
You have to provide the containerAndQueue URI and the credentials.
41.4. Usage
41.4.1. Message headers evaluated by the Azure Storage Queue Service producer
| Header | Type | Description |
|---|---|---|
41.4.2. Message headers set by the Azure Storage Queue Service producer
| Header | Type | Description |
|---|---|---|
41.4.3. Message headers set by the Azure Storage Queue Service producer consumer
| Header | Type | Description |
|---|---|---|
41.4.4. Azure Queue Service operations
| Operation | Description |
|---|---|
|
| List the queues. |
|
| Create the queue. |
|
| Delete the queue. |
|
| Add a message to the queue. |
|
| Retrieve a message from the queue. |
|
| View the message inside the queue, for example, to determine whether the message arrived at the correct queue. |
|
| Update the message in the queue. |
|
| Delete the message in the queue. |
41.4.5. Azure Queue Client configuration
If your Camel Application is running behind a firewall or if you need to have more control over the Azure Queue Client configuration, you can create your own instance:
StorageCredentials credentials = new StorageCredentialsAccountAndKey("camelazure", "thekey");
CloudQueue client = new CloudQueue("camelazure", credentials);
registry.bind("azureQueueClient", client);and refer to it in your Camel azure-queue component configuration:
from("azure-queue:/camelazure/messageQueue?azureQueueClient=#client")
.to("mock:result");41.5. Dependencies
Maven users will need to add the following dependency to their pom.xml.
pom.xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-azure</artifactId>
<version>${camel-version}</version>
</dependency>
where ${camel-version} must be replaced by the actual version of Camel (2.19.0 or higher).
41.6. See Also
- Configuring Camel
- Component
- Endpoint
- Getting Started
- Azure Component
