Azure Storage Queue Service (Deprecated)

Since Camel 2.19

Both producer and consumer are supported

The Azure Queue component supports storing and retrieving the messages to/from Azure Storage Queue service.

Note: This component uses the legacy Azure SDK v8 and thus is Deprecated. There is another component Azure Storage Queue Component that uses the latest 12+ Azure SDK version.

Prerequisites

You must have a valid Microsoft Azure account. More information is available at Azure Portal.

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");

URI Options

The Azure Storage Queue Service (Deprecated) component supports 13 options, which are listed below.

Name Description Default Type

azureQueueClient (common)

The queue service client

CloudQueue

credentials (common)

Set the storage credentials, required in most cases

StorageCredentials

validateClientURI (common)

Whether to validate the Azure client URI

true

boolean

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

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

messageTimeToLive (producer)

Message Time To Live in seconds

int

messageVisibilityDelay (producer)

Message Visibility Delay in seconds

int

operation (producer)

Queue service operation hint to the producer. There are 8 enums and the value can be one of: listQueues, createQueue, deleteQueue, addMessage, retrieveMessage, peekMessage, updateMessage, deleteMessage

listQueues

QueueServiceOperations

queuePrefix (producer)

Set a prefix which can be used for listing the queues

String

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

configuration (advanced)

The Queue Service configuration

QueueServiceConfiguration

credentialsAccountKey (security)

Set the storage account key used during authentication phase

String

credentialsAccountName (security)

Set the storage account name used during authentication phase

String

The Azure Storage Queue Service (Deprecated) endpoint is configured using URI syntax:

azure-queue:containerAndQueueUri

with the following path and query parameters:

Path Parameters (1 parameters):

Name Description Default Type

containerAndQueueUri

Required Container Queue compact Uri

String

Query Parameters (13 parameters):

Name Description Default Type

azureQueueClient (common)

The queue service client

CloudQueue

credentials (common)

Set the storage credentials, required in most cases

StorageCredentials

validateClientURI (common)

Whether to validate the Azure client URI

true

boolean

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. 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

messageTimeToLive (producer)

Message Time To Live in seconds

int

messageVisibilityDelay (producer)

Message Visibility Delay in seconds

int

operation (producer)

Queue service operation hint to the producer. There are 8 enums and the value can be one of: listQueues, createQueue, deleteQueue, addMessage, retrieveMessage, peekMessage, updateMessage, deleteMessage

listQueues

QueueServiceOperations

queuePrefix (producer)

Set a prefix which can be used for listing the queues

String

credentialsAccountKey (security)

Set the storage account key used during authentication phase

String

credentialsAccountName (security)

Set the storage account name used during authentication phase

String

Required Azure Storage Queue Service component options

You have to provide the containerAndQueue URI and the credentials.

Usage

Azure Queue Service operations

Operation Description

listQueues

List the queues.

createQueue

Create the queue.

deleteQueue

Delete the queue.

addMessage

Add a message to the queue.

retrieveMessage

Retrieve a message from the queue.

peekMessage

View the message inside the queue, for example, to determine whether the message arrived at the correct queue.

updateMessage

Update the message in the queue.

deleteMessage

Delete the message in the queue.

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");

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.

Unresolved include directive in modules/ROOT/pages/azure-queue-component.adoc - include::camel-spring-boot::page$azure-starter.adoc[]