Repository: camel Updated Branches: refs/heads/master 82c57a965 -> 99084f4b1
[CAMEL-10786] Adding a missing doc resource Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/99084f4b Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/99084f4b Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/99084f4b Branch: refs/heads/master Commit: 99084f4b1c7c6fb2c6ff58678a8823baee29a4e1 Parents: 82c57a9 Author: Sergey Beryozkin <sberyoz...@gmail.com> Authored: Mon Feb 27 13:41:49 2017 +0000 Committer: Sergey Beryozkin <sberyoz...@gmail.com> Committed: Mon Feb 27 13:41:49 2017 +0000 ---------------------------------------------------------------------- .../src/main/docs/azure-queue-component.adoc | 150 +++++++++++++++++++ 1 file changed, 150 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/99084f4b/components/camel-azure/src/main/docs/azure-queue-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-azure/src/main/docs/azure-queue-component.adoc b/components/camel-azure/src/main/docs/azure-queue-component.adoc new file mode 100644 index 0000000..c50f454 --- /dev/null +++ b/components/camel-azure/src/main/docs/azure-queue-component.adoc @@ -0,0 +1,150 @@ +## Azure Storage Queue Service Component + +*Available as of Camel version 2.19* + +The Azure Queue component supports storing and retrieving the messages to/from +https://azure.microsoft.com/services/storage/queues/[Azure Storage Queue] service. + +Prerequisites + +You must have a valid Windows Azure Storage account. More information is available at +https://docs.microsoft.com/azure/[Azure Documentation Portal]. + +### URI Format + +[source,java] +------------------------------ +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: + +[source,java] +-------------------------------------------------------------------------------- +from("azure-queue:/camelazure/messageQueue"). +to("file://queuedirectory"); +-------------------------------------------------------------------------------- + +### URI Options + + +// component options: START +The Azure Storage Queue Service component has no options. +// component options: END + + + + + + + + + + + +// endpoint options: START +The Azure Storage Queue Service component supports 11 endpoint options which are listed below: + +{% raw %} +[width="100%",cols="2,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| containerAndQueueUri | common | | String | *Required* Container Queue compact Uri +| azureQueueClient | common | | CloudQueue | The queue service client +| credentials | common | | StorageCredentials | Set the storage credentials required in most cases +| bridgeErrorHandler | consumer | false | boolean | 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. +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. +| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. +| messageTimeToLive | producer | | int | Message Time To Live in seconds +| messageVisibilityDelay | producer | | int | Message Visibility Delay in seconds +| operation | producer | listQueues | QueueServiceOperations | Queue service operation hint to the producer +| queuePrefix | producer | | String | Set a prefix which can be used for listing the queues +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +|======================================================================= +{% endraw %} +// endpoint options: END + + + +Required Azure Storage Queue Service component options + +You have to provide the containerAndQueue URI and the credentials. + +### Usage + +#### Message headers evaluated by the Azure Storage Queue Service producer + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Header |Type |Description + +|======================================================================= + +#### Message headers set by the Azure Storage Queue Service producer + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Header |Type |Description +|======================================================================= + +#### Message headers set by the Azure Storage Queue Service producer consumer + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Header |Type |Description +|======================================================================= + +#### 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: + +[source,java] +-------------------------------------------------------------------------------------- +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: + +[source,java] +-------------------------------------------------------------------------------- +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* + +[source,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). + +### See Also + +* link:configuring-camel.html[Configuring Camel] +* link:component.html[Component] +* link:endpoint.html[Endpoint] +* link:getting-started.html[Getting Started] + +* link:azure.html[Azure Component]
