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 2019/07/05 10:52:06 UTC
[camel] 12/18: CAMEL-13723 - Better docs, S3
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 45a850d4372d7ab294162b0615f8a81c0f654d9d
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Fri Jul 5 12:31:39 2019 +0200
CAMEL-13723 - Better docs, S3
---
.../camel-aws-s3/src/main/docs/aws-s3-component.adoc | 2 +-
.../apache/camel/component/aws/s3/S3Configuration.java | 3 ++-
.../builder/endpoint/dsl/S3EndpointBuilderFactory.java | 15 ++++++++++++---
.../aws/s3/springboot/S3ComponentConfiguration.java | 5 ++++-
4 files changed, 19 insertions(+), 6 deletions(-)
diff --git a/components/camel-aws-s3/src/main/docs/aws-s3-component.adoc b/components/camel-aws-s3/src/main/docs/aws-s3-component.adoc
index d4f3955..f5e1b12 100644
--- a/components/camel-aws-s3/src/main/docs/aws-s3-component.adoc
+++ b/components/camel-aws-s3/src/main/docs/aws-s3-component.adoc
@@ -93,7 +93,7 @@ with the following path and query parameters:
| *policy* (common) | The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method. | | String
| *proxyHost* (common) | To define a proxy host when instantiating the SQS client | | String
| *proxyPort* (common) | Specify a proxy port to be used inside the client definition. | | Integer
-| *region* (common) | The region in which S3 client needs to work | | String
+| *region* (common) | The region in which S3 client needs to work. 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
| *useIAMCredentials* (common) | Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in. | false | boolean
| *encryptionMaterials* (common) | The encryption materials to use in case of Symmetric/Asymmetric client usage | | EncryptionMaterials
| *useEncryption* (common) | Define if encryption must be used or not | false | boolean
diff --git a/components/camel-aws-s3/src/main/java/org/apache/camel/component/aws/s3/S3Configuration.java b/components/camel-aws-s3/src/main/java/org/apache/camel/component/aws/s3/S3Configuration.java
index e239115..a816049 100644
--- a/components/camel-aws-s3/src/main/java/org/apache/camel/component/aws/s3/S3Configuration.java
+++ b/components/camel-aws-s3/src/main/java/org/apache/camel/component/aws/s3/S3Configuration.java
@@ -204,7 +204,8 @@ public class S3Configuration implements Cloneable {
}
/**
- * The region in which S3 client needs to work
+ * The region in which S3 client needs to work. 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()
*/
public void setRegion(String region) {
this.region = region;
diff --git a/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/S3EndpointBuilderFactory.java b/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/S3EndpointBuilderFactory.java
index b219863..d964551 100644
--- a/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/S3EndpointBuilderFactory.java
+++ b/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/S3EndpointBuilderFactory.java
@@ -166,7 +166,10 @@ public interface S3EndpointBuilderFactory {
return this;
}
/**
- * The region in which S3 client needs to work.
+ * The region in which S3 client needs to work. 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().
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1276,7 +1279,10 @@ public interface S3EndpointBuilderFactory {
return this;
}
/**
- * The region in which S3 client needs to work.
+ * The region in which S3 client needs to work. 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().
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1904,7 +1910,10 @@ public interface S3EndpointBuilderFactory {
return this;
}
/**
- * The region in which S3 client needs to work.
+ * The region in which S3 client needs to work. 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().
*
* The option is a: <code>java.lang.String</code> type.
*
diff --git a/platforms/spring-boot/components-starter/camel-aws-s3-starter/src/main/java/org/apache/camel/component/aws/s3/springboot/S3ComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-aws-s3-starter/src/main/java/org/apache/camel/component/aws/s3/springboot/S3ComponentConfiguration.java
index 5e629d7..8fd9c20 100644
--- a/platforms/spring-boot/components-starter/camel-aws-s3-starter/src/main/java/org/apache/camel/component/aws/s3/springboot/S3ComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-aws-s3-starter/src/main/java/org/apache/camel/component/aws/s3/springboot/S3ComponentConfiguration.java
@@ -165,7 +165,10 @@ public class S3ComponentConfiguration
*/
private String fileName;
/**
- * The region in which S3 client needs to work
+ * The region in which S3 client needs to work. 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()
*/
private String region;
/**