You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2016/04/14 14:21:34 UTC
[2/2] camel git commit: CAMEL-9844: Fix so component docs is correct.
CAMEL-9844: Fix so component docs is correct.
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/3c334129
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/3c334129
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/3c334129
Branch: refs/heads/master
Commit: 3c3341297770566ea01127b27894e5f3cf91937a
Parents: ddb7208
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Apr 14 14:20:18 2016 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Apr 14 14:21:24 2016 +0200
----------------------------------------------------------------------
components/camel-aws/src/main/docs/aws-s3.adoc | 6 ++++--
components/camel-aws/src/main/docs/aws-sns.adoc | 6 ++++--
components/camel-aws/src/main/docs/aws-sqs.adoc | 6 ++++--
.../org/apache/camel/component/aws/s3/S3Configuration.java | 4 ----
.../java/org/apache/camel/component/aws/s3/S3Endpoint.java | 7 ++++++-
.../org/apache/camel/component/aws/sns/SnsConfiguration.java | 4 ----
.../java/org/apache/camel/component/aws/sns/SnsEndpoint.java | 5 +++++
.../org/apache/camel/component/aws/sqs/SqsConfiguration.java | 5 -----
.../java/org/apache/camel/component/aws/sqs/SqsEndpoint.java | 5 +++++
9 files changed, 28 insertions(+), 20 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/3c334129/components/camel-aws/src/main/docs/aws-s3.adoc
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/docs/aws-s3.adoc b/components/camel-aws/src/main/docs/aws-s3.adoc
index 59c10e9..6bf206a 100644
--- a/components/camel-aws/src/main/docs/aws-s3.adoc
+++ b/components/camel-aws/src/main/docs/aws-s3.adoc
@@ -19,7 +19,7 @@ URI Format
[source,java]
------------------------------
-aws-s3://bucket-name[?options]
+aws-s3://bucketNameOrArn[?options]
------------------------------
The bucket will be created if it don't already exists. +
@@ -37,13 +37,14 @@ The AWS S3 Storage Service component has no options.
+
// endpoint options: START
The AWS S3 Storage Service component supports 38 endpoint options which are listed below:
[width="100%",cols="2s,1,1m,1m,5",options="header"]
|=======================================================================
| Name | Group | Default | Java Type | Description
-| bucketName | common | | String | *Required* Name of the bucket. The bucket will be created if it don't already exists.
+| bucketNameOrArn | common | | String | *Required* Bucket name or ARN
| accessKey | common | | String | Amazon AWS Access Key
| amazonS3Client | common | | AmazonS3 | Reference to a com.amazonaws.services.sqs.AmazonS3 in the link:registry.htmlRegistry.
| amazonS3Endpoint | common | | String | The region with which the AWS-S3 client wants to work with.
@@ -86,6 +87,7 @@ The AWS S3 Storage Service component supports 38 endpoint options which are list
+
|=======================================================================
Required S3 component options
http://git-wip-us.apache.org/repos/asf/camel/blob/3c334129/components/camel-aws/src/main/docs/aws-sns.adoc
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/docs/aws-sns.adoc b/components/camel-aws/src/main/docs/aws-sns.adoc
index 6e2e142..e10e73a 100644
--- a/components/camel-aws/src/main/docs/aws-sns.adoc
+++ b/components/camel-aws/src/main/docs/aws-sns.adoc
@@ -21,7 +21,7 @@ URI Format
[source,java]
-----------------------------
-aws-sns://topicName[?options]
+aws-sns://topicNameOrArn[?options]
-----------------------------
The topic will be created if they don't already exists. +
@@ -39,13 +39,14 @@ The AWS Simple Notification System component has no options.
+
// endpoint options: START
The AWS Simple Notification System component supports 12 endpoint options which are listed below:
[width="100%",cols="2s,1,1m,1m,5",options="header"]
|=======================================================================
| Name | Group | Default | Java Type | Description
-| topicName | producer | | String | *Required* The name of the topic
+| topicNameOrArn | producer | | String | *Required* Topic name or ARN
| accessKey | producer | | String | Amazon AWS Access Key
| amazonSNSClient | producer | | AmazonSNS | To use the AmazonSNS as the client
| amazonSNSEndpoint | producer | | String | The region with which the AWS-SNS client wants to work with.
@@ -61,6 +62,7 @@ The AWS Simple Notification System component supports 12 endpoint options which
// endpoint options: END
+
Required SNS component options
You have to provide the amazonSNSClient in the
http://git-wip-us.apache.org/repos/asf/camel/blob/3c334129/components/camel-aws/src/main/docs/aws-sqs.adoc
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/docs/aws-sqs.adoc b/components/camel-aws/src/main/docs/aws-sqs.adoc
index 18123b0..2988bf6 100644
--- a/components/camel-aws/src/main/docs/aws-sqs.adoc
+++ b/components/camel-aws/src/main/docs/aws-sqs.adoc
@@ -19,7 +19,7 @@ URI Format
[source,java]
------------------------------
-aws-sqs://queue-name[?options]
+aws-sqs://queueNameOrArn[?options]
------------------------------
The queue will be created if they don't already exists. +
@@ -37,13 +37,14 @@ The AWS Simple Queue Service component has no options.
+
// endpoint options: START
The AWS Simple Queue Service component supports 45 endpoint options which are listed below:
[width="100%",cols="2s,1,1m,1m,5",options="header"]
|=======================================================================
| Name | Group | Default | Java Type | Description
-| queueName | common | | String | *Required* Name of queue. The queue will be created if they don't already exists.
+| queueNameOrArn | common | | String | *Required* Queue name or ARN
| accessKey | common | | String | Amazon AWS Access Key
| amazonSQSClient | common | | AmazonSQS | To use the AmazonSQS as client
| amazonSQSEndpoint | common | | String | The region with which the AWS-SQS client wants to work with. Only works if Camel creates the AWS-SQS client i.e. if you explicitly set amazonSQSClient then this setting will have no effect. You would have to set it on the client you create directly
@@ -92,6 +93,7 @@ The AWS Simple Queue Service component supports 45 endpoint options which are li
// endpoint options: END
+
Required SQS component options
You have to provide the amazonSQSClient in the
http://git-wip-us.apache.org/repos/asf/camel/blob/3c334129/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 2326478..1057763 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
@@ -17,16 +17,12 @@
package org.apache.camel.component.aws.s3;
import com.amazonaws.services.s3.AmazonS3;
-
-import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriParams;
-import org.apache.camel.spi.UriPath;
@UriParams
public class S3Configuration implements Cloneable {
- @UriPath @Metadata(required = "true")
private String bucketName;
@UriParam
private AmazonS3 amazonS3Client;
http://git-wip-us.apache.org/repos/asf/camel/blob/3c334129/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Endpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Endpoint.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Endpoint.java
index b95dfa1..9e5b2ad 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Endpoint.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Endpoint.java
@@ -38,14 +38,16 @@ import org.apache.camel.Message;
import org.apache.camel.Processor;
import org.apache.camel.Producer;
import org.apache.camel.impl.ScheduledPollEndpoint;
+import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
+import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ObjectHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * The aws-s3 component is used for storing and retrieving objetc from Amazon S3 Storage Service.
+ * The aws-s3 component is used for storing and retrieving objecct from Amazon S3 Storage Service.
*/
@UriEndpoint(scheme = "aws-s3", title = "AWS S3 Storage Service", syntax = "aws-s3:bucketNameOrArn", consumerClass = S3Consumer.class, label = "cloud,file")
public class S3Endpoint extends ScheduledPollEndpoint {
@@ -54,6 +56,9 @@ public class S3Endpoint extends ScheduledPollEndpoint {
private AmazonS3 s3Client;
+ @UriPath(description = "Bucket name or ARN")
+ @Metadata(required = "true")
+ private String bucketNameOrArn; // to support component docs
@UriParam
private S3Configuration configuration;
@UriParam(label = "consumer", defaultValue = "10")
http://git-wip-us.apache.org/repos/asf/camel/blob/3c334129/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsConfiguration.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsConfiguration.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsConfiguration.java
index f567643..06dd582 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsConfiguration.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsConfiguration.java
@@ -17,11 +17,8 @@
package org.apache.camel.component.aws.sns;
import com.amazonaws.services.sns.AmazonSNS;
-
-import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriParams;
-import org.apache.camel.spi.UriPath;
@UriParams
public class SnsConfiguration implements Cloneable {
@@ -29,7 +26,6 @@ public class SnsConfiguration implements Cloneable {
private String topicArn;
// Common properties
- @UriPath @Metadata(required = "true")
private String topicName;
@UriParam
private AmazonSNS amazonSNSClient;
http://git-wip-us.apache.org/repos/asf/camel/blob/3c334129/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsEndpoint.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsEndpoint.java
index 9991310..5ffc83e 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsEndpoint.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsEndpoint.java
@@ -31,8 +31,10 @@ import org.apache.camel.Consumer;
import org.apache.camel.Processor;
import org.apache.camel.Producer;
import org.apache.camel.impl.DefaultEndpoint;
+import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
+import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ObjectHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -47,6 +49,9 @@ public class SnsEndpoint extends DefaultEndpoint {
private AmazonSNS snsClient;
+ @UriPath(description = "Topic name or ARN")
+ @Metadata(required = "true")
+ private String topicNameOrArn; // to support component docs
@UriParam
private SnsConfiguration configuration;
http://git-wip-us.apache.org/repos/asf/camel/blob/3c334129/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsConfiguration.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsConfiguration.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsConfiguration.java
index 22c33d5..92ce834 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsConfiguration.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsConfiguration.java
@@ -16,19 +16,14 @@
*/
package org.apache.camel.component.aws.sqs;
-import java.util.Collection;
-
import com.amazonaws.services.sqs.AmazonSQS;
-import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriParams;
-import org.apache.camel.spi.UriPath;
@UriParams
public class SqsConfiguration {
// common properties
- @UriPath @Metadata(required = "true")
private String queueName;
@UriParam
private AmazonSQS amazonSQSClient;
http://git-wip-us.apache.org/repos/asf/camel/blob/3c334129/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsEndpoint.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsEndpoint.java
index c9ca0d2..f777444 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsEndpoint.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsEndpoint.java
@@ -43,8 +43,10 @@ import org.apache.camel.impl.DefaultScheduledPollConsumerScheduler;
import org.apache.camel.impl.ScheduledPollEndpoint;
import org.apache.camel.spi.HeaderFilterStrategy;
import org.apache.camel.spi.HeaderFilterStrategyAware;
+import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
+import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ObjectHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -60,6 +62,9 @@ public class SqsEndpoint extends ScheduledPollEndpoint implements HeaderFilterSt
private AmazonSQS client;
private String queueUrl;
+ @UriPath(description = "Queue name or ARN")
+ @Metadata(required = "true")
+ private String queueNameOrArn; // to support component docs
@UriParam
private SqsConfiguration configuration;
@UriParam(label = "consumer")