Author: buildbot
Date: Thu Oct 20 18:19:16 2016
New Revision: 999716
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/aws-sqs.html
websites/production/camel/content/book-component-appendix.html
websites/production/camel/content/book-in-one-page.html
websites/production/camel/content/cache/main.pageCache
Modified: websites/production/camel/content/aws-sqs.html
==============================================================================
--- websites/production/camel/content/aws-sqs.html (original)
+++ websites/production/camel/content/aws-sqs.html Thu Oct 20 18:19:16 2016
@@ -87,9 +87,9 @@
<td valign="top" width="100%">
<div class="wiki-content maincontent"><h2 id="AWS-SQS-SQSComponent">SQS
Component</h2><p><strong>Available as of Camel 2.6</strong></p><p>The sqs
component supports sending and receiving messages to <a shape="rect"
class="external-link" href="http://aws.amazon.com/sqs" rel="nofollow">Amazon's
SQS</a> service.</p><div class="confluence-information-macro
confluence-information-macro-information"><p
class="title">Prerequisites</p><span class="aui-icon aui-icon-small
aui-iconfont-info confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>You must have a valid Amazon Web
Services developer account, and be signed up to use Amazon SQS. More
information are available at <a shape="rect" class="external-link"
href="http://aws.amazon.com/sqs" rel="nofollow">Amazon
SQS</a>.</p></div></div><h3 id="AWS-SQS-URIFormat">URI Format</h3><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[aws-sqs://queueName[?options]
-aws-sqs://queueNameOrArn[?options] (Camel 2.18 onwards)
+aws-sqs://queueNameOrArn[?options] (from Camel 2.18)
]]></script>
-</div></div><p>The queue will be created if they don't already exists.<br
clear="none"> You can append query options to the URI in the following format,
?options=value&option2=value&...</p><h3 id="AWS-SQS-URIOptions">URI
Options</h3><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Context</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>amazonSQSClient</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Reference to a
<code>com.amazonaws.services.sqs.AmazonSQS</code> in the <a shape="rect"
href="registry.html">Registry</a>.</p></t
d></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>accessKey</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Amazon AWS Access Key</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>secretKey</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Amazon AWS Secret Key</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>amazonSQSEndpoint</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The region with which the AWS-SQS client wants to work
with. Only works if Camel creates the AWS-SQ
S client, i.e., if you explicitly set amazonSQSClient, then this setting will
have no effect. You would have to set it on the client you create
directly</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>attributeNames</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Consumer</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>A list of attribute names to receive when consuming.
<strong>Camel 2.17:</strong> Multiple names can be separated by comma. Camel
2.16 or older: The type is a Collection so its much harder to configure and
use.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">messageAttributeNames</td><td colspan="1" rowspan="1"
class="confluenceTd"><code>null</code></td><td colspan="1" rowspan="1"
class="confluenceTd">Consumer</td><td colspan="1" rowspan="1"
class="confluenceTd">A list of message attribute names to receive when
consuming. <strong
>Camel 2.17:</strong><span> </span>Multiple names can be separated by
>comma. <span>Camel 2.16 or older: The type is a Collection so its much harder
>to configure and use.</span></td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><p>concurrentConsumers</p></td><td colspan="1"
>rowspan="1" class="confluenceTd">1</td><td colspan="1" rowspan="1"
>class="confluenceTd">Consumer</td><td colspan="1" rowspan="1"
>class="confluenceTd">(<strong>as of 2.15.0</strong>) Allows you to use
>multiple threads to poll the sqs queue to increase throughput. You must also
>set t<span>he </span><code>maxMessagesPerPoll</code> option for this to work
>properly.</td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><p>defaultVisibilityTimeout</p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p>The visibility timeout (in seconds) to
>set in t
he
<code>com.amazonaws.services.sqs.model.CreateQueueRequest</code>.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>deleteAfterRead</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Delete message from SQS after
it has been read (and processed by the route).</p><p>If this option is false,
then the same objects will be retrieve over and over again on the polls.
Therefore you need to use the <a shape="rect"
href="idempotent-consumer.html">Idempotent Consumer EIP</a> in the route to
filter out duplicates. You can filter using the S3Constants#BUCKET_NAME and
S3Constants#KEY headers, or only the S3Constants#KEY
header.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>deleteIfFiltered</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan=
"1" class="confluenceTd"><p>Consumer</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.12.2,2.13.0</strong> Whether or not to
send the DeleteMessage to the SQS queue if an exchange fails to get through a
filter. If 'false' and exchange does not make it through a Camel filter
upstream in the route, then don't send DeleteMessage.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>maxMessagesPerPoll</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The maximum number of messages
which can be received in one poll to set in the
<code>com.amazonaws.services.sqs.model.ReceiveMessageRequest</code>.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>visibilityTimeout</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="
1" class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The duration (in seconds) that the received messages
are hidden from subsequent retrieve requests after being retrieved by a
ReceiveMessage request. This only make sense if its different from
<code>defaultVisibilityTimeout</code>.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>extendMessageVisibility</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.10:</strong> If
enabled a scheduled background task will keep extending the message visibility
on SQS. This is needed if it takes a long time to process the message. If set
to true<code> visibilityTimeout</code> must be set. See details at <a
shape="rect" class="external-link"
href="http://docs.amazonwebservices.com/AWSSimpleQueueService/latest/APIRefer
ence/Query_QueryChangeMessageVisibility.html" rel="nofollow">Amazon
docs</a>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>maximumMessageSize</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.8:</strong> The maximumMessageSize (in
bytes) an SQS message can contain for this queue, to set in the
<code>com.amazonaws.services.sqs.model.SetQueueAttributesRequest</code>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p>messageRetentionPeriod</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.8:</strong> The messageRetentionPeriod
(in seconds) a message will be retained by SQS for this queue, to set in the
<code
>com.amazonaws.services.sqs.model.SetQueueAttributesRequest</code>.</p></td></tr><tr><td
> colspan="1" rowspan="1" class="confluenceTd"><p>policy</p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p>Shared</p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong>
>The policy for this queue to set in the
><code>com.amazonaws.services.sqs.model.SetQueueAttributesRequest</code>.</p></td></tr><tr><td
> colspan="1" rowspan="1" class="confluenceTd"><p>delaySeconds</p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p>Producer</p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.9.3:</strong>
>Delay sending messages for a number of seconds.</p></td></tr><tr><td
>colspan="1" rowspan="1" class="confluenceTd"><p>waitTimeSeconds</p></td><td
>colspan="1" rowspan="1" class="confluenceTd
"><p><code>0</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Producer</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> Duration in seconds (0 to
20) that the ReceiveMessage action call will wait until a message is in the
queue to include in the response.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>receiveMessageWaitTimeSeconds</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> If you do not specify
WaitTimeSeconds in the request, the queue attribute
ReceiveMessageWaitTimeSeconds is used to determine how long to
wait.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>queueOwnerAWSAccountId</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" clas
s="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.12:</strong> Specify the queue owner
aws account id when you need to connect the queue with different account
owner.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>region</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.12.3:</strong> Specify the queue region
which could be used with <code>queueOwnerAWSAccountId</code> to build the
service URL.<br clear="none">Note: Region will still default to us-east-1 if
 <span>queueOwnerAWSAccountId is not specified</span></p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>redrivePolicy</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>null</code></td><td
