You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2021/01/29 15:37:56 UTC
[camel] 02/02: [CAMEL-16108] docs added
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 2d1e4f17f09c37490134aca99f362698d577c4ad
Author: Vilmos Nagy <vi...@outlook.com>
AuthorDate: Fri Jan 29 14:24:47 2021 +0100
[CAMEL-16108] docs added
---
.../src/main/docs/aws2-s3-component.adoc | 29 +++++++++++-----------
1 file changed, 15 insertions(+), 14 deletions(-)
diff --git a/components/camel-aws2-s3/src/main/docs/aws2-s3-component.adoc b/components/camel-aws2-s3/src/main/docs/aws2-s3-component.adoc
index dc800b1..15b03cb 100644
--- a/components/camel-aws2-s3/src/main/docs/aws2-s3-component.adoc
+++ b/components/camel-aws2-s3/src/main/docs/aws2-s3-component.adoc
@@ -269,6 +269,7 @@ see `com.amazonaws.services.s3.model.AccessControlList` for more details
the object using AWS-managed keys. For example use AES256.
|`CamelAwsS3VersionId` |`String` |The version Id of the object to be stored or returned from the current operation
+|`CamelAwsS3Metadata` |`Map<String, String>` |A map of metadata stored with the object in S3.
|=======================================================================
=== Message headers set by the S3 producer
@@ -346,7 +347,7 @@ Camel-AWS2-S3 component provides the following operation on the producer side:
- createDownloadLink
If you don't specify an operation explicitly the producer will do:
-- a single file upload
+- a single file upload
- a multipart upload if multiPartUpload option is enabled
=== Advanced AmazonS3 configuration
@@ -391,7 +392,7 @@ policies are updated). This is the AWS recommended way to manage credentials and
[source,java]
--------------------------------------------------------------------------------
from("direct:start").process(new Processor() {
-
+
@Override
public void process(Exchange exchange) throws Exception {
exchange.getIn().setHeader(S3Constants.KEY, "camel.txt");
@@ -409,7 +410,7 @@ This operation will upload the file camel.txt with the content "Camel rocks!" in
[source,java]
--------------------------------------------------------------------------------
from("direct:start").process(new Processor() {
-
+
@Override
public void process(Exchange exchange) throws Exception {
exchange.getIn().setHeader(AWS2S3Constants.KEY, "empty.txt");
@@ -427,12 +428,12 @@ This operation will perform a multipart upload of the file empty.txt with based
[source,java]
--------------------------------------------------------------------------------
from("direct:start").process(new Processor() {
-
+
@Override
public void process(Exchange exchange) throws Exception {
exchange.getIn().setHeader(S3Constants.BUCKET_DESTINATION_NAME, "camelDestinationBucket");
exchange.getIn().setHeader(S3Constants.KEY, "camelKey");
- exchange.getIn().setHeader(S3Constants.DESTINATION_KEY, "camelDestinationKey");
+ exchange.getIn().setHeader(S3Constants.DESTINATION_KEY, "camelDestinationKey");
}
})
.to("aws2-s3://mycamelbucket?amazonS3Client=#amazonS3Client&operation=copyObject")
@@ -446,10 +447,10 @@ This operation will copy the object with the name expressed in the header camelD
[source,java]
--------------------------------------------------------------------------------
from("direct:start").process(new Processor() {
-
+
@Override
public void process(Exchange exchange) throws Exception {
- exchange.getIn().setHeader(S3Constants.KEY, "camelKey");
+ exchange.getIn().setHeader(S3Constants.KEY, "camelKey");
}
})
.to("aws2-s3://mycamelbucket?amazonS3Client=#amazonS3Client&operation=deleteObject")
@@ -496,10 +497,10 @@ This operation will list the objects in the mycamelbucket bucket
[source,java]
--------------------------------------------------------------------------------
from("direct:start").process(new Processor() {
-
+
@Override
public void process(Exchange exchange) throws Exception {
- exchange.getIn().setHeader(S3Constants.KEY, "camelKey");
+ exchange.getIn().setHeader(S3Constants.KEY, "camelKey");
}
})
.to("aws2-s3://mycamelbucket?amazonS3Client=#amazonS3Client&operation=getObject")
@@ -513,7 +514,7 @@ This operation will return an S3Object instance related to the camelKey object i
[source,java]
--------------------------------------------------------------------------------
from("direct:start").process(new Processor() {
-
+
@Override
public void process(Exchange exchange) throws Exception {
exchange.getIn().setHeader(S3Constants.KEY, "camelKey");
@@ -532,7 +533,7 @@ This operation will return an S3Object instance related to the camelKey object i
[source,java]
--------------------------------------------------------------------------------
from("direct:start").process(new Processor() {
-
+
@Override
public void process(Exchange exchange) throws Exception {
exchange.getIn().setHeader(S3Constants.KEY, "camelKey");
@@ -552,7 +553,7 @@ If set to false any operation on a not-existent bucket in AWS won't be successfu
== Moving stuff between a bucket and another bucket
Some users like to consume stuff from a bucket and move the content in a different one without using the copyObject feature of this component.
-If this is case for you, don't forget to remove the bucketName header from the incoming exchange of the consumer, otherwise the file will be always overwritten on the same
+If this is case for you, don't forget to remove the bucketName header from the incoming exchange of the consumer, otherwise the file will be always overwritten on the same
original bucket.
== MoveAfterRead consumer option
@@ -615,7 +616,7 @@ from("direct:aws2-s3")
In this way you'll pass the request directly without the need of passing headers and options specifically related to this operation.
== Create S3 client and add component to registry
-Sometimes you would want to perform some advanced configuration using AWS2S3Configuration which also allows to set the S3 client.
+Sometimes you would want to perform some advanced configuration using AWS2S3Configuration which also allows to set the S3 client.
You can create and set the S3 client in the component configuration as shown in the following example
[source,java]
@@ -633,7 +634,7 @@ configuration.setBucketName("s3bucket2020");
configuration.setRegion("us-east-1");
--------------------------------------------------------------------------------
-Now you can configure the S3 component (using the configuration object created above) and add it to the registry in the
+Now you can configure the S3 component (using the configuration object created above) and add it to the registry in the
configure method before initialization of routes.
[source,java]