This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
commit 8be7f48b78d087a0310b06a5f31a848cb30acd9c Author: Andrea Cosentino <[email protected]> AuthorDate: Wed Feb 17 09:05:32 2021 +0100 CAMEL-16115 - Remove Camel-AWS-* components - AWS-SQS --- .../org/apache/camel/catalog/components.properties | 1 - .../apache/camel/catalog/components/aws-sqs.json | 126 ------- .../org/apache/camel/catalog/docs.properties | 1 - .../camel/catalog/docs/aws-sqs-component.adoc | 400 -------------------- .../component/ComponentsBuilderFactory.java | 14 - .../src/generated/resources/metadata.json | 23 -- .../builder/endpoint/EndpointBuilderFactory.java | 1 - .../camel/builder/endpoint/EndpointBuilders.java | 1 - .../builder/endpoint/StaticEndpointBuilders.java | 47 +-- docs/components/modules/ROOT/nav.adoc | 1 - .../modules/ROOT/pages/aws-sqs-component.adoc | 402 --------------------- 11 files changed, 1 insertion(+), 1016 deletions(-) diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties index 66e4934..f4843c2 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties @@ -34,7 +34,6 @@ aws-msk aws-s3 aws-ses aws-sns -aws-sqs aws-swf aws2-athena aws2-cw diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-sqs.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-sqs.json deleted file mode 100644 index 3dbe6a5..0000000 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-sqs.json +++ /dev/null @@ -1,126 +0,0 @@ -{ - "component": { - "kind": "component", - "name": "aws-sqs", - "title": "AWS Simple Queue Service (SQS)", - "description": "Sending and receive messages to\/from AWS SQS service.", - "deprecated": true, - "deprecatedSince": "3.8.0", - "firstVersion": "2.6.0", - "label": "cloud,messaging", - "javaType": "org.apache.camel.component.aws.sqs.SqsComponent", - "supportLevel": "Stable", - "groupId": "org.apache.camel", - "artifactId": "camel-aws-sqs", - "version": "3.9.0-SNAPSHOT", - "scheme": "aws-sqs", - "extendsScheme": "", - "syntax": "aws-sqs:queueNameOrArn", - "async": false, - "api": false, - "consumerOnly": false, - "producerOnly": false, - "lenientProperties": false - }, - "componentProperties": { - "amazonAWSHost": { "kind": "property", "displayName": "Amazon AWSHost", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "amazonaws.com", "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The hostname of the Amazon AWS cloud." }, - "amazonSQSClient": { "kind": "property", "displayName": "Amazon SQSClient", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.services.sqs.AmazonSQS", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "To use the AmazonSQS as client" }, - "autoCreateQueue": { "kind": "property", "displayName": "Auto Create Queue", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Setting the autocreation of the queue" }, - "autoDiscoverClient": { "kind": "property", "displayName": "Auto Discover Client", "group": "common", "label": "common", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Setting the autoDiscoverClient mechanism, if true, the component will look for a client instan [...] - "configuration": { "kind": "property", "displayName": "Configuration", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.aws.sqs.SqsConfiguration", "deprecated": false, "autowired": false, "secret": false, "description": "The component configuration" }, - "protocol": { "kind": "property", "displayName": "Protocol", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "https", "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The underlying protocol used to communicate with SQS" }, - "proxyProtocol": { "kind": "property", "displayName": "Proxy Protocol", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the SQS client" }, - "queueOwnerAWSAccountId": { "kind": "property", "displayName": "Queue Owner AWSAccount Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Specify the queue owner aws account id when you need to connect the queue with different account owner." }, - "region": { "kind": "property", "displayName": "Region", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. When using this parameter, the configurat [...] - "attributeNames": { "kind": "property", "displayName": "Attribute Names", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "A list of attribute names to receive when consuming. Multiple names can be separated by comma." }, - "bridgeErrorHandler": { "kind": "property", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 me [...] - "concurrentConsumers": { "kind": "property", "displayName": "Concurrent Consumers", "group": "consumer", "label": "consumer", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Allows you to use multiple threads to poll the sqs queue to increase throughput" }, - "defaultVisibilityTimeout": { "kind": "property", "displayName": "Default Visibility Timeout", "group": "consumer", "label": "consumer", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The default visibility timeout (in seconds)" }, - "deleteAfterRead": { "kind": "property", "displayName": "Delete After Read", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Delete message from SQS after it has been read" }, - "deleteIfFiltered": { "kind": "property", "displayName": "Delete If Filtered", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through [...] - "extendMessageVisibility": { "kind": "property", "displayName": "Extend Message Visibility", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "If enabled then a scheduled background task will keep extending the message vis [...] - "kmsDataKeyReusePeriodSeconds": { "kind": "property", "displayName": "Kms Data Key Reuse Period Seconds", "group": "consumer", "label": "consumer", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The length of time, in seconds, for which Amazon SQS can reuse a data key to en [...] - "kmsMasterKeyId": { "kind": "property", "displayName": "Kms Master Key Id", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK." }, - "messageAttributeNames": { "kind": "property", "displayName": "Message Attribute Names", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "A list of message attribute names to receive when consuming. Multiple names can be separated by co [...] - "serverSideEncryptionEnabled": { "kind": "property", "displayName": "Server Side Encryption Enabled", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Define if Server Side Encryption is enabled or not on the queue" }, - "visibilityTimeout": { "kind": "property", "displayName": "Visibility Timeout", "group": "consumer", "label": "consumer", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after b [...] - "waitTimeSeconds": { "kind": "property", "displayName": "Wait Time Seconds", "group": "consumer", "label": "consumer", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue [...] - "delaySeconds": { "kind": "property", "displayName": "Delay Seconds", "group": "producer", "label": "producer", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Delay sending messages for a number of seconds." }, - "lazyStartProducer": { "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 star [...] - "messageDeduplicationIdStrategy": { "kind": "property", "displayName": "Message Deduplication Id Strategy", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "useExchangeId", "useContentBasedDeduplication" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "useExchangeId", "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", " [...] - "messageGroupIdStrategy": { "kind": "property", "displayName": "Message Group Id Strategy", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "useConstant", "useExchangeId", "usePropertyValue" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Only for FIFO queues. Strategy [...] - "operation": { "kind": "property", "displayName": "Operation", "group": "producer", "label": "producer", "required": false, "type": "object", "javaType": "org.apache.camel.component.aws.sqs.SqsOperations", "enum": [ "sendBatchMessage", "deleteMessage", "listQueues" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The operation to do in case t [...] - "autowiredEnabled": { "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which t [...] - "delayQueue": { "kind": "property", "displayName": "Delay Queue", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Define if you want to apply delaySeconds option to the queue or on single messages" }, - "queueUrl": { "kind": "property", "displayName": "Queue Url", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is i [...] - "proxyHost": { "kind": "property", "displayName": "Proxy Host", "group": "proxy", "label": "proxy", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the SQS client" }, - "proxyPort": { "kind": "property", "displayName": "Proxy Port", "group": "proxy", "label": "proxy", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the SQS client" }, - "maximumMessageSize": { "kind": "property", "displayName": "Maximum Message Size", "group": "queue", "label": "queue", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The maximumMessageSize (in bytes) an SQS message can contain for this queue." }, - "messageRetentionPeriod": { "kind": "property", "displayName": "Message Retention Period", "group": "queue", "label": "queue", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue." }, - "policy": { "kind": "property", "displayName": "Policy", "group": "queue", "label": "queue", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The policy for this queue" }, - "receiveMessageWaitTimeSeconds": { "kind": "property", "displayName": "Receive Message Wait Time Seconds", "group": "queue", "label": "queue", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMes [...] - "redrivePolicy": { "kind": "property", "displayName": "Redrive Policy", "group": "queue", "label": "queue", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Specify the policy that send message to DeadLetter queue. See detail at Amazon docs." }, - "accessKey": { "kind": "property", "displayName": "Access Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Amazon AWS Access Key" }, - "secretKey": { "kind": "property", "displayName": "Secret Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Amazon AWS Secret Key" } - }, - "properties": { - "queueNameOrArn": { "kind": "path", "displayName": "Queue Name Or Arn", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Queue name or ARN" }, - "amazonAWSHost": { "kind": "parameter", "displayName": "Amazon AWSHost", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "amazonaws.com", "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The hostname of the Amazon AWS cloud." }, - "amazonSQSClient": { "kind": "parameter", "displayName": "Amazon SQSClient", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.services.sqs.AmazonSQS", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "To use the AmazonSQS as client" }, - "autoCreateQueue": { "kind": "parameter", "displayName": "Auto Create Queue", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Setting the autocreation of the queue" }, - "autoDiscoverClient": { "kind": "parameter", "displayName": "Auto Discover Client", "group": "common", "label": "common", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Setting the autoDiscoverClient mechanism, if true, the component will look for a client insta [...] - "headerFilterStrategy": { "kind": "parameter", "displayName": "Header Filter Strategy", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.spi.HeaderFilterStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "To use a custom HeaderFilterStrategy to map headers to\/from Camel." }, - "protocol": { "kind": "parameter", "displayName": "Protocol", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "https", "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The underlying protocol used to communicate with SQS" }, - "proxyProtocol": { "kind": "parameter", "displayName": "Proxy Protocol", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the SQS client" }, - "queueOwnerAWSAccountId": { "kind": "parameter", "displayName": "Queue Owner AWSAccount Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Specify the queue owner aws account id when you need to connect the queue with different account owner." }, - "region": { "kind": "parameter", "displayName": "Region", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. When using this parameter, the configura [...] - "attributeNames": { "kind": "parameter", "displayName": "Attribute Names", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "A list of attribute names to receive when consuming. Multiple names can be separated by comma." }, - "bridgeErrorHandler": { "kind": "parameter", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 m [...] - "concurrentConsumers": { "kind": "parameter", "displayName": "Concurrent Consumers", "group": "consumer", "label": "consumer", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Allows you to use multiple threads to poll the sqs queue to increase throughput" }, - "defaultVisibilityTimeout": { "kind": "parameter", "displayName": "Default Visibility Timeout", "group": "consumer", "label": "consumer", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The default visibility timeout (in seconds)" }, - "deleteAfterRead": { "kind": "parameter", "displayName": "Delete After Read", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Delete message from SQS after it has been read" }, - "deleteIfFiltered": { "kind": "parameter", "displayName": "Delete If Filtered", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through [...] - "extendMessageVisibility": { "kind": "parameter", "displayName": "Extend Message Visibility", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "If enabled then a scheduled background task will keep extending the message vi [...] - "kmsDataKeyReusePeriodSeconds": { "kind": "parameter", "displayName": "Kms Data Key Reuse Period Seconds", "group": "consumer", "label": "consumer", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The length of time, in seconds, for which Amazon SQS can reuse a data key to e [...] - "kmsMasterKeyId": { "kind": "parameter", "displayName": "Kms Master Key Id", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK." }, - "maxMessagesPerPoll": { "kind": "parameter", "displayName": "Max Messages Per Poll", "group": "consumer", "label": "consumer", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited." }, - "messageAttributeNames": { "kind": "parameter", "displayName": "Message Attribute Names", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "A list of message attribute names to receive when consuming. Multiple names can be separated by c [...] - "sendEmptyMessageWhenIdle": { "kind": "parameter", "displayName": "Send Empty Message When Idle", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead." }, - "serverSideEncryptionEnabled": { "kind": "parameter", "displayName": "Server Side Encryption Enabled", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Define if Server Side Encryption is enabled or not on the queue" }, - "visibilityTimeout": { "kind": "parameter", "displayName": "Visibility Timeout", "group": "consumer", "label": "consumer", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after [...] - "waitTimeSeconds": { "kind": "parameter", "displayName": "Wait Time Seconds", "group": "consumer", "label": "consumer", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue [...] - "exceptionHandler": { "kind": "parameter", "displayName": "Exception Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.", "deprecated": false, "autowired": false, "secret": false, "description": "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 con [...] - "exchangePattern": { "kind": "parameter", "displayName": "Exchange Pattern", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut", "InOptionalOut" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the exchange pattern when the consumer creates an exchange." }, - "pollStrategy": { "kind": "parameter", "displayName": "Poll Strategy", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.PollingConsumerPollStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation [...] - "delaySeconds": { "kind": "parameter", "displayName": "Delay Seconds", "group": "producer", "label": "producer", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Delay sending messages for a number of seconds." }, - "lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 sta [...] - "messageDeduplicationIdStrategy": { "kind": "parameter", "displayName": "Message Deduplication Id Strategy", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "useExchangeId", "useContentBasedDeduplication" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "useExchangeId", "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", [...] - "messageGroupIdStrategy": { "kind": "parameter", "displayName": "Message Group Id Strategy", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "useConstant", "useExchangeId", "usePropertyValue" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Only for FIFO queues. Strategy [...] - "operation": { "kind": "parameter", "displayName": "Operation", "group": "producer", "label": "producer", "required": false, "type": "object", "javaType": "org.apache.camel.component.aws.sqs.SqsOperations", "enum": [ "sendBatchMessage", "deleteMessage", "listQueues" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The operation to do in case [...] - "delayQueue": { "kind": "parameter", "displayName": "Delay Queue", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Define if you want to apply delaySeconds option to the queue or on single messages" }, - "queueUrl": { "kind": "parameter", "displayName": "Queue Url", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is [...] - "proxyHost": { "kind": "parameter", "displayName": "Proxy Host", "group": "proxy", "label": "proxy", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the SQS client" }, - "proxyPort": { "kind": "parameter", "displayName": "Proxy Port", "group": "proxy", "label": "proxy", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the SQS client" }, - "maximumMessageSize": { "kind": "parameter", "displayName": "Maximum Message Size", "group": "queue", "label": "queue", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The maximumMessageSize (in bytes) an SQS message can contain for this queue." }, - "messageRetentionPeriod": { "kind": "parameter", "displayName": "Message Retention Period", "group": "queue", "label": "queue", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue." }, - "policy": { "kind": "parameter", "displayName": "Policy", "group": "queue", "label": "queue", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "The policy for this queue" }, - "receiveMessageWaitTimeSeconds": { "kind": "parameter", "displayName": "Receive Message Wait Time Seconds", "group": "queue", "label": "queue", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMe [...] - "redrivePolicy": { "kind": "parameter", "displayName": "Redrive Policy", "group": "queue", "label": "queue", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Specify the policy that send message to DeadLetter queue. See detail at Amazon docs." }, - "backoffErrorThreshold": { "kind": "parameter", "displayName": "Backoff Error Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in." }, - "backoffIdleThreshold": { "kind": "parameter", "displayName": "Backoff Idle Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent idle polls that should happen before the backoffMultipler should kick-in." }, - "backoffMultiplier": { "kind": "parameter", "displayName": "Backoff Multiplier", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "To let the scheduled polling consumer backoff if there has been a number of subsequent idles\/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening agai [...] - "delay": { "kind": "parameter", "displayName": "Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 500, "description": "Milliseconds before the next poll." }, - "greedy": { "kind": "parameter", "displayName": "Greedy", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages." }, - "initialDelay": { "kind": "parameter", "displayName": "Initial Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1000, "description": "Milliseconds before the first poll starts." }, - "repeatCount": { "kind": "parameter", "displayName": "Repeat Count", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "description": "Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever." }, - "runLoggingLevel": { "kind": "parameter", "displayName": "Run Logging Level", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "org.apache.camel.LoggingLevel", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "TRACE", "description": "The consumer logs a start\/complete log line when it polls. This option allows you to configure the logging level [...] - "scheduledExecutorService": { "kind": "parameter", "displayName": "Scheduled Executor Service", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.ScheduledExecutorService", "deprecated": false, "autowired": false, "secret": false, "description": "Allows for configuring a custom\/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool." }, - "scheduler": { "kind": "parameter", "displayName": "Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "none", "description": "To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler" }, - "schedulerProperties": { "kind": "parameter", "displayName": "Scheduler Properties", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "scheduler.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "description": "To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler." }, - "startScheduler": { "kind": "parameter", "displayName": "Start Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether the scheduler should be auto started." }, - "timeUnit": { "kind": "parameter", "displayName": "Time Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.TimeUnit", "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "MILLISECONDS", "description": "Time unit for initialDelay and delay options." }, - "useFixedDelay": { "kind": "parameter", "displayName": "Use Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details." }, - "accessKey": { "kind": "parameter", "displayName": "Access Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Amazon AWS Access Key" }, - "secretKey": { "kind": "parameter", "displayName": "Secret Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.sqs.SqsConfiguration", "configurationField": "configuration", "description": "Amazon AWS Secret Key" } - } -} diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties index 3f924e5..6896e38 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties @@ -38,7 +38,6 @@ aws-msk-component aws-s3-component aws-ses-component aws-sns-component -aws-sqs-component aws-summary aws-swf-component aws-xray diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-sqs-component.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-sqs-component.adoc deleted file mode 100644 index b43dab9..0000000 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-sqs-component.adoc +++ /dev/null @@ -1,400 +0,0 @@ -[[aws-sqs-component]] -= AWS Simple Queue Service (SQS) Component (deprecated) -:docTitle: AWS Simple Queue Service (SQS) -:artifactId: camel-aws-sqs -:description: Sending and receive messages to/from AWS SQS service. -:since: 2.6 -:supportLevel: Stable-deprecated -:deprecated: *deprecated* -:component-header: Both producer and consumer are supported -include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws-sqs.adoc[opts=optional] -//Manually maintained attributes -:group: AWS - -*Since Camel {since}* - -*{component-header}* - -The sqs component supports sending and receiving messages to -https://aws.amazon.com/sqs[Amazon's SQS] service. - -Prerequisites - -You must have a valid Amazon Web Services developer account, and be -signed up to use Amazon SQS. More information is available at -https://aws.amazon.com/sqs[Amazon SQS]. - -== URI Format - -[source,java] ------------------------------- -aws-sqs://queueNameOrArn[?options] ------------------------------- - -The queue will be created if they don't already exists. + - You can append query options to the URI in the following format, -?options=value&option2=value&... - -== URI Options - - -// component options: START -The AWS Simple Queue Service (SQS) component supports 39 options, which are listed below. - - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *amazonAWSHost* (common) | The hostname of the Amazon AWS cloud. | amazonaws.com | String -| *amazonSQSClient* (common) | To use the AmazonSQS as client | | AmazonSQS -| *autoCreateQueue* (common) | Setting the autocreation of the queue | true | boolean -| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | boolean -| *configuration* (common) | The component configuration | | SqsConfiguration -| *protocol* (common) | The underlying protocol used to communicate with SQS | https | String -| *proxyProtocol* (common) | To define a proxy protocol when instantiating the SQS client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol -| *queueOwnerAWSAccountId* (common) | Specify the queue owner aws account id when you need to connect the queue with different account owner. | | String -| *region* (common) | Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name() | | String -| *attributeNames* (consumer) | A list of attribute names to receive when consuming. Multiple names can be separated by comma. | | String -| *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 -| *concurrentConsumers* (consumer) | Allows you to use multiple threads to poll the sqs queue to increase throughput | 1 | int -| *defaultVisibilityTimeout* (consumer) | The default visibility timeout (in seconds) | | Integer -| *deleteAfterRead* (consumer) | Delete message from SQS after it has been read | true | boolean -| *deleteIfFiltered* (consumer) | 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. | true | boolean -| *extendMessageVisibility* (consumer) | If enabled then 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 defaultVisibilityTimeout must be set. See details at Amazon docs. | false | boolean -| *kmsDataKeyReusePeriodSeconds* (consumer) | The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). | | Integer -| *kmsMasterKeyId* (consumer) | The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. | | String -| *messageAttributeNames* (consumer) | A list of message attribute names to receive when consuming. Multiple names can be separated by comma. | | String -| *serverSideEncryptionEnabled* (consumer) | Define if Server Side Encryption is enabled or not on the queue | false | boolean -| *visibilityTimeout* (consumer) | The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently. | | Integer -| *waitTimeSeconds* (consumer) | 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. | | Integer -| *delaySeconds* (producer) | Delay sending messages for a number of seconds. | | Integer -| *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 [...] -| *messageDeduplicationIdStrategy* (producer) | Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. Can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message. There are 2 enums and the value can be one of: useExchangeId, useContentBasedDeduplication | useExchangeId | String -| *messageGroupIdStrategy* (producer) | Only for FIFO queues. Strategy for setting the messageGroupId on the message. Can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used. There are 3 enums and the value can be one of: useConstant, useExchangeId, usePropertyValue | | String -| *operation* (producer) | The operation to do in case the user don't want to send only a message. There are 3 enums and the value can be one of: sendBatchMessage, deleteMessage, listQueues | | SqsOperations -| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean -| *delayQueue* (advanced) | Define if you want to apply delaySeconds option to the queue or on single messages | false | boolean -| *queueUrl* (advanced) | To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes. | | String -| *proxyHost* (proxy) | To define a proxy host when instantiating the SQS client | | String -| *proxyPort* (proxy) | To define a proxy port when instantiating the SQS client | | Integer -| *maximumMessageSize* (queue) | The maximumMessageSize (in bytes) an SQS message can contain for this queue. | | Integer -| *messageRetentionPeriod* (queue) | The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. | | Integer -| *policy* (queue) | The policy for this queue | | String -| *receiveMessageWaitTimeSeconds* (queue) | If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. | | Integer -| *redrivePolicy* (queue) | Specify the policy that send message to DeadLetter queue. See detail at Amazon docs. | | String -| *accessKey* (security) | Amazon AWS Access Key | | String -| *secretKey* (security) | Amazon AWS Secret Key | | String -|=== -// component options: END - - - - - - - - -// endpoint options: START -The AWS Simple Queue Service (SQS) endpoint is configured using URI syntax: - ----- -aws-sqs:queueNameOrArn ----- - -with the following path and query parameters: - -=== Path Parameters (1 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *queueNameOrArn* | *Required* Queue name or ARN | | String -|=== - - -=== Query Parameters (57 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *amazonAWSHost* (common) | The hostname of the Amazon AWS cloud. | amazonaws.com | String -| *amazonSQSClient* (common) | To use the AmazonSQS as client | | AmazonSQS -| *autoCreateQueue* (common) | Setting the autocreation of the queue | true | boolean -| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | boolean -| *headerFilterStrategy* (common) | To use a custom HeaderFilterStrategy to map headers to/from Camel. | | HeaderFilterStrategy -| *protocol* (common) | The underlying protocol used to communicate with SQS | https | String -| *proxyProtocol* (common) | To define a proxy protocol when instantiating the SQS client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol -| *queueOwnerAWSAccountId* (common) | Specify the queue owner aws account id when you need to connect the queue with different account owner. | | String -| *region* (common) | Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name() | | String -| *attributeNames* (consumer) | A list of attribute names to receive when consuming. Multiple names can be separated by comma. | | String -| *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 -| *concurrentConsumers* (consumer) | Allows you to use multiple threads to poll the sqs queue to increase throughput | 1 | int -| *defaultVisibilityTimeout* (consumer) | The default visibility timeout (in seconds) | | Integer -| *deleteAfterRead* (consumer) | Delete message from SQS after it has been read | true | boolean -| *deleteIfFiltered* (consumer) | 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. | true | boolean -| *extendMessageVisibility* (consumer) | If enabled then 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 defaultVisibilityTimeout must be set. See details at Amazon docs. | false | boolean -| *kmsDataKeyReusePeriodSeconds* (consumer) | The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). | | Integer -| *kmsMasterKeyId* (consumer) | The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. | | String -| *maxMessagesPerPoll* (consumer) | Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited. | | int -| *messageAttributeNames* (consumer) | A list of message attribute names to receive when consuming. Multiple names can be separated by comma. | | String -| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | false | boolean -| *serverSideEncryptionEnabled* (consumer) | Define if Server Side Encryption is enabled or not on the queue | false | boolean -| *visibilityTimeout* (consumer) | The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently. | | Integer -| *waitTimeSeconds* (consumer) | 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. | | Integer -| *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 -| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPollStrategy -| *delaySeconds* (producer) | Delay sending messages for a number of seconds. | | Integer -| *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 [...] -| *messageDeduplicationIdStrategy* (producer) | Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. Can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message. There are 2 enums and the value can be one of: useExchangeId, useContentBasedDeduplication | useExchangeId | String -| *messageGroupIdStrategy* (producer) | Only for FIFO queues. Strategy for setting the messageGroupId on the message. Can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used. There are 3 enums and the value can be one of: useConstant, useExchangeId, usePropertyValue | | String -| *operation* (producer) | The operation to do in case the user don't want to send only a message. There are 3 enums and the value can be one of: sendBatchMessage, deleteMessage, listQueues | | SqsOperations -| *delayQueue* (advanced) | Define if you want to apply delaySeconds option to the queue or on single messages | false | boolean -| *queueUrl* (advanced) | To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes. | | String -| *proxyHost* (proxy) | To define a proxy host when instantiating the SQS client | | String -| *proxyPort* (proxy) | To define a proxy port when instantiating the SQS client | | Integer -| *maximumMessageSize* (queue) | The maximumMessageSize (in bytes) an SQS message can contain for this queue. | | Integer -| *messageRetentionPeriod* (queue) | The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. | | Integer -| *policy* (queue) | The policy for this queue | | String -| *receiveMessageWaitTimeSeconds* (queue) | If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. | | Integer -| *redrivePolicy* (queue) | Specify the policy that send message to DeadLetter queue. See detail at Amazon docs. | | String -| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int -| *delay* (scheduler) | Milliseconds before the next poll. | 500 | long -| *greedy* (scheduler) | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | false | boolean -| *initialDelay* (scheduler) | Milliseconds before the first poll starts. | 1000 | long -| *repeatCount* (scheduler) | Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. | 0 | long -| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | TRACE | LoggingLevel -| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutorService -| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler | none | Object -| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. | | Map -| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean -| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. There are 7 enums and the value can be one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS | MILLISECONDS | TimeUnit -| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean -| *accessKey* (security) | Amazon AWS Access Key | | String -| *secretKey* (security) | Amazon AWS Secret Key | | String -|=== -// endpoint options: END - - - - - - - - -Required SQS component options - -You have to provide the amazonSQSClient in the -Registry or your accessKey and secretKey to access -the https://aws.amazon.com/sqs[Amazon's SQS]. - -== Batch Consumer - -This component implements the Batch Consumer. - -This allows you for instance to know how many messages exists in this -batch and for instance let the Aggregator -aggregate this number of messages. - -== Usage - -=== Message headers set by the SQS producer - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsSqsMD5OfBody` |`String` |The MD5 checksum of the Amazon SQS message. - -|`CamelAwsSqsMessageId` |`String` |The Amazon SQS message ID. - -|`CamelAwsSqsDelaySeconds` |`Integer` |The delay seconds that the Amazon SQS message can be -see by others. -|======================================================================= - -=== Message headers set by the SQS consumer - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsSqsMD5OfBody` |`String` |The MD5 checksum of the Amazon SQS message. - -|`CamelAwsSqsMessageId` |`String` |The Amazon SQS message ID. - -|`CamelAwsSqsReceiptHandle` |`String` |The Amazon SQS message receipt handle. - -|`CamelAwsSqsMessageAttributes` |`Map<String, String>` |The Amazon SQS message attributes. -|======================================================================= - -=== Advanced AmazonSQS configuration - -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: - -[source,java] --------------------------------------------------------------------------------------- -AWSCredentials awsCredentials = new BasicAWSCredentials("myAccessKey", "mySecretKey"); - -ClientConfiguration clientConfiguration = new ClientConfiguration(); -clientConfiguration.setProxyHost("http://myProxyHost";); -clientConfiguration.setProxyPort(8080); - -AmazonSQS client = new AmazonSQSClient(awsCredentials, clientConfiguration); - -registry.bind("client", client); --------------------------------------------------------------------------------------- - -and refer to it in your Camel aws-sqs component configuration: - -[source,java] ---------------------------------------------------------------------------------- -from("aws-sqs://MyQueue?amazonSQSClient=#client&delay=5000&maxMessagesPerPoll=5") -.to("mock:result"); ---------------------------------------------------------------------------------- - -=== Creating or updating an SQS Queue - -In the SQS Component, when an endpoint is started, a check is executed to obtain information -about the existence of the queue or not. You're able to customize the creation through the QueueAttributeName -mapping with the SQSConfiguration option. - -[source,java] ---------------------------------------------------------------------------------- -from("aws-sqs://MyQueue?amazonSQSClient=#client&delay=5000&maxMessagesPerPoll=5") -.to("mock:result"); ---------------------------------------------------------------------------------- - -In this example if the MyQueue queue is not already created on AWS (and the autoCreateQueue option is set to true), it will be created with default parameters from the -SQS configuration. If it's already up on AWS, the SQS configuration options will be used to override the existent AWS configuration. - -=== DelayQueue VS Delay for Single message - -When the option delayQueue is set to true, the SQS Queue will be a DelayQueue with the -DelaySeconds option as delay. For more information about DelayQueue you can read the https://docs.aws.amazon.com/en_us/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-delay-queues.html[AWS SQS documentation]. -One important information to take into account is the following: - -- For standard queues, the per-queue delay setting is not retroactive—changing the setting doesn't affect the delay of messages already in the queue. -- For FIFO queues, the per-queue delay setting is retroactive—changing the setting affects the delay of messages already in the queue. - -as stated in the official documentation. If you want to specify a delay on single messages, you can ignore the delayQueue option, while you can set this option -to true, if you need to add a fixed delay to all messages enqueued. - -=== Server Side Encryption - -There is a set of Server Side Encryption attributes for a queue. The related option are serverSideEncryptionEnabled, keyMasterKeyId and kmsDataKeyReusePeriod. -The SSE is disabled by default. You need to explicitly set the option to true and set the related parameters as queue attributes. - -== 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-aws-sqs</artifactId> - <version>${camel-version}</version> -</dependency> ---------------------------------------- - -where `$\{camel-version}` must be replaced by the actual version of Camel. - -== JMS-style Selectors - -SQS does not allow selectors, but you can effectively achieve this by -using the Camel Filter EIP and setting an -appropriate `visibilityTimeout`. 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: - -[source,java] ------------------------------------------------------------------------------------------------------- -from("aws-sqs://MyQueue?amazonSQSClient=#client&defaultVisibilityTimeout=5000&deleteIfFiltered=false&deleteAfterRead=false") -.filter("${header.login} == true") -.to("mock:result"); ------------------------------------------------------------------------------------------------------- - -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 milliseconds, the message will become visible to other -consumers. - -== Available Producer Operations -- single message (default) -- sendBatchMessage -- deleteMessage -- listQueues - -== Send Batch Message - -You can set a `SendMessageBatchRequest` or an `Iterable` - ------------------------------------------------------------------------------------------------------- -from("direct:start") - .setHeader(SqsConstants.SQS_OPERATION, constant("sendBatchMessage")).to("aws-sqs://camel-1?accessKey=RAW(xxx)&secretKey=RAW(xxx)®ion=EU_WEST_1"); ------------------------------------------------------------------------------------------------------- - -As result you'll get an exchange containing a `SendMessageBatchResult` instance, that you can examinate to check what messages were successfull and what not. -The id set on each message of the batch will be a Random UUID. - -== Delete single Message - -Use deleteMessage operation to delete a single message. You'll need to set a receipt handle header for the message you want to delete. - ------------------------------------------------------------------------------------------------------- -from("direct:start") - .setHeader(SqsConstants.SQS_OPERATION, constant("deleteMessage")) - .setHeader(SqsConstants.RECEIPT_HANDLE, constant("123456")) - .to("aws-sqs://camel-1?accessKey=RAW(xxx)&secretKey=RAW(xxx)®ion=EU_WEST_1"); ------------------------------------------------------------------------------------------------------- - -As result you'll get an exchange containing a `DeleteMessageResult` instance, that you can use to check if the message was deleted or not. - -== List Queues - -Use listQueues operation to list queues. - ------------------------------------------------------------------------------------------------------- -from("direct:start") - .setHeader(SqsConstants.SQS_OPERATION, constant("listQueues")).to("aws-sqs://camel-1?accessKey=RAW(xxx)&secretKey=RAW(xxx)®ion=EU_WEST_1"); ------------------------------------------------------------------------------------------------------- - -As result you'll get an exchange containing a `ListQueuesResult` instance, that you can examinate to check the actual queues. - -== Queue Autocreation - -With the option `autoCreateQueue` users are able to avoid the autocreation of an SQS Queue in case it doesn't exist. The default for this option is `true`. -If set to false any operation on a not-existent queue in AWS won't be successful and an error will be returned. - -== Automatic detection of AmazonSQS client in registry - -The component is capable of detecting the presence of an AmazonSQS bean into the registry. -If it's the only instance of that type it will be used as client and you won't have to define it as uri parameter. -This may be really useful for smarter configuration of the endpoint. - -== Send Batch Message and Message Deduplication Strategy - -In case you're using a SendBatchMessage Operation, you can set two different kind of Message Deduplication Strategy: -- useExchangeId -- useContentBasedDeduplication - -The first one will use a ExchangeIdMessageDeduplicationIdStrategy, that will use the Exchange ID as parameter -The other one will use a NullMessageDeduplicationIdStrategy, that will use the body as deduplication element. - -In case of send batch message operation, you'll need to use the `useContentBasedDeduplication` and on the Queue you're pointing you'll need to enable the `content based deduplication` option. - - -include::camel-spring-boot::page$aws-sqs-starter.adoc[] diff --git a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java index a47b8d2..027baef 100644 --- a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java +++ b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java @@ -530,20 +530,6 @@ public interface ComponentsBuilderFactory { return org.apache.camel.builder.component.dsl.AwsSnsComponentBuilderFactory.awsSns(); } /** - * AWS Simple Queue Service (SQS) (camel-aws-sqs) - * Sending and receive messages to/from AWS SQS service. - * - * Category: cloud,messaging - * Since: 2.6 - * Maven coordinates: org.apache.camel:camel-aws-sqs - * - * @return the dsl builder - */ - @Deprecated - static org.apache.camel.builder.component.dsl.AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder awsSqs() { - return org.apache.camel.builder.component.dsl.AwsSqsComponentBuilderFactory.awsSqs(); - } - /** * AWS Simple Workflow (SWF) (camel-aws-swf) * Manage workflows in the AWS Simple Workflow service. * diff --git a/core/camel-componentdsl/src/generated/resources/metadata.json b/core/camel-componentdsl/src/generated/resources/metadata.json index 390ac5b..ca3ab07f 100644 --- a/core/camel-componentdsl/src/generated/resources/metadata.json +++ b/core/camel-componentdsl/src/generated/resources/metadata.json @@ -1274,29 +1274,6 @@ "producerOnly": true, "lenientProperties": false }, - "AwsSqsComponentBuilderFactory": { - "kind": "component", - "name": "aws-sqs", - "title": "AWS Simple Queue Service (SQS)", - "description": "Sending and receive messages to\/from AWS SQS service.", - "deprecated": true, - "deprecatedSince": "3.8.0", - "firstVersion": "2.6.0", - "label": "cloud,messaging", - "javaType": "org.apache.camel.component.aws.sqs.SqsComponent", - "supportLevel": "Stable", - "groupId": "org.apache.camel", - "artifactId": "camel-aws-sqs", - "version": "3.9.0-SNAPSHOT", - "scheme": "aws-sqs", - "extendsScheme": "", - "syntax": "aws-sqs:queueNameOrArn", - "async": false, - "api": false, - "consumerOnly": false, - "producerOnly": false, - "lenientProperties": false - }, "AwsSwfComponentBuilderFactory": { "kind": "component", "name": "aws-swf", diff --git a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java index 17b0fe0..f248469 100644 --- a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java +++ b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java @@ -333,7 +333,6 @@ public interface EndpointBuilderFactory org.apache.camel.builder.endpoint.dsl.SqlEndpointBuilderFactory.SqlBuilders, org.apache.camel.builder.endpoint.dsl.SqlStoredEndpointBuilderFactory.SqlStoredBuilders, org.apache.camel.builder.endpoint.dsl.Sqs2EndpointBuilderFactory.Sqs2Builders, - org.apache.camel.builder.endpoint.dsl.SqsEndpointBuilderFactory.SqsBuilders, org.apache.camel.builder.endpoint.dsl.SshEndpointBuilderFactory.SshBuilders, org.apache.camel.builder.endpoint.dsl.StAXEndpointBuilderFactory.StAXBuilders, org.apache.camel.builder.endpoint.dsl.StitchEndpointBuilderFactory.StitchBuilders, diff --git a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilders.java b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilders.java index daef6a3..051ec94 100644 --- a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilders.java +++ b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilders.java @@ -330,7 +330,6 @@ public interface EndpointBuilders org.apache.camel.builder.endpoint.dsl.SqlEndpointBuilderFactory, org.apache.camel.builder.endpoint.dsl.SqlStoredEndpointBuilderFactory, org.apache.camel.builder.endpoint.dsl.Sqs2EndpointBuilderFactory, - org.apache.camel.builder.endpoint.dsl.SqsEndpointBuilderFactory, org.apache.camel.builder.endpoint.dsl.SshEndpointBuilderFactory, org.apache.camel.builder.endpoint.dsl.StAXEndpointBuilderFactory, org.apache.camel.builder.endpoint.dsl.StitchEndpointBuilderFactory, diff --git a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java index f0d50e9..e25dee7 100644 --- a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java +++ b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java @@ -2552,51 +2552,6 @@ public class StaticEndpointBuilders { return org.apache.camel.builder.endpoint.dsl.SnsEndpointBuilderFactory.endpointBuilder(componentName, path); } /** - * AWS Simple Queue Service (SQS) (camel-aws-sqs) - * Sending and receive messages to/from AWS SQS service. - * - * Category: cloud,messaging - * Since: 2.6 - * Maven coordinates: org.apache.camel:camel-aws-sqs - * - * Syntax: <code>aws-sqs:queueNameOrArn</code> - * - * Path parameter: queueNameOrArn (required) - * Queue name or ARN - * - * @param path queueNameOrArn - * @return the dsl builder - */ - @Deprecated - public static org.apache.camel.builder.endpoint.dsl.SqsEndpointBuilderFactory.SqsEndpointBuilder awsSqs( - String path) { - return org.apache.camel.builder.endpoint.dsl.SqsEndpointBuilderFactory.endpointBuilder("aws-sqs", path); - } - /** - * AWS Simple Queue Service (SQS) (camel-aws-sqs) - * Sending and receive messages to/from AWS SQS service. - * - * Category: cloud,messaging - * Since: 2.6 - * Maven coordinates: org.apache.camel:camel-aws-sqs - * - * Syntax: <code>aws-sqs:queueNameOrArn</code> - * - * Path parameter: queueNameOrArn (required) - * Queue name or ARN - * - * @param componentName to use a custom component name for the endpoint - * instead of the default name - * @param path queueNameOrArn - * @return the dsl builder - */ - @Deprecated - public static org.apache.camel.builder.endpoint.dsl.SqsEndpointBuilderFactory.SqsEndpointBuilder awsSqs( - String componentName, - String path) { - return org.apache.camel.builder.endpoint.dsl.SqsEndpointBuilderFactory.endpointBuilder(componentName, path); - } - /** * AWS Simple Workflow (SWF) (camel-aws-swf) * Manage workflows in the AWS Simple Workflow service. * @@ -17207,4 +17162,4 @@ public class StaticEndpointBuilders { return org.apache.camel.builder.endpoint.dsl.ZooKeeperMasterEndpointBuilderFactory.endpointBuilder(componentName, path); } } -//CHECKSTYLE:ON \ No newline at end of file +//CHECKSTYLE:ON diff --git a/docs/components/modules/ROOT/nav.adoc b/docs/components/modules/ROOT/nav.adoc index 0b396c2..4d35f04 100644 --- a/docs/components/modules/ROOT/nav.adoc +++ b/docs/components/modules/ROOT/nav.adoc @@ -38,7 +38,6 @@ *** xref:aws-s3-component.adoc[AWS S3 Storage Service] *** xref:aws-ses-component.adoc[AWS Simple Email Service (SES)] *** xref:aws-sns-component.adoc[AWS Simple Notification System (SNS)] -*** xref:aws-sqs-component.adoc[AWS Simple Queue Service (SQS)] *** xref:aws-swf-component.adoc[AWS Simple Workflow (SWF)] ** xref:aws2-summary.adoc[AWS 2] *** xref:aws2-athena-component.adoc[AWS 2 Athena] diff --git a/docs/components/modules/ROOT/pages/aws-sqs-component.adoc b/docs/components/modules/ROOT/pages/aws-sqs-component.adoc deleted file mode 100644 index 6fbaab7..0000000 --- a/docs/components/modules/ROOT/pages/aws-sqs-component.adoc +++ /dev/null @@ -1,402 +0,0 @@ -[[aws-sqs-component]] -= AWS Simple Queue Service (SQS) Component (deprecated) -//THIS FILE IS COPIED: EDIT THE SOURCE FILE: -:page-source: components/camel-aws-sqs/src/main/docs/aws-sqs-component.adoc -:docTitle: AWS Simple Queue Service (SQS) -:artifactId: camel-aws-sqs -:description: Sending and receive messages to/from AWS SQS service. -:since: 2.6 -:supportLevel: Stable-deprecated -:deprecated: *deprecated* -:component-header: Both producer and consumer are supported -include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws-sqs.adoc[opts=optional] -//Manually maintained attributes -:group: AWS - -*Since Camel {since}* - -*{component-header}* - -The sqs component supports sending and receiving messages to -https://aws.amazon.com/sqs[Amazon's SQS] service. - -Prerequisites - -You must have a valid Amazon Web Services developer account, and be -signed up to use Amazon SQS. More information is available at -https://aws.amazon.com/sqs[Amazon SQS]. - -== URI Format - -[source,java] ------------------------------- -aws-sqs://queueNameOrArn[?options] ------------------------------- - -The queue will be created if they don't already exists. + - You can append query options to the URI in the following format, -?options=value&option2=value&... - -== URI Options - - -// component options: START -The AWS Simple Queue Service (SQS) component supports 39 options, which are listed below. - - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *amazonAWSHost* (common) | The hostname of the Amazon AWS cloud. | amazonaws.com | String -| *amazonSQSClient* (common) | To use the AmazonSQS as client | | AmazonSQS -| *autoCreateQueue* (common) | Setting the autocreation of the queue | true | boolean -| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | boolean -| *configuration* (common) | The component configuration | | SqsConfiguration -| *protocol* (common) | The underlying protocol used to communicate with SQS | https | String -| *proxyProtocol* (common) | To define a proxy protocol when instantiating the SQS client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol -| *queueOwnerAWSAccountId* (common) | Specify the queue owner aws account id when you need to connect the queue with different account owner. | | String -| *region* (common) | Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name() | | String -| *attributeNames* (consumer) | A list of attribute names to receive when consuming. Multiple names can be separated by comma. | | String -| *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 -| *concurrentConsumers* (consumer) | Allows you to use multiple threads to poll the sqs queue to increase throughput | 1 | int -| *defaultVisibilityTimeout* (consumer) | The default visibility timeout (in seconds) | | Integer -| *deleteAfterRead* (consumer) | Delete message from SQS after it has been read | true | boolean -| *deleteIfFiltered* (consumer) | 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. | true | boolean -| *extendMessageVisibility* (consumer) | If enabled then 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 defaultVisibilityTimeout must be set. See details at Amazon docs. | false | boolean -| *kmsDataKeyReusePeriodSeconds* (consumer) | The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). | | Integer -| *kmsMasterKeyId* (consumer) | The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. | | String -| *messageAttributeNames* (consumer) | A list of message attribute names to receive when consuming. Multiple names can be separated by comma. | | String -| *serverSideEncryptionEnabled* (consumer) | Define if Server Side Encryption is enabled or not on the queue | false | boolean -| *visibilityTimeout* (consumer) | The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently. | | Integer -| *waitTimeSeconds* (consumer) | 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. | | Integer -| *delaySeconds* (producer) | Delay sending messages for a number of seconds. | | Integer -| *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 [...] -| *messageDeduplicationIdStrategy* (producer) | Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. Can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message. There are 2 enums and the value can be one of: useExchangeId, useContentBasedDeduplication | useExchangeId | String -| *messageGroupIdStrategy* (producer) | Only for FIFO queues. Strategy for setting the messageGroupId on the message. Can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used. There are 3 enums and the value can be one of: useConstant, useExchangeId, usePropertyValue | | String -| *operation* (producer) | The operation to do in case the user don't want to send only a message. There are 3 enums and the value can be one of: sendBatchMessage, deleteMessage, listQueues | | SqsOperations -| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean -| *delayQueue* (advanced) | Define if you want to apply delaySeconds option to the queue or on single messages | false | boolean -| *queueUrl* (advanced) | To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes. | | String -| *proxyHost* (proxy) | To define a proxy host when instantiating the SQS client | | String -| *proxyPort* (proxy) | To define a proxy port when instantiating the SQS client | | Integer -| *maximumMessageSize* (queue) | The maximumMessageSize (in bytes) an SQS message can contain for this queue. | | Integer -| *messageRetentionPeriod* (queue) | The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. | | Integer -| *policy* (queue) | The policy for this queue | | String -| *receiveMessageWaitTimeSeconds* (queue) | If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. | | Integer -| *redrivePolicy* (queue) | Specify the policy that send message to DeadLetter queue. See detail at Amazon docs. | | String -| *accessKey* (security) | Amazon AWS Access Key | | String -| *secretKey* (security) | Amazon AWS Secret Key | | String -|=== -// component options: END - - - - - - - - -// endpoint options: START -The AWS Simple Queue Service (SQS) endpoint is configured using URI syntax: - ----- -aws-sqs:queueNameOrArn ----- - -with the following path and query parameters: - -=== Path Parameters (1 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *queueNameOrArn* | *Required* Queue name or ARN | | String -|=== - - -=== Query Parameters (57 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *amazonAWSHost* (common) | The hostname of the Amazon AWS cloud. | amazonaws.com | String -| *amazonSQSClient* (common) | To use the AmazonSQS as client | | AmazonSQS -| *autoCreateQueue* (common) | Setting the autocreation of the queue | true | boolean -| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | boolean -| *headerFilterStrategy* (common) | To use a custom HeaderFilterStrategy to map headers to/from Camel. | | HeaderFilterStrategy -| *protocol* (common) | The underlying protocol used to communicate with SQS | https | String -| *proxyProtocol* (common) | To define a proxy protocol when instantiating the SQS client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol -| *queueOwnerAWSAccountId* (common) | Specify the queue owner aws account id when you need to connect the queue with different account owner. | | String -| *region* (common) | Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name() | | String -| *attributeNames* (consumer) | A list of attribute names to receive when consuming. Multiple names can be separated by comma. | | String -| *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 -| *concurrentConsumers* (consumer) | Allows you to use multiple threads to poll the sqs queue to increase throughput | 1 | int -| *defaultVisibilityTimeout* (consumer) | The default visibility timeout (in seconds) | | Integer -| *deleteAfterRead* (consumer) | Delete message from SQS after it has been read | true | boolean -| *deleteIfFiltered* (consumer) | 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. | true | boolean -| *extendMessageVisibility* (consumer) | If enabled then 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 defaultVisibilityTimeout must be set. See details at Amazon docs. | false | boolean -| *kmsDataKeyReusePeriodSeconds* (consumer) | The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). | | Integer -| *kmsMasterKeyId* (consumer) | The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. | | String -| *maxMessagesPerPoll* (consumer) | Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited. | | int -| *messageAttributeNames* (consumer) | A list of message attribute names to receive when consuming. Multiple names can be separated by comma. | | String -| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | false | boolean -| *serverSideEncryptionEnabled* (consumer) | Define if Server Side Encryption is enabled or not on the queue | false | boolean -| *visibilityTimeout* (consumer) | The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently. | | Integer -| *waitTimeSeconds* (consumer) | 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. | | Integer -| *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 -| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPollStrategy -| *delaySeconds* (producer) | Delay sending messages for a number of seconds. | | Integer -| *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 [...] -| *messageDeduplicationIdStrategy* (producer) | Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. Can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message. There are 2 enums and the value can be one of: useExchangeId, useContentBasedDeduplication | useExchangeId | String -| *messageGroupIdStrategy* (producer) | Only for FIFO queues. Strategy for setting the messageGroupId on the message. Can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used. There are 3 enums and the value can be one of: useConstant, useExchangeId, usePropertyValue | | String -| *operation* (producer) | The operation to do in case the user don't want to send only a message. There are 3 enums and the value can be one of: sendBatchMessage, deleteMessage, listQueues | | SqsOperations -| *delayQueue* (advanced) | Define if you want to apply delaySeconds option to the queue or on single messages | false | boolean -| *queueUrl* (advanced) | To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes. | | String -| *proxyHost* (proxy) | To define a proxy host when instantiating the SQS client | | String -| *proxyPort* (proxy) | To define a proxy port when instantiating the SQS client | | Integer -| *maximumMessageSize* (queue) | The maximumMessageSize (in bytes) an SQS message can contain for this queue. | | Integer -| *messageRetentionPeriod* (queue) | The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. | | Integer -| *policy* (queue) | The policy for this queue | | String -| *receiveMessageWaitTimeSeconds* (queue) | If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. | | Integer -| *redrivePolicy* (queue) | Specify the policy that send message to DeadLetter queue. See detail at Amazon docs. | | String -| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int -| *delay* (scheduler) | Milliseconds before the next poll. | 500 | long -| *greedy* (scheduler) | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | false | boolean -| *initialDelay* (scheduler) | Milliseconds before the first poll starts. | 1000 | long -| *repeatCount* (scheduler) | Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. | 0 | long -| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | TRACE | LoggingLevel -| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutorService -| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler | none | Object -| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. | | Map -| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean -| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. There are 7 enums and the value can be one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS | MILLISECONDS | TimeUnit -| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean -| *accessKey* (security) | Amazon AWS Access Key | | String -| *secretKey* (security) | Amazon AWS Secret Key | | String -|=== -// endpoint options: END - - - - - - - - -Required SQS component options - -You have to provide the amazonSQSClient in the -Registry or your accessKey and secretKey to access -the https://aws.amazon.com/sqs[Amazon's SQS]. - -== Batch Consumer - -This component implements the Batch Consumer. - -This allows you for instance to know how many messages exists in this -batch and for instance let the Aggregator -aggregate this number of messages. - -== Usage - -=== Message headers set by the SQS producer - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsSqsMD5OfBody` |`String` |The MD5 checksum of the Amazon SQS message. - -|`CamelAwsSqsMessageId` |`String` |The Amazon SQS message ID. - -|`CamelAwsSqsDelaySeconds` |`Integer` |The delay seconds that the Amazon SQS message can be -see by others. -|======================================================================= - -=== Message headers set by the SQS consumer - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsSqsMD5OfBody` |`String` |The MD5 checksum of the Amazon SQS message. - -|`CamelAwsSqsMessageId` |`String` |The Amazon SQS message ID. - -|`CamelAwsSqsReceiptHandle` |`String` |The Amazon SQS message receipt handle. - -|`CamelAwsSqsMessageAttributes` |`Map<String, String>` |The Amazon SQS message attributes. -|======================================================================= - -=== Advanced AmazonSQS configuration - -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: - -[source,java] --------------------------------------------------------------------------------------- -AWSCredentials awsCredentials = new BasicAWSCredentials("myAccessKey", "mySecretKey"); - -ClientConfiguration clientConfiguration = new ClientConfiguration(); -clientConfiguration.setProxyHost("http://myProxyHost";); -clientConfiguration.setProxyPort(8080); - -AmazonSQS client = new AmazonSQSClient(awsCredentials, clientConfiguration); - -registry.bind("client", client); --------------------------------------------------------------------------------------- - -and refer to it in your Camel aws-sqs component configuration: - -[source,java] ---------------------------------------------------------------------------------- -from("aws-sqs://MyQueue?amazonSQSClient=#client&delay=5000&maxMessagesPerPoll=5") -.to("mock:result"); ---------------------------------------------------------------------------------- - -=== Creating or updating an SQS Queue - -In the SQS Component, when an endpoint is started, a check is executed to obtain information -about the existence of the queue or not. You're able to customize the creation through the QueueAttributeName -mapping with the SQSConfiguration option. - -[source,java] ---------------------------------------------------------------------------------- -from("aws-sqs://MyQueue?amazonSQSClient=#client&delay=5000&maxMessagesPerPoll=5") -.to("mock:result"); ---------------------------------------------------------------------------------- - -In this example if the MyQueue queue is not already created on AWS (and the autoCreateQueue option is set to true), it will be created with default parameters from the -SQS configuration. If it's already up on AWS, the SQS configuration options will be used to override the existent AWS configuration. - -=== DelayQueue VS Delay for Single message - -When the option delayQueue is set to true, the SQS Queue will be a DelayQueue with the -DelaySeconds option as delay. For more information about DelayQueue you can read the https://docs.aws.amazon.com/en_us/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-delay-queues.html[AWS SQS documentation]. -One important information to take into account is the following: - -- For standard queues, the per-queue delay setting is not retroactive—changing the setting doesn't affect the delay of messages already in the queue. -- For FIFO queues, the per-queue delay setting is retroactive—changing the setting affects the delay of messages already in the queue. - -as stated in the official documentation. If you want to specify a delay on single messages, you can ignore the delayQueue option, while you can set this option -to true, if you need to add a fixed delay to all messages enqueued. - -=== Server Side Encryption - -There is a set of Server Side Encryption attributes for a queue. The related option are serverSideEncryptionEnabled, keyMasterKeyId and kmsDataKeyReusePeriod. -The SSE is disabled by default. You need to explicitly set the option to true and set the related parameters as queue attributes. - -== 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-aws-sqs</artifactId> - <version>${camel-version}</version> -</dependency> ---------------------------------------- - -where `$\{camel-version}` must be replaced by the actual version of Camel. - -== JMS-style Selectors - -SQS does not allow selectors, but you can effectively achieve this by -using the Camel Filter EIP and setting an -appropriate `visibilityTimeout`. 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: - -[source,java] ------------------------------------------------------------------------------------------------------- -from("aws-sqs://MyQueue?amazonSQSClient=#client&defaultVisibilityTimeout=5000&deleteIfFiltered=false&deleteAfterRead=false") -.filter("${header.login} == true") -.to("mock:result"); ------------------------------------------------------------------------------------------------------- - -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 milliseconds, the message will become visible to other -consumers. - -== Available Producer Operations -- single message (default) -- sendBatchMessage -- deleteMessage -- listQueues - -== Send Batch Message - -You can set a `SendMessageBatchRequest` or an `Iterable` - ------------------------------------------------------------------------------------------------------- -from("direct:start") - .setHeader(SqsConstants.SQS_OPERATION, constant("sendBatchMessage")).to("aws-sqs://camel-1?accessKey=RAW(xxx)&secretKey=RAW(xxx)®ion=EU_WEST_1"); ------------------------------------------------------------------------------------------------------- - -As result you'll get an exchange containing a `SendMessageBatchResult` instance, that you can examinate to check what messages were successfull and what not. -The id set on each message of the batch will be a Random UUID. - -== Delete single Message - -Use deleteMessage operation to delete a single message. You'll need to set a receipt handle header for the message you want to delete. - ------------------------------------------------------------------------------------------------------- -from("direct:start") - .setHeader(SqsConstants.SQS_OPERATION, constant("deleteMessage")) - .setHeader(SqsConstants.RECEIPT_HANDLE, constant("123456")) - .to("aws-sqs://camel-1?accessKey=RAW(xxx)&secretKey=RAW(xxx)®ion=EU_WEST_1"); ------------------------------------------------------------------------------------------------------- - -As result you'll get an exchange containing a `DeleteMessageResult` instance, that you can use to check if the message was deleted or not. - -== List Queues - -Use listQueues operation to list queues. - ------------------------------------------------------------------------------------------------------- -from("direct:start") - .setHeader(SqsConstants.SQS_OPERATION, constant("listQueues")).to("aws-sqs://camel-1?accessKey=RAW(xxx)&secretKey=RAW(xxx)®ion=EU_WEST_1"); ------------------------------------------------------------------------------------------------------- - -As result you'll get an exchange containing a `ListQueuesResult` instance, that you can examinate to check the actual queues. - -== Queue Autocreation - -With the option `autoCreateQueue` users are able to avoid the autocreation of an SQS Queue in case it doesn't exist. The default for this option is `true`. -If set to false any operation on a not-existent queue in AWS won't be successful and an error will be returned. - -== Automatic detection of AmazonSQS client in registry - -The component is capable of detecting the presence of an AmazonSQS bean into the registry. -If it's the only instance of that type it will be used as client and you won't have to define it as uri parameter. -This may be really useful for smarter configuration of the endpoint. - -== Send Batch Message and Message Deduplication Strategy - -In case you're using a SendBatchMessage Operation, you can set two different kind of Message Deduplication Strategy: -- useExchangeId -- useContentBasedDeduplication - -The first one will use a ExchangeIdMessageDeduplicationIdStrategy, that will use the Exchange ID as parameter -The other one will use a NullMessageDeduplicationIdStrategy, that will use the body as deduplication element. - -In case of send batch message operation, you'll need to use the `useContentBasedDeduplication` and on the Queue you're pointing you'll need to enable the `content based deduplication` option. - - -include::camel-spring-boot::page$aws-sqs-starter.adoc[]