colspan="1" rowspan="1" class="confluenceTd">Shared</td><td cols
pan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.15</strong>: Specify
the policy that send message to DeadLetter queue. See detail at <a shape="rect"
class="external-link"
href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues-redrivepolicy.html"
rel="nofollow">Amazon docs</a>.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>proxyHost</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><code>null</code></td><td colspan="1" rowspan="1"
class="confluenceTd">Shared</td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Camel 2.16</strong>: Specify a proxy host to be
used inside the client definition.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>proxyPort</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><code>null</code></td><td colspan="1" rowspan="1"
class="confluenceTd">Shared</td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Camel 2.16</strong>: Specify a proxy port to b
e used inside the client definition.</td></tr></tbody></table></div><div
class="confluence-information-macro
confluence-information-macro-information"><p class="title">Required SQS
component options</p><span class="aui-icon aui-icon-small aui-iconfont-info
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>You have to provide the
amazonSQSClient in the <a shape="rect" href="registry.html">Registry</a> or
your accessKey and secretKey to access the <a shape="rect"
class="external-link" href="http://aws.amazon.com/sqs" rel="nofollow">Amazon's
SQS</a>.</p></div></div><h3 id="AWS-SQS-BatchConsumer">Batch
Consumer</h3><p>This component implements the <a shape="rect"
href="batch-consumer.html">Batch Consumer</a>.</p><p>This allows you for
instance to know how many messages exists in this batch and for instance let
the <a shape="rect" href="aggregator.html">Aggregator</a> aggregate this number
of messages.</p><h3 id="AWS-SQS-Usage">Usage</h3><h4 id="
AWS-SQS-MessageheaderssetbytheSQSproducer">Message headers set by the SQS
producer</h4><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>CamelAwsSqsMD5OfBody</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The MD5 checksum of the Amazon
SQS message.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelAwsSqsMessageId</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The Amazon SQS message
ID.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelAwsSqsDelay
Seconds</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>Integer</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Since <strong>Camel 2.11</strong>, the
delay seconds that the Amazon SQS message can be see by
others.</p></td></tr></tbody></table></div><h4
id="AWS-SQS-MessageheaderssetbytheSQSconsumer">Message headers set by the SQS
consumer</h4><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>CamelAwsSqsMD5OfBody</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The MD5 checksum of the Amazon
SQS message.</p></td></tr><tr><td colspan="1" rowspan="1" class="conflue
nceTd"><p><code>CamelAwsSqsMessageId</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The Amazon SQS message
ID.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelAwsSqsReceiptHandle</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The Amazon SQS message receipt
handle.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelAwsSqsAttributes</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>Map<String,
String></code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The Amazon SQS message
attributes.</p></td></tr></tbody></table></div><h4
id="AWS-SQS-AdvancedAmazonSQSconfiguration">Advanced AmazonSQS
configuration</h4><p>If your Camel Application is running behind a firewall or
if you need to have m
ore control over the AmazonSQS instance configuration, you can create your own
instance:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+</div></div><p>The queue will be created if they don't already exists. You can
append query options to the URI in the following format:
<strong><code>?options=value&option2=value&...</code></strong></p><h3
id="AWS-SQS-URIOptions">URI Options</h3><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Context</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>accessKey</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Amazon AWS Access
Key.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><cod
e>amazonSQSClient</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>Shared</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Reference to a
<strong><code>com.amazonaws.services.sqs.AmazonSQS</code></strong> in the <a
shape="rect" href="registry.html">Registry</a>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>amazonSQSEndpoint</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The region with which
the <strong><code>aws-sqs</code></strong> client wants to work with. Only
works if Camel creates the <strong><code>aws-sqs</code></strong> client,
i.e., if you explicitly set <strong><code>amazonSQSClient</code></strong>, then
this setting will have no effect. You
would have to set it on the client you create directly</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>attributeNames</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Consumer</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>A list of attribute names to
receive when consuming. </p><p><strong>Camel 2.17:</strong> Multiple names can
be separated by comma. </p><p><strong>Camel 2.16</strong> or older: The type is
a Collection so its much harder to configure and use.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>concurrentConsumers</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>1</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>Consumer</code></td><td colspan="1"
rowspan="1" class="confluenceTd">(<strong>as of 2.15.0</strong>) Allows you to
use multiple threads to poll the S
QS queue to increase throughput. You must also set t<span>he
</span><strong><code>maxMessagesPerPoll</code></strong> option for this to work
properly.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>defaultVisibilityTimeout</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The visibility timeout (in
seconds) to set in the
<strong><code>com.amazonaws.services.sqs.model.CreateQueueRequest</code></strong>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>delaySeconds</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Producer</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.9.3:</strong>
Delay sending messages for a number of seconds.
</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>deleteAfterRead</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Consumer</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Delete message from SQS after
it has been read (and processed by the route).</p><p>If this option is false,
then the same objects will be retrieve over and over again on the polls.
Therefore you need to use the <a shape="rect"
href="idempotent-consumer.html">Idempotent Consumer EIP</a> in the route to
filter out duplicates. You can filter using
the <strong><code>S3Constants#BUCKET_NAME</code></strong>
and <strong><code>S3Constants#KEY</code></strong> headers, or only
the <strong><code>S3Constants#KEY</code></strong>
header.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>deleteIfFiltered</code></p></td><td colspan="1"
rowspan="1
" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Consumer</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.2,
2.13.0</strong>: Whether or not to send
the <strong><code>DeleteMessage</code></strong> to the SQS queue if an
exchange fails to get through a
filter.</p><p>If <strong><code>false</code></strong> and exchange does not
make it through a Camel filter upstream in the route, then don't send
<strong><code>DeleteMessage</code></strong>.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>extendMessageVisibility</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>Consumer</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.10:</strong> If enabled a
scheduled background task will keep extending the message visibility on SQS.
This is needed if it takes a long time to process the message. If set to
true<strong><code> visibilityTimeout</code></strong> must be set.</p><p>See
details at <a shape="rect" class="external-link"
href="http://docs.amazonwebservices.com/AWSSimpleQueueService/latest/APIReference/Query_QueryChangeMessageVisibility.html"
rel="nofollow">Amazon docs</a>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>maximumMessageSize</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong>
The <strong><code>maximumMessageSize</code></strong> (in bytes) an SQS
message can contain for this queue, to set in the
<strong><code>com.amazonaws.services.sqs.model.SetQueueAttributesRequest</code></strong>.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>maxMes
sagesPerPoll</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>Consumer</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The maximum number of messages which can be
received in one poll to set in the
<strong><code>com.amazonaws.services.sqs.model.ReceiveMessageRequest</code></strong>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><code>messageAttributeNames</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>Consumer</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>A list of message attribute names to
receive when consuming. </p><p><strong>Camel
2.17:</strong><span> </span>Multiple names can be separated by comma.
<span> </span></p><p><span><strong>Camel 2.16</strong> or older: The type
is a Collection so its much harder to configure and u
se.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>messageRetentionPeriod</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong>
The <strong><code>messageRetentionPeriod</code></strong> (in seconds) a
message will be retained by SQS for this queue, to set in the
<strong><code>com.amazonaws.services.sqs.model.SetQueueAttributesRequest</code></strong>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>proxyHost</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>Shared</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>Camel 2.16</strong>: Specify a proxy
host to be used inside the client definition.</td></tr><tr><td colsp
an="1" rowspan="1" class="confluenceTd"><p><code>proxyPort</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>null</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>Shared</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16</strong>:
Specify a proxy port to be used inside the client definition.</td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>queueOwnerAWSAccountId</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong>
Specify the queue owner aws account id when you need to connect the queue with
different account owner.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>policy</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan=
"1" rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong> The
policy for this queue to set in the
<strong><code>com.amazonaws.services.sqs.model.SetQueueAttributesRequest</code></strong>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>receiveMessageWaitTimeSeconds</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> If
you do not specify <strong><code>WaitTimeSeconds</code></strong> in the
request, the queue
attribute <strong><code>ReceiveMessageWaitTimeSeconds</code></strong> is
used to determine how long to wait.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>redrivePolicy</code></p></td><td
colspan="1" rowspan="1" class="confluenceT
d"><code>null</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><code>Shared</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Camel 2.15</strong>: Specify the policy that send
message to <strong><code>DeadLetter</code></strong> queue. See detail at
<a shape="rect" class="external-link"
href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues-redrivepolicy.html"
rel="nofollow">Amazon docs</a>.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>region</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>Shared</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.12.3:</strong> Specify the queue region
which could be used with <strong><code>queueOwnerAWSAccountId</code></strong>
to build the service URL.<br clear="none"><strong>Note</strong>: Region will
still default to
 <strong><code>us-east-1</code></strong> if
 <span><strong><code>queueOwnerAWSAccountId</code></strong> is not
