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 c8d45d618bba85cd6bc5de860678047e5389c7a0
Author: Andrea Cosentino <anco...@gmail.com>
AuthorDate: Wed Aug 26 09:04:19 2020 +0200
Regen catalog
---
.../apache/camel/catalog/components/aws2-s3.json | 4 ++++
.../camel/catalog/docs/aws2-s3-component.adoc | 22 ++++++++++++++++++++--
2 files changed, 24 insertions(+), 2 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-s3.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-s3.json
index 93957ad..33a2656 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-s3.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-s3.json
@@ -42,6 +42,8 @@
"deleteAfterRead": { "kind": "property", "displayName": "Delete After
Read", "group": "consumer", "label": "consumer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": "true", "configurationClass":
"org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField":
"configuration", "description": "Delete objects from S3 after they have been
retrieved. The delete is only performed if the Exchange is committe [...]
"delimiter": { "kind": "property", "displayName": "Delimiter", "group":
"consumer", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration",
"configurationField": "configuration", "description": "The delimiter which is
used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume
objects we are interested in." },
"destinationBucket": { "kind": "property", "displayName": "Destination
Bucket", "group": "consumer", "label": "consumer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration",
"configurationField": "configuration", "description": "Define the destination
bucket where an object must be moved when moveAfterRead is set to true." },
+ "destinationBucketPrefix": { "kind": "property", "displayName":
"Destination Bucket Prefix", "group": "consumer", "label": "consumer",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField":
"configuration", "description": "Define the destination bucket prefix to use
when an object must be moved and moveAfterRead is set to true." },
+ "destinationBucketSuffix": { "kind": "property", "displayName":
"Destination Bucket Suffix", "group": "consumer", "label": "consumer",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField":
"configuration", "description": "Define the destination bucket suffix to use
when an object must be moved and moveAfterRead is set to true." },
"fileName": { "kind": "property", "displayName": "File Name", "group":
"consumer", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration",
"configurationField": "configuration", "description": "To get the object from
the bucket with the given file name" },
"includeBody": { "kind": "property", "displayName": "Include Body",
"group": "consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
"true", "configurationClass":
"org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField":
"configuration", "description": "If it is true, the exchange body will be set
to a stream to the contents of the file. If false, the headers will be set
[...]
"includeFolders": { "kind": "property", "displayName": "Include Folders",
"group": "consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
"true", "configurationClass":
"org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField":
"configuration", "description": "If it is true, the folders\/directories will
be consumed. If it is false, they will be ignored, and Exchanges will [...]
@@ -84,6 +86,8 @@
"deleteAfterRead": { "kind": "parameter", "displayName": "Delete After
Read", "group": "consumer", "label": "consumer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": "true", "configurationClass":
"org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField":
"configuration", "description": "Delete objects from S3 after they have been
retrieved. The delete is only performed if the Exchange is committ [...]
"delimiter": { "kind": "parameter", "displayName": "Delimiter", "group":
"consumer", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration",
"configurationField": "configuration", "description": "The delimiter which is
used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume
objects we are interested in." },
"destinationBucket": { "kind": "parameter", "displayName": "Destination
Bucket", "group": "consumer", "label": "consumer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration",
"configurationField": "configuration", "description": "Define the destination
bucket where an object must be moved when moveAfterRead is set to true." },
+ "destinationBucketPrefix": { "kind": "parameter", "displayName":
"Destination Bucket Prefix", "group": "consumer", "label": "consumer",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField":
"configuration", "description": "Define the destination bucket prefix to use
when an object must be moved and moveAfterRead is set to true." },
+ "destinationBucketSuffix": { "kind": "parameter", "displayName":
"Destination Bucket Suffix", "group": "consumer", "label": "consumer",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField":
"configuration", "description": "Define the destination bucket suffix to use
when an object must be moved and moveAfterRead is set to true." },
"fileName": { "kind": "parameter", "displayName": "File Name", "group":
"consumer", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.s3.AWS2S3Configuration",
"configurationField": "configuration", "description": "To get the object from
the bucket with the given file name" },
"includeBody": { "kind": "parameter", "displayName": "Include Body",
"group": "consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
"true", "configurationClass":
"org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField":
"configuration", "description": "If it is true, the exchange body will be set
to a stream to the contents of the file. If false, the headers will be set [...]
"includeFolders": { "kind": "parameter", "displayName": "Include Folders",
"group": "consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
"true", "configurationClass":
"org.apache.camel.component.aws2.s3.AWS2S3Configuration", "configurationField":
"configuration", "description": "If it is true, the folders\/directories will
be consumed. If it is false, they will be ignored, and Exchanges wil [...]
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws2-s3-component.adoc
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws2-s3-component.adoc
index 33f054e..e45e4b4 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws2-s3-component.adoc
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws2-s3-component.adoc
@@ -46,7 +46,7 @@
from("aws2-s3://helloBucket?accessKey=yourAccessKey&secretKey=yourSecretKey&pref
// component options: START
-The AWS 2 S3 Storage Service component supports 40 options, which are listed
below.
+The AWS 2 S3 Storage Service component supports 42 options, which are listed
below.
@@ -74,6 +74,8 @@ The AWS 2 S3 Storage Service component supports 40 options,
which are listed bel
| *deleteAfterRead* (consumer) | Delete objects from S3 after they have been
retrieved. The delete is only performed if the Exchange is committed. If a
rollback occurs, the object is not deleted. If this option is false, then the
same objects will be retrieve over and over again on the polls. Therefore you
need to use the Idempotent Consumer EIP in the route to filter out duplicates.
You can filter using the AWS2S3Constants#BUCKET_NAME and AWS2S3Constants#KEY
headers, or only the AWS2S3C [...]
| *delimiter* (consumer) | The delimiter which is used in the
com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we
are interested in. | | String
| *destinationBucket* (consumer) | Define the destination bucket where an
object must be moved when moveAfterRead is set to true. | | String
+| *destinationBucketPrefix* (consumer) | Define the destination bucket prefix
to use when an object must be moved and moveAfterRead is set to true. | |
String
+| *destinationBucketSuffix* (consumer) | Define the destination bucket suffix
to use when an object must be moved and moveAfterRead is set to true. | |
String
| *fileName* (consumer) | To get the object from the bucket with the given
file name | | String
| *includeBody* (consumer) | If it is true, the exchange body will be set to a
stream to the contents of the file. If false, the headers will be set with the
S3 object metadata, but the body will be null. This option is strongly related
to autocloseBody option. In case of setting includeBody to true and
autocloseBody to false, it will be up to the caller to close the S3Object
stream. Setting autocloseBody to true, will close the S3Object stream
automatically. | true | boolean
| *includeFolders* (consumer) | If it is true, the folders/directories will be
consumed. If it is false, they will be ignored, and Exchanges will not be
created for those | true | boolean
@@ -125,7 +127,7 @@ with the following path and query parameters:
|===
-=== Query Parameters (60 parameters):
+=== Query Parameters (62 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
@@ -151,6 +153,8 @@ with the following path and query parameters:
| *deleteAfterRead* (consumer) | Delete objects from S3 after they have been
retrieved. The delete is only performed if the Exchange is committed. If a
rollback occurs, the object is not deleted. If this option is false, then the
same objects will be retrieve over and over again on the polls. Therefore you
need to use the Idempotent Consumer EIP in the route to filter out duplicates.
You can filter using the AWS2S3Constants#BUCKET_NAME and AWS2S3Constants#KEY
headers, or only the AWS2S3C [...]
| *delimiter* (consumer) | The delimiter which is used in the
com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we
are interested in. | | String
| *destinationBucket* (consumer) | Define the destination bucket where an
object must be moved when moveAfterRead is set to true. | | String
+| *destinationBucketPrefix* (consumer) | Define the destination bucket prefix
to use when an object must be moved and moveAfterRead is set to true. | |
String
+| *destinationBucketSuffix* (consumer) | Define the destination bucket suffix
to use when an object must be moved and moveAfterRead is set to true. | |
String
| *fileName* (consumer) | To get the object from the bucket with the given
file name | | String
| *includeBody* (consumer) | If it is true, the exchange body will be set to a
stream to the contents of the file. If false, the headers will be set with the
S3 object metadata, but the body will be null. This option is strongly related
to autocloseBody option. In case of setting includeBody to true and
autocloseBody to false, it will be up to the caller to close the S3Object
stream. Setting autocloseBody to true, will close the S3Object stream
automatically. | true | boolean
| *includeFolders* (consumer) | If it is true, the folders/directories will be
consumed. If it is false, they will be ignored, and Exchanges will not be
created for those | true | boolean
@@ -529,6 +533,20 @@ This will require specifying the destinationBucket option.
As example:
In this case the objects consumed will be moved to myothercamelbucket bucket
and deleted from the original one (because of deleteAfterRead set to true as
default).
+You have also the possibility of using a key prefix/suffix while moving the
file to a different bucket. The options are destinationBucketPrefix and
destinationBucketSuffix.
+
+Taking the above example, you could do something like:
+
+[source,java]
+--------------------------------------------------------------------------------
+
from("aws2-s3://mycamelbucket?amazonS3Client=#amazonS3Client&moveAfterRead=true&destinationBucket=myothercamelbucket&destinationBucketPrefix=RAW(pre-)&destinationBucketSuffix=RAW(-suff)")
+ .to("mock:result");
+--------------------------------------------------------------------------------
+
+In this case the objects consumed will be moved to myothercamelbucket bucket
and deleted from the original one (because of deleteAfterRead set to true as
default).
+
+So if the file name is test, in the myothercamelbucket you should see a file
called pre-test-suff.
+
== Using customer key as encryption
We introduced also the customer key support (an alternative of using KMS). The
following code shows an example.
