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

basicPropertyBinding (advanced)

Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

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 (15 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

basicPropertyBinding (advanced)

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

boolean

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.

Spring Boot Auto-Configuration

When using azure 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-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 37 options, which are listed below.

Name Description Default Type

camel.component.azure-blob.azure-blob-client

The blob service client. The option is a com.microsoft.azure.storage.blob.CloudBlob type.

String

camel.component.azure-blob.blob-metadata

Set the blob meta-data

Map

camel.component.azure-blob.blob-offset

Set the blob offset for the upload or download operations, default is 0

0

Long

camel.component.azure-blob.blob-prefix

Set a prefix which can be used for listing the blobs

String

camel.component.azure-blob.blob-type

Set a blob type, 'blockblob' is default

BlobType

camel.component.azure-blob.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-blob.close-stream-after-read

Close the stream after read or keep it open, default is true

true

Boolean

camel.component.azure-blob.close-stream-after-write

Close the stream after write or keep it open, default is true

true

Boolean

camel.component.azure-blob.configuration

The Blob Service configuration. The option is a org.apache.camel.component.azure.blob.BlobServiceConfiguration type.

String

camel.component.azure-blob.credentials

Set the storage credentials, required in most cases. The option is a com.microsoft.azure.storage.StorageCredentials type.

String

camel.component.azure-blob.credentials-account-key

Set the storage account key used during authentication phase

String

camel.component.azure-blob.credentials-account-name

Set the storage account name used during authentication phase

String

camel.component.azure-blob.data-length

Set the data length for the download or page blob upload operations

Long

camel.component.azure-blob.enabled

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

Boolean

camel.component.azure-blob.file-dir

Set the file directory where the downloaded blobs will be saved to

String

camel.component.azure-blob.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-blob.operation

Blob service operation hint to the producer

BlobServiceOperations

camel.component.azure-blob.public-for-read

Storage resources can be public for reading their content, if this property is enabled then the credentials do not have to be set

false

Boolean

camel.component.azure-blob.stream-read-size

Set the minimum read size in bytes when reading the blob content

Integer

camel.component.azure-blob.stream-write-size

Set the size of the buffer for writing block and page blocks

Integer

camel.component.azure-blob.use-flat-listing

Specify if the flat or hierarchical blob listing should be used

true

Boolean

camel.component.azure-blob.validate-client-u-r-i

Whether to validate the Azure client URI

true

Boolean

camel.component.azure-queue.azure-queue-client

The queue service client. The option is a com.microsoft.azure.storage.queue.CloudQueue type.

String

camel.component.azure-queue.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-queue.configuration

The Queue Service configuration. The option is a org.apache.camel.component.azure.queue.QueueServiceConfiguration type.

String

camel.component.azure-queue.credentials

Set the storage credentials, required in most cases. The option is a com.microsoft.azure.storage.StorageCredentials type.

String

camel.component.azure-queue.credentials-account-key

Set the storage account key used during authentication phase

String

camel.component.azure-queue.credentials-account-name

Set the storage account name used during authentication phase

String

camel.component.azure-queue.enabled

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

Boolean

camel.component.azure-queue.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-queue.message-time-to-live

Message Time To Live in seconds

Integer

camel.component.azure-queue.message-visibility-delay

Message Visibility Delay in seconds

Integer

camel.component.azure-queue.operation

Queue service operation hint to the producer

QueueServiceOperations

camel.component.azure-queue.queue-prefix

Set a prefix which can be used for listing the queues

String

camel.component.azure-queue.validate-client-u-r-i

Whether to validate the Azure client URI

true

Boolean

camel.component.azure-blob.basic-property-binding

Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

Boolean

camel.component.azure-queue.basic-property-binding

Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

Boolean