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 2017/01/27 12:33:31 UTC
camel git commit: CAMEL-10729: Improved docs
Repository: camel
Updated Branches:
refs/heads/master 7e9e8b7fd -> 389de20b4
CAMEL-10729: Improved docs
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/389de20b
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/389de20b
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/389de20b
Branch: refs/heads/master
Commit: 389de20b4641620024a2650a555eb77ddfcbe490
Parents: 7e9e8b7
Author: Andrea Cosentino <an...@gmail.com>
Authored: Fri Jan 27 13:27:16 2017 +0100
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Fri Jan 27 13:31:02 2017 +0100
----------------------------------------------------------------------
components/camel-aws/src/main/docs/aws-s3-component.adoc | 4 ++--
.../org/apache/camel/component/aws/s3/S3Configuration.java | 8 ++++++--
2 files changed, 8 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/389de20b/components/camel-aws/src/main/docs/aws-s3-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/docs/aws-s3-component.adoc b/components/camel-aws/src/main/docs/aws-s3-component.adoc
index 944d851..8cf6c29 100644
--- a/components/camel-aws/src/main/docs/aws-s3-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-s3-component.adoc
@@ -64,11 +64,11 @@ The AWS S3 Storage Service component supports 41 endpoint options which are list
| proxyHost | common | | String | Camel 2.16: To define a proxy host when instantiating the SQS client
| proxyPort | common | | Integer | Camel 2.16: Specify a proxy port to be used inside the client definition.
| secretKey | common | | String | Amazon AWS Secret Key
-| autocloseBody | consumer | true | boolean | If this option is true and includeBody is true then the S3Object.close() method will be called on exchange completion
+| autocloseBody | consumer | true | boolean | If this option is true and includeBody is true then the S3Object.close() method will be called on exchange completion This option is strongly related to includeBody 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.
| bridgeErrorHandler | consumer | false | boolean | 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.
| deleteAfterRead | consumer | true | boolean | 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 link S3ConstantsBUCKET_NAME and link S3ConstantsKEY headers or only the link S3ConstantsKEY header.
| fileName | consumer | | String | To get the object from the bucket with the given file name
-| includeBody | consumer | true | boolean | Camel 2.17: 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.
+| includeBody | consumer | true | boolean | 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.
| maxMessagesPerPoll | consumer | 10 | int | 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.
| prefix | consumer | | String | Camel 2.10.1: The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.
| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
http://git-wip-us.apache.org/repos/asf/camel/blob/389de20b/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Configuration.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Configuration.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Configuration.java
index aafec13..03f17b1 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Configuration.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Configuration.java
@@ -180,8 +180,10 @@ public class S3Configuration implements Cloneable {
}
/**
- * *Camel 2.17*: 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.
+ * 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.
*/
public void setIncludeBody(boolean includeBody) {
this.includeBody = includeBody;
@@ -302,6 +304,8 @@ public class S3Configuration implements Cloneable {
/**
* If this option is true and includeBody is true, then the S3Object.close() method will be called on exchange completion
+ * This option is strongly related to includeBody 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.
*/
public void setAutocloseBody(boolean autocloseBody) {
this.autocloseBody = autocloseBody;