specified</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>secretKey</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Amazon AWS Secret Key.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>waitTimeSeconds</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Producer</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
Duration in seconds (0 to 20) that
the <strong><code>ReceiveMessage</code></strong> action call will wait
until a message is in the queue to include in the response.</p></td></t
r><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>visibilityTimeout</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The duration (in seconds) that the received
messages are hidden from subsequent retrieve requests after being retrieved by
a <strong><code>ReceiveMessage</code></strong> request. This only make
sense if its different from
<strong><code>defaultVisibilityTimeout</code></strong>.</p></td></tr></tbody></table></div><div
class="confluence-information-macro
confluence-information-macro-information"><p class="title">Required SQS
component options</p><span class="aui-icon aui-icon-small aui-iconfont-info
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>You have to provide
the <strong><code>amazonSQSClient</code></strong> in the <a shape=
"rect" href="registry.html">Registry</a> or
your <strong><code>accessKey</code></strong>
and <strong><code>secretKey</code></strong> to access the <a shape="rect"
class="external-link" href="http://aws.amazon.com/sqs" rel="nofollow">Amazon's
SQS</a>.</p></div></div><h3 id="AWS-SQS-BatchConsumer">Batch
Consumer</h3><p>This component implements the <a shape="rect"
href="batch-consumer.html">Batch Consumer</a>.</p><p>This allows you for
instance to know how many messages exists in this batch and for instance let
the <a shape="rect" href="aggregator.html">Aggregator</a> aggregate this number
of messages.</p><h3 id="AWS-SQS-Usage">Usage</h3><h4
id="AWS-SQS-MessageheaderssetbytheSQSproducer">Message headers set by the SQS
producer</h4><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><
p>Description</p></th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelAwsSqsMD5OfBody</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The MD5 checksum of the Amazon
SQS message.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelAwsSqsMessageId</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The Amazon SQS message
ID.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelAwsSqsDelaySeconds</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>Integer</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Since <strong>Camel 2.11</strong>, the
delay seconds that the Amazon SQS message can be see by
others.</p></td></tr></tbody></table></div><h4
id="AWS-SQS-MessageheaderssetbytheSQS
consumer">Message headers set by the SQS consumer</h4><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>CamelAwsSqsMD5OfBody</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The MD5 checksum of the Amazon
SQS message.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelAwsSqsMessageId</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The Amazon SQS message
ID.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelAwsSqsReceiptHandle</code></p></td><td colsp
an="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The Amazon SQS message receipt
handle.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelAwsSqsAttributes</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>Map<String,
String></code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The Amazon SQS message
attributes.</p></td></tr></tbody></table></div><h4
id="AWS-SQS-AdvancedAmazonSQSconfiguration">Advanced AmazonSQS
configuration</h4><p>If your Camel Application is running behind a firewall or
if you need to have more control over the AmazonSQS instance configuration, you
can create your own instance:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[AWSCredentials awsCredentials = new
BasicAWSCredentials("myAccessKey", "mySecretKey");
ClientConfiguration clientConfiguration = new ClientConfiguration();
@@ -102,21 +102,21 @@ registry.bind("client", client
]]></script>
</div></div><p>and refer to it in your Camel aws-sqs component
configuration:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[from("aws-sqs://MyQueue?amazonSQSClient=#client&delay=5000&maxMessagesPerPoll=5")
-.to("mock:result");
+ .to("mock:result");
]]></script>
-</div></div><h3 id="AWS-SQS-Dependencies">Dependencies</h3><p>Maven users will
need to add the following dependency to their pom.xml.</p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl"
style="border-bottom-width: 1px;"><b>pom.xml</b></div><div class="codeContent
panelContent pdl">
+</div></div><h3 id="AWS-SQS-Dependencies">Dependencies</h3><p>Maven users will
need to add the following dependency to their
<strong><code>pom.xml</code></strong>.</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeHeader panelHeader pdl"
style="border-bottom-width: 1px;"><b>pom.xml</b></div><div class="codeContent
panelContent pdl">
<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-aws</artifactId>
<version>${camel-version}</version>
</dependency>
]]></script>
-</div></div><p>where <code>${camel-version</code>} must be replaced by the
actual version of Camel (2.6 or higher).</p><h3
id="AWS-SQS-JMS-styleSelectors">JMS-style Selectors</h3><p>SQS does not allow
selectors, but you can effectively achieve this by using the <a shape="rect"
href="message-filter.html">Camel Filter EIP</a> and setting an appropriate
<code>visibilityTimeout</code>. When SQS dispatches a message, it will wait up
to the visibility timeout before it will try to dispatch the message to a
different consumer unless a DeleteMessage is received. By default, Camel will
always send the DeleteMessage at the end of the route, unless the route ended
in failure. To achieve appropriate filtering and not send the DeleteMessage
even on successful completion of the route, use a Filter:</p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>where <strong><code>${camel-version</code>}</strong> must be
replaced by the actual version of Camel (2.6 or higher).</p><h3
id="AWS-SQS-JMS-styleSelectors">JMS-style Selectors</h3><p>SQS does not allow
selectors, but you can effectively achieve this by using the <a shape="rect"
href="message-filter.html">Camel Filter EIP</a> and setting an appropriate
<strong><code>visibilityTimeout</code></strong>. When SQS dispatches a message,
it will wait up to the visibility timeout before it will try to dispatch the
message to a different consumer unless
a <strong><code>DeleteMessage</code></strong> is received. By default,
Camel will always send the <strong><code>DeleteMessage</code></strong> at
the end of the route, unless the route ended in failure. To achieve appropriate
filtering and not send the <strong><code>DeleteMessage</code></strong>
even on successful completion of the route, use a Filter:</p><div class="code
panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[from("aws-sqs://MyQueue?amazonSQSClient=#client&defaultVisibilityTimeout=5000&deleteIfFiltered=false")
-.filter("${header.login} == true")
-.to("mock:result");
+ .filter("${header.login} == true")
+ .to("mock:result");
]]></script>
-</div></div><p>In the above code, if an exchange doesn't have an appropriate
header, it will not make it through the filter AND also not be deleted from the
SQS queue. After 5000 miliseconds, the message will become visible to other
consumers.</p><p></p><h3 id="AWS-SQS-SeeAlso">See Also</h3>
+</div></div><p>In the above code, if an exchange doesn't have an appropriate
header, it will not make it through the filter AND also not be deleted from the
SQS queue. After <code>5000</code> miliseconds, the message will become
visible to other consumers.</p><p></p><h3 id="AWS-SQS-SeeAlso">See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul><ul
class="alternate"><li><a shape="rect" href="aws.html">AWS
Component</a></li></ul></div>
</td>
<td valign="top">
Modified: websites/production/camel/content/book-component-appendix.html
==============================================================================
--- websites/production/camel/content/book-component-appendix.html (original)
+++ websites/production/camel/content/book-component-appendix.html Thu Oct 20
18:19:16 2016
@@ -223,15 +223,15 @@
</div>
</div><h3 id="BookComponentAppendix-URIFormat">URI Format</h3><div class="code
panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
- <script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter">aws-sqs://queueName[?options]
aws-sqs://queueNameOrArn[?options] (Camel 2.18 onwards) </script>
+ <script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter">aws-sqs://queueName[?options]
aws-sqs://queueNameOrArn[?options] (from Camel 2.18) </script>
</div>
-</div><p>The queue will be created if they don't already exists.<br
clear="none"> You can append query options to the URI in the following format,
?options=value&option2=value&...</p><h3
id="BookComponentAppendix-URIOptions">URI Options</h3><div class="table-wrap">
- <table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Context</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>amazonSQSClient</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Reference to a
<code>com.amazonaws.services.sqs.AmazonSQS</code> in the <a shape="rect"
href="registry.html">Registry</a>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>accessKey</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1" class="con
fluenceTd"><p>Amazon AWS Access Key</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>secretKey</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Amazon AWS Secret Key</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>amazonSQSEndpoint</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The region with which the AWS-SQS client wants to work
with. Only works if Camel creates the AWS-SQS client, i.e., if you explicitly
set amazonSQSClient, then this setting will have no effect. You would have to
set it on the client you create directly</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>attributeNames</p></td><td colspan="1" row
span="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Consumer</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>A list of attribute names to receive when
consuming. <strong>Camel 2.17:</strong> Multiple names can be separated by
comma. Camel 2.16 or older: The type is a Collection so its much harder to
configure and use.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">messageAttributeNames</td><td colspan="1" rowspan="1"
class="confluenceTd"><code>null</code></td><td colspan="1" rowspan="1"
class="confluenceTd">Consumer</td><td colspan="1" rowspan="1"
class="confluenceTd">A list of message attribute names to receive when
consuming. <strong>Camel 2.17:</strong><span> </span>Multiple names can be
separated by comma. <span>Camel 2.16 or older: The type is a Collection so its
much harder to configure and use.</span></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>concurrentConsume
rs</p></td><td colspan="1" rowspan="1" class="confluenceTd">1</td><td
colspan="1" rowspan="1" class="confluenceTd">Consumer</td><td colspan="1"
rowspan="1" class="confluenceTd">(<strong>as of 2.15.0</strong>) Allows you to
use multiple threads to poll the sqs queue to increase throughput. You must
also set t<span>he </span><code>maxMessagesPerPoll</code> option for this to
work properly.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>defaultVisibilityTimeout</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The visibility timeout (in seconds) to set in the
<code>com.amazonaws.services.sqs.model.CreateQueueRequest</code>.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>deleteAfterRead</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
colspan="1" rowspan=
"1" class="confluenceTd"><p>Consumer</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Delete message from SQS after it has been read (and
processed by the route).</p><p>If this option is false, then the same objects
will be retrieve over and over again on the polls. Therefore you need to use
the <a shape="rect" href="idempotent-consumer.html">Idempotent Consumer EIP</a>
in the route to filter out duplicates. You can filter using the
S3Constants#BUCKET_NAME and S3Constants#KEY headers, or only the
S3Constants#KEY header.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>deleteIfFiltered</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Consumer</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.12.2,2.13.0</strong> Whether or not to
send the DeleteMessage to the SQS queue if an exchange fails to get through a
filter. If 'false' and exchange do
es not make it through a Camel filter upstream in the route, then don't send
DeleteMessage.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>maxMessagesPerPoll</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Consumer</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The maximum number of messages which can be received in
one poll to set in the
<code>com.amazonaws.services.sqs.model.ReceiveMessageRequest</code>.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>visibilityTimeout</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The duration (in seconds) that the received
messages are hidden from subsequent retrieve requests after being retrieved by
a ReceiveMessage request. This only make sense
if its different from
<code>defaultVisibilityTimeout</code>.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>extendMessageVisibility</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.10:</strong> If
enabled a scheduled background task will keep extending the message visibility
on SQS. This is needed if it takes a long time to process the message. If set
to true<code> visibilityTimeout</code> must be set. See details at <a
shape="rect" class="external-link"
href="http://docs.amazonwebservices.com/AWSSimpleQueueService/latest/APIReference/Query_QueryChangeMessageVisibility.html"
rel="nofollow">Amazon docs</a>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>maximumMessageSize</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan=
"1" rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong> The
maximumMessageSize (in bytes) an SQS message can contain for this queue, to set
in the
<code>com.amazonaws.services.sqs.model.SetQueueAttributesRequest</code>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p>messageRetentionPeriod</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.8:</strong> The messageRetentionPeriod
(in seconds) a message will be retained by SQS for this queue, to set in the
<code>com.amazonaws.services.sqs.model.SetQueueAttributesRequest</code>.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>policy</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class=
"confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.8:</strong> The policy for this queue
to set in the
<code>com.amazonaws.services.sqs.model.SetQueueAttributesRequest</code>.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>delaySeconds</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Producer</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.9.3:</strong>
Delay sending messages for a number of seconds.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>waitTimeSeconds</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Producer</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
Duration in seconds (0 to 20) that the ReceiveMessage action call will wait
until a me
ssage is in the queue to include in the response.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p>receiveMessageWaitTimeSeconds</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> If you do not specify
WaitTimeSeconds in the request, the queue attribute
ReceiveMessageWaitTimeSeconds is used to determine how long to
wait.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>queueOwnerAWSAccountId</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.12:</strong> Specify the queue owner
aws account id when you need to connect the queue with different account
owner.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>region</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.12.3:</strong> Specify the queue region
which could be used with <code>queueOwnerAWSAccountId</code> to build the
service URL.<br clear="none">Note: Region will still default to us-east-1 if
 <span>queueOwnerAWSAccountId is not specified</span></p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>redrivePolicy</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>null</code></td><td
colspan="1" rowspan="1" class="confluenceTd">Shared</td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>Camel 2.15</strong>: Specify the
policy that send message to DeadLetter queue. See detail at <a shape="rect"
class="external-link"
href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s
qs-queues-redrivepolicy.html" rel="nofollow">Amazon docs</a>.</td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>proxyHost</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>null</code></td><td
colspan="1" rowspan="1" class="confluenceTd">Shared</td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>Camel 2.16</strong>: Specify a proxy
host to be used inside the client definition.</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>proxyPort</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1"
rowspan="1" class="confluenceTd">Shared</td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Camel 2.16</strong>: Specify a proxy port to be
used inside the client definition.</td></tr></tbody></table>
+</div><p>The queue will be created if they don't already exists. You can
append query options to the URI in the following format:
<strong><code>?options=value&option2=value&...</code></strong></p><h3
id="BookComponentAppendix-URIOptions">URI Options</h3><div class="table-wrap">
+ <table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Context</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>accessKey</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Amazon AWS Access
Key.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>amazonSQSClient</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Reference to a <strong><code>com.a
mazonaws.services.sqs.AmazonSQS</code></strong> in the <a shape="rect"
href="registry.html">Registry</a>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>amazonSQSEndpoint</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The region with which
the <strong><code>aws-sqs</code></strong> client wants to work with. Only
works if Camel creates the <strong><code>aws-sqs</code></strong> client,
i.e., if you explicitly set <strong><code>amazonSQSClient</code></strong>, then
this setting will have no effect. You would have to set it on the client you
create directly</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>attributeNames</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="con
fluenceTd"><p><code>Consumer</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>A list of attribute names to receive when consuming.
</p><p><strong>Camel 2.17:</strong> Multiple names can be separated by comma.
</p><p><strong>Camel 2.16</strong> or older: The type is a Collection so its
much harder to configure and use.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>concurrentConsumers</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>1</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>Consumer</code></td><td colspan="1"
rowspan="1" class="confluenceTd">(<strong>as of 2.15.0</strong>) Allows you to
use multiple threads to poll the SQS queue to increase throughput. You must
also set t<span>he </span><strong><code>maxMessagesPerPoll</code></strong>
option for this to work properly.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>defaultVisibilityTimeout</code></p></td><td
colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The visibility timeout (in seconds) to set
in the
<strong><code>com.amazonaws.services.sqs.model.CreateQueueRequest</code></strong>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>delaySeconds</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Producer</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.9.3:</strong>
Delay sending messages for a number of seconds.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>deleteAfterRead</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Consumer</code></p></td><td colspa
n="1" rowspan="1" class="confluenceTd"><p>Delete message from SQS after it has
been read (and processed by the route).</p><p>If this option is false, then the
same objects will be retrieve over and over again on the polls. Therefore you
need to use the <a shape="rect" href="idempotent-consumer.html">Idempotent
Consumer EIP</a> in the route to filter out duplicates. You can filter using
the <strong><code>S3Constants#BUCKET_NAME</code></strong>
and <strong><code>S3Constants#KEY</code></strong> headers, or only
the <strong><code>S3Constants#KEY</code></strong>
header.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>deleteIfFiltered</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Consumer</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.2,
2.13.0</strong>: Whether or not to send the <strong><code>Delete
Message</code></strong> to the SQS queue if an exchange fails to get through a
filter.</p><p>If <strong><code>false</code></strong> and exchange does not
make it through a Camel filter upstream in the route, then don't send
<strong><code>DeleteMessage</code></strong>.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>extendMessageVisibility</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>Consumer</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.10:</strong> If enabled a
scheduled background task will keep extending the message visibility on SQS.
This is needed if it takes a long time to process the message. If set to
true<strong><code> visibilityTimeout</code></strong> must be set.</p><p>See
details at <a shape="rect" class="external-link"
href="http://docs.amazonwebservices.com/AWSSimpleQueueService/latest/APIReferen
ce/Query_QueryChangeMessageVisibility.html" rel="nofollow">Amazon
docs</a>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>maximumMessageSize</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong>
The <strong><code>maximumMessageSize</code></strong> (in bytes) an SQS
message can contain for this queue, to set in the
<strong><code>com.amazonaws.services.sqs.model.SetQueueAttributesRequest</code></strong>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>maxMessagesPerPoll</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Consumer</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The maximum number of messages
which
can be received in one poll to set in the
<strong><code>com.amazonaws.services.sqs.model.ReceiveMessageRequest</code></strong>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><code>messageAttributeNames</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>Consumer</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>A list of message attribute names to
receive when consuming. </p><p><strong>Camel
2.17:</strong><span> </span>Multiple names can be separated by comma.
<span> </span></p><p><span><strong>Camel 2.16</strong> or older: The type
is a Collection so its much harder to configure and
use.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>messageRetentionPeriod</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>Shared</code></p>
</td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel
2.8:</strong> The <strong><code>messageRetentionPeriod</code></strong> (in
seconds) a message will be retained by SQS for this queue, to set in the
<strong><code>com.amazonaws.services.sqs.model.SetQueueAttributesRequest</code></strong>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>proxyHost</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>Shared</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>Camel 2.16</strong>: Specify a proxy
host to be used inside the client definition.</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>proxyPort</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>null</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>Shared</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><strong>Ca
mel 2.16</strong>: Specify a proxy port to be used inside the client
definition.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>queueOwnerAWSAccountId</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong>
Specify the queue owner aws account id when you need to connect the queue with
different account owner.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>policy</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>Shared</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.8:</strong> The policy for this queue
to set in the
<strong><code>com.amazonaws.services.sqs.model.SetQueueAttributesRequest</code></strong>.
</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>receiveMessageWaitTimeSeconds</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> If
you do not specify <strong><code>WaitTimeSeconds</code></strong> in the
request, the queue
attribute <strong><code>ReceiveMessageWaitTimeSeconds</code></strong> is
used to determine how long to wait.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>redrivePolicy</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>null</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>Shared</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.15</strong>:
Specify the policy that send message
to <strong><code>DeadLetter</code></strong> queue. See deta
il at <a shape="rect" class="external-link"
href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues-redrivepolicy.html"
rel="nofollow">Amazon docs</a>.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>region</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>Shared</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.12.3:</strong> Specify the queue region
which could be used with <strong><code>queueOwnerAWSAccountId</code></strong>
to build the service URL.<br clear="none"><strong>Note</strong>: Region will
still default to <strong><code>us-east-1</code></strong> if
 <span><strong><code>queueOwnerAWSAccountId</code></strong> is not
specified</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>secretKey</code></p></td><td colspan="1"
rowspan="1" class="conf
luenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>Shared</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Amazon AWS Secret Key.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>waitTimeSeconds</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>Producer</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Duration in
seconds (0 to 20) that the <strong><code>ReceiveMessage</code></strong>
action call will wait until a message is in the queue to include in the
response.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>visibilityTimeout</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Shared</code></p></td><td colspan="1"
rowspa
n="1" class="confluenceTd"><p>The duration (in seconds) that the received
messages are hidden from subsequent retrieve requests after being retrieved by
a <strong><code>ReceiveMessage</code></strong> request. This only make
sense if its different from
<strong><code>defaultVisibilityTimeout</code></strong>.</p></td></tr></tbody></table>
</div><div class="confluence-information-macro
confluence-information-macro-information">
<p class="title">Required SQS component options</p>
<span class="aui-icon aui-icon-small aui-iconfont-info
confluence-information-macro-icon"></span>
<div class="confluence-information-macro-body">
- <p>You have to provide the amazonSQSClient in the <a shape="rect"
href="registry.html">Registry</a> or your accessKey and secretKey to access the
<a shape="rect" class="external-link" href="http://aws.amazon.com/sqs"
rel="nofollow">Amazon's SQS</a>.</p>
+ <p>You have to provide
the <strong><code>amazonSQSClient</code></strong> in the <a shape="rect"
href="registry.html">Registry</a> or
your <strong><code>accessKey</code></strong>
and <strong><code>secretKey</code></strong> to access the <a shape="rect"
class="external-link" href="http://aws.amazon.com/sqs" rel="nofollow">Amazon's
SQS</a>.</p>
</div>
</div><h3 id="BookComponentAppendix-BatchConsumer">Batch Consumer</h3><p>This
component implements the <a shape="rect" href="batch-consumer.html">Batch
Consumer</a>.</p><p>This allows you for instance to know how many messages
exists in this batch and for instance let the <a shape="rect"
href="aggregator.html">Aggregator</a> aggregate this number of messages.</p><h3
id="BookComponentAppendix-Usage.1">Usage</h3><h4
id="BookComponentAppendix-MessageheaderssetbytheSQSproducer">Message headers
set by the SQS producer</h4><div class="table-wrap">
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>CamelAwsSqsMD5OfBody</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The MD5 checksum of the Amazon
SQS message.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelAwsSqsMessageId</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The Amazon SQS message
ID.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelAwsSqsDelaySeconds</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>Integer</code></p></td><td co
lspan="1" rowspan="1" class="confluenceTd"><p>Since <strong>Camel
2.11</strong>, the delay seconds that the Amazon SQS message can be see by
others.</p></td></tr></tbody></table>
@@ -245,18 +245,18 @@
<div class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter">from(&quot;aws-sqs://MyQueue?amazonSQSClient=#client&amp;delay=5000&amp;maxMessagesPerPoll=5&quot;)
.to(&quot;mock:result&quot;); </script>
</div>
-</div><h3 id="BookComponentAppendix-Dependencies">Dependencies</h3><p>Maven
users will need to add the following dependency to their pom.xml.</p><div
class="code panel pdl" style="border-width: 1px;">
+</div><h3 id="BookComponentAppendix-Dependencies">Dependencies</h3><p>Maven
users will need to add the following dependency to their
<strong><code>pom.xml</code></strong>.</p><div class="code panel pdl"
style="border-width: 1px;">
<div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;">
<b>pom.xml</b>
</div>
<div class="codeContent panelContent pdl">
<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter">&lt;dependency&gt;
&lt;groupId&gt;org.apache.camel&lt;/groupId&gt;
&lt;artifactId&gt;camel-aws&lt;/artifactId&gt;
&lt;version&gt;${camel-version}&lt;/version&gt;
&lt;/dependency&gt; </script>
</div>
-</div><p>where <code>${camel-version</code>} must be replaced by the actual
version of Camel (2.6 or higher).</p><h3
id="BookComponentAppendix-JMS-styleSelectors">JMS-style Selectors</h3><p>SQS
does not allow selectors, but you can effectively achieve this by using the <a
shape="rect" href="message-filter.html">Camel Filter EIP</a> and setting an
appropriate <code>visibilityTimeout</code>. When SQS dispatches a message, it
will wait up to the visibility timeout before it will try to dispatch the
message to a different consumer unless a DeleteMessage is received. By default,
Camel will always send the DeleteMessage at the end of the route, unless the
route ended in failure. To achieve appropriate filtering and not send the
DeleteMessage even on successful completion of the route, use a Filter:</p><div
class="code panel pdl" style="border-width: 1px;">
+</div><p>where <strong><code>${camel-version</code>}</strong> must be replaced
by the actual version of Camel (2.6 or higher).</p><h3
id="BookComponentAppendix-JMS-styleSelectors">JMS-style Selectors</h3><p>SQS
does not allow selectors, but you can effectively achieve this by using the <a
shape="rect" href="message-filter.html">Camel Filter EIP</a> and setting an
appropriate <strong><code>visibilityTimeout</code></strong>. When SQS
dispatches a message, it will wait up to the visibility timeout before it will
try to dispatch the message to a different consumer unless
a <strong><code>DeleteMessage</code></strong> is received. By default,
Camel will always send the <strong><code>DeleteMessage</code></strong> at
the end of the route, unless the route ended in failure. To achieve appropriate
filtering and not send the <strong><code>DeleteMessage</code></strong>
even on successful completion of the route, use a Filter:</p><div class="code
panel pdl" style="border-width: 1p
x;">
<div class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter">from(&quot;aws-sqs://MyQueue?amazonSQSClient=#client&amp;defaultVisibilityTimeout=5000&amp;deleteIfFiltered=false&quot;)
.filter(&quot;${header.login} == true&quot;)
.to(&quot;mock:result&quot;); </script>
</div>
-</div><p>In the above code, if an exchange doesn't have an appropriate header,
it will not make it through the filter AND also not be deleted from the SQS
queue. After 5000 miliseconds, the message will become visible to other
consumers.</p><p></p><h3 id="BookComponentAppendix-SeeAlso.2">See Also</h3>
+</div><p>In the above code, if an exchange doesn't have an appropriate header,
it will not make it through the filter AND also not be deleted from the SQS
queue. After <code>5000</code> miliseconds, the message will become
visible to other consumers.</p><p></p><h3
id="BookComponentAppendix-SeeAlso.2">See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul><ul
class="alternate"><li><a shape="rect" href="aws.html">AWS
Component</a></li></ul><h2 id="BookComponentAppendix-AtomComponent">Atom
Component</h2><p>The <strong>atom:</strong> component is used for polling Atom
feeds.</p><p>Camel will poll the feed every 60 seconds by default.<br
clear="none"> <strong>Note:</strong> The component currently only supports
polling (consuming) feeds.</p><p>Maven users will need to add the following
dependency to their <code>pom.xml</code> for this component:</p><div
class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter">&lt;dependency&gt;
&lt;groupId&gt;org.apache.camel&lt;/groupId&gt;
&lt;artifactId&gt;camel-atom&lt;/artifactId&gt;
&lt;version&gt;x.x.x&lt;/version&gt; &lt;!-- use the same
version as your Camel core version --&gt; &lt;/dependency&gt;
</script>
@@ -621,8 +621,8 @@ cometds://localhost:8443/service/mychann
<div class="confluence-information-macro-body">
<p>When using CXF in streaming modes (see DataFormat option), then also read
about <a shape="rect" href="stream-caching.html">Stream caching</a>.</p>
</div>
-</div><p>The <strong>cxf:</strong> component provides integration with <a
shape="rect" href="http://cxf.apache.org">Apache CXF</a> for connecting to
JAX-WS services hosted in CXF.</p><p><style type="text/css">/**/
div.rbtoc1476919081689 {padding: 0px;} div.rbtoc1476919081689 ul {list-style:
disc;margin-left: 0px;} div.rbtoc1476919081689 li {margin-left:
0px;padding-left: 0px;} /**/</style>
- </p><div class="toc-macro rbtoc1476919081689">
+</div><p>The <strong>cxf:</strong> component provides integration with <a
shape="rect" href="http://cxf.apache.org">Apache CXF</a> for connecting to
JAX-WS services hosted in CXF.</p><p><style type="text/css">/**/
div.rbtoc1476987464342 {padding: 0px;} div.rbtoc1476987464342 ul {list-style:
disc;margin-left: 0px;} div.rbtoc1476987464342 li {margin-left:
0px;padding-left: 0px;} /**/</style>
+ </p><div class="toc-macro rbtoc1476987464342">
<ul class="toc-indentation"><li><a shape="rect"
href="#BookComponentAppendix-CXFComponent">CXF Component</a>
<ul class="toc-indentation"><li><a shape="rect"
href="#BookComponentAppendix-URIformat">URI format</a></li><li><a shape="rect"
href="#BookComponentAppendix-Options">Options</a>
<ul class="toc-indentation"><li><a shape="rect"
href="#BookComponentAppendix-Thedescriptionsofthedataformats">The descriptions
of the dataformats</a>