camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From davscl...@apache.org
Subject [01/20] camel git commit: CAMEL-8561: Better component docs summary of components - we use javadoc from the endpoint class instead of component so its in the same source file as @UriEndpoint.
Date Sun, 27 Dec 2015 17:28:31 GMT
Repository: camel
Updated Branches:
  refs/heads/master 5cd78fa33 -> fcfd7bd50


CAMEL-8561: Better component docs summary of components - we use javadoc from the endpoint
class instead of component so its in the same source file as @UriEndpoint.


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/3ebf1873
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/3ebf1873
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/3ebf1873

Branch: refs/heads/master
Commit: 3ebf1873e05a9d9ea0cdb89e02ff895e462de681
Parents: 5cd78fa
Author: Claus Ibsen <davsclaus@apache.org>
Authored: Sun Dec 27 10:03:16 2015 +0100
Committer: Claus Ibsen <davsclaus@apache.org>
Committed: Sun Dec 27 18:25:23 2015 +0100

----------------------------------------------------------------------
 .../camel/component/ahc/ws/WsComponent.java     |  2 +-
 .../camel/component/ahc/ws/WsEndpoint.java      |  2 +-
 .../camel/component/ahc/AhcComponent.java       |  2 +-
 .../camel/component/amqp/AMQPComponent.java     |  2 +-
 .../camel/component/amqp/AMQPEndpoint.java      |  4 +-
 .../camel/component/apns/ApnsComponent.java     |  3 ++
 .../websocket/WebsocketComponent.java           |  3 ++
 .../camel/component/atom/AtomComponent.java     |  6 +--
 .../camel/component/atom/AtomEndpoint.java      |  7 +--
 .../camel/component/avro/AvroComponent.java     |  3 ++
 .../camel/component/aws/cw/CwComponent.java     |  2 +-
 .../camel/component/aws/cw/CwEndpoint.java      |  3 --
 .../camel/component/aws/ddb/DdbComponent.java   |  2 +-
 .../camel/component/aws/ddb/DdbEndpoint.java    |  3 --
 .../aws/ddbstream/DdbStreamComponent.java       |  5 +-
 .../camel/component/aws/ec2/EC2Component.java   |  2 +-
 .../camel/component/aws/ec2/EC2Endpoint.java    |  3 --
 .../component/aws/kinesis/KinesisComponent.java |  3 ++
 .../camel/component/aws/s3/S3Component.java     |  2 +-
 .../camel/component/aws/sdb/SdbComponent.java   |  2 +-
 .../camel/component/aws/sdb/SdbEndpoint.java    |  3 --
 .../camel/component/aws/ses/SesComponent.java   |  2 +-
 .../camel/component/aws/ses/SesEndpoint.java    |  4 --
 .../camel/component/aws/sns/SnsComponent.java   |  2 +-
 .../camel/component/aws/sns/SnsEndpoint.java    |  3 --
 .../camel/component/aws/sqs/SqsComponent.java   |  3 +-
 .../camel/component/aws/sqs/SqsEndpoint.java    |  3 --
 .../camel/component/aws/swf/SWFComponent.java   |  2 +-
 .../camel/component/aws/swf/SWFEndpoint.java    |  3 --
 .../apache/camel/component/rss/RssEndpoint.java |  2 +-
 .../camel/commands/CatalogCommandTest.java      | 57 ++++++++++++++++++++
 .../tools/apt/EndpointAnnotationProcessor.java  | 30 +++++------
 32 files changed, 104 insertions(+), 71 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsComponent.java
b/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsComponent.java
index eebab4d..7d557a5 100644
--- a/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsComponent.java
+++ b/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsComponent.java
@@ -22,7 +22,7 @@ import org.apache.camel.component.ahc.AhcComponent;
 import org.apache.camel.component.ahc.AhcEndpoint;
 
 /**
- *  Defines the <a href="http://camel.apache.org/ws.html">WebSocket Client Component</a>
+ *  To exchange data with external Websocket servers using <a href="http://github.com/sonatype/async-http-client">Async
Http Client</a>
  */
 public class WsComponent extends AhcComponent {
     

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsEndpoint.java
b/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsEndpoint.java
index 973ca79..77ed754 100644
--- a/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsEndpoint.java
+++ b/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsEndpoint.java
@@ -47,7 +47,7 @@ public class WsEndpoint extends AhcEndpoint {
     private static final boolean GRIZZLY_AVAILABLE = 
         probeClass("com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider");
 
-    private final Set<WsConsumer> consumers  = new HashSet<WsConsumer>();
+    private final Set<WsConsumer> consumers = new HashSet<WsConsumer>();
 
     private WebSocket websocket;
     @UriParam

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-ahc/src/main/java/org/apache/camel/component/ahc/AhcComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-ahc/src/main/java/org/apache/camel/component/ahc/AhcComponent.java
b/components/camel-ahc/src/main/java/org/apache/camel/component/ahc/AhcComponent.java
index 75b0015..58b1afd 100644
--- a/components/camel-ahc/src/main/java/org/apache/camel/component/ahc/AhcComponent.java
+++ b/components/camel-ahc/src/main/java/org/apache/camel/component/ahc/AhcComponent.java
@@ -34,7 +34,7 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- *  Defines the <a href="http://camel.apache.org/ahc.html">Async HTTP Client Component</a>
+ *  To call external HTTP services using <a href="http://github.com/sonatype/async-http-client">Async
Http Client</a>
  */
 public class AhcComponent extends HeaderFilterStrategyComponent {
     

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPComponent.java
b/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPComponent.java
index 6dd8226..43aebab 100644
--- a/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPComponent.java
+++ b/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPComponent.java
@@ -26,7 +26,7 @@ import org.apache.camel.component.jms.JmsConfiguration;
 import org.apache.qpid.jms.JmsConnectionFactory;
 
 /**
- * This component supports the AMQP protocol using the Client API of the Apache Qpid project.
+ * Messaging with AMQP protocol using Apache QPid Client.
  */
 public class AMQPComponent extends JmsComponent {
 

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPEndpoint.java
b/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPEndpoint.java
index 4fb5c9e..a06fee8 100644
--- a/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPEndpoint.java
+++ b/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPEndpoint.java
@@ -20,12 +20,12 @@ import org.apache.camel.component.jms.JmsConsumer;
 import org.apache.camel.component.jms.JmsEndpoint;
 import org.apache.camel.spi.UriEndpoint;
 
-@UriEndpoint(scheme = "amqp", extendsScheme = "jms", title = "AMQP",
-        syntax = "amqp:destinationType:destinationName", consumerClass = JmsConsumer.class,
label = "messaging")
 /**
  * AMQP endpoint. This class extends JmsEndpoint because it uses Apache Qpid JMS-compatible
client for
  * performing the AMQP connectivity.
  */
+@UriEndpoint(scheme = "amqp", extendsScheme = "jms", title = "AMQP",
+        syntax = "amqp:destinationType:destinationName", consumerClass = JmsConsumer.class,
label = "messaging")
 public class AMQPEndpoint extends JmsEndpoint {
 
 }

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-apns/src/main/java/org/apache/camel/component/apns/ApnsComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-apns/src/main/java/org/apache/camel/component/apns/ApnsComponent.java
b/components/camel-apns/src/main/java/org/apache/camel/component/apns/ApnsComponent.java
index ba43bec..6426c11 100644
--- a/components/camel-apns/src/main/java/org/apache/camel/component/apns/ApnsComponent.java
+++ b/components/camel-apns/src/main/java/org/apache/camel/component/apns/ApnsComponent.java
@@ -22,6 +22,9 @@ import com.notnoop.apns.ApnsService;
 import org.apache.camel.Endpoint;
 import org.apache.camel.impl.UriEndpointComponent;
 
+/**
+ * For sending notifications to Apple iOS devices
+ */
 public class ApnsComponent extends UriEndpointComponent {
 
     private ApnsService apnsService;

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-atmosphere-websocket/src/main/java/org/apache/camel/component/atmosphere/websocket/WebsocketComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-atmosphere-websocket/src/main/java/org/apache/camel/component/atmosphere/websocket/WebsocketComponent.java
b/components/camel-atmosphere-websocket/src/main/java/org/apache/camel/component/atmosphere/websocket/WebsocketComponent.java
index b9d5fa2..fa9e843 100644
--- a/components/camel-atmosphere-websocket/src/main/java/org/apache/camel/component/atmosphere/websocket/WebsocketComponent.java
+++ b/components/camel-atmosphere-websocket/src/main/java/org/apache/camel/component/atmosphere/websocket/WebsocketComponent.java
@@ -23,6 +23,9 @@ import java.util.Map;
 import org.apache.camel.component.servlet.ServletComponent;
 import org.apache.camel.component.servlet.ServletEndpoint;
 
+/**
+ * To exchange data with external Websocket clients using Atmosphere
+ */
 public class WebsocketComponent extends ServletComponent {
     private Map<String, WebSocketStore> stores;
     

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomComponent.java
b/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomComponent.java
index 53e4050..7e0cf26 100644
--- a/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomComponent.java
+++ b/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomComponent.java
@@ -25,11 +25,7 @@ import org.apache.camel.component.feed.FeedEndpoint;
 import org.apache.camel.util.URISupport;
 
 /**
- * An <a href="http://camel.apache.org/atom.html">Atom Component</a>.
- * <p/>
- * Camel uses Apache Abdera as the Atom implementation.
- *
- * @version 
+ * To consume Atom RSS feeds.
  */
 public class AtomComponent extends FeedComponent {
 

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomEndpoint.java
b/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomEndpoint.java
index 55c4a5e..d5600f4 100644
--- a/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomEndpoint.java
+++ b/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomEndpoint.java
@@ -26,12 +26,7 @@ import org.apache.camel.component.feed.FeedEndpoint;
 import org.apache.camel.component.feed.FeedPollingConsumer;
 import org.apache.camel.spi.UriEndpoint;
 
-/**
- * Atom is used for polling atom feeds
- *
- * @version 
- */
-@UriEndpoint(scheme = "atom", title = "Atom", syntax = "atom:feedUri", consumerOnly = true,
consumerClass = FeedPollingConsumer.class, label = "feeds")
+@UriEndpoint(scheme = "atom", title = "Atom", syntax = "atom:feedUri", consumerOnly = true,
consumerClass = FeedPollingConsumer.class, label = "rss")
 public class AtomEndpoint extends FeedEndpoint {
 
     public AtomEndpoint() {

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroComponent.java
b/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroComponent.java
index 108348b..6406af2 100644
--- a/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroComponent.java
+++ b/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroComponent.java
@@ -30,6 +30,9 @@ import org.apache.camel.Endpoint;
 import org.apache.camel.impl.UriEndpointComponent;
 import org.apache.camel.util.URISupport;
 
+/**
+ * Working with Apache Avro for data serialization.
+ */
 public class AvroComponent extends UriEndpointComponent {
 
     private AvroConfiguration configuration;

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwComponent.java
b/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwComponent.java
index 4ab46a6..85e4f76 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwComponent.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwComponent.java
@@ -23,7 +23,7 @@ import org.apache.camel.Endpoint;
 import org.apache.camel.impl.UriEndpointComponent;
 
 /**
- * Defines the <a href="http://aws.amazon.com/cloudwatch/">AWS CloudWatch Component</a>
+ * For working with Amazon's CloudWatch (CW).
  */
 public class CwComponent extends UriEndpointComponent {
 

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwEndpoint.java
b/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwEndpoint.java
index aa1ba61..b33b09d 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwEndpoint.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwEndpoint.java
@@ -32,9 +32,6 @@ import org.apache.camel.spi.UriEndpoint;
 import org.apache.camel.spi.UriParam;
 import org.apache.camel.util.ObjectHelper;
 
-/**
- * Defines the <a href="http://aws.amazon.com/cloudwatch/">AWS CloudWatch Endpoint</a>
- */
 @UriEndpoint(scheme = "aws-cw", title = "AWS CloudWatch", syntax = "aws-cw:namespace", producerOnly
= true, label = "cloud,monitoring")
 public class CwEndpoint extends DefaultEndpoint {
 

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbComponent.java
b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbComponent.java
index c895557..7523d62 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbComponent.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbComponent.java
@@ -23,7 +23,7 @@ import org.apache.camel.Endpoint;
 import org.apache.camel.impl.UriEndpointComponent;
 
 /**
- * Defines the <a href="http://aws.amazon.com/dynamodb/">AWS DynamoDB component</a>
+ * For working with Amazon's DynamoDB (DDB).
  */
 public class DdbComponent extends UriEndpointComponent {
 

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbEndpoint.java
b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbEndpoint.java
index 4c471fc..e238528 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbEndpoint.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbEndpoint.java
@@ -42,9 +42,6 @@ import org.apache.camel.util.ObjectHelper;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/**
- * Defines the <a href="http://aws.amazon.com/dynamodb/">AWS DynamoDB endpoint</a>
- */
 @UriEndpoint(scheme = "aws-ddb", title = "AWS DynamoDB", syntax = "aws-ddb:tableName", producerOnly
= true, label = "cloud,database,nosql")
 public class DdbEndpoint extends ScheduledPollEndpoint {
 

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamComponent.java
b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamComponent.java
index 559597b..b7bad44 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamComponent.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamComponent.java
@@ -23,6 +23,9 @@ import org.apache.camel.impl.UriEndpointComponent;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * For working with Amazon's DynamoDB (DDB) Streams.
+ */
 public class DdbStreamComponent extends UriEndpointComponent {
     private static final Logger LOG = LoggerFactory.getLogger(DdbStreamComponent.class);
 
@@ -37,8 +40,6 @@ public class DdbStreamComponent extends UriEndpointComponent {
     @Override
     protected Endpoint createEndpoint(String uri, String remaining, Map<String, Object>
parameters) throws Exception {
         DdbStreamEndpoint endpoint = new DdbStreamEndpoint(uri, remaining, this);
-
-        LOG.debug("Created endpoint: {}", endpoint.toString());
         return endpoint;
     }
 }

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Component.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Component.java
b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Component.java
index 8378943..1dc8c4c 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Component.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Component.java
@@ -23,7 +23,7 @@ import org.apache.camel.Endpoint;
 import org.apache.camel.impl.UriEndpointComponent;
 
 /**
- * Defines the <a href="http://aws.amazon.com/ec2/">AWS EC2 Component</a> 
+ * For working with Amazon's Elastic Compute Cloud (EC2).
  */
 public class EC2Component extends UriEndpointComponent {
 

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Endpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Endpoint.java
b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Endpoint.java
index c9e2904..6098959 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Endpoint.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Endpoint.java
@@ -30,9 +30,6 @@ import org.apache.camel.spi.UriEndpoint;
 import org.apache.camel.spi.UriParam;
 import org.apache.camel.util.ObjectHelper;
 
-/**
- * Defines the <a href="http://camel.apache.org/aws.html">AWS EC2 Endpoint</a>.
 
- */
 @UriEndpoint(scheme = "aws-ec2", title = "AWS EC2", syntax = "aws-ec2:label", producerOnly
= true, label = "cloud,management")
 public class EC2Endpoint extends ScheduledPollEndpoint {
     

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisComponent.java
b/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisComponent.java
index 9740600..0bcd285 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisComponent.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisComponent.java
@@ -24,6 +24,9 @@ import org.apache.camel.impl.UriEndpointComponent;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * For working with Amazon's Kinesis Streams.
+ */
 public class KinesisComponent extends UriEndpointComponent {
     private static final Logger LOG = LoggerFactory.getLogger(KinesisComponent.class);
 

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Component.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Component.java
b/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Component.java
index 06c43da..86cf1e5 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Component.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Component.java
@@ -23,7 +23,7 @@ import org.apache.camel.Endpoint;
 import org.apache.camel.impl.UriEndpointComponent;
 
 /**
- * Defines the <a href="http://aws.amazon.com/s3/">AWS S3 Component</a> 
+ * For working with Amazon's Simple Storage Service (S3).
  */
 public class S3Component extends UriEndpointComponent {
     

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbComponent.java
b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbComponent.java
index fd6ce02..92182f9 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbComponent.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbComponent.java
@@ -23,7 +23,7 @@ import org.apache.camel.Endpoint;
 import org.apache.camel.impl.UriEndpointComponent;
 
 /**
- * Defines the <a href="http://aws.amazon.com/simpledb/">AWS SDB component</a>

+ * For working with Amazon's SimpleDB (SDB).
  */
 public class SdbComponent extends UriEndpointComponent {
 

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbEndpoint.java
b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbEndpoint.java
index 3118dd9..05fc371 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbEndpoint.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbEndpoint.java
@@ -38,9 +38,6 @@ import org.apache.camel.util.ObjectHelper;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/**
- * Defines the <a href="http://camel.apache.org/aws.html">AWS SDB Endpoint</a>.
 
- */
 @UriEndpoint(scheme = "aws-sdb", title = "AWS SimpleDB", syntax = "aws-sdb:domainName", producerOnly
= true, label = "cloud,database,nosql")
 public class SdbEndpoint extends ScheduledPollEndpoint {
     

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesComponent.java
b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesComponent.java
index 11becd1..3afeade 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesComponent.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesComponent.java
@@ -23,7 +23,7 @@ import org.apache.camel.Endpoint;
 import org.apache.camel.impl.UriEndpointComponent;
 
 /**
- * Defines the <a href="http://aws.amazon.com/ses/">AWS SES component</a> 
+ * For working with Amazon's Simple Email Service (SES).
  */
 public class SesComponent extends UriEndpointComponent {
 

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesEndpoint.java
b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesEndpoint.java
index f8aade2..1366cf8 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesEndpoint.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesEndpoint.java
@@ -32,10 +32,6 @@ import org.apache.camel.spi.UriEndpoint;
 import org.apache.camel.spi.UriParam;
 import org.apache.camel.util.ObjectHelper;
 
-/**
- * Defines the <a href="http://camel.apache.org/aws.html">AWS SES Endpoint</a>.
 
- *
- */
 @UriEndpoint(scheme = "aws-ses", title = "AWS Simple Email Service", syntax = "aws-ses:from",
producerOnly = true, label = "cloud,mail")
 public class SesEndpoint extends DefaultEndpoint {
 

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsComponent.java
b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsComponent.java
index 239cec6..1f1eaf3 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsComponent.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsComponent.java
@@ -23,7 +23,7 @@ import org.apache.camel.Endpoint;
 import org.apache.camel.impl.UriEndpointComponent;
 
 /**
- * Defines the <a href="http://aws.amazon.com/sns/">AWS SNS Component</a> 
+ * For Messaging with Amazon's Simple Notification Service (SNS).
  */
 public class SnsComponent extends UriEndpointComponent {
     

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/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 b2dc4ce..0458a44 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
@@ -37,9 +37,6 @@ import org.apache.camel.util.ObjectHelper;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/**
- * Defines the <a href="http://camel.apache.org/aws.html">AWS SNS Endpoint</a>.
 
- */
 @UriEndpoint(scheme = "aws-sns", title = "AWS Simple Notification System", syntax = "aws-sns:topicName",
producerOnly = true, label = "cloud,mobile,messaging")
 public class SnsEndpoint extends DefaultEndpoint {
 

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsComponent.java
b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsComponent.java
index e6aa9c0..df55176 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsComponent.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsComponent.java
@@ -23,8 +23,7 @@ import org.apache.camel.Endpoint;
 import org.apache.camel.impl.UriEndpointComponent;
 
 /**
- * Defines the <a href="http://camel.apache.org/aws.html">AWS Component</a> 
- * 
+ * For Messaging with Amazon's Simple Queue Service (SQS).
  */
 public class SqsComponent extends UriEndpointComponent {
     

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/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 9567076..6872efd 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
@@ -50,9 +50,6 @@ import org.apache.camel.util.ObjectHelper;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/**
- * Defines the <a href="http://camel.apache.org/aws.html">AWS SQS Endpoint</a>.
 
- */
 @UriEndpoint(scheme = "aws-sqs", title = "AWS Simple Queue Service", syntax = "aws-sqs:queueName",
consumerClass = SqsConsumer.class, label = "cloud,messaging")
 public class SqsEndpoint extends ScheduledPollEndpoint implements HeaderFilterStrategyAware
{
     

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFComponent.java
b/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFComponent.java
index 6731421..7a1a9ae 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFComponent.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFComponent.java
@@ -23,7 +23,7 @@ import org.apache.camel.impl.UriEndpointComponent;
 import org.apache.camel.util.IntrospectionSupport;
 
 /**
- * Defines the <a href="http://aws.amazon.com/swf/">Amazon Simple Workflow Component</a>
+ * For Messaging with Amazon's Simple Workflow Service (SWF).
  */
 public class SWFComponent extends UriEndpointComponent {
 

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFEndpoint.java
b/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFEndpoint.java
index a2d51ce..8ecaca3 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFEndpoint.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFEndpoint.java
@@ -32,9 +32,6 @@ import org.apache.camel.spi.UriParam;
 import org.apache.camel.util.EndpointHelper;
 import org.apache.camel.util.ExchangeHelper;
 
-/**
- * Defines the <a href="http://aws.amazon.com/swf/">Amazon Simple Workflow Endpoint</a>
- */
 @UriEndpoint(scheme = "aws-swf", title = "AWS Simple Workflow", syntax = "aws-swf:type",
consumerClass = SWFWorkflowConsumer.class, label = "cloud,workflow")
 public class SWFEndpoint extends DefaultEndpoint {
 

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssEndpoint.java
b/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssEndpoint.java
index c4cc6d0..eee6e7e 100644
--- a/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssEndpoint.java
+++ b/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssEndpoint.java
@@ -34,7 +34,7 @@ import org.slf4j.LoggerFactory;
  * Is used for polling rss feeds.
  */
 @UriEndpoint(scheme = "rss", extendsScheme = "atom", title = "RSS",
-        syntax = "rss:feedUri", consumerOnly = true, consumerClass = RssEntryPollingConsumer.class,
label = "feeds")
+        syntax = "rss:feedUri", consumerOnly = true, consumerClass = RssEntryPollingConsumer.class,
label = "rss")
 public class RssEndpoint extends FeedEndpoint {
     protected static final Logger LOG = LoggerFactory.getLogger(RssEndpoint.class);
 

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/platforms/commands/commands-core/src/test/java/org/apache/camel/commands/CatalogCommandTest.java
----------------------------------------------------------------------
diff --git a/platforms/commands/commands-core/src/test/java/org/apache/camel/commands/CatalogCommandTest.java
b/platforms/commands/commands-core/src/test/java/org/apache/camel/commands/CatalogCommandTest.java
new file mode 100644
index 0000000..be4b941
--- /dev/null
+++ b/platforms/commands/commands-core/src/test/java/org/apache/camel/commands/CatalogCommandTest.java
@@ -0,0 +1,57 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.camel.commands;
+
+import java.io.ByteArrayOutputStream;
+import java.io.OutputStream;
+import java.io.PrintStream;
+
+import org.apache.camel.CamelContext;
+import org.apache.camel.impl.DefaultCamelContext;
+import org.apache.camel.impl.ExplicitCamelContextNameStrategy;
+import org.junit.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import static org.junit.Assert.assertNotNull;
+
+public class CatalogCommandTest {
+
+    private static final Logger LOG = LoggerFactory.getLogger(CatalogCommandTest.class);
+
+    @Test
+    public void testListComponents() throws Exception {
+        CamelContext context = new DefaultCamelContext();
+        context.setNameStrategy(new ExplicitCamelContextNameStrategy("foobar"));
+        context.start();
+
+        CamelController controller = new DummyCamelController(context);
+
+        OutputStream os = new ByteArrayOutputStream();
+        PrintStream ps = new PrintStream(os);
+
+        CatalogComponentListCommand command = new CatalogComponentListCommand(false, null);
+        command.execute(controller, ps, null);
+
+        String out = os.toString();
+        assertNotNull(out);
+        LOG.info("\n\n{}\n", out);
+
+        context.stop();
+    }
+
+}

http://git-wip-us.apache.org/repos/asf/camel/blob/3ebf1873/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java
----------------------------------------------------------------------
diff --git a/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java
b/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java
index e662217..61e5dbc 100644
--- a/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java
+++ b/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java
@@ -132,7 +132,7 @@ public class EndpointAnnotationProcessor extends AbstractAnnotationProcessor
{
     protected void writeHtmlDocumentation(PrintWriter writer, RoundEnvironment roundEnv,
TypeElement classElement, UriEndpoint uriEndpoint,
                                           String title, String scheme, String extendsScheme,
String label) {
         // gather component information
-        ComponentModel componentModel = findComponentProperties(roundEnv, uriEndpoint, title,
scheme, extendsScheme, label);
+        ComponentModel componentModel = findComponentProperties(roundEnv, uriEndpoint, classElement,
title, scheme, extendsScheme, label);
 
         String syntax = componentModel.getSyntax();
         String description = componentModel.getDescription();
@@ -180,7 +180,7 @@ public class EndpointAnnotationProcessor extends AbstractAnnotationProcessor
{
     protected void writeJSonSchemeDocumentation(PrintWriter writer, RoundEnvironment roundEnv,
TypeElement classElement, UriEndpoint uriEndpoint,
                                                 String title, String scheme, String extendsScheme,
String label) {
         // gather component information
-        ComponentModel componentModel = findComponentProperties(roundEnv, uriEndpoint, title,
scheme, extendsScheme, label);
+        ComponentModel componentModel = findComponentProperties(roundEnv, uriEndpoint, classElement,
title, scheme, extendsScheme, label);
 
         // get endpoint information which is divided into paths and options (though there
should really only be one path)
         Set<EndpointPath> endpointPaths = new LinkedHashSet<EndpointPath>();
@@ -408,7 +408,7 @@ public class EndpointAnnotationProcessor extends AbstractAnnotationProcessor
{
         }
     }
 
-    protected ComponentModel findComponentProperties(RoundEnvironment roundEnv, UriEndpoint
uriEndpoint,
+    protected ComponentModel findComponentProperties(RoundEnvironment roundEnv, UriEndpoint
uriEndpoint, TypeElement endpointClassElement,
                                                      String title, String scheme, String
extendsScheme, String label) {
         ComponentModel model = new ComponentModel(scheme);
 
@@ -456,19 +456,17 @@ public class EndpointAnnotationProcessor extends AbstractAnnotationProcessor
{
             }
         }
 
-        // favor to use class javadoc of component as description
-        if (model.getJavaType() != null) {
-            Elements elementUtils = processingEnv.getElementUtils();
-            TypeElement typeElement = findTypeElement(roundEnv, model.getJavaType());
-            if (typeElement != null) {
-                String doc = elementUtils.getDocComment(typeElement);
-                if (doc != null) {
-                    // need to sanitize the description first (we only want a summary)
-                    doc = sanitizeDescription(doc, true);
-                    // the javadoc may actually be empty, so only change the doc if we got
something
-                    if (!Strings.isNullOrEmpty(doc)) {
-                        model.setDescription(doc);
-                    }
+        // favor to use endpoint class javadoc as description
+        Elements elementUtils = processingEnv.getElementUtils();
+        TypeElement typeElement = findTypeElement(roundEnv, endpointClassElement.getQualifiedName().toString());
+        if (typeElement != null) {
+            String doc = elementUtils.getDocComment(typeElement);
+            if (doc != null) {
+                // need to sanitize the description first (we only want a summary)
+                doc = sanitizeDescription(doc, true);
+                // the javadoc may actually be empty, so only change the doc if we got something
+                if (!Strings.isNullOrEmpty(doc)) {
+                    model.setDescription(doc);
                 }
             }
         }


Mime
View raw message