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 2015/12/27 18:28:31 UTC
[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.
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 <da...@apache.org>
Authored: Sun Dec 27 10:03:16 2015 +0100
Committer: Claus Ibsen <da...@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);
}
}
}
[10/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.
Posted by da...@apache.org.
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/0577b699
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/0577b699
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/0577b699
Branch: refs/heads/master
Commit: 0577b699987a1e331a6f1120fa5870e5d52b9ee2
Parents: 3076ca4
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 15:10:37 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:27 2015 +0100
----------------------------------------------------------------------
.../main/java/org/apache/camel/component/mail/MailEndpoint.java | 2 +-
.../java/org/apache/camel/component/metrics/MetricsEndpoint.java | 3 +++
components/camel-mina/pom.xml | 2 +-
.../main/java/org/apache/camel/component/mina/MinaEndpoint.java | 4 +---
.../java/org/apache/camel/component/mina2/Mina2Endpoint.java | 4 +---
.../java/org/apache/camel/component/mongodb/MongoDbEndpoint.java | 3 +++
.../main/java/org/apache/camel/component/mqtt/MQTTEndpoint.java | 4 ++--
.../org/apache/camel/component/validator/msv/MsvEndpoint.java | 3 +++
.../org/apache/camel/component/mustache/MustacheEndpoint.java | 2 +-
.../main/java/org/apache/camel/component/mvel/MvelEndpoint.java | 3 +++
.../java/org/apache/camel/component/mybatis/MyBatisEndpoint.java | 2 +-
.../java/org/apache/camel/component/nagios/NagiosEndpoint.java | 2 +-
components/camel-netty-http/pom.xml | 2 +-
.../org/apache/camel/component/netty/http/NettyHttpEndpoint.java | 2 +-
components/camel-netty/pom.xml | 2 +-
.../java/org/apache/camel/component/netty/NettyEndpoint.java | 3 +++
.../apache/camel/component/netty4/http/NettyHttpEndpoint.java | 2 +-
.../java/org/apache/camel/component/netty4/NettyEndpoint.java | 3 +++
.../java/org/apache/camel/component/olingo2/Olingo2Endpoint.java | 2 +-
.../org/apache/camel/component/openshift/OpenShiftEndpoint.java | 3 +++
.../apache/camel/component/optaplanner/OptaPlannerEndpoint.java | 2 +-
21 files changed, 36 insertions(+), 19 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailEndpoint.java b/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailEndpoint.java
index f020bf6..08a56e0 100644
--- a/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailEndpoint.java
+++ b/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailEndpoint.java
@@ -30,7 +30,7 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
/**
- * Endpoint for Camel Mail.
+ * To send or receive emails using imap/pop3 or stmp protocols.
*/
@UriEndpoint(scheme = "imap,imaps,pop3,pop3s,smtp,smtps", title = "IMAP,IMAPS,POP3,POP3S,SMTP,SMTPS", syntax = "imap:host:port", consumerClass = MailConsumer.class, label = "mail")
public class MailEndpoint extends ScheduledPollEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-metrics/src/main/java/org/apache/camel/component/metrics/MetricsEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-metrics/src/main/java/org/apache/camel/component/metrics/MetricsEndpoint.java b/components/camel-metrics/src/main/java/org/apache/camel/component/metrics/MetricsEndpoint.java
index c6462a6..7fe7e15 100644
--- a/components/camel-metrics/src/main/java/org/apache/camel/component/metrics/MetricsEndpoint.java
+++ b/components/camel-metrics/src/main/java/org/apache/camel/component/metrics/MetricsEndpoint.java
@@ -28,6 +28,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
+/**
+ * To collect various metrics directly from Camel routes using the DropWizard metrics library.
+ */
@UriEndpoint(scheme = "metrics", title = "Metrics", syntax = "metrics:metricsType:metricsName", producerOnly = true, label = "monitoring")
public class MetricsEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-mina/pom.xml
----------------------------------------------------------------------
diff --git a/components/camel-mina/pom.xml b/components/camel-mina/pom.xml
index b07104f..7505fea 100644
--- a/components/camel-mina/pom.xml
+++ b/components/camel-mina/pom.xml
@@ -26,7 +26,7 @@
<artifactId>camel-mina</artifactId>
<packaging>bundle</packaging>
- <name>Camel :: MINA</name>
+ <name>Camel :: MINA (deprecated)</name>
<description>Camel MINA support</description>
<properties>
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-mina/src/main/java/org/apache/camel/component/mina/MinaEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-mina/src/main/java/org/apache/camel/component/mina/MinaEndpoint.java b/components/camel-mina/src/main/java/org/apache/camel/component/mina/MinaEndpoint.java
index 6c2801d..7b5290b 100644
--- a/components/camel-mina/src/main/java/org/apache/camel/component/mina/MinaEndpoint.java
+++ b/components/camel-mina/src/main/java/org/apache/camel/component/mina/MinaEndpoint.java
@@ -37,9 +37,7 @@ import org.apache.mina.common.IoConnectorConfig;
import org.apache.mina.common.IoSession;
/**
- * Endpoint for Camel MINA.
- *
- * @version
+ * Socket level networking using TCP or UDP with the Apache Mina 1.x library.
*/
@UriEndpoint(scheme = "mina", title = "Mina", syntax = "mina:protocol:host:port", consumerClass = MinaConsumer.class, label = "networking,tcp,udp")
public class MinaEndpoint extends DefaultEndpoint implements MultipleConsumersSupport {
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-mina2/src/main/java/org/apache/camel/component/mina2/Mina2Endpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-mina2/src/main/java/org/apache/camel/component/mina2/Mina2Endpoint.java b/components/camel-mina2/src/main/java/org/apache/camel/component/mina2/Mina2Endpoint.java
index e22a259..ce21d8c 100644
--- a/components/camel-mina2/src/main/java/org/apache/camel/component/mina2/Mina2Endpoint.java
+++ b/components/camel-mina2/src/main/java/org/apache/camel/component/mina2/Mina2Endpoint.java
@@ -29,9 +29,7 @@ import org.apache.camel.util.ObjectHelper;
import org.apache.mina.core.session.IoSession;
/**
- * Endpoint for Camel MINA.
- *
- * @version
+ * Socket level networking using TCP or UDP with the Apache Mina 2.x library.
*/
@UriEndpoint(scheme = "mina2", title = "Mina2", syntax = "mina2:protocol:host:port", consumerClass = Mina2Consumer.class, label = "networking,tcp,udp")
public class Mina2Endpoint extends DefaultEndpoint implements MultipleConsumersSupport {
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-mongodb/src/main/java/org/apache/camel/component/mongodb/MongoDbEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-mongodb/src/main/java/org/apache/camel/component/mongodb/MongoDbEndpoint.java b/components/camel-mongodb/src/main/java/org/apache/camel/component/mongodb/MongoDbEndpoint.java
index b3980d7..daea215 100644
--- a/components/camel-mongodb/src/main/java/org/apache/camel/component/mongodb/MongoDbEndpoint.java
+++ b/components/camel-mongodb/src/main/java/org/apache/camel/component/mongodb/MongoDbEndpoint.java
@@ -46,6 +46,9 @@ import org.apache.camel.util.ObjectHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Component for working with documents stored in MongoDB database.
+ */
@UriEndpoint(scheme = "mongodb", title = "MongoDB", syntax = "mongodb:connectionBean", consumerClass = MongoDbTailableCursorConsumer.class, label = "database,nosql")
public class MongoDbEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-mqtt/src/main/java/org/apache/camel/component/mqtt/MQTTEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-mqtt/src/main/java/org/apache/camel/component/mqtt/MQTTEndpoint.java b/components/camel-mqtt/src/main/java/org/apache/camel/component/mqtt/MQTTEndpoint.java
index 89caedd..3040831 100644
--- a/components/camel-mqtt/src/main/java/org/apache/camel/component/mqtt/MQTTEndpoint.java
+++ b/components/camel-mqtt/src/main/java/org/apache/camel/component/mqtt/MQTTEndpoint.java
@@ -58,9 +58,9 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * MQTT endpoint
+ * Component for communicating with MQTT M2M message brokers
*/
-@UriEndpoint(scheme = "mqtt", title = "MQTT", syntax = "mqtt:name", consumerClass = MQTTConsumer.class, label = "messaging")
+@UriEndpoint(scheme = "mqtt", title = "MQTT", syntax = "mqtt:name", consumerClass = MQTTConsumer.class, label = "messaging,iot")
public class MQTTEndpoint extends DefaultEndpoint {
private static final Logger LOG = LoggerFactory.getLogger(MQTTEndpoint.class);
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-msv/src/main/java/org/apache/camel/component/validator/msv/MsvEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-msv/src/main/java/org/apache/camel/component/validator/msv/MsvEndpoint.java b/components/camel-msv/src/main/java/org/apache/camel/component/validator/msv/MsvEndpoint.java
index 78d75c6..e4b856f 100644
--- a/components/camel-msv/src/main/java/org/apache/camel/component/validator/msv/MsvEndpoint.java
+++ b/components/camel-msv/src/main/java/org/apache/camel/component/validator/msv/MsvEndpoint.java
@@ -24,6 +24,9 @@ import org.apache.camel.processor.validation.ValidatingProcessor;
import org.apache.camel.spi.UriEndpoint;
import org.iso_relax.verifier.jaxp.validation.RELAXNGSchemaFactoryImpl;
+/**
+ * Validates the payload of a message using the MSV Library.
+ */
@UriEndpoint(scheme = "msv", title = "MSV", syntax = "msv:resourceUri", producerOnly = true, label = "validation")
public class MsvEndpoint extends ValidatorEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-mustache/src/main/java/org/apache/camel/component/mustache/MustacheEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-mustache/src/main/java/org/apache/camel/component/mustache/MustacheEndpoint.java b/components/camel-mustache/src/main/java/org/apache/camel/component/mustache/MustacheEndpoint.java
index f48448d..67a798d 100644
--- a/components/camel-mustache/src/main/java/org/apache/camel/component/mustache/MustacheEndpoint.java
+++ b/components/camel-mustache/src/main/java/org/apache/camel/component/mustache/MustacheEndpoint.java
@@ -40,7 +40,7 @@ import static org.apache.camel.component.mustache.MustacheConstants.MUSTACHE_RES
import static org.apache.camel.component.mustache.MustacheConstants.MUSTACHE_TEMPLATE;
/**
- * Represents a Camel Mustache endpoint.
+ * Generates a response using a Mustache template.
*/
@UriEndpoint(scheme = "mustache", title = "Mustache", syntax = "mustache:resourceUri", producerOnly = true, label = "transformation")
public class MustacheEndpoint extends ResourceEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-mvel/src/main/java/org/apache/camel/component/mvel/MvelEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-mvel/src/main/java/org/apache/camel/component/mvel/MvelEndpoint.java b/components/camel-mvel/src/main/java/org/apache/camel/component/mvel/MvelEndpoint.java
index d581862..634f207 100644
--- a/components/camel-mvel/src/main/java/org/apache/camel/component/mvel/MvelEndpoint.java
+++ b/components/camel-mvel/src/main/java/org/apache/camel/component/mvel/MvelEndpoint.java
@@ -34,6 +34,9 @@ import org.mvel2.templates.CompiledTemplate;
import org.mvel2.templates.TemplateCompiler;
import org.mvel2.templates.TemplateRuntime;
+/**
+ * Generates a response using an MVEL template.
+ */
@UriEndpoint(scheme = "mvel", title = "MVEL", syntax = "mvel:resourceUri", producerOnly = true, label = "transformation,script")
public class MvelEndpoint extends ResourceEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-mybatis/src/main/java/org/apache/camel/component/mybatis/MyBatisEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-mybatis/src/main/java/org/apache/camel/component/mybatis/MyBatisEndpoint.java b/components/camel-mybatis/src/main/java/org/apache/camel/component/mybatis/MyBatisEndpoint.java
index ce460c1..e4e1ced 100644
--- a/components/camel-mybatis/src/main/java/org/apache/camel/component/mybatis/MyBatisEndpoint.java
+++ b/components/camel-mybatis/src/main/java/org/apache/camel/component/mybatis/MyBatisEndpoint.java
@@ -32,7 +32,7 @@ import org.apache.ibatis.session.ExecutorType;
import org.apache.ibatis.session.SqlSessionFactory;
/**
- * @version
+ * Performs a query, poll, insert, update or delete in a relational database using MyBatis
*/
@UriEndpoint(scheme = "mybatis", title = "MyBatis", syntax = "mybatis:statement", consumerClass = MyBatisConsumer.class, label = "database,sql")
public class MyBatisEndpoint extends DefaultPollingEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-nagios/src/main/java/org/apache/camel/component/nagios/NagiosEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-nagios/src/main/java/org/apache/camel/component/nagios/NagiosEndpoint.java b/components/camel-nagios/src/main/java/org/apache/camel/component/nagios/NagiosEndpoint.java
index 20184ee..107d97b 100644
--- a/components/camel-nagios/src/main/java/org/apache/camel/component/nagios/NagiosEndpoint.java
+++ b/components/camel-nagios/src/main/java/org/apache/camel/component/nagios/NagiosEndpoint.java
@@ -29,7 +29,7 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.util.ObjectHelper;
/**
- * @version
+ * To send passive checks to Nagios using JSendNSCA
*/
@UriEndpoint(scheme = "nagios", title = "Nagios", syntax = "nagios:host:port", producerOnly = true, label = "monitoring")
public class NagiosEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-netty-http/pom.xml
----------------------------------------------------------------------
diff --git a/components/camel-netty-http/pom.xml b/components/camel-netty-http/pom.xml
index 070afe1..37c53fa 100644
--- a/components/camel-netty-http/pom.xml
+++ b/components/camel-netty-http/pom.xml
@@ -25,7 +25,7 @@
<artifactId>camel-netty-http</artifactId>
<packaging>bundle</packaging>
- <name>Camel :: Netty HTTP</name>
+ <name>Camel :: Netty HTTP (deprecated)</name>
<description>Camel Netty HTTP support</description>
<properties>
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-netty-http/src/main/java/org/apache/camel/component/netty/http/NettyHttpEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-netty-http/src/main/java/org/apache/camel/component/netty/http/NettyHttpEndpoint.java b/components/camel-netty-http/src/main/java/org/apache/camel/component/netty/http/NettyHttpEndpoint.java
index 7c35ae2..062eddd 100644
--- a/components/camel-netty-http/src/main/java/org/apache/camel/component/netty/http/NettyHttpEndpoint.java
+++ b/components/camel-netty-http/src/main/java/org/apache/camel/component/netty/http/NettyHttpEndpoint.java
@@ -37,7 +37,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * HTTP based {@link NettyEndpoint}
+ * Netty HTTP server and client using the Netty 3.x library.
*/
@UriEndpoint(scheme = "netty-http", extendsScheme = "netty", title = "Netty HTTP",
syntax = "netty-http:protocol:host:port/path", consumerClass = NettyHttpConsumer.class, label = "http")
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-netty/pom.xml
----------------------------------------------------------------------
diff --git a/components/camel-netty/pom.xml b/components/camel-netty/pom.xml
index 408f43b..37f56fb 100644
--- a/components/camel-netty/pom.xml
+++ b/components/camel-netty/pom.xml
@@ -25,7 +25,7 @@
<artifactId>camel-netty</artifactId>
<packaging>bundle</packaging>
- <name>Camel :: Netty</name>
+ <name>Camel :: Netty (deprecated)</name>
<description>Camel Netty NIO based socket communication component</description>
<properties>
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-netty/src/main/java/org/apache/camel/component/netty/NettyEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-netty/src/main/java/org/apache/camel/component/netty/NettyEndpoint.java b/components/camel-netty/src/main/java/org/apache/camel/component/netty/NettyEndpoint.java
index e8fcbcc..bebde56 100644
--- a/components/camel-netty/src/main/java/org/apache/camel/component/netty/NettyEndpoint.java
+++ b/components/camel-netty/src/main/java/org/apache/camel/component/netty/NettyEndpoint.java
@@ -37,6 +37,9 @@ import org.jboss.netty.channel.MessageEvent;
import org.jboss.netty.handler.ssl.SslHandler;
import org.jboss.netty.util.Timer;
+/**
+ * Socket level networking using TCP or UDP with the Netty 3.x library.
+ */
@UriEndpoint(scheme = "netty", title = "Netty", syntax = "netty:protocol:host:port", consumerClass = NettyConsumer.class, label = "networking,tcp,udp")
public class NettyEndpoint extends DefaultEndpoint {
@UriParam
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-netty4-http/src/main/java/org/apache/camel/component/netty4/http/NettyHttpEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-netty4-http/src/main/java/org/apache/camel/component/netty4/http/NettyHttpEndpoint.java b/components/camel-netty4-http/src/main/java/org/apache/camel/component/netty4/http/NettyHttpEndpoint.java
index a7da693..6f7a8da 100644
--- a/components/camel-netty4-http/src/main/java/org/apache/camel/component/netty4/http/NettyHttpEndpoint.java
+++ b/components/camel-netty4-http/src/main/java/org/apache/camel/component/netty4/http/NettyHttpEndpoint.java
@@ -36,7 +36,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * HTTP based {@link NettyEndpoint}
+ * Netty HTTP server and client using the Netty 4.x library.
*/
@UriEndpoint(scheme = "netty4-http", extendsScheme = "netty4", title = "Netty4 HTTP",
syntax = "netty4-http:protocol:host:port/path", consumerClass = NettyHttpConsumer.class, label = "http")
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-netty4/src/main/java/org/apache/camel/component/netty4/NettyEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-netty4/src/main/java/org/apache/camel/component/netty4/NettyEndpoint.java b/components/camel-netty4/src/main/java/org/apache/camel/component/netty4/NettyEndpoint.java
index 1b57b11..2f2224f 100644
--- a/components/camel-netty4/src/main/java/org/apache/camel/component/netty4/NettyEndpoint.java
+++ b/components/camel-netty4/src/main/java/org/apache/camel/component/netty4/NettyEndpoint.java
@@ -37,6 +37,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.util.ObjectHelper;
+/**
+ * Socket level networking using TCP or UDP with the Netty 4.x library.
+ */
@UriEndpoint(scheme = "netty4", title = "Netty4", syntax = "netty4:protocol:host:port", consumerClass = NettyConsumer.class, label = "networking,tcp,udp")
public class NettyEndpoint extends DefaultEndpoint {
@UriParam
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Endpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Endpoint.java b/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Endpoint.java
index 130d6b1..8156e50 100644
--- a/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Endpoint.java
+++ b/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Endpoint.java
@@ -36,7 +36,7 @@ import org.apache.camel.util.component.ApiMethod;
import org.apache.camel.util.component.ApiMethodPropertiesHelper;
/**
- * Represents a Olingo2 endpoint.
+ * Communicates with OData 2.0 and 3.0 services using Apache Olingo.
*/
@UriEndpoint(scheme = "olingo2", title = "Olingo2", syntax = "olingo2:apiName/methodName", consumerClass = Olingo2Consumer.class, label = "cloud")
public class Olingo2Endpoint extends AbstractApiEndpoint<Olingo2ApiName, Olingo2Configuration> {
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-openshift/src/main/java/org/apache/camel/component/openshift/OpenShiftEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-openshift/src/main/java/org/apache/camel/component/openshift/OpenShiftEndpoint.java b/components/camel-openshift/src/main/java/org/apache/camel/component/openshift/OpenShiftEndpoint.java
index 03166bf..dc34008 100644
--- a/components/camel-openshift/src/main/java/org/apache/camel/component/openshift/OpenShiftEndpoint.java
+++ b/components/camel-openshift/src/main/java/org/apache/camel/component/openshift/OpenShiftEndpoint.java
@@ -29,6 +29,9 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ObjectHelper;
+/**
+ * To manage your Openshift 2.x applications.
+ */
@UriEndpoint(scheme = "openshift", title = "OpenShift", syntax = "openshift:clientId", consumerClass = OpenShiftConsumer.class, label = "cloud,paas")
public class OpenShiftEndpoint extends ScheduledPollEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0577b699/components/camel-optaplanner/src/main/java/org/apache/camel/component/optaplanner/OptaPlannerEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-optaplanner/src/main/java/org/apache/camel/component/optaplanner/OptaPlannerEndpoint.java b/components/camel-optaplanner/src/main/java/org/apache/camel/component/optaplanner/OptaPlannerEndpoint.java
index 6eee2b8..292afb8 100644
--- a/components/camel-optaplanner/src/main/java/org/apache/camel/component/optaplanner/OptaPlannerEndpoint.java
+++ b/components/camel-optaplanner/src/main/java/org/apache/camel/component/optaplanner/OptaPlannerEndpoint.java
@@ -30,7 +30,7 @@ import org.optaplanner.core.api.solver.Solver;
import org.optaplanner.core.api.solver.SolverFactory;
/**
- * OptaPlanner endpoint for Camel
+ * Solves the planning problem contained in a message with OptaPlanner.
*/
@UriEndpoint(scheme = "optaplanner", title = "OptaPlanner", syntax = "optaplanner:resourceUri", label = "engine,planning")
public class OptaPlannerEndpoint extends DefaultEndpoint {
[19/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.
Posted by da...@apache.org.
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/bd6f3f4a
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/bd6f3f4a
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/bd6f3f4a
Branch: refs/heads/master
Commit: bd6f3f4a2b6419304ec7df8cccc45262028a4476
Parents: 0d49f6b
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 18:23:10 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:29 2015 +0100
----------------------------------------------------------------------
.../org/apache/camel/component/atmos/AtmosEndpoint.java | 3 +++
.../camel/component/sjms/batch/SjmsBatchEndpoint.java | 3 +++
.../org/apache/camel/commands/CatalogCommandTest.java | 1 -
.../camel/tools/apt/EndpointAnnotationProcessor.java | 12 ++++++------
4 files changed, 12 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/bd6f3f4a/components/camel-atmos/src/main/java/org/apache/camel/component/atmos/AtmosEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-atmos/src/main/java/org/apache/camel/component/atmos/AtmosEndpoint.java b/components/camel-atmos/src/main/java/org/apache/camel/component/atmos/AtmosEndpoint.java
index bc0c35c..03c919e 100644
--- a/components/camel-atmos/src/main/java/org/apache/camel/component/atmos/AtmosEndpoint.java
+++ b/components/camel-atmos/src/main/java/org/apache/camel/component/atmos/AtmosEndpoint.java
@@ -35,6 +35,9 @@ import org.slf4j.LoggerFactory;
import static org.apache.camel.component.atmos.util.AtmosConstants.POLL_CONSUMER_DELAY;
+/**
+ * The atmos component is used for integrating with EMC's Atomos Storage.
+ */
@UriEndpoint(scheme = "atmos", title = "Atmos", syntax = "atmos:name/operation", consumerClass = AtmosScheduledPollConsumer.class, label = "file,cloud")
public class AtmosEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bd6f3f4a/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/batch/SjmsBatchEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/batch/SjmsBatchEndpoint.java b/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/batch/SjmsBatchEndpoint.java
index 49c74ba..705e9c9 100644
--- a/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/batch/SjmsBatchEndpoint.java
+++ b/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/batch/SjmsBatchEndpoint.java
@@ -40,6 +40,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
+/**
+ * The sjms-batch component is a specialized for highly performant, transactional batch consumption from a JMS queue.
+ */
@UriEndpoint(scheme = "sjms-batch", title = "Simple JMS Batch Component", syntax = "sjms-batch:destinationName",
consumerClass = SjmsBatchComponent.class, label = "messaging", consumerOnly = true)
public class SjmsBatchEndpoint extends DefaultEndpoint implements HeaderFilterStrategyAware {
http://git-wip-us.apache.org/repos/asf/camel/blob/bd6f3f4a/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
index af5cc97..be4b941 100644
--- 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
@@ -50,7 +50,6 @@ public class CatalogCommandTest {
String out = os.toString();
assertNotNull(out);
LOG.info("\n\n{}\n", out);
- System.out.println(out);
context.stop();
}
http://git-wip-us.apache.org/repos/asf/camel/blob/bd6f3f4a/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 b9f4ca6..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
@@ -433,12 +433,12 @@ public class EndpointAnnotationProcessor extends AbstractAnnotationProcessor {
Map<String, String> map = parseAsMap(data);
// now we have a lot more data, so we need to load it as key/value
// need to sanitize the description first
-// String doc = map.get("projectDescription");
-// if (doc != null) {
-// model.setDescription(sanitizeDescription(doc, true));
-// } else {
- model.setDescription("TODO");
-// }
+ String doc = map.get("projectDescription");
+ if (doc != null) {
+ model.setDescription(sanitizeDescription(doc, true));
+ } else {
+ model.setDescription("");
+ }
if (map.containsKey("groupId")) {
model.setGroupId(map.get("groupId"));
} else {
[18/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.
Posted by da...@apache.org.
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/5b9595a8
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/5b9595a8
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/5b9595a8
Branch: refs/heads/master
Commit: 5b9595a8ef89f0c689cb4d9931ccf5479f147023
Parents: 1aca713
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 16:49:56 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:29 2015 +0100
----------------------------------------------------------------------
.../component/spring/batch/SpringBatchEndpoint.java | 3 +++
.../spring/integration/SpringIntegrationEndpoint.java | 4 +---
.../camel/component/springldap/SpringLdapEndpoint.java | 3 +++
.../apache/camel/component/redis/RedisEndpoint.java | 2 +-
.../component/spring/ws/SpringWebserviceEndpoint.java | 13 ++++++++-----
.../apache/camel/component/event/EventEndpoint.java | 5 +----
.../org/apache/camel/component/sql/SqlEndpoint.java | 4 +---
.../org/apache/camel/component/ssh/SshEndpoint.java | 2 +-
.../org/apache/camel/component/stax/StAXEndpoint.java | 3 +++
.../apache/camel/component/stomp/StompEndpoint.java | 3 +++
.../apache/camel/component/stream/StreamEndpoint.java | 3 +++
.../stringtemplate/StringTemplateEndpoint.java | 2 +-
12 files changed, 29 insertions(+), 18 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/5b9595a8/components/camel-spring-batch/src/main/java/org/apache/camel/component/spring/batch/SpringBatchEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-spring-batch/src/main/java/org/apache/camel/component/spring/batch/SpringBatchEndpoint.java b/components/camel-spring-batch/src/main/java/org/apache/camel/component/spring/batch/SpringBatchEndpoint.java
index 0592d20..569e089 100644
--- a/components/camel-spring-batch/src/main/java/org/apache/camel/component/spring/batch/SpringBatchEndpoint.java
+++ b/components/camel-spring-batch/src/main/java/org/apache/camel/component/spring/batch/SpringBatchEndpoint.java
@@ -31,6 +31,9 @@ import org.apache.camel.util.CamelContextHelper;
import org.springframework.batch.core.Job;
import org.springframework.batch.core.launch.JobLauncher;
+/**
+ * The spring-batch component allows to send messages to Spring Batch for further processing.
+ */
@UriEndpoint(scheme = "spring-batch", title = "Spring Batch", syntax = "spring-batch:jobName", producerOnly = true, label = "spring,batch,scheduling")
public class SpringBatchEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/5b9595a8/components/camel-spring-integration/src/main/java/org/apache/camel/component/spring/integration/SpringIntegrationEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-spring-integration/src/main/java/org/apache/camel/component/spring/integration/SpringIntegrationEndpoint.java b/components/camel-spring-integration/src/main/java/org/apache/camel/component/spring/integration/SpringIntegrationEndpoint.java
index e612a1f..72a2154 100644
--- a/components/camel-spring-integration/src/main/java/org/apache/camel/component/spring/integration/SpringIntegrationEndpoint.java
+++ b/components/camel-spring-integration/src/main/java/org/apache/camel/component/spring/integration/SpringIntegrationEndpoint.java
@@ -29,9 +29,7 @@ import org.apache.camel.spring.SpringCamelContext;
import org.springframework.messaging.MessageChannel;
/**
- * Defines the <a href="http://camel.apache.org/springIntergration.html">Spring Integration Endpoint</a>
- *
- * @version
+ * Bridges Camel with Spring Integration.
*/
@UriEndpoint(scheme = "spring-integration", title = "Spring Integration", syntax = "spring-integration:defaultChannel",
consumerClass = SpringIntegrationConsumer.class, label = "spring,eventbus")
http://git-wip-us.apache.org/repos/asf/camel/blob/5b9595a8/components/camel-spring-ldap/src/main/java/org/apache/camel/component/springldap/SpringLdapEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-spring-ldap/src/main/java/org/apache/camel/component/springldap/SpringLdapEndpoint.java b/components/camel-spring-ldap/src/main/java/org/apache/camel/component/springldap/SpringLdapEndpoint.java
index 3e54c27..d986553 100644
--- a/components/camel-spring-ldap/src/main/java/org/apache/camel/component/springldap/SpringLdapEndpoint.java
+++ b/components/camel-spring-ldap/src/main/java/org/apache/camel/component/springldap/SpringLdapEndpoint.java
@@ -28,6 +28,9 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
import org.springframework.ldap.core.LdapTemplate;
+/**
+ * The spring-ldap component allows you to perform searches in LDAP servers using filters as the message payload.
+ */
@UriEndpoint(scheme = "spring-ldap", title = "Spring LDAP", syntax = "spring-ldap:templateName", producerOnly = true, label = "spring,ldap")
public class SpringLdapEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/5b9595a8/components/camel-spring-redis/src/main/java/org/apache/camel/component/redis/RedisEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-spring-redis/src/main/java/org/apache/camel/component/redis/RedisEndpoint.java b/components/camel-spring-redis/src/main/java/org/apache/camel/component/redis/RedisEndpoint.java
index 2952dd6..d3a8294 100755
--- a/components/camel-spring-redis/src/main/java/org/apache/camel/component/redis/RedisEndpoint.java
+++ b/components/camel-spring-redis/src/main/java/org/apache/camel/component/redis/RedisEndpoint.java
@@ -24,7 +24,7 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
/**
- * Represents a Redis endpoint.
+ * The spring-redis component allows sending and receiving messages from Redis.
*/
@UriEndpoint(scheme = "spring-redis", title = "Spring Redis", syntax = "spring-redist:host:port", consumerClass = RedisConsumer.class, label = "spring,nosql")
public class RedisEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/5b9595a8/components/camel-spring-ws/src/main/java/org/apache/camel/component/spring/ws/SpringWebserviceEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-spring-ws/src/main/java/org/apache/camel/component/spring/ws/SpringWebserviceEndpoint.java b/components/camel-spring-ws/src/main/java/org/apache/camel/component/spring/ws/SpringWebserviceEndpoint.java
index 573ed4e..10c2262 100644
--- a/components/camel-spring-ws/src/main/java/org/apache/camel/component/spring/ws/SpringWebserviceEndpoint.java
+++ b/components/camel-spring-ws/src/main/java/org/apache/camel/component/spring/ws/SpringWebserviceEndpoint.java
@@ -5,9 +5,9 @@
* 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
- *
+ * <p/>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p/>
* 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.
@@ -24,9 +24,12 @@ import org.apache.camel.impl.DefaultEndpoint;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
+/**
+ * The spring-ws component is used for SOAP WebServices using Spring WebServices.
+ */
@UriEndpoint(scheme = "spring-ws", title = "Spring WebService",
-syntax = "spring-ws:type:lookupKey:webServiceEndpointUri",
-consumerClass = SpringWebserviceConsumer.class, label = "soap,webservice")
+ syntax = "spring-ws:type:lookupKey:webServiceEndpointUri",
+ consumerClass = SpringWebserviceConsumer.class, label = "soap,webservice")
public class SpringWebserviceEndpoint extends DefaultEndpoint {
@UriParam
http://git-wip-us.apache.org/repos/asf/camel/blob/5b9595a8/components/camel-spring/src/main/java/org/apache/camel/component/event/EventEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-spring/src/main/java/org/apache/camel/component/event/EventEndpoint.java b/components/camel-spring/src/main/java/org/apache/camel/component/event/EventEndpoint.java
index 70c2992..04da3e5 100644
--- a/components/camel-spring/src/main/java/org/apache/camel/component/event/EventEndpoint.java
+++ b/components/camel-spring/src/main/java/org/apache/camel/component/event/EventEndpoint.java
@@ -34,10 +34,7 @@ import org.springframework.context.ApplicationEvent;
import static org.apache.camel.util.ObjectHelper.wrapRuntimeCamelException;
/**
- * An <a href="http://camel.apache.org/event.html">Event Endpoint</a>
- * for working with Spring ApplicationEvents
- *
- * @version
+ * The spring-event component allows to listen for Spring Application Events.
*/
@UriEndpoint(scheme = "spring-event", title = "Spring Event", syntax = "spring-event:name", consumerClass = EventConsumer.class, label = "spring,eventbus")
public class EventEndpoint extends DefaultEndpoint implements ApplicationContextAware {
http://git-wip-us.apache.org/repos/asf/camel/blob/5b9595a8/components/camel-sql/src/main/java/org/apache/camel/component/sql/SqlEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-sql/src/main/java/org/apache/camel/component/sql/SqlEndpoint.java b/components/camel-sql/src/main/java/org/apache/camel/component/sql/SqlEndpoint.java
index fdf049c..b16147d 100644
--- a/components/camel-sql/src/main/java/org/apache/camel/component/sql/SqlEndpoint.java
+++ b/components/camel-sql/src/main/java/org/apache/camel/component/sql/SqlEndpoint.java
@@ -27,9 +27,7 @@ import org.apache.camel.util.UnsafeUriCharactersEncoder;
import org.springframework.jdbc.core.JdbcTemplate;
/**
- * SQL Endpoint. Endpoint URI should contain valid SQL statement, but instead of
- * question marks (that are parameter placeholders), sharp signs should be used.
- * This is because in camel question mark has other meaning.
+ * The sql component can be used to perform SQL query to a database.
*/
@UriEndpoint(scheme = "sql", title = "SQL", syntax = "sql:query", consumerClass = SqlConsumer.class, label = "database,sql")
public class SqlEndpoint extends DefaultSqlEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/5b9595a8/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshEndpoint.java b/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshEndpoint.java
index af709f4..27c1f47 100644
--- a/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshEndpoint.java
+++ b/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshEndpoint.java
@@ -38,7 +38,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Represents an SSH endpoint.
+ * The ssh component enables access to SSH servers such that you can send an SSH command, and process the response.
*/
@UriEndpoint(scheme = "ssh", title = "SSH", syntax = "ssh:host:port", consumerClass = SshConsumer.class, label = "file")
public class SshEndpoint extends ScheduledPollEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/5b9595a8/components/camel-stax/src/main/java/org/apache/camel/component/stax/StAXEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-stax/src/main/java/org/apache/camel/component/stax/StAXEndpoint.java b/components/camel-stax/src/main/java/org/apache/camel/component/stax/StAXEndpoint.java
index 612afea..899c27b 100644
--- a/components/camel-stax/src/main/java/org/apache/camel/component/stax/StAXEndpoint.java
+++ b/components/camel-stax/src/main/java/org/apache/camel/component/stax/StAXEndpoint.java
@@ -26,6 +26,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriPath;
import org.apache.camel.util.EndpointHelper;
+/**
+ * The stax component allows messages to be process through a SAX ContentHandler.
+ */
@UriEndpoint(scheme = "stax", title = "StAX", syntax = "stax:contentHandlerClass", producerOnly = true, label = "transformation")
public class StAXEndpoint extends ProcessorEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/5b9595a8/components/camel-stomp/src/main/java/org/apache/camel/component/stomp/StompEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-stomp/src/main/java/org/apache/camel/component/stomp/StompEndpoint.java b/components/camel-stomp/src/main/java/org/apache/camel/component/stomp/StompEndpoint.java
index 344169f..c0b4d58 100644
--- a/components/camel-stomp/src/main/java/org/apache/camel/component/stomp/StompEndpoint.java
+++ b/components/camel-stomp/src/main/java/org/apache/camel/component/stomp/StompEndpoint.java
@@ -45,6 +45,9 @@ import static org.fusesource.stomp.client.Constants.SEND;
import static org.fusesource.stomp.client.Constants.SUBSCRIBE;
import static org.fusesource.stomp.client.Constants.UNSUBSCRIBE;
+/**
+ * The stomp component is used for communicating with Stomp compliant message brokers.
+ */
@UriEndpoint(scheme = "stomp", title = "Stomp", syntax = "stomp:destination", consumerClass = StompConsumer.class, label = "messaging")
public class StompEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/5b9595a8/components/camel-stream/src/main/java/org/apache/camel/component/stream/StreamEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-stream/src/main/java/org/apache/camel/component/stream/StreamEndpoint.java b/components/camel-stream/src/main/java/org/apache/camel/component/stream/StreamEndpoint.java
index e1a19ff..78933a0 100644
--- a/components/camel-stream/src/main/java/org/apache/camel/component/stream/StreamEndpoint.java
+++ b/components/camel-stream/src/main/java/org/apache/camel/component/stream/StreamEndpoint.java
@@ -31,6 +31,9 @@ import org.apache.camel.spi.UriPath;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * The stream: component provides access to the system-in, system-out and system-err streams as well as allowing streaming of file and URL.
+ */
@UriEndpoint(scheme = "stream", title = "Stream", syntax = "stream:url", consumerClass = StreamConsumer.class, label = "file,system")
public class StreamEndpoint extends DefaultEndpoint {
private static final Logger LOG = LoggerFactory.getLogger(StreamEndpoint.class);
http://git-wip-us.apache.org/repos/asf/camel/blob/5b9595a8/components/camel-stringtemplate/src/main/java/org/apache/camel/component/stringtemplate/StringTemplateEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-stringtemplate/src/main/java/org/apache/camel/component/stringtemplate/StringTemplateEndpoint.java b/components/camel-stringtemplate/src/main/java/org/apache/camel/component/stringtemplate/StringTemplateEndpoint.java
index ca2978a..39ab4df 100644
--- a/components/camel-stringtemplate/src/main/java/org/apache/camel/component/stringtemplate/StringTemplateEndpoint.java
+++ b/components/camel-stringtemplate/src/main/java/org/apache/camel/component/stringtemplate/StringTemplateEndpoint.java
@@ -32,7 +32,7 @@ import org.stringtemplate.v4.ST;
import org.stringtemplate.v4.STGroup;
/**
- * @version
+ * Generates a response using a String Template
*/
@UriEndpoint(scheme = "stringtemplate", title = "String Template", syntax = "stringtemplate:resourceUri", producerOnly = true, label = "transformation")
public class StringTemplateEndpoint extends ResourceEndpoint {
[14/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.
Posted by da...@apache.org.
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/ed1223a0
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/ed1223a0
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/ed1223a0
Branch: refs/heads/master
Commit: ed1223a0e3a75fefa8b5c8a3f5f6f999acc4e64c
Parents: 0577b69
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 15:14:48 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:28 2015 +0100
----------------------------------------------------------------------
.../camel/component/mqtt/MQTTEndpoint.java | 2 +-
.../camel/component/paho/PahoEndpoint.java | 7 ++++---
.../paxlogging/PaxLoggingEndpoint.java | 2 +-
.../apache/camel/component/pdf/PdfEndpoint.java | 3 +++
.../component/pgevent/PgEventEndpoint.java | 21 ++++++++++----------
5 files changed, 20 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/ed1223a0/components/camel-mqtt/src/main/java/org/apache/camel/component/mqtt/MQTTEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-mqtt/src/main/java/org/apache/camel/component/mqtt/MQTTEndpoint.java b/components/camel-mqtt/src/main/java/org/apache/camel/component/mqtt/MQTTEndpoint.java
index 3040831..d079778 100644
--- a/components/camel-mqtt/src/main/java/org/apache/camel/component/mqtt/MQTTEndpoint.java
+++ b/components/camel-mqtt/src/main/java/org/apache/camel/component/mqtt/MQTTEndpoint.java
@@ -58,7 +58,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Component for communicating with MQTT M2M message brokers
+ * Component for communicating with MQTT M2M message brokers using FuseSource MQTT Client.
*/
@UriEndpoint(scheme = "mqtt", title = "MQTT", syntax = "mqtt:name", consumerClass = MQTTConsumer.class, label = "messaging,iot")
public class MQTTEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/ed1223a0/components/camel-paho/src/main/java/org/apache/camel/component/paho/PahoEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-paho/src/main/java/org/apache/camel/component/paho/PahoEndpoint.java b/components/camel-paho/src/main/java/org/apache/camel/component/paho/PahoEndpoint.java
index 09665e1..250943c 100644
--- a/components/camel-paho/src/main/java/org/apache/camel/component/paho/PahoEndpoint.java
+++ b/components/camel-paho/src/main/java/org/apache/camel/component/paho/PahoEndpoint.java
@@ -37,9 +37,10 @@ import org.eclipse.paho.client.mqttv3.persist.MqttDefaultFilePersistence;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-
-
-@UriEndpoint(scheme = "paho", title = "Paho", consumerClass = PahoConsumer.class, label = "messaging", syntax = "paho:topic")
+/**
+ * Component for communicating with MQTT M2M message brokers using Eclipse Paho MQTT Client.
+ */
+@UriEndpoint(scheme = "paho", title = "Paho", consumerClass = PahoConsumer.class, label = "messaging,iot", syntax = "paho:topic")
public class PahoEndpoint extends DefaultEndpoint {
private static final Logger LOG = LoggerFactory.getLogger(PahoEndpoint.class);
http://git-wip-us.apache.org/repos/asf/camel/blob/ed1223a0/components/camel-paxlogging/src/main/java/org/apache/camel/component/paxlogging/PaxLoggingEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-paxlogging/src/main/java/org/apache/camel/component/paxlogging/PaxLoggingEndpoint.java b/components/camel-paxlogging/src/main/java/org/apache/camel/component/paxlogging/PaxLoggingEndpoint.java
index 2884c55..202f354 100644
--- a/components/camel-paxlogging/src/main/java/org/apache/camel/component/paxlogging/PaxLoggingEndpoint.java
+++ b/components/camel-paxlogging/src/main/java/org/apache/camel/component/paxlogging/PaxLoggingEndpoint.java
@@ -26,7 +26,7 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriPath;
/**
- * Paxlogging endpoint.
+ * The paxlogging component can be used in an OSGi environment to receive PaxLogging events and process them.
*/
@UriEndpoint(scheme = "paxlogging", title = "OSGi PAX Logging", syntax = "paxlogging:appender", consumerOnly = true, consumerClass = PaxLoggingConsumer.class, label = "monitoring")
public class PaxLoggingEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/ed1223a0/components/camel-pdf/src/main/java/org/apache/camel/component/pdf/PdfEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-pdf/src/main/java/org/apache/camel/component/pdf/PdfEndpoint.java b/components/camel-pdf/src/main/java/org/apache/camel/component/pdf/PdfEndpoint.java
index fb3f2fa..2004ccd 100644
--- a/components/camel-pdf/src/main/java/org/apache/camel/component/pdf/PdfEndpoint.java
+++ b/components/camel-pdf/src/main/java/org/apache/camel/component/pdf/PdfEndpoint.java
@@ -24,6 +24,9 @@ import org.apache.camel.impl.DefaultEndpoint;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
+/**
+ * The pdf components provides the ability to create, modify or extract content from PDF documents.
+ */
@UriEndpoint(scheme = "pdf", title = "PDF", syntax = "pdf:operation", producerOnly = true, label = "pdf,printing")
public class PdfEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/ed1223a0/components/camel-pgevent/src/main/java/org/apache/camel/component/pgevent/PgEventEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-pgevent/src/main/java/org/apache/camel/component/pgevent/PgEventEndpoint.java b/components/camel-pgevent/src/main/java/org/apache/camel/component/pgevent/PgEventEndpoint.java
index ca3ff39..8e2e285 100644
--- a/components/camel-pgevent/src/main/java/org/apache/camel/component/pgevent/PgEventEndpoint.java
+++ b/components/camel-pgevent/src/main/java/org/apache/camel/component/pgevent/PgEventEndpoint.java
@@ -19,7 +19,6 @@ package org.apache.camel.component.pgevent;
import java.io.InvalidClassException;
import java.sql.DriverManager;
import java.util.Properties;
-import javax.naming.directory.InvalidAttributesException;
import javax.sql.DataSource;
import com.impossibl.postgres.api.jdbc.PGConnection;
@@ -37,7 +36,9 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Represents a PgEvent endpoint.
+ * The pgevent component allows for producing/consuming PostgreSQL events related to the LISTEN/NOTIFY commands.
+ *
+ * This requires using PostgreSQL 8.3 or newer.
*/
@UriEndpoint(scheme = "pgevent", title = "PostgresSQL Event", syntax = "pgevent:host:port/database/channel", consumerClass = PgEventConsumer.class, label = "database,sql")
public class PgEventEndpoint extends DefaultEndpoint {
@@ -67,13 +68,13 @@ public class PgEventEndpoint extends DefaultEndpoint {
private PGConnection dbConnection;
- public PgEventEndpoint(String uri, PgEventComponent component) throws InvalidAttributesException {
+ public PgEventEndpoint(String uri, PgEventComponent component) {
super(uri, component);
this.uri = uri;
parseUri();
}
- public PgEventEndpoint(String uri, PgEventComponent component, DataSource dataSource) throws InvalidAttributesException {
+ public PgEventEndpoint(String uri, PgEventComponent component, DataSource dataSource) {
super(uri, component);
this.uri = uri;
this.datasource = dataSource;
@@ -97,9 +98,9 @@ public class PgEventEndpoint extends DefaultEndpoint {
/**
* Parse the provided URI and extract available parameters
*
- * @throws InvalidAttributesException if there is an error in the parameters
+ * @throws IllegalArgumentException if there is an error in the parameters
*/
- protected final void parseUri() throws InvalidAttributesException {
+ protected final void parseUri() throws IllegalArgumentException {
LOG.info("URI: " + uri);
if (uri.matches(FORMAT1)) {
LOG.info("FORMAT1");
@@ -128,7 +129,7 @@ public class PgEventEndpoint extends DefaultEndpoint {
database = parts[0];
channel = parts[1];
} else {
- throw new InvalidAttributesException("The provided URL does not match the acceptable patterns.");
+ throw new IllegalArgumentException("The provided URL does not match the acceptable patterns.");
}
}
@@ -138,9 +139,9 @@ public class PgEventEndpoint extends DefaultEndpoint {
return new PgEventProducer(this);
}
- private void validateInputs() throws InvalidClassException, InvalidAttributesException {
+ private void validateInputs() throws InvalidClassException, IllegalArgumentException {
if (getChannel() == null || getChannel().length() == 0) {
- throw new InvalidAttributesException("A required parameter was not set when creating this Endpoint (channel)");
+ throw new IllegalArgumentException("A required parameter was not set when creating this Endpoint (channel)");
}
if (datasource != null) {
LOG.debug("******Datasource detected*****");
@@ -151,7 +152,7 @@ public class PgEventEndpoint extends DefaultEndpoint {
}
} else {
if (user == null) {
- throw new InvalidAttributesException("A required parameter was "
+ throw new IllegalArgumentException("A required parameter was "
+ "not set when creating this Endpoint (pgUser or pgDataSource)");
}
}
[13/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.
Posted by da...@apache.org.
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/3076ca4f
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/3076ca4f
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/3076ca4f
Branch: refs/heads/master
Commit: 3076ca4f40b03ddf82f8b57f602b4e04ed1b9ef4
Parents: 62a7aad
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 14:57:40 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:27 2015 +0100
----------------------------------------------------------------------
.../main/java/org/apache/camel/component/kafka/KafkaEndpoint.java | 3 +++
.../java/org/apache/camel/component/kestrel/KestrelEndpoint.java | 2 +-
.../main/java/org/apache/camel/component/krati/KratiEndpoint.java | 2 +-
.../org/apache/camel/component/kubernetes/KubernetesEndpoint.java | 3 +++
.../main/java/org/apache/camel/component/ldap/LdapEndpoint.java | 2 +-
.../org/apache/camel/component/linkedin/LinkedInEndpoint.java | 2 +-
.../java/org/apache/camel/component/lucene/LuceneEndpoint.java | 3 +++
7 files changed, 13 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/3076ca4f/components/camel-kafka/src/main/java/org/apache/camel/component/kafka/KafkaEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-kafka/src/main/java/org/apache/camel/component/kafka/KafkaEndpoint.java b/components/camel-kafka/src/main/java/org/apache/camel/component/kafka/KafkaEndpoint.java
index 3073385..760ec19a 100644
--- a/components/camel-kafka/src/main/java/org/apache/camel/component/kafka/KafkaEndpoint.java
+++ b/components/camel-kafka/src/main/java/org/apache/camel/component/kafka/KafkaEndpoint.java
@@ -30,6 +30,9 @@ import org.apache.camel.impl.DefaultEndpoint;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
+/**
+ * The kafka component allows messages to be sent to (or consumed from) Apache Kafka brokers.
+ */
@UriEndpoint(scheme = "kafka", title = "Kafka", syntax = "kafka:brokers", consumerClass = KafkaConsumer.class, label = "messaging")
public class KafkaEndpoint extends DefaultEndpoint implements MultipleConsumersSupport {
http://git-wip-us.apache.org/repos/asf/camel/blob/3076ca4f/components/camel-kestrel/src/main/java/org/apache/camel/component/kestrel/KestrelEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-kestrel/src/main/java/org/apache/camel/component/kestrel/KestrelEndpoint.java b/components/camel-kestrel/src/main/java/org/apache/camel/component/kestrel/KestrelEndpoint.java
index ad245c1..bdef44c 100644
--- a/components/camel-kestrel/src/main/java/org/apache/camel/component/kestrel/KestrelEndpoint.java
+++ b/components/camel-kestrel/src/main/java/org/apache/camel/component/kestrel/KestrelEndpoint.java
@@ -27,7 +27,7 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
- * Camel endpoint for communication with a kestrel based queue.
+ * The kestrel component allows messages to be sent to (or consumed from) Kestrel brokers.
*/
@UriEndpoint(scheme = "kestrel", title = "Kestrel", syntax = "kestrel:addresses/queue", consumerClass = KestrelConsumer.class, label = "messaging")
public class KestrelEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/3076ca4f/components/camel-krati/src/main/java/org/apache/camel/component/krati/KratiEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-krati/src/main/java/org/apache/camel/component/krati/KratiEndpoint.java b/components/camel-krati/src/main/java/org/apache/camel/component/krati/KratiEndpoint.java
index 16a38be..c96cac3 100644
--- a/components/camel-krati/src/main/java/org/apache/camel/component/krati/KratiEndpoint.java
+++ b/components/camel-krati/src/main/java/org/apache/camel/component/krati/KratiEndpoint.java
@@ -38,7 +38,7 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
- * Represents a Krati endpoint.
+ * The krati allows the use krati datastores and datasets inside Camel.
*/
@UriEndpoint(scheme = "krati", title = "Krati", syntax = "krati:path", consumerClass = KratiConsumer.class, label = "database,nosql")
public class KratiEndpoint extends ScheduledPollEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/3076ca4f/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java b/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java
index 188640f..0f95f71 100644
--- a/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java
+++ b/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java
@@ -47,6 +47,9 @@ import org.apache.camel.util.ObjectHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * The kubernetes component allows to work with Kubernetes PaaS.
+ */
@UriEndpoint(scheme = "kubernetes", title = "Kubernetes", syntax = "kubernetes:master", label = "container,cloud,paas")
public class KubernetesEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/3076ca4f/components/camel-ldap/src/main/java/org/apache/camel/component/ldap/LdapEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-ldap/src/main/java/org/apache/camel/component/ldap/LdapEndpoint.java b/components/camel-ldap/src/main/java/org/apache/camel/component/ldap/LdapEndpoint.java
index f8ed247..d5d209d 100644
--- a/components/camel-ldap/src/main/java/org/apache/camel/component/ldap/LdapEndpoint.java
+++ b/components/camel-ldap/src/main/java/org/apache/camel/component/ldap/LdapEndpoint.java
@@ -30,7 +30,7 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
- * Represents an endpoint that synchronously invokes an LDAP server when a producer sends a message to it.
+ * The ldap component allows you to perform searches in LDAP servers using filters as the message payload.
*/
@UriEndpoint(scheme = "ldap", title = "LDAP", syntax = "ldap:dirContextName", producerOnly = true, label = "ldap")
public class LdapEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/3076ca4f/components/camel-linkedin/camel-linkedin-component/src/main/java/org/apache/camel/component/linkedin/LinkedInEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-linkedin/camel-linkedin-component/src/main/java/org/apache/camel/component/linkedin/LinkedInEndpoint.java b/components/camel-linkedin/camel-linkedin-component/src/main/java/org/apache/camel/component/linkedin/LinkedInEndpoint.java
index 4200a06..0873b11 100644
--- a/components/camel-linkedin/camel-linkedin-component/src/main/java/org/apache/camel/component/linkedin/LinkedInEndpoint.java
+++ b/components/camel-linkedin/camel-linkedin-component/src/main/java/org/apache/camel/component/linkedin/LinkedInEndpoint.java
@@ -44,7 +44,7 @@ import org.apache.cxf.jaxrs.client.JAXRSClientFactory;
import org.apache.cxf.jaxrs.client.WebClient;
/**
- * Represents a LinkedIn endpoint.
+ * The linkedin component is uses for retrieving LinkedIn user profiles, connections, companies, groups, posts, etc.
*/
@UriEndpoint(scheme = "linkedin", title = "Linkedin", syntax = "linkedin:apiName/methodName", label = "api,cloud,social", consumerClass = LinkedInConsumer.class)
public class LinkedInEndpoint extends AbstractApiEndpoint<LinkedInApiName, LinkedInConfiguration> {
http://git-wip-us.apache.org/repos/asf/camel/blob/3076ca4f/components/camel-lucene/src/main/java/org/apache/camel/component/lucene/LuceneEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-lucene/src/main/java/org/apache/camel/component/lucene/LuceneEndpoint.java b/components/camel-lucene/src/main/java/org/apache/camel/component/lucene/LuceneEndpoint.java
index 01fd455..2ae943b 100644
--- a/components/camel-lucene/src/main/java/org/apache/camel/component/lucene/LuceneEndpoint.java
+++ b/components/camel-lucene/src/main/java/org/apache/camel/component/lucene/LuceneEndpoint.java
@@ -25,6 +25,9 @@ import org.apache.camel.impl.DefaultEndpoint;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
+/**
+ * To insert or query from Apache Lucene databases.
+ */
@UriEndpoint(scheme = "lucene", title = "Lucene", syntax = "lucene:host:operation", producerOnly = true, label = "database,search")
public class LuceneEndpoint extends DefaultEndpoint {
@UriParam
[09/20] camel git commit: CAMEL-9454: camel-gora - Should preserve
headers
Posted by da...@apache.org.
CAMEL-9454: camel-gora - Should preserve headers
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/ea488090
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/ea488090
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/ea488090
Branch: refs/heads/master
Commit: ea488090ba0673809d35a73ed7fd5724fbcac30a
Parents: cfc1f1f
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 13:50:55 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:26 2015 +0100
----------------------------------------------------------------------
.../camel/component/gora/GoraAttribute.java | 5 +-
.../camel/component/gora/GoraComponent.java | 30 +------
.../camel/component/gora/GoraConfiguration.java | 93 --------------------
.../camel/component/gora/GoraConstants.java | 1 -
.../camel/component/gora/GoraConsumer.java | 12 +--
.../camel/component/gora/GoraOperation.java | 5 +-
.../camel/component/gora/GoraProducer.java | 19 +---
7 files changed, 8 insertions(+), 157 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/ea488090/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraAttribute.java
----------------------------------------------------------------------
diff --git a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraAttribute.java b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraAttribute.java
index 069a42d..31d8337 100644
--- a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraAttribute.java
+++ b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraAttribute.java
@@ -14,7 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.camel.component.gora;
/**
@@ -86,6 +85,7 @@ public enum GoraAttribute {
* Gora Query Fields attribute
*/
GORA_QUERY_FIELDS("fields");
+
/**
* Enum value
*/
@@ -96,8 +96,7 @@ public enum GoraAttribute {
*
* @param str Operation Value
*/
- private GoraAttribute(final String str) {
-
+ GoraAttribute(final String str) {
value = str;
}
http://git-wip-us.apache.org/repos/asf/camel/blob/ea488090/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraComponent.java b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraComponent.java
index c2f899d..a3825b0 100644
--- a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraComponent.java
+++ b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraComponent.java
@@ -14,7 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.camel.component.gora;
import java.io.IOException;
@@ -30,10 +29,6 @@ import org.apache.hadoop.conf.Configuration;
import static org.apache.camel.component.gora.GoraConstants.GORA_DEFAULT_DATASTORE_KEY;
-/**
- * Camel-Gora {@link Endpoint}.
- *
- */
public class GoraComponent extends UriEndpointComponent {
/**
@@ -63,9 +58,7 @@ public class GoraComponent extends UriEndpointComponent {
* @throws IOException
*/
private void init(final GoraConfiguration config) throws IOException {
-
this.goraProperties = DataStoreFactory.createProps();
-
this.dataStore = DataStoreFactory.getDataStore(goraProperties.getProperty(GORA_DEFAULT_DATASTORE_KEY,
config.getDataStoreClass()),
config.getKeyClass(),
@@ -73,9 +66,6 @@ public class GoraComponent extends UriEndpointComponent {
this.configuration);
}
- /**
- * {@inheritDoc}
- */
@Override
protected Endpoint createEndpoint(final String uri,
final String remaining,
@@ -84,31 +74,17 @@ public class GoraComponent extends UriEndpointComponent {
final GoraConfiguration config = new GoraConfiguration();
setProperties(config, parameters);
config.setName(remaining);
-
- try {
-
- init(config);
- } catch (IOException ex) {
-
- throw new RuntimeException(ex);
- }
-
+ init(config);
return new GoraEndpoint(uri, this, config, dataStore);
}
/**
* Get DataStore
- *
- * @return DataStore
*/
public DataStore<Object, Persistent> getDataStore() {
-
return dataStore;
}
- /**
- * {@inheritDoc}
- */
@Override
protected void doStart() throws Exception {
if (configuration == null) {
@@ -116,12 +92,8 @@ public class GoraComponent extends UriEndpointComponent {
}
}
- /**
- * {@inheritDoc}
- */
@Override
protected void doStop() throws Exception {
-
if (dataStore != null) {
dataStore.close();
}
http://git-wip-us.apache.org/repos/asf/camel/blob/ea488090/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraConfiguration.java
----------------------------------------------------------------------
diff --git a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraConfiguration.java b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraConfiguration.java
index a8e8a91..4be4836 100644
--- a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraConfiguration.java
+++ b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraConfiguration.java
@@ -14,7 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.camel.component.gora;
import com.google.common.base.Strings;
@@ -27,10 +26,8 @@ import org.apache.hadoop.conf.Configuration;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Strings.isNullOrEmpty;
-
/**
* Gora Configuration.
- *
*/
@UriParams
public class GoraConfiguration {
@@ -150,7 +147,6 @@ public class GoraConfiguration {
* Default Constructor
*/
public GoraConfiguration() {
-
this.hadoopConfiguration = new Configuration();
}
@@ -160,17 +156,13 @@ public class GoraConfiguration {
* @return key class
*/
public String getKeyClass() {
-
return keyClass;
}
/**
* Set type class of the key
- *
- * @param keyClass
*/
public void setKeyClass(final String keyClass) {
-
if (isNullOrEmpty(keyClass)) {
throw new IllegalArgumentException("Key class could not be null or empty!");
}
@@ -180,157 +172,110 @@ public class GoraConfiguration {
/**
* Get type of the value
- *
- * @return
*/
public String getValueClass() {
-
return valueClass;
}
/**
* Set type of the value
- *
- * @param valueClass
*/
public void setValueClass(final String valueClass) {
-
if (isNullOrEmpty(valueClass)) {
throw new IllegalArgumentException("Value class could not be null or empty!");
}
-
this.valueClass = valueClass;
}
/**
* Get type of the dataStore
- *
- * @return DataStore class
*/
public String getDataStoreClass() {
-
return dataStoreClass;
}
/**
* Set type of the dataStore
- *
- * @param dataStoreClass
*/
public void setDataStoreClass(String dataStoreClass) {
-
-
if (isNullOrEmpty(dataStoreClass)) {
throw new IllegalArgumentException("DataStore class could not be null or empty!");
}
-
this.dataStoreClass = dataStoreClass;
}
/**
* Get Hadoop Configuration
- *
- * @return
*/
public Configuration getHadoopConfiguration() {
-
return hadoopConfiguration;
}
/**
* Get Start Time
- *
- * @return
*/
public long getStartTime() {
-
return startTime;
}
/**
* Set Start Time
- *
- * @return
*/
public void setStartTime(long startTime) {
-
this.startTime = startTime;
}
/**
* Get End Time
- *
- * @return
*/
public long getEndTime() {
-
return endTime;
}
/**
* Set End Time
- *
- * @return
*/
public void setEndTime(long endTime) {
-
this.endTime = endTime;
}
/**
* Get Time Range From
- *
- * @return
*/
public long getTimeRangeFrom() {
-
return timeRangeFrom;
}
/**
* Set Time Range From
- *
- * @return
*/
public void setTimeRangeFrom(long timeRangeFrom) {
-
this.timeRangeFrom = timeRangeFrom;
}
/**
* Get Time Range To
- *
- * @return
*/
public long getTimeRangeTo() {
-
return timeRangeTo;
}
/**
* Set Time Range To
- *
- * @return
*/
public void setTimeRangeTo(long timeRangeTo) {
-
this.timeRangeTo = timeRangeTo;
}
/**
* Get Limit
- *
- * @return
*/
public long getLimit() {
-
return limit;
}
/**
* Set Limit
- *
- * @param limit
*/
public void setLimit(long limit) {
this.limit = limit;
@@ -338,28 +283,20 @@ public class GoraConfiguration {
/**
* Get Timestamp
- *
- * @return
*/
public long getTimestamp() {
-
return timestamp;
}
/**
* Set Timestamp
- *
- * @param timestamp
*/
public void setTimestamp(long timestamp) {
-
this.timestamp = timestamp;
}
/**
* Get Start Key
- *
- * @return
*/
public Object getStartKey() {
return startKey;
@@ -367,8 +304,6 @@ public class GoraConfiguration {
/**
* Set Start Key
- *
- * @param startKey
*/
public void setStartKey(Object startKey) {
this.startKey = startKey;
@@ -376,8 +311,6 @@ public class GoraConfiguration {
/**
* Get End Key
- *
- * @return
*/
public Object getEndKey() {
return endKey;
@@ -385,8 +318,6 @@ public class GoraConfiguration {
/**
* Set End Key
- *
- * @param endKey
*/
public void setEndKey(Object endKey) {
this.endKey = endKey;
@@ -394,7 +325,6 @@ public class GoraConfiguration {
/**
* Get Key Range From
- * @return
*/
public Object getKeyRangeFrom() {
return keyRangeFrom;
@@ -402,8 +332,6 @@ public class GoraConfiguration {
/**
* Set Key Range From
- *
- * @param keyRangeFrom
*/
public void setKeyRangeFrom(Object keyRangeFrom) {
this.keyRangeFrom = keyRangeFrom;
@@ -411,7 +339,6 @@ public class GoraConfiguration {
/**
* Get Key Range To
- * @return
*/
public Object getKeyRangeTo() {
return keyRangeTo;
@@ -419,8 +346,6 @@ public class GoraConfiguration {
/**
* Set Key Range To
- *
- * @param keyRangeTo
*/
public void setKeyRangeTo(Object keyRangeTo) {
this.keyRangeTo = keyRangeTo;
@@ -428,47 +353,34 @@ public class GoraConfiguration {
/**
* Get Fields
- *
- * @return
*/
public Strings getFields() {
-
return fields;
}
/**
* Set Fields
- *
- * @param fields
*/
public void setFields(Strings fields) {
-
this.fields = fields;
}
/**
* Get Concurrent Consumers
- * @return
*/
public int getConcurrentConsumers() {
-
return concurrentConsumers;
}
/**
* Set Concurrent Consumers
- *
- * @param concurrentConsumers
*/
public void setConcurrentConsumers(int concurrentConsumers) {
-
this.concurrentConsumers = concurrentConsumers;
}
/**
* Get flush on every operation
- *
- * @return
*/
public boolean isFlushOnEveryOperation() {
return flushOnEveryOperation;
@@ -476,8 +388,6 @@ public class GoraConfiguration {
/**
* Set flush on every operation
- *
- * @param flushOnEveryOperation
*/
public void setFlushOnEveryOperation(boolean flushOnEveryOperation) {
this.flushOnEveryOperation = flushOnEveryOperation;
@@ -485,11 +395,8 @@ public class GoraConfiguration {
/**
* Set Hadoop Configuration
- *
- * @param hadoopConfiguration
*/
public void setHadoopConfiguration(Configuration hadoopConfiguration) {
-
checkNotNull(hadoopConfiguration, "Hadoop Configuration could not be null!");
this.hadoopConfiguration = hadoopConfiguration;
}
http://git-wip-us.apache.org/repos/asf/camel/blob/ea488090/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraConstants.java
----------------------------------------------------------------------
diff --git a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraConstants.java b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraConstants.java
index 999056e..04ab7ea 100644
--- a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraConstants.java
+++ b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraConstants.java
@@ -14,7 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.camel.component.gora;
/**
http://git-wip-us.apache.org/repos/asf/camel/blob/ea488090/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraConsumer.java
----------------------------------------------------------------------
diff --git a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraConsumer.java b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraConsumer.java
index 24c2e22..2ec9176 100644
--- a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraConsumer.java
+++ b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraConsumer.java
@@ -14,7 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.camel.component.gora;
import java.lang.reflect.InvocationTargetException;
@@ -84,22 +83,16 @@ public class GoraConsumer extends ScheduledPollConsumer {
final DataStore<Object, Persistent> dataStore) throws ClassNotFoundException, NoSuchMethodException, InvocationTargetException, IllegalAccessException {
super(endpoint, processor);
-
this.configuration = configuration;
this.dataStore = dataStore;
-
this.query = GoraUtils.constractQueryFromConfiguration(this.dataStore, this.configuration);
}
- /**
- * {@inheritDoc}
- */
@Override
protected int poll() throws Exception {
-
final Exchange exchange = this.getEndpoint().createExchange();
- // compute time (aprox) since last update
+ // compute time (approx) since last update
if (firstRun) {
this.query.setStartTime(System.currentTimeMillis());
} else {
@@ -112,12 +105,9 @@ public class GoraConsumer extends ScheduledPollConsumer {
LOG.trace("Processing exchange [{}]...", exchange);
try {
-
getProcessor().process(exchange);
} finally {
-
if (exchange.getException() != null) {
-
getExceptionHandler().handleException("Error processing exchange", exchange, exchange.getException());
}
}
http://git-wip-us.apache.org/repos/asf/camel/blob/ea488090/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraOperation.java
----------------------------------------------------------------------
diff --git a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraOperation.java b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraOperation.java
index 29dbe6c..400c186 100644
--- a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraOperation.java
+++ b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraOperation.java
@@ -73,11 +73,8 @@ public enum GoraOperation {
/**
* Enum constructor
- *
- * @param str Operation Value
*/
- private GoraOperation(final String str) {
-
+ GoraOperation(final String str) {
value = str;
}
}
http://git-wip-us.apache.org/repos/asf/camel/blob/ea488090/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraProducer.java
----------------------------------------------------------------------
diff --git a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraProducer.java b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraProducer.java
index 7e25fd5..8ed67fd 100644
--- a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraProducer.java
+++ b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraProducer.java
@@ -14,7 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.camel.component.gora;
import java.util.Map;
@@ -32,10 +31,8 @@ import static org.apache.camel.component.gora.utils.GoraUtils.constractQueryFrom
import static org.apache.camel.component.gora.utils.GoraUtils.getKeyFromExchange;
import static org.apache.camel.component.gora.utils.GoraUtils.getValueFromExchange;
-
/**
* Camel-Gora {@link DefaultProducer}.
- *
*/
public class GoraProducer extends DefaultProducer implements ServicePoolAware {
@@ -75,48 +72,36 @@ public class GoraProducer extends DefaultProducer implements ServicePoolAware {
*/
@Override
public void process(final Exchange exchange) throws Exception {
-
final String operation = (String) exchange.getIn().getHeader(GoraAttribute.GORA_OPERATION.value);
if (operation == null || operation.isEmpty()) {
-
throw new RuntimeException("Gora operation is null or empty!");
}
Object result = 0; // 0 used as default response in order to avoid null body exception
if (GoraOperation.PUT.value.equalsIgnoreCase(operation)) {
-
dataStore.put(getKeyFromExchange(exchange), getValueFromExchange(exchange));
} else if (GoraOperation.GET.value.equalsIgnoreCase(operation)) {
-
result = dataStore.get(getKeyFromExchange(exchange));
} else if (GoraOperation.DELETE.value.equalsIgnoreCase(operation)) {
-
result = dataStore.delete(getKeyFromExchange(exchange));
} else if (GoraOperation.QUERY.value.equalsIgnoreCase(operation)) {
-
final Map<String, Object> props = exchange.getIn().getHeaders();
result = constractQueryFromPropertiesMap(props, dataStore, this.configuration).execute();
} else if (GoraOperation.DELETE_BY_QUERY.value.equalsIgnoreCase(operation)) {
-
final Map<String, Object> props = exchange.getIn().getHeaders();
result = dataStore.deleteByQuery(constractQueryFromPropertiesMap(props, dataStore, this.configuration));
} else if (GoraOperation.GET_SCHEMA_NAME.value.equalsIgnoreCase(operation)) {
-
result = dataStore.getSchemaName();
} else if (GoraOperation.DELETE_SCHEMA.value.equalsIgnoreCase(operation)) {
-
dataStore.deleteSchema();
} else if (GoraOperation.CREATE_SCHEMA.value.equalsIgnoreCase(operation)) {
-
dataStore.createSchema();
} else if (GoraOperation.SCHEMA_EXIST.value.equalsIgnoreCase(operation)) {
-
result = dataStore.schemaExists();
} else {
-
- throw new RuntimeException("Unknown operation!");
+ throw new RuntimeException("Unknown operation: " + operation);
}
/*
@@ -129,6 +114,8 @@ public class GoraProducer extends DefaultProducer implements ServicePoolAware {
}
exchange.getOut().setBody(result);
+ // preserve headers
+ exchange.getOut().setHeaders(exchange.getIn().getHeaders());
}
}
[17/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.
Posted by da...@apache.org.
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/0d49f6bc
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/0d49f6bc
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/0d49f6bc
Branch: refs/heads/master
Commit: 0d49f6bcdc71096ea6b7682fd1679817234dcd6c
Parents: 5b9595a
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 16:58:56 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:29 2015 +0100
----------------------------------------------------------------------
.../apache/camel/component/twitter/TwitterEndpointPolling.java | 2 +-
.../org/apache/camel/component/undertow/UndertowEndpoint.java | 2 +-
.../org/apache/camel/component/velocity/VelocityEndpoint.java | 3 +++
.../java/org/apache/camel/component/vertx/VertxEndpoint.java | 2 +-
.../org/apache/camel/component/weather/WeatherEndpoint.java | 2 +-
.../org/apache/camel/component/websocket/WebsocketEndpoint.java | 5 +++++
.../java/org/apache/camel/component/xmlrpc/XmlRpcEndpoint.java | 2 +-
.../camel/component/xmlsecurity/XmlSignatureEndpoint.java | 3 +++
.../main/java/org/apache/camel/component/xmpp/XmppEndpoint.java | 2 +-
.../java/org/apache/camel/component/yammer/YammerEndpoint.java | 2 +-
.../org/apache/camel/component/zookeeper/ZooKeeperEndpoint.java | 2 +-
11 files changed, 19 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-twitter/src/main/java/org/apache/camel/component/twitter/TwitterEndpointPolling.java
----------------------------------------------------------------------
diff --git a/components/camel-twitter/src/main/java/org/apache/camel/component/twitter/TwitterEndpointPolling.java b/components/camel-twitter/src/main/java/org/apache/camel/component/twitter/TwitterEndpointPolling.java
index 2d42b93..4a77d29 100644
--- a/components/camel-twitter/src/main/java/org/apache/camel/component/twitter/TwitterEndpointPolling.java
+++ b/components/camel-twitter/src/main/java/org/apache/camel/component/twitter/TwitterEndpointPolling.java
@@ -29,7 +29,7 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
/**
- * Twitter polling endpoint
+ * This component integrates with Twitter to send tweets or search for tweets and more.
*/
@ManagedResource(description = "Managed Twitter Endpoint")
@UriEndpoint(scheme = "twitter", title = "Twitter", syntax = "twitter:type", consumerClass = Twitter4JConsumer.class, label = "api,social")
http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-undertow/src/main/java/org/apache/camel/component/undertow/UndertowEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-undertow/src/main/java/org/apache/camel/component/undertow/UndertowEndpoint.java b/components/camel-undertow/src/main/java/org/apache/camel/component/undertow/UndertowEndpoint.java
index 621c5fd..b41a205 100644
--- a/components/camel-undertow/src/main/java/org/apache/camel/component/undertow/UndertowEndpoint.java
+++ b/components/camel-undertow/src/main/java/org/apache/camel/component/undertow/UndertowEndpoint.java
@@ -44,7 +44,7 @@ import org.xnio.OptionMap;
import org.xnio.Options;
/**
- * Represents an Undertow endpoint.
+ * The undertow component provides HTTP-based endpoints for consuming and producing HTTP requests
*/
@UriEndpoint(scheme = "undertow", title = "Undertow", syntax = "undertow:httpURI",
consumerClass = UndertowConsumer.class, label = "http")
http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityEndpoint.java b/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityEndpoint.java
index c36c7d1..1429bae 100644
--- a/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityEndpoint.java
+++ b/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityEndpoint.java
@@ -40,6 +40,9 @@ import org.apache.velocity.context.Context;
import org.apache.velocity.runtime.RuntimeConstants;
import org.apache.velocity.runtime.log.CommonsLogLogChute;
+/**
+ * Generates a response using an Apache Velocity template.
+ */
@UriEndpoint(scheme = "velocity", title = "Velocity", syntax = "velocity:resourceUri", producerOnly = true, label = "transformation")
public class VelocityEndpoint extends ResourceEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxEndpoint.java b/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxEndpoint.java
index 2831282..7fbdccd 100644
--- a/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxEndpoint.java
+++ b/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxEndpoint.java
@@ -29,7 +29,7 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
- * A Camel Endpoint for working with <a href="http://vertx.io/">vert.x</a> event bus endpoints
+ * The vertx component is used for sending and receive messages from a vertx event bus.
*/
@UriEndpoint(scheme = "vertx", title = "Vert.x", syntax = "vertx:address", consumerClass = VertxConsumer.class, label = "eventbus")
public class VertxEndpoint extends DefaultEndpoint implements MultipleConsumersSupport {
http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-weather/src/main/java/org/apache/camel/component/weather/WeatherEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-weather/src/main/java/org/apache/camel/component/weather/WeatherEndpoint.java b/components/camel-weather/src/main/java/org/apache/camel/component/weather/WeatherEndpoint.java
index 987718f..acff9e6 100644
--- a/components/camel-weather/src/main/java/org/apache/camel/component/weather/WeatherEndpoint.java
+++ b/components/camel-weather/src/main/java/org/apache/camel/component/weather/WeatherEndpoint.java
@@ -24,7 +24,7 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
/**
- * Weather Endpoint
+ * Polls the weather information from Open Weather Map
*/
@UriEndpoint(scheme = "weather", title = "Weather", syntax = "weather:name", consumerClass = WeatherConsumer.class, label = "api")
public class WeatherEndpoint extends DefaultPollingEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-websocket/src/main/java/org/apache/camel/component/websocket/WebsocketEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-websocket/src/main/java/org/apache/camel/component/websocket/WebsocketEndpoint.java b/components/camel-websocket/src/main/java/org/apache/camel/component/websocket/WebsocketEndpoint.java
index 26100f9..a71eabc 100644
--- a/components/camel-websocket/src/main/java/org/apache/camel/component/websocket/WebsocketEndpoint.java
+++ b/components/camel-websocket/src/main/java/org/apache/camel/component/websocket/WebsocketEndpoint.java
@@ -33,6 +33,11 @@ import org.apache.camel.util.ObjectHelper;
import org.apache.camel.util.jsse.SSLContextParameters;
import org.eclipse.jetty.server.Handler;
+/**
+ * The websocket component provides websocket endpoints for communicating with clients using websocket.
+ *
+ * This component uses Jetty as the websocket implementation.
+ */
@UriEndpoint(scheme = "websocket", title = "Jetty Websocket", syntax = "websocket:host:port/resourceUri", consumerClass = WebsocketConsumer.class, label = "websocket")
public class WebsocketEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcEndpoint.java b/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcEndpoint.java
index 0576d0f..343bf43 100644
--- a/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcEndpoint.java
+++ b/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcEndpoint.java
@@ -35,7 +35,7 @@ import org.apache.xmlrpc.client.XmlRpcClient;
import org.apache.xmlrpc.client.XmlRpcClientConfigImpl;
/**
- * Represents a xmlrpc endpoint.
+ * The xmlrpc component is used for sending messages to a XML RPC service.
*/
@UriEndpoint(scheme = "xmlrpc", title = "XML RPC", syntax = "xmlrpc:address", producerOnly = true, label = "transformation")
public class XmlRpcEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/XmlSignatureEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/XmlSignatureEndpoint.java b/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/XmlSignatureEndpoint.java
index dd93b56..c3883fe 100644
--- a/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/XmlSignatureEndpoint.java
+++ b/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/XmlSignatureEndpoint.java
@@ -31,6 +31,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
+/**
+ * Used to sign and verify exchanges using the XML signature specification.
+ */
@UriEndpoint(scheme = "xmlsecurity", title = "XML Security", syntax = "xmlsecurity:command/name", producerOnly = true, label = "security,transformation")
public abstract class XmlSignatureEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-xmpp/src/main/java/org/apache/camel/component/xmpp/XmppEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-xmpp/src/main/java/org/apache/camel/component/xmpp/XmppEndpoint.java b/components/camel-xmpp/src/main/java/org/apache/camel/component/xmpp/XmppEndpoint.java
index 041c7c1..97c022d 100644
--- a/components/camel-xmpp/src/main/java/org/apache/camel/component/xmpp/XmppEndpoint.java
+++ b/components/camel-xmpp/src/main/java/org/apache/camel/component/xmpp/XmppEndpoint.java
@@ -47,7 +47,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * A XMPP Endpoint
+ * To send and receive messages from a XMPP (chat) server.
*/
@UriEndpoint(scheme = "xmpp", title = "XMPP", syntax = "xmpp:host:port/participant", consumerClass = XmppConsumer.class, label = "chat,messaging")
public class XmppEndpoint extends DefaultEndpoint implements HeaderFilterStrategyAware {
http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerEndpoint.java b/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerEndpoint.java
index 5027962..d2675e5 100644
--- a/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerEndpoint.java
+++ b/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerEndpoint.java
@@ -24,7 +24,7 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
/**
- * Represents a Yammer endpoint.
+ * The yammer component allows you to interact with the Yammer enterprise social network.
*/
@UriEndpoint(scheme = "yammer", title = "Yammer", syntax = "yammer:function", consumerClass = YammerMessagePollingConsumer.class, label = "social")
public class YammerEndpoint extends ScheduledPollEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-zookeeper/src/main/java/org/apache/camel/component/zookeeper/ZooKeeperEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-zookeeper/src/main/java/org/apache/camel/component/zookeeper/ZooKeeperEndpoint.java b/components/camel-zookeeper/src/main/java/org/apache/camel/component/zookeeper/ZooKeeperEndpoint.java
index 0cc2036..e85876d 100644
--- a/components/camel-zookeeper/src/main/java/org/apache/camel/component/zookeeper/ZooKeeperEndpoint.java
+++ b/components/camel-zookeeper/src/main/java/org/apache/camel/component/zookeeper/ZooKeeperEndpoint.java
@@ -29,7 +29,7 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
/**
- * <code>ZooKeeperEndpoint</code>
+ * The zookeeper component allows interaction with a ZooKeeper cluster.
*/
@ManagedResource(description = "ZooKeeper Endpoint")
@UriEndpoint(scheme = "zookeeper", title = "ZooKeeper", syntax = "zookeeper:serverUrls/path", consumerClass = ZooKeeperConsumer.class, label = "clustering")
[08/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.
Posted by da...@apache.org.
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/87f2194d
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/87f2194d
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/87f2194d
Branch: refs/heads/master
Commit: 87f2194dea18fc07b7d1f4f845ca5296aeaf55ab
Parents: ea48809
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 13:57:17 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:26 2015 +0100
----------------------------------------------------------------------
.../org/apache/camel/component/grape/GrapeEndpoint.groovy | 3 +++
.../camel/component/guava/eventbus/GuavaEventBusEndpoint.java | 3 +--
.../camel/component/hazelcast/HazelcastDefaultEndpoint.java | 3 +++
.../java/org/apache/camel/component/hbase/HBaseEndpoint.java | 2 +-
.../main/java/org/apache/camel/component/hdfs/HdfsEndpoint.java | 3 +++
.../java/org/apache/camel/component/hdfs2/HdfsEndpoint.java | 3 +++
.../org/apache/camel/component/hipchat/HipchatComponent.java | 2 +-
.../org/apache/camel/component/hipchat/HipchatEndpoint.java | 5 +----
.../main/java/org/apache/camel/component/http/HttpEndpoint.java | 4 +---
.../java/org/apache/camel/component/http4/HttpEndpoint.java | 4 +---
10 files changed, 18 insertions(+), 14 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-grape/src/main/groovy/org/apache/camel/component/grape/GrapeEndpoint.groovy
----------------------------------------------------------------------
diff --git a/components/camel-grape/src/main/groovy/org/apache/camel/component/grape/GrapeEndpoint.groovy b/components/camel-grape/src/main/groovy/org/apache/camel/component/grape/GrapeEndpoint.groovy
index 9e0c730..e845f0c 100644
--- a/components/camel-grape/src/main/groovy/org/apache/camel/component/grape/GrapeEndpoint.groovy
+++ b/components/camel-grape/src/main/groovy/org/apache/camel/component/grape/GrapeEndpoint.groovy
@@ -26,6 +26,9 @@ import org.apache.camel.spi.UriEndpoint
import static groovy.grape.Grape.grab
import static org.apache.camel.component.grape.MavenCoordinates.parseMavenCoordinates
+/**
+ * The grape component allows you to fetch, load and manage additional jars when CamelContext is running.
+ */
@UriEndpoint(scheme = "grape", syntax = "grape:defaultCoordinates", title = "Grape", producerOnly = true, label = "management,deployment")
class GrapeEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusEndpoint.java b/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusEndpoint.java
index e7db21d..74f1325 100644
--- a/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusEndpoint.java
+++ b/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusEndpoint.java
@@ -30,8 +30,7 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.util.CamelContextHelper;
/**
- * Guava EventBus (http://docs.guava-libraries.googlecode.com/git/javadoc/com/google/common/eventbus/EventBus.html)
- * endpoint. Can create both producer and consumer ends of the route.
+ * The guava-eventbus component provides integration bridge between Camel and Google Guava EventBus.
*/
@UriEndpoint(scheme = "guava-eventbus", title = "Guava EventBus", syntax = "guava-eventbus:eventBusRef", consumerClass = GuavaEventBusConsumer.class, label = "eventbus")
public class GuavaEventBusEndpoint extends DefaultEndpoint implements MultipleConsumersSupport {
http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-hazelcast/src/main/java/org/apache/camel/component/hazelcast/HazelcastDefaultEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-hazelcast/src/main/java/org/apache/camel/component/hazelcast/HazelcastDefaultEndpoint.java b/components/camel-hazelcast/src/main/java/org/apache/camel/component/hazelcast/HazelcastDefaultEndpoint.java
index 5cdee44..dec3f48 100644
--- a/components/camel-hazelcast/src/main/java/org/apache/camel/component/hazelcast/HazelcastDefaultEndpoint.java
+++ b/components/camel-hazelcast/src/main/java/org/apache/camel/component/hazelcast/HazelcastDefaultEndpoint.java
@@ -27,6 +27,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
+/**
+ * The hazelcast component allows you to work with the Hazelcast distributed data grid / cache.
+ */
@UriEndpoint(scheme = "hazelcast", title = "Hazelcast", syntax = "hazelcast:command:cacheName", consumerClass = HazelcastDefaultConsumer.class, label = "cache,datagrid")
public abstract class HazelcastDefaultEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-hbase/src/main/java/org/apache/camel/component/hbase/HBaseEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-hbase/src/main/java/org/apache/camel/component/hbase/HBaseEndpoint.java b/components/camel-hbase/src/main/java/org/apache/camel/component/hbase/HBaseEndpoint.java
index 00bf8df..2ccfde6 100644
--- a/components/camel-hbase/src/main/java/org/apache/camel/component/hbase/HBaseEndpoint.java
+++ b/components/camel-hbase/src/main/java/org/apache/camel/component/hbase/HBaseEndpoint.java
@@ -37,7 +37,7 @@ import org.apache.hadoop.hbase.filter.Filter;
import org.apache.hadoop.security.UserGroupInformation;
/**
- * Represents an HBase endpoint.
+ * For reading/writing from/to an HBase store (Hadoop database)
*/
@UriEndpoint(scheme = "hbase", title = "HBase", syntax = "hbase:tableName", consumerClass = HBaseConsumer.class, label = "hadoop")
public class HBaseEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-hdfs/src/main/java/org/apache/camel/component/hdfs/HdfsEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-hdfs/src/main/java/org/apache/camel/component/hdfs/HdfsEndpoint.java b/components/camel-hdfs/src/main/java/org/apache/camel/component/hdfs/HdfsEndpoint.java
index 0aeb4a9..ad02148 100644
--- a/components/camel-hdfs/src/main/java/org/apache/camel/component/hdfs/HdfsEndpoint.java
+++ b/components/camel-hdfs/src/main/java/org/apache/camel/component/hdfs/HdfsEndpoint.java
@@ -27,6 +27,9 @@ import org.apache.camel.impl.DefaultEndpoint;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
+/**
+ * For reading/writing from/to an HDFS filesystem using Hadoop 1.x
+ */
@UriEndpoint(scheme = "hdfs", title = "HDFS", syntax = "hdfs:hostName:port/path", consumerClass = HdfsConsumer.class, label = "hadoop,file")
public class HdfsEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-hdfs2/src/main/java/org/apache/camel/component/hdfs2/HdfsEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-hdfs2/src/main/java/org/apache/camel/component/hdfs2/HdfsEndpoint.java b/components/camel-hdfs2/src/main/java/org/apache/camel/component/hdfs2/HdfsEndpoint.java
index 257670f..f32884d 100644
--- a/components/camel-hdfs2/src/main/java/org/apache/camel/component/hdfs2/HdfsEndpoint.java
+++ b/components/camel-hdfs2/src/main/java/org/apache/camel/component/hdfs2/HdfsEndpoint.java
@@ -27,6 +27,9 @@ import org.apache.camel.impl.DefaultEndpoint;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
+/**
+ * For reading/writing from/to an HDFS filesystem using Hadoop 2.x
+ */
@UriEndpoint(scheme = "hdfs2", title = "HDFS2", syntax = "hdfs2:hostName:port/path", consumerClass = HdfsConsumer.class, label = "hadoop,file")
public class HdfsEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatComponent.java b/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatComponent.java
index a47cfa2..10f634f 100644
--- a/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatComponent.java
+++ b/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatComponent.java
@@ -53,7 +53,7 @@ public class HipchatComponent extends UriEndpointComponent {
throw new HipchatException("OAuth 2 auth token must be specified");
}
parseUri(uri, endpoint);
- LOG.info("Using Hipchat API URL: " + endpoint.getConfiguration().hipChatUrl());
+ LOG.debug("Using Hipchat API URL: {}", endpoint.getConfiguration().hipChatUrl());
return endpoint;
}
http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatEndpoint.java b/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatEndpoint.java
index 87680c2..0210df7 100644
--- a/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatEndpoint.java
+++ b/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatEndpoint.java
@@ -19,15 +19,12 @@ package org.apache.camel.component.hipchat;
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.impl.ScheduledPollEndpoint;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
/**
- * Represents a Hipchat endpoint.
+ * The hipchat component supports producing and consuming messages from/to Hipchat service.
*/
@UriEndpoint(scheme = "hipchat", title = "Hipchat", syntax = "hipchat:protocol:host:port", consumerClass = HipchatConsumer.class, label = "api,cloud")
public class HipchatEndpoint extends ScheduledPollEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-http/src/main/java/org/apache/camel/component/http/HttpEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-http/src/main/java/org/apache/camel/component/http/HttpEndpoint.java b/components/camel-http/src/main/java/org/apache/camel/component/http/HttpEndpoint.java
index 98df503..4106975 100644
--- a/components/camel-http/src/main/java/org/apache/camel/component/http/HttpEndpoint.java
+++ b/components/camel-http/src/main/java/org/apache/camel/component/http/HttpEndpoint.java
@@ -37,9 +37,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Represents a <a href="http://camel.apache.org/http.html">HTTP endpoint</a>
- *
- * @version
+ * For calling out to external HTTP servers using Apache HTTP Client 3.x.
*/
@UriEndpoint(scheme = "http,https", title = "HTTP,HTTPS", syntax = "http:httpUri", producerOnly = true, label = "http")
public class HttpEndpoint extends HttpCommonEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-http4/src/main/java/org/apache/camel/component/http4/HttpEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-http4/src/main/java/org/apache/camel/component/http4/HttpEndpoint.java b/components/camel-http4/src/main/java/org/apache/camel/component/http4/HttpEndpoint.java
index b589e65..7dfeaf3 100644
--- a/components/camel-http4/src/main/java/org/apache/camel/component/http4/HttpEndpoint.java
+++ b/components/camel-http4/src/main/java/org/apache/camel/component/http4/HttpEndpoint.java
@@ -42,9 +42,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Represents a <a href="http://camel.apache.org/http.html">HTTP endpoint</a>
- *
- * @version
+ * For calling out to external HTTP servers using Apache HTTP Client 4.x
*/
@UriEndpoint(scheme = "http4,http4s", title = "HTTP4,HTTP4S", syntax = "http4:httpUri", producerOnly = true, label = "http")
public class HttpEndpoint extends HttpCommonEndpoint {
[04/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.
Posted by da...@apache.org.
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/cfc1f1f3
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/cfc1f1f3
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/cfc1f1f3
Branch: refs/heads/master
Commit: cfc1f1f334fb878f63fa5a1e02bebb51c2186b05
Parents: 5f269bd
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 13:44:44 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:25 2015 +0100
----------------------------------------------------------------------
.../crypto/DigitalSignatureEndpoint.java | 2 +-
.../camel/component/docker/DockerEndpoint.java | 2 +-
.../camel/component/elsql/ElsqlEndpoint.java | 2 +-
.../component/facebook/FacebookEndpoint.java | 5 +++-
.../component/flatpack/FlatpackEndpoint.java | 4 +--
.../apache/camel/component/fop/FopEndpoint.java | 2 +-
.../freemarker/FreemarkerEndpoint.java | 2 +-
.../component/file/remote/FtpEndpoint.java | 2 +-
.../component/file/remote/FtpsEndpoint.java | 4 +--
.../component/file/remote/SftpEndpoint.java | 2 +-
.../camel/component/gae/auth/GAuthEndpoint.java | 4 ++-
.../camel/component/gae/http/GHttpEndpoint.java | 5 ++--
.../component/gae/login/GLoginEndpoint.java | 5 ++--
.../camel/component/gae/mail/GMailEndpoint.java | 4 +--
.../camel/component/gae/task/GTaskEndpoint.java | 4 +--
.../component/ganglia/GangliaEndpoint.java | 3 +++
.../component/geocoder/GeoCoderEndpoint.java | 2 +-
.../apache/camel/component/git/GitEndpoint.java | 3 +++
.../camel/component/github/GitHubEndpoint.java | 2 ++
.../google/calendar/GoogleCalendarEndpoint.java | 2 +-
.../google/drive/GoogleDriveEndpoint.java | 2 +-
.../google/mail/GoogleMailEndpoint.java | 2 +-
.../camel/component/gora/GoraEndpoint.java | 28 +-------------------
.../kubernetes/KubernetesEndpoint.java | 2 +-
.../component/openshift/OpenShiftEndpoint.java | 2 +-
25 files changed, 39 insertions(+), 58 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java b/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java
index a390e3e..1560bc5 100644
--- a/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java
+++ b/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java
@@ -34,7 +34,7 @@ import org.apache.camel.spi.UriParam;
/**
* The crypto component is used for signing and verifying exchanges using the Signature Service of the Java Cryptographic Extension (JCE).
*/
-@UriEndpoint(scheme = "crypto", title = "Crypto (Java Cryptographic Extension)", syntax = "crypto:cryptoOperation", producerOnly = true, label = "security,transformation")
+@UriEndpoint(scheme = "crypto", title = "Crypto (JCE)", syntax = "crypto:cryptoOperation", producerOnly = true, label = "security,transformation")
public class DigitalSignatureEndpoint extends DefaultEndpoint {
@UriParam
private DigitalSignatureConfiguration configuration;
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java
index 09d80f6..62bdb6a 100644
--- a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java
+++ b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java
@@ -30,7 +30,7 @@ import org.apache.camel.spi.UriParam;
/**
* The docker component is used for managing Docker containers.
*/
-@UriEndpoint(scheme = "docker", title = "Docker", syntax = "docker:operation", consumerClass = DockerEventsConsumer.class, label = "container,cloud,management,platform")
+@UriEndpoint(scheme = "docker", title = "Docker", syntax = "docker:operation", consumerClass = DockerEventsConsumer.class, label = "container,cloud,paas")
public class DockerEndpoint extends DefaultEndpoint {
@UriParam
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java b/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java
index 07abfad..ab09ab0 100644
--- a/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java
+++ b/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java
@@ -45,7 +45,7 @@ import org.springframework.jdbc.core.namedparam.SqlParameterSource;
/**
* The elsql component is an extension to the existing SQL Component that uses ElSql to define the SQL queries.
*/
-@UriEndpoint(scheme = "elsql", title = "SQL", syntax = "elsql:elsqlName:resourceUri", consumerClass = ElsqlConsumer.class, label = "database,sql")
+@UriEndpoint(scheme = "elsql", title = "ElSQL", syntax = "elsql:elsqlName:resourceUri", consumerClass = ElsqlConsumer.class, label = "database,sql")
public class ElsqlEndpoint extends DefaultSqlEndpoint {
private static final Logger LOG = LoggerFactory.getLogger(ElsqlEndpoint.class);
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java
index 740ce85..905d0c1 100644
--- a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java
+++ b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java
@@ -48,7 +48,10 @@ import static org.apache.camel.component.facebook.data.FacebookMethodsTypeHelper
import static org.apache.camel.component.facebook.data.FacebookPropertiesHelper.getEndpointPropertyNames;
/**
- * Represents a Facebook endpoint.
+ * The Facebook component provides access to all of the Facebook APIs accessible using Facebook4J.
+ *
+ * It allows producing messages to retrieve, add, and delete posts, likes, comments, photos, albums, videos, photos,
+ * checkins, locations, links, etc. It also supports APIs that allow polling for posts, users, checkins, groups, locations, etc.
*/
@UriEndpoint(scheme = "facebook", title = "Facebook", syntax = "facebook:methodName", consumerClass = FacebookConsumer.class, label = "social")
public class FacebookEndpoint extends DefaultEndpoint implements FacebookConstants {
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-flatpack/src/main/java/org/apache/camel/component/flatpack/FlatpackEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-flatpack/src/main/java/org/apache/camel/component/flatpack/FlatpackEndpoint.java b/components/camel-flatpack/src/main/java/org/apache/camel/component/flatpack/FlatpackEndpoint.java
index 8c5cabe..080c5b4 100644
--- a/components/camel-flatpack/src/main/java/org/apache/camel/component/flatpack/FlatpackEndpoint.java
+++ b/components/camel-flatpack/src/main/java/org/apache/camel/component/flatpack/FlatpackEndpoint.java
@@ -44,9 +44,7 @@ import org.apache.camel.util.ObjectHelper;
import org.apache.camel.util.ResourceHelper;
/**
- * Processing fixed width or delimited files or messages using the FlatPack library.
- *
- * @version
+ * The flatpack component supports fixed width and delimited file parsing via the FlatPack library.
*/
@UriEndpoint(scheme = "flatpack", title = "Flatpack", syntax = "flatpack:type:resourceUri", consumerClass = FlatpackConsumer.class, label = "transformation")
public class FlatpackEndpoint extends DefaultPollingEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-fop/src/main/java/org/apache/camel/component/fop/FopEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-fop/src/main/java/org/apache/camel/component/fop/FopEndpoint.java b/components/camel-fop/src/main/java/org/apache/camel/component/fop/FopEndpoint.java
index 2cffd26..42df6ef 100644
--- a/components/camel-fop/src/main/java/org/apache/camel/component/fop/FopEndpoint.java
+++ b/components/camel-fop/src/main/java/org/apache/camel/component/fop/FopEndpoint.java
@@ -32,7 +32,7 @@ import org.apache.camel.util.ResourceHelper;
import org.apache.fop.apps.FopFactory;
/**
- * Represents a Fop endpoint.
+ * The fop component allows you to render a message into different output formats using Apache FOP.
*/
@UriEndpoint(scheme = "fop", title = "FOP", syntax = "fop:outputType", producerOnly = true, label = "transformation")
public class FopEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-freemarker/src/main/java/org/apache/camel/component/freemarker/FreemarkerEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-freemarker/src/main/java/org/apache/camel/component/freemarker/FreemarkerEndpoint.java b/components/camel-freemarker/src/main/java/org/apache/camel/component/freemarker/FreemarkerEndpoint.java
index 8f63376..3c2c134 100644
--- a/components/camel-freemarker/src/main/java/org/apache/camel/component/freemarker/FreemarkerEndpoint.java
+++ b/components/camel-freemarker/src/main/java/org/apache/camel/component/freemarker/FreemarkerEndpoint.java
@@ -34,7 +34,7 @@ import org.apache.camel.util.ExchangeHelper;
import org.apache.camel.util.ObjectHelper;
/**
- * Freemarker endpoint
+ * Generates a response using a FreeMarker template
*/
@UriEndpoint(scheme = "freemarker", title = "Freemarker", syntax = "freemarker:resourceUri", producerOnly = true, label = "transformation")
public class FreemarkerEndpoint extends ResourceEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpEndpoint.java b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpEndpoint.java
index 6f1b025..0b2e56d 100644
--- a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpEndpoint.java
+++ b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpEndpoint.java
@@ -34,7 +34,7 @@ import org.apache.commons.net.ftp.FTPClientConfig;
import org.apache.commons.net.ftp.FTPFile;
/**
- * FTP endpoint
+ * The ftp component is used for uploading or downloading files from FTP servers.
*/
@UriEndpoint(scheme = "ftp", extendsScheme = "file", title = "FTP",
syntax = "ftp:host:port/directoryName", consumerClass = FtpConsumer.class, label = "file")
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpsEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpsEndpoint.java b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpsEndpoint.java
index 3dfa806..036d281 100644
--- a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpsEndpoint.java
+++ b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpsEndpoint.java
@@ -37,9 +37,7 @@ import org.apache.commons.net.ftp.FTPFile;
import org.apache.commons.net.ftp.FTPSClient;
/**
- * FTP Secure (FTP over SSL/TLS) endpoint
- *
- * @version
+ * The ftps (FTP secure SSL/TLS) component is used for uploading or downloading files from FTP servers.
*/
@UriEndpoint(scheme = "ftps", extendsScheme = "file", title = "FTPS",
syntax = "ftps:host:port/directoryName", consumerClass = FtpConsumer.class, label = "file")
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/SftpEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/SftpEndpoint.java b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/SftpEndpoint.java
index 5859aa4..12af0f8 100644
--- a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/SftpEndpoint.java
+++ b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/SftpEndpoint.java
@@ -25,7 +25,7 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
/**
- * Secure FTP endpoint
+ * The sftp (FTP over SSH) component is used for uploading or downloading files from SFTP servers.
*/
@UriEndpoint(scheme = "sftp", extendsScheme = "file", title = "SFTP",
syntax = "sftp:host:port/directoryName", consumerClass = SftpConsumer.class, label = "file")
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-gae/src/main/java/org/apache/camel/component/gae/auth/GAuthEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-gae/src/main/java/org/apache/camel/component/gae/auth/GAuthEndpoint.java b/components/camel-gae/src/main/java/org/apache/camel/component/gae/auth/GAuthEndpoint.java
index 7385570..5e4f9ff 100644
--- a/components/camel-gae/src/main/java/org/apache/camel/component/gae/auth/GAuthEndpoint.java
+++ b/components/camel-gae/src/main/java/org/apache/camel/component/gae/auth/GAuthEndpoint.java
@@ -37,6 +37,8 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
+ * The gauth component is used by web applications to implement a Google-specific OAuth consumer.
+ *
* Represents a <a href="http://camel.apache.org/gauth.html">GAuth Endpoint</a>.
* Instances can have one of two names, either <code>authorize</code> for
* requesting an unauthorized request token or <code>upgrade</code> for
@@ -44,7 +46,7 @@ import org.apache.camel.spi.UriPath;
* endpoint URIs are <code>gauth:authorize</code> and <code>gauth:upgrade</code>
* , respectively.
*/
-@UriEndpoint(scheme = "gauth", title = "Google GAuth", syntax = "gauth:name", producerOnly = true, label = "cloud")
+@UriEndpoint(scheme = "gauth", title = "Google GAuth", syntax = "gauth:name", producerOnly = true, label = "cloud,paas")
public class GAuthEndpoint extends DefaultEndpoint {
public static enum Name {
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-gae/src/main/java/org/apache/camel/component/gae/http/GHttpEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-gae/src/main/java/org/apache/camel/component/gae/http/GHttpEndpoint.java b/components/camel-gae/src/main/java/org/apache/camel/component/gae/http/GHttpEndpoint.java
index 75e3cf7..c205ece 100644
--- a/components/camel-gae/src/main/java/org/apache/camel/component/gae/http/GHttpEndpoint.java
+++ b/components/camel-gae/src/main/java/org/apache/camel/component/gae/http/GHttpEndpoint.java
@@ -42,11 +42,10 @@ import org.apache.camel.util.URISupport;
import org.apache.camel.util.UnsafeUriCharactersEncoder;
/**
- * Represents a <a href="http://camel.apache.org/ghttp.html">Google App Engine
- * HTTP endpoint</a>.
+ * The ghttp component provides HTTP connectivity to the GAE.
*/
@UriEndpoint(scheme = "ghttp", extendsScheme = "servlet", title = "Google HTTP",
- syntax = "ghttp:httpUri", producerOnly = true, label = "cloud")
+ syntax = "ghttp:httpUri", producerOnly = true, label = "cloud,paas")
public class GHttpEndpoint extends ServletEndpoint implements OutboundBindingSupport<GHttpEndpoint, HTTPRequest, HTTPResponse> {
public static final String GHTTP_SCHEME = "ghttp";
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-gae/src/main/java/org/apache/camel/component/gae/login/GLoginEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-gae/src/main/java/org/apache/camel/component/gae/login/GLoginEndpoint.java b/components/camel-gae/src/main/java/org/apache/camel/component/gae/login/GLoginEndpoint.java
index d0ba8f0..cfc3f23 100644
--- a/components/camel-gae/src/main/java/org/apache/camel/component/gae/login/GLoginEndpoint.java
+++ b/components/camel-gae/src/main/java/org/apache/camel/component/gae/login/GLoginEndpoint.java
@@ -28,10 +28,9 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
- * Represents a <a href="http://camel.apache.org/glogin.html">GLogin
- * Endpoint</a>.
+ * The glogin component is used by Camel applications outside Google App Engine (GAE) for programmatic login to GAE applications.
*/
-@UriEndpoint(scheme = "glogin", title = "Google Login", syntax = "glogin:hostName", producerOnly = true, label = "cloud")
+@UriEndpoint(scheme = "glogin", title = "Google Login", syntax = "glogin:hostName", producerOnly = true, label = "cloud,paas")
public class GLoginEndpoint extends DefaultEndpoint {
private OutboundBinding<GLoginEndpoint, GLoginData, GLoginData> outboundBinding;
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-gae/src/main/java/org/apache/camel/component/gae/mail/GMailEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-gae/src/main/java/org/apache/camel/component/gae/mail/GMailEndpoint.java b/components/camel-gae/src/main/java/org/apache/camel/component/gae/mail/GMailEndpoint.java
index 1562601..246711c 100644
--- a/components/camel-gae/src/main/java/org/apache/camel/component/gae/mail/GMailEndpoint.java
+++ b/components/camel-gae/src/main/java/org/apache/camel/component/gae/mail/GMailEndpoint.java
@@ -33,9 +33,9 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
- * Represents a <a href="http://camel.apache.org/gmail.html">Google App Engine Mail endpoint</a>.
+ * The gmail component is used for sending emails to GAE.
*/
-@UriEndpoint(scheme = "gmail", title = "Google mail", syntax = "gmail:sender", producerOnly = true, label = "cloud,mail")
+@UriEndpoint(scheme = "gmail", title = "Google mail", syntax = "gmail:sender", producerOnly = true, label = "cloud,mail,paas")
public class GMailEndpoint extends DefaultEndpoint implements OutboundBindingSupport<GMailEndpoint, Message, Void> {
private OutboundBinding<GMailEndpoint, Message, Void> outboundBinding;
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-gae/src/main/java/org/apache/camel/component/gae/task/GTaskEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-gae/src/main/java/org/apache/camel/component/gae/task/GTaskEndpoint.java b/components/camel-gae/src/main/java/org/apache/camel/component/gae/task/GTaskEndpoint.java
index e688d67..2128711 100644
--- a/components/camel-gae/src/main/java/org/apache/camel/component/gae/task/GTaskEndpoint.java
+++ b/components/camel-gae/src/main/java/org/apache/camel/component/gae/task/GTaskEndpoint.java
@@ -39,10 +39,10 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
- * Represents a <a href="http://camel.apache.org/gtask.html">Google App Engine Task Queueing endpoint</a>.
+ * The gtask component is used for sending messages to GAE task queue service.
*/
@UriEndpoint(scheme = "gtask", extendsScheme = "servlet", title = "Google Task",
- syntax = "gtask:queueName", producerOnly = true, label = "cloud")
+ syntax = "gtask:queueName", producerOnly = true, label = "cloud,paas")
public class GTaskEndpoint extends ServletEndpoint implements OutboundBindingSupport<GTaskEndpoint, TaskOptions, Void> {
private OutboundBinding<GTaskEndpoint, TaskOptions, Void> outboundBinding;
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-ganglia/src/main/java/org/apache/camel/component/ganglia/GangliaEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-ganglia/src/main/java/org/apache/camel/component/ganglia/GangliaEndpoint.java b/components/camel-ganglia/src/main/java/org/apache/camel/component/ganglia/GangliaEndpoint.java
index 529b272..847e724 100644
--- a/components/camel-ganglia/src/main/java/org/apache/camel/component/ganglia/GangliaEndpoint.java
+++ b/components/camel-ganglia/src/main/java/org/apache/camel/component/ganglia/GangliaEndpoint.java
@@ -28,6 +28,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.util.ObjectHelper;
+/**
+ * The ganglia component is used for sending metrics to the Ganglia monitoring system.
+ */
@UriEndpoint(scheme = "ganglia", title = "Ganglia", syntax = "ganglia:host:port", producerOnly = true, label = "monitoring")
public class GangliaEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-geocoder/src/main/java/org/apache/camel/component/geocoder/GeoCoderEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-geocoder/src/main/java/org/apache/camel/component/geocoder/GeoCoderEndpoint.java b/components/camel-geocoder/src/main/java/org/apache/camel/component/geocoder/GeoCoderEndpoint.java
index a4c07d5..bf65e7b 100644
--- a/components/camel-geocoder/src/main/java/org/apache/camel/component/geocoder/GeoCoderEndpoint.java
+++ b/components/camel-geocoder/src/main/java/org/apache/camel/component/geocoder/GeoCoderEndpoint.java
@@ -25,7 +25,7 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
- * Represents a GeoCoder endpoint.
+ * The geocoder component is used for looking up geocodes (latitude and longitude) for a given address, or reverse lookup.
*/
@UriEndpoint(scheme = "geocoder", title = "Geocoder", syntax = "geocoder:address:latlng", producerOnly = true, label = "api,location")
public class GeoCoderEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-git/src/main/java/org/apache/camel/component/git/GitEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-git/src/main/java/org/apache/camel/component/git/GitEndpoint.java b/components/camel-git/src/main/java/org/apache/camel/component/git/GitEndpoint.java
index 2b11d10..505aa3f 100644
--- a/components/camel-git/src/main/java/org/apache/camel/component/git/GitEndpoint.java
+++ b/components/camel-git/src/main/java/org/apache/camel/component/git/GitEndpoint.java
@@ -30,6 +30,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
+/**
+ * The git component is used for working with git repositories.
+ */
@UriEndpoint(scheme = "git", title = "Git", syntax = "git:localpath", label = "file")
public class GitEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java b/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java
index e2edcf3..a76fee4 100644
--- a/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java
+++ b/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java
@@ -36,6 +36,8 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ObjectHelper;
/**
+ * The github component is used for integrating Camel with github.
+ *
* The endpoint encapsulates portions of the GitHub API, relying on the org.eclipse.egit.github.core Java SDK.
* Available endpoint URIs include:
*
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/GoogleCalendarEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/GoogleCalendarEndpoint.java b/components/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/GoogleCalendarEndpoint.java
index 13c3c87..e955f6c 100644
--- a/components/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/GoogleCalendarEndpoint.java
+++ b/components/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/GoogleCalendarEndpoint.java
@@ -34,7 +34,7 @@ import org.apache.camel.util.component.ApiMethod;
import org.apache.camel.util.component.ApiMethodPropertiesHelper;
/**
- * Represents a GoogleCalendar endpoint.
+ * The google-calendar component provides access to Google Calendar.
*/
@UriEndpoint(scheme = "google-calendar", title = "Google Calendar", syntax = "google-calendar:apiName/methodName",
consumerClass = GoogleCalendarConsumer.class, consumerPrefix = "consumer", label = "api,cloud")
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-google-drive/src/main/java/org/apache/camel/component/google/drive/GoogleDriveEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-google-drive/src/main/java/org/apache/camel/component/google/drive/GoogleDriveEndpoint.java b/components/camel-google-drive/src/main/java/org/apache/camel/component/google/drive/GoogleDriveEndpoint.java
index d6e509c..c6769f2 100644
--- a/components/camel-google-drive/src/main/java/org/apache/camel/component/google/drive/GoogleDriveEndpoint.java
+++ b/components/camel-google-drive/src/main/java/org/apache/camel/component/google/drive/GoogleDriveEndpoint.java
@@ -33,7 +33,7 @@ import org.apache.camel.util.component.ApiMethod;
import org.apache.camel.util.component.ApiMethodPropertiesHelper;
/**
- * Represents a GoogleDrive endpoint.
+ * The google-driverr component provides access to Google Drive file storage service.
*/
@UriEndpoint(scheme = "google-drive", title = "Google Drive", syntax = "google:drive:apiName/methodName",
consumerClass = GoogleDriveConsumer.class, consumerPrefix = "consumer", label = "api,cloud,file")
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/GoogleMailEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/GoogleMailEndpoint.java b/components/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/GoogleMailEndpoint.java
index 55a580a..a1333cf 100644
--- a/components/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/GoogleMailEndpoint.java
+++ b/components/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/GoogleMailEndpoint.java
@@ -34,7 +34,7 @@ import org.apache.camel.util.component.ApiMethod;
import org.apache.camel.util.component.ApiMethodPropertiesHelper;
/**
- * Represents a GoogleMail endpoint.
+ * The google-mail component provides access to Google Mail
*/
@UriEndpoint(scheme = "google-mail", title = "Google Mail", syntax = "google-mail:apiName/methodName", consumerClass = GoogleMailConsumer.class, consumerPrefix = "consumer", label = "api,cloud,mail")
public class GoogleMailEndpoint extends AbstractApiEndpoint<GoogleMailApiName, GoogleMailConfiguration> {
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraEndpoint.java b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraEndpoint.java
index 238786d..f72960f 100644
--- a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraEndpoint.java
+++ b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraEndpoint.java
@@ -14,7 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.camel.component.gora;
import org.apache.camel.Consumer;
@@ -25,21 +24,14 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.gora.persistency.Persistent;
import org.apache.gora.store.DataStore;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
/**
- * Gora endpoint
+ * The gora component allows you to work with NoSQL databases using the Apache Gora framework.
*/
@UriEndpoint(scheme = "gora", title = "Gora", syntax = "gora:name", consumerClass = GoraConsumer.class, label = "database,hadoop,nosql")
public class GoraEndpoint extends DefaultEndpoint {
/**
- * logger
- */
- private static final Logger LOG = LoggerFactory.getLogger(GoraEndpoint.class);
-
- /**
* Gora DataStore
*/
private final DataStore<Object, Persistent> dataStore;
@@ -68,39 +60,21 @@ public class GoraEndpoint extends DefaultEndpoint {
this.dataStore = dataStore;
}
- /**
- * {@inheritDoc}
- */
@Override
public Producer createProducer() throws Exception {
-
return new GoraProducer(this, this.configuration, this.dataStore);
}
- /**
- * {@inheritDoc}
- */
- @Override
public Consumer createConsumer(final Processor processor) throws Exception {
-
return new GoraConsumer(this, processor, this.configuration, this.dataStore);
}
- /**
- * Get Configutation
- *
- * @return
- */
public GoraConfiguration getConfiguration() {
return configuration;
}
- /**
- * {@inheritDoc}
- */
@Override
public boolean isSingleton() {
-
return true;
}
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java b/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java
index 2f45522..188640f 100644
--- a/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java
+++ b/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java
@@ -47,7 +47,7 @@ import org.apache.camel.util.ObjectHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-@UriEndpoint(scheme = "kubernetes", title = "Kubernetes", syntax = "kubernetes:master", label = "cloud,paas")
+@UriEndpoint(scheme = "kubernetes", title = "Kubernetes", syntax = "kubernetes:master", label = "container,cloud,paas")
public class KubernetesEndpoint extends DefaultEndpoint {
private static final Logger LOG = LoggerFactory.getLogger(KubernetesEndpoint.class);
http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-openshift/src/main/java/org/apache/camel/component/openshift/OpenShiftEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-openshift/src/main/java/org/apache/camel/component/openshift/OpenShiftEndpoint.java b/components/camel-openshift/src/main/java/org/apache/camel/component/openshift/OpenShiftEndpoint.java
index fb57ae9..03166bf 100644
--- a/components/camel-openshift/src/main/java/org/apache/camel/component/openshift/OpenShiftEndpoint.java
+++ b/components/camel-openshift/src/main/java/org/apache/camel/component/openshift/OpenShiftEndpoint.java
@@ -29,7 +29,7 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ObjectHelper;
-@UriEndpoint(scheme = "openshift", title = "OpenShift", syntax = "openshift:clientId", consumerClass = OpenShiftConsumer.class, label = "cloud")
+@UriEndpoint(scheme = "openshift", title = "OpenShift", syntax = "openshift:clientId", consumerClass = OpenShiftConsumer.class, label = "cloud,paas")
public class OpenShiftEndpoint extends ScheduledPollEndpoint {
@UriPath @Metadata(required = "true")
[07/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.
Posted by da...@apache.org.
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/e918b75e
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/e918b75e
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/e918b75e
Branch: refs/heads/master
Commit: e918b75e10bf3fa90919c00b10331066acd4989a
Parents: 87f2194
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 14:24:30 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:26 2015 +0100
----------------------------------------------------------------------
components/camel-ibatis/pom.xml | 2 +-
.../java/org/apache/camel/component/ibatis/IBatisEndpoint.java | 3 +--
.../apache/camel/component/infinispan/InfinispanEndpoint.java | 3 +++
.../main/java/org/apache/camel/component/irc/IrcEndpoint.java | 4 +---
components/camel-javaspace/pom.xml | 2 +-
.../org/apache/camel/component/javaspace/JavaSpaceEndpoint.java | 2 +-
.../main/java/org/apache/camel/component/jbpm/JBPMEndpoint.java | 3 +++
.../java/org/apache/camel/component/jclouds/JcloudsEndpoint.java | 3 +++
.../main/java/org/apache/camel/component/jcr/JcrEndpoint.java | 2 +-
.../main/java/org/apache/camel/component/jdbc/JdbcEndpoint.java | 2 +-
.../org/apache/camel/component/jetty8/JettyHttpEndpoint8.java | 3 +++
.../org/apache/camel/component/jetty9/JettyHttpEndpoint9.java | 3 +++
.../java/org/apache/camel/component/jgroups/JGroupsEndpoint.java | 3 +++
.../org/apache/camel/component/validator/jing/JingEndpoint.java | 3 +++
.../main/java/org/apache/camel/component/jira/JIRAEndpoint.java | 2 ++
.../main/java/org/apache/camel/component/jms/JmsEndpoint.java | 4 +---
.../main/java/org/apache/camel/component/jmx/JMXEndpoint.java | 2 ++
.../main/java/org/apache/camel/component/jolt/JoltEndpoint.java | 3 +++
.../main/java/org/apache/camel/component/jpa/JpaEndpoint.java | 3 +++
.../main/java/org/apache/camel/component/scp/ScpEndpoint.java | 2 +-
.../java/org/apache/camel/component/jt400/Jt400Endpoint.java | 3 +++
21 files changed, 43 insertions(+), 14 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-ibatis/pom.xml
----------------------------------------------------------------------
diff --git a/components/camel-ibatis/pom.xml b/components/camel-ibatis/pom.xml
index 6546699..84c6706 100644
--- a/components/camel-ibatis/pom.xml
+++ b/components/camel-ibatis/pom.xml
@@ -26,7 +26,7 @@
<artifactId>camel-ibatis</artifactId>
<packaging>bundle</packaging>
- <name>Camel :: iBatis</name>
+ <name>Camel :: iBatis (deprecated)</name>
<description>Camel iBatis support</description>
<properties>
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-ibatis/src/main/java/org/apache/camel/component/ibatis/IBatisEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-ibatis/src/main/java/org/apache/camel/component/ibatis/IBatisEndpoint.java b/components/camel-ibatis/src/main/java/org/apache/camel/component/ibatis/IBatisEndpoint.java
index 8cf7791..7e65c3f 100644
--- a/components/camel-ibatis/src/main/java/org/apache/camel/component/ibatis/IBatisEndpoint.java
+++ b/components/camel-ibatis/src/main/java/org/apache/camel/component/ibatis/IBatisEndpoint.java
@@ -32,8 +32,7 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ObjectHelper;
/**
- * An <a href="http://camel.apache.org/ibatis.html>iBatis Endpoint</a>
- * for performing SQL operations using an XML mapping file to abstract away the SQL
+ * Performs a query, poll, insert, update or delete in a relational database using Apache iBATIS
*/
@UriEndpoint(scheme = "ibatis", title = "iBatis", syntax = "ibatis:statement", consumerClass = IBatisConsumer.class, label = "database,sql")
public class IBatisEndpoint extends DefaultPollingEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-infinispan/src/main/java/org/apache/camel/component/infinispan/InfinispanEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-infinispan/src/main/java/org/apache/camel/component/infinispan/InfinispanEndpoint.java b/components/camel-infinispan/src/main/java/org/apache/camel/component/infinispan/InfinispanEndpoint.java
index 035d4e5..12c8d64 100644
--- a/components/camel-infinispan/src/main/java/org/apache/camel/component/infinispan/InfinispanEndpoint.java
+++ b/components/camel-infinispan/src/main/java/org/apache/camel/component/infinispan/InfinispanEndpoint.java
@@ -23,6 +23,9 @@ import org.apache.camel.impl.DefaultEndpoint;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
+/**
+ * For reading/writing from/to Infinispan distributed key/value store and data grid.
+ */
@UriEndpoint(scheme = "infinispan", title = "Infinispan", syntax = "infinispan:host", consumerClass = InfinispanConsumer.class, label = "cache,datagrid,clustering")
public class InfinispanEndpoint extends DefaultEndpoint {
@UriParam
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-irc/src/main/java/org/apache/camel/component/irc/IrcEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-irc/src/main/java/org/apache/camel/component/irc/IrcEndpoint.java b/components/camel-irc/src/main/java/org/apache/camel/component/irc/IrcEndpoint.java
index 6b63c94..fc16738 100644
--- a/components/camel-irc/src/main/java/org/apache/camel/component/irc/IrcEndpoint.java
+++ b/components/camel-irc/src/main/java/org/apache/camel/component/irc/IrcEndpoint.java
@@ -32,9 +32,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Defines the <a href="http://camel.apache.org/irc.html">IRC Endpoint</a>
- *
- * @version
+ * For IRC chat communication.
*/
@UriEndpoint(scheme = "irc", title = "IRC", syntax = "irc:hostname:port", consumerClass = IrcConsumer.class, label = "chat")
public class IrcEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-javaspace/pom.xml
----------------------------------------------------------------------
diff --git a/components/camel-javaspace/pom.xml b/components/camel-javaspace/pom.xml
index dece1b8..1dd4927 100644
--- a/components/camel-javaspace/pom.xml
+++ b/components/camel-javaspace/pom.xml
@@ -26,7 +26,7 @@
<artifactId>camel-javaspace</artifactId>
<packaging>bundle</packaging>
- <name>Camel :: Javaspace</name>
+ <name>Camel :: Javaspace (deprecated)</name>
<description>Camel Javaspace support</description>
<properties>
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-javaspace/src/main/java/org/apache/camel/component/javaspace/JavaSpaceEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-javaspace/src/main/java/org/apache/camel/component/javaspace/JavaSpaceEndpoint.java b/components/camel-javaspace/src/main/java/org/apache/camel/component/javaspace/JavaSpaceEndpoint.java
index cb64167..60ef607 100644
--- a/components/camel-javaspace/src/main/java/org/apache/camel/component/javaspace/JavaSpaceEndpoint.java
+++ b/components/camel-javaspace/src/main/java/org/apache/camel/component/javaspace/JavaSpaceEndpoint.java
@@ -26,7 +26,7 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
- * @version
+ * Sending and receiving messages through JavaSpace.
*/
@UriEndpoint(scheme = "javaspace", title = "JavaSpace", syntax = "javaspace:url", consumerClass = JavaSpaceConsumer.class, label = "messaging")
public class JavaSpaceEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-jbpm/src/main/java/org/apache/camel/component/jbpm/JBPMEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-jbpm/src/main/java/org/apache/camel/component/jbpm/JBPMEndpoint.java b/components/camel-jbpm/src/main/java/org/apache/camel/component/jbpm/JBPMEndpoint.java
index 453e66c..a63e23d 100644
--- a/components/camel-jbpm/src/main/java/org/apache/camel/component/jbpm/JBPMEndpoint.java
+++ b/components/camel-jbpm/src/main/java/org/apache/camel/component/jbpm/JBPMEndpoint.java
@@ -31,6 +31,9 @@ import org.kie.services.client.api.RemoteRuntimeEngineFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * The jbpm component provides integration with jBPM (Business Process Management)
+ */
@UriEndpoint(scheme = "jbpm", title = "JBPM", syntax = "jbpm:host", producerOnly = true, label = "process")
public class JBPMEndpoint extends DefaultEndpoint {
private static final transient Logger LOGGER = LoggerFactory.getLogger(JBPMEndpoint.class);
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-jclouds/src/main/java/org/apache/camel/component/jclouds/JcloudsEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-jclouds/src/main/java/org/apache/camel/component/jclouds/JcloudsEndpoint.java b/components/camel-jclouds/src/main/java/org/apache/camel/component/jclouds/JcloudsEndpoint.java
index 00d0a90..43a8525 100644
--- a/components/camel-jclouds/src/main/java/org/apache/camel/component/jclouds/JcloudsEndpoint.java
+++ b/components/camel-jclouds/src/main/java/org/apache/camel/component/jclouds/JcloudsEndpoint.java
@@ -20,6 +20,9 @@ import org.apache.camel.impl.DefaultEndpoint;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
+/**
+ * For interacting with cloud compute & blobstore service via jclouds.
+ */
@UriEndpoint(scheme = "jclouds", title = "JClouds", syntax = "jclouds:command:providerId", consumerClass = JcloudsConsumer.class, label = "api,cloud")
public abstract class JcloudsEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-jcr/src/main/java/org/apache/camel/component/jcr/JcrEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-jcr/src/main/java/org/apache/camel/component/jcr/JcrEndpoint.java b/components/camel-jcr/src/main/java/org/apache/camel/component/jcr/JcrEndpoint.java
index b736726..961c8f3 100644
--- a/components/camel-jcr/src/main/java/org/apache/camel/component/jcr/JcrEndpoint.java
+++ b/components/camel-jcr/src/main/java/org/apache/camel/component/jcr/JcrEndpoint.java
@@ -34,7 +34,7 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ObjectHelper;
/**
- * A JCR endpoint
+ * The jcr component allows you to add/read nodes to/from a JCR compliant content repository.
*/
@UriEndpoint(scheme = "jcr", title = "JCR", syntax = "jcr:host/base", consumerClass = JcrConsumer.class, label = "cms,database")
public class JcrEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-jdbc/src/main/java/org/apache/camel/component/jdbc/JdbcEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-jdbc/src/main/java/org/apache/camel/component/jdbc/JdbcEndpoint.java b/components/camel-jdbc/src/main/java/org/apache/camel/component/jdbc/JdbcEndpoint.java
index aedd920..c6afd0a 100755
--- a/components/camel-jdbc/src/main/java/org/apache/camel/component/jdbc/JdbcEndpoint.java
+++ b/components/camel-jdbc/src/main/java/org/apache/camel/component/jdbc/JdbcEndpoint.java
@@ -30,7 +30,7 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
- * @version
+ * The jdbc component enables you to access databases through JDBC, where SQL queries are sent in the message body.
*/
@UriEndpoint(scheme = "jdbc", title = "JDBC", syntax = "jdbc:dataSourceName", producerOnly = true, label = "database,sql")
public class JdbcEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-jetty8/src/main/java/org/apache/camel/component/jetty8/JettyHttpEndpoint8.java
----------------------------------------------------------------------
diff --git a/components/camel-jetty8/src/main/java/org/apache/camel/component/jetty8/JettyHttpEndpoint8.java b/components/camel-jetty8/src/main/java/org/apache/camel/component/jetty8/JettyHttpEndpoint8.java
index 59f8637..d8c76c4 100644
--- a/components/camel-jetty8/src/main/java/org/apache/camel/component/jetty8/JettyHttpEndpoint8.java
+++ b/components/camel-jetty8/src/main/java/org/apache/camel/component/jetty8/JettyHttpEndpoint8.java
@@ -25,6 +25,9 @@ import org.apache.camel.component.jetty.JettyHttpEndpoint;
import org.apache.camel.http.common.HttpConsumer;
import org.apache.camel.spi.UriEndpoint;
+/**
+ * The jetty component provides HTTP-based endpoints for consuming and producing HTTP requests.
+ */
@UriEndpoint(scheme = "jetty", extendsScheme = "http", title = "Jetty",
syntax = "jetty:httpUri", consumerClass = HttpConsumer.class, label = "http")
public class JettyHttpEndpoint8 extends JettyHttpEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-jetty9/src/main/java/org/apache/camel/component/jetty9/JettyHttpEndpoint9.java
----------------------------------------------------------------------
diff --git a/components/camel-jetty9/src/main/java/org/apache/camel/component/jetty9/JettyHttpEndpoint9.java b/components/camel-jetty9/src/main/java/org/apache/camel/component/jetty9/JettyHttpEndpoint9.java
index b6f46dd..30d62ab 100644
--- a/components/camel-jetty9/src/main/java/org/apache/camel/component/jetty9/JettyHttpEndpoint9.java
+++ b/components/camel-jetty9/src/main/java/org/apache/camel/component/jetty9/JettyHttpEndpoint9.java
@@ -26,6 +26,9 @@ import org.apache.camel.http.common.HttpBinding;
import org.apache.camel.http.common.HttpConsumer;
import org.apache.camel.spi.UriEndpoint;
+/**
+ * The jetty component provides HTTP-based endpoints for consuming and producing HTTP requests.
+ */
@UriEndpoint(scheme = "jetty", extendsScheme = "http", title = "Jetty 9",
syntax = "jetty:httpUri", consumerClass = HttpConsumer.class, label = "http")
public class JettyHttpEndpoint9 extends JettyHttpEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsEndpoint.java b/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsEndpoint.java
index ea32da8..14e3838 100644
--- a/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsEndpoint.java
+++ b/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsEndpoint.java
@@ -35,6 +35,9 @@ import org.jgroups.View;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * The jgroups component provides exchange of messages between Camel and JGroups clusters.
+ */
@UriEndpoint(scheme = "jgroups", title = "JGroups", syntax = "jgroups:clusterName", consumerClass = JGroupsConsumer.class, label = "clustering,messaging")
public class JGroupsEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-jing/src/main/java/org/apache/camel/component/validator/jing/JingEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-jing/src/main/java/org/apache/camel/component/validator/jing/JingEndpoint.java b/components/camel-jing/src/main/java/org/apache/camel/component/validator/jing/JingEndpoint.java
index 56eb0d8..7934efe 100644
--- a/components/camel-jing/src/main/java/org/apache/camel/component/validator/jing/JingEndpoint.java
+++ b/components/camel-jing/src/main/java/org/apache/camel/component/validator/jing/JingEndpoint.java
@@ -36,6 +36,9 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ObjectHelper;
import org.apache.camel.util.ResourceHelper;
+/**
+ * Validates the payload of a message using RelaxNG Syntax using Jing library.
+ */
@UriEndpoint(scheme = "jing", title = "Jing", syntax = "jing:resourceUri", producerOnly = true, label = "validation")
public class JingEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-jira/src/main/java/org/apache/camel/component/jira/JIRAEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-jira/src/main/java/org/apache/camel/component/jira/JIRAEndpoint.java b/components/camel-jira/src/main/java/org/apache/camel/component/jira/JIRAEndpoint.java
index faa23c7..be09cc4 100644
--- a/components/camel-jira/src/main/java/org/apache/camel/component/jira/JIRAEndpoint.java
+++ b/components/camel-jira/src/main/java/org/apache/camel/component/jira/JIRAEndpoint.java
@@ -29,6 +29,8 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
+ * The jira component interacts with the JIRA issue tracker.
+ *
* The endpoint encapsulates portions of the JIRA API, relying on the jira-rest-java-client SDK.
* Available endpoint URIs include:
*
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsEndpoint.java b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsEndpoint.java
index 36f982a..bd57c2d 100644
--- a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsEndpoint.java
+++ b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsEndpoint.java
@@ -63,9 +63,7 @@ import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.util.ErrorHandler;
/**
- * A <a href="http://activemq.apache.org/jms.html">JMS Endpoint</a>
- *
- * @version
+ * The jms component allows messages to be sent to (or consumed from) a JMS Queue or Topic.
*/
@ManagedResource(description = "Managed JMS Endpoint")
@UriEndpoint(scheme = "jms", title = "JMS", syntax = "jms:destinationType:destinationName", consumerClass = JmsConsumer.class, label = "messaging")
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-jmx/src/main/java/org/apache/camel/component/jmx/JMXEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-jmx/src/main/java/org/apache/camel/component/jmx/JMXEndpoint.java b/components/camel-jmx/src/main/java/org/apache/camel/component/jmx/JMXEndpoint.java
index 4522bc6..20fadc7 100644
--- a/components/camel-jmx/src/main/java/org/apache/camel/component/jmx/JMXEndpoint.java
+++ b/components/camel-jmx/src/main/java/org/apache/camel/component/jmx/JMXEndpoint.java
@@ -32,6 +32,8 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ObjectHelper;
/**
+ * The jmx component allows to receive JMX notifications.
+ *
* Endpoint that describes a connection to an mbean.
* <p/>
* The component can connect to the local platform mbean server with the following URI:
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-jolt/src/main/java/org/apache/camel/component/jolt/JoltEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-jolt/src/main/java/org/apache/camel/component/jolt/JoltEndpoint.java b/components/camel-jolt/src/main/java/org/apache/camel/component/jolt/JoltEndpoint.java
index ebc0837..b75ce70 100644
--- a/components/camel-jolt/src/main/java/org/apache/camel/component/jolt/JoltEndpoint.java
+++ b/components/camel-jolt/src/main/java/org/apache/camel/component/jolt/JoltEndpoint.java
@@ -34,6 +34,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.util.ObjectHelper;
+/**
+ * The jolt component allows you to process a JSON messages using an JOLT specification (such as JSON-JSON transformation).
+ */
@UriEndpoint(scheme = "jolt", title = "JOLT", syntax = "jolt:resourceUri", producerOnly = true, label = "transformation")
public class JoltEndpoint extends ResourceEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-jpa/src/main/java/org/apache/camel/component/jpa/JpaEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-jpa/src/main/java/org/apache/camel/component/jpa/JpaEndpoint.java b/components/camel-jpa/src/main/java/org/apache/camel/component/jpa/JpaEndpoint.java
index 655845e..5df8112 100644
--- a/components/camel-jpa/src/main/java/org/apache/camel/component/jpa/JpaEndpoint.java
+++ b/components/camel-jpa/src/main/java/org/apache/camel/component/jpa/JpaEndpoint.java
@@ -43,6 +43,9 @@ import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.transaction.TransactionDefinition;
import org.springframework.transaction.support.TransactionTemplate;
+/**
+ * The jpa component enables you to store and retrieve Java objects from databases using JPA.
+ */
@UriEndpoint(scheme = "jpa", title = "JPA", syntax = "jpa:entityType", consumerClass = JpaConsumer.class, label = "database,sql")
public class JpaEndpoint extends ScheduledPollEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-jsch/src/main/java/org/apache/camel/component/scp/ScpEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-jsch/src/main/java/org/apache/camel/component/scp/ScpEndpoint.java b/components/camel-jsch/src/main/java/org/apache/camel/component/scp/ScpEndpoint.java
index 80bb6fb..3925660 100644
--- a/components/camel-jsch/src/main/java/org/apache/camel/component/scp/ScpEndpoint.java
+++ b/components/camel-jsch/src/main/java/org/apache/camel/component/scp/ScpEndpoint.java
@@ -26,7 +26,7 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
/**
- * Secure Copy Endpoint
+ * To copy files using the secure copy protocol (SCP).
*/
@UriEndpoint(scheme = "scp", extendsScheme = "ftp", title = "SCP",
syntax = "scp:host:port/directoryName", producerOnly = true, label = "file")
http://git-wip-us.apache.org/repos/asf/camel/blob/e918b75e/components/camel-jt400/src/main/java/org/apache/camel/component/jt400/Jt400Endpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-jt400/src/main/java/org/apache/camel/component/jt400/Jt400Endpoint.java b/components/camel-jt400/src/main/java/org/apache/camel/component/jt400/Jt400Endpoint.java
index c102ed7..bfc5ac7 100644
--- a/components/camel-jt400/src/main/java/org/apache/camel/component/jt400/Jt400Endpoint.java
+++ b/components/camel-jt400/src/main/java/org/apache/camel/component/jt400/Jt400Endpoint.java
@@ -33,6 +33,9 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.util.ObjectHelper;
import org.apache.camel.util.URISupport;
+/**
+ * The jt400 component allows you to exchanges messages with an AS/400 system using data queues or program call.
+ */
@UriEndpoint(scheme = "jt400", title = "JT400", syntax = "jt400:userID:password/systemName/objectPath.type", consumerClass = Jt400DataQueueConsumer.class, label = "messaging")
public class Jt400Endpoint extends DefaultPollingEndpoint {
[20/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.
Posted by da...@apache.org.
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/fcfd7bd5
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/fcfd7bd5
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/fcfd7bd5
Branch: refs/heads/master
Commit: fcfd7bd50fab00f2c8464739fed603bc17746b1c
Parents: bd6f3f4
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 18:28:17 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:28:17 2015 +0100
----------------------------------------------------------------------
.../src/main/java/org/apache/camel/component/sip/SipEndpoint.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/fcfd7bd5/components/camel-sip/src/main/java/org/apache/camel/component/sip/SipEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-sip/src/main/java/org/apache/camel/component/sip/SipEndpoint.java b/components/camel-sip/src/main/java/org/apache/camel/component/sip/SipEndpoint.java
index 5a59e0c..503318e 100644
--- a/components/camel-sip/src/main/java/org/apache/camel/component/sip/SipEndpoint.java
+++ b/components/camel-sip/src/main/java/org/apache/camel/component/sip/SipEndpoint.java
@@ -27,7 +27,7 @@ import org.apache.camel.spi.UriParam;
/**
* To send and receive messages using the SIP protocol (used in telco and mobile).
*/
-@UriEndpoint(scheme = "sip,sips", title = "SIP (Session Initiation Protocol)", syntax = "sip:uri", label = "mobile")
+@UriEndpoint(scheme = "sip,sips", title = "SIP", syntax = "sip:uri", label = "mobile")
public class SipEndpoint extends DefaultEndpoint {
@UriParam
private SipConfiguration configuration;
[03/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.
Posted by da...@apache.org.
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/bbbdb64d
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/bbbdb64d
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/bbbdb64d
Branch: refs/heads/master
Commit: bbbdb64d302f49dd73e42b44670994ca32cd9b23
Parents: 3ebf187
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 11:45:23 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:24 2015 +0100
----------------------------------------------------------------------
.../org/apache/camel/component/bean/BeanComponent.java | 2 --
.../org/apache/camel/component/bean/BeanEndpoint.java | 4 +---
.../apache/camel/component/beanclass/ClassEndpoint.java | 2 +-
.../apache/camel/component/binding/BindingEndpoint.java | 10 ++++++++++
.../org/apache/camel/component/browse/BrowseEndpoint.java | 5 ++---
.../camel/component/controlbus/ControlBusEndpoint.java | 4 +++-
.../camel/component/dataformat/DataFormatEndpoint.java | 3 +++
.../apache/camel/component/dataset/DataSetEndpoint.java | 5 +++--
.../org/apache/camel/component/direct/DirectEndpoint.java | 5 ++---
.../apache/camel/component/directvm/DirectVmEndpoint.java | 4 +++-
.../org/apache/camel/component/file/FileEndpoint.java | 2 +-
.../apache/camel/component/language/LanguageEndpoint.java | 10 ++++++++--
.../java/org/apache/camel/component/log/LogEndpoint.java | 4 +++-
.../org/apache/camel/component/mock/MockEndpoint.java | 2 ++
.../java/org/apache/camel/component/ref/RefEndpoint.java | 3 +++
.../org/apache/camel/component/rest/RestApiEndpoint.java | 3 +++
.../org/apache/camel/component/rest/RestEndpoint.java | 3 +++
.../camel/component/scheduler/SchedulerEndpoint.java | 6 ++++++
.../org/apache/camel/component/seda/SedaEndpoint.java | 4 +---
.../org/apache/camel/component/stub/StubEndpoint.java | 10 ++++++++++
.../org/apache/camel/component/test/TestEndpoint.java | 10 ++++++----
.../org/apache/camel/component/timer/TimerEndpoint.java | 4 ++--
.../camel/component/validator/ValidatorEndpoint.java | 3 +++
.../java/org/apache/camel/component/vm/VmEndpoint.java | 3 +++
.../org/apache/camel/component/xslt/XsltEndpoint.java | 3 +++
.../org/apache/camel/component/aws/cw/CwComponent.java | 3 ---
.../org/apache/camel/component/aws/cw/CwEndpoint.java | 3 +++
.../org/apache/camel/component/aws/ddb/DdbComponent.java | 3 ---
.../org/apache/camel/component/aws/ddb/DdbEndpoint.java | 3 +++
.../camel/component/aws/ddbstream/DdbStreamComponent.java | 3 ---
.../camel/component/aws/ddbstream/DdbStreamEndpoint.java | 3 +++
.../org/apache/camel/component/aws/ec2/EC2Endpoint.java | 3 +++
.../camel/component/aws/kinesis/KinesisComponent.java | 3 ---
.../camel/component/aws/kinesis/KinesisEndpoint.java | 3 +++
.../org/apache/camel/component/aws/s3/S3Component.java | 3 ---
.../org/apache/camel/component/aws/s3/S3Endpoint.java | 3 +--
.../org/apache/camel/component/aws/sdb/SdbComponent.java | 3 ---
.../org/apache/camel/component/aws/sdb/SdbEndpoint.java | 3 +++
.../org/apache/camel/component/aws/ses/SesComponent.java | 3 ---
.../org/apache/camel/component/aws/ses/SesEndpoint.java | 3 +++
.../org/apache/camel/component/aws/sns/SnsComponent.java | 3 ---
.../org/apache/camel/component/aws/sns/SnsEndpoint.java | 3 +++
.../org/apache/camel/component/aws/sqs/SqsComponent.java | 3 ---
.../org/apache/camel/component/aws/sqs/SqsEndpoint.java | 3 +++
.../org/apache/camel/component/aws/swf/SWFComponent.java | 3 ---
.../org/apache/camel/component/aws/swf/SWFEndpoint.java | 3 +++
.../org/apache/camel/commands/CatalogCommandTest.java | 1 +
.../camel/tools/apt/EndpointAnnotationProcessor.java | 10 +++++-----
48 files changed, 122 insertions(+), 66 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/bean/BeanComponent.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/bean/BeanComponent.java b/camel-core/src/main/java/org/apache/camel/component/bean/BeanComponent.java
index 24d04c8..6e54402 100644
--- a/camel-core/src/main/java/org/apache/camel/component/bean/BeanComponent.java
+++ b/camel-core/src/main/java/org/apache/camel/component/bean/BeanComponent.java
@@ -26,8 +26,6 @@ import org.slf4j.LoggerFactory;
/**
* The <a href="http://camel.apache.org/bean.html">Bean Component</a> is for invoking Java beans from Camel.
- *
- * @version
*/
public class BeanComponent extends UriEndpointComponent {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java
index 5a7c880..a42f664 100644
--- a/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java
@@ -30,9 +30,7 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
- * Endpoint for the bean component.
- *
- * @version
+ * The <a href="http://camel.apache.org/bean.html">Bean Component</a> is for invoking Java beans from Camel.
*/
@UriEndpoint(scheme = "bean", title = "Bean", syntax = "bean:beanName", producerOnly = true, label = "core,java")
public class BeanEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/beanclass/ClassEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/beanclass/ClassEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/beanclass/ClassEndpoint.java
index 577091c..23b1807 100644
--- a/camel-core/src/main/java/org/apache/camel/component/beanclass/ClassEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/beanclass/ClassEndpoint.java
@@ -21,7 +21,7 @@ import org.apache.camel.component.bean.BeanEndpoint;
import org.apache.camel.spi.UriEndpoint;
/**
- * Endpoint for the class component.
+ * The <a href="http://camel.apache.org/class.html">Class Component</a> is for invoking Java Classes (Java beans) from Camel.
*/
@UriEndpoint(scheme = "class", title = "Class", syntax = "class:beanName", label = "core,java")
public class ClassEndpoint extends BeanEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/binding/BindingEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/binding/BindingEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/binding/BindingEndpoint.java
index 228d05b..10032a8 100644
--- a/camel-core/src/main/java/org/apache/camel/component/binding/BindingEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/binding/BindingEndpoint.java
@@ -36,6 +36,16 @@ import org.apache.camel.util.ServiceHelper;
import static org.apache.camel.util.CamelContextHelper.getMandatoryEndpoint;
/**
+ * The binding component is used for as a of wrapping an Endpoint in a contract with a data format.
+ *
+ * In Camel terms a binding is a way of wrapping an Endpoint in a contract; such as a Data Format,
+ * a Content Enricher or validation step. Bindings are completely optional and you can choose to use
+ * them on any camel endpoint.
+ * Bindings are inspired by the work of SwitchYard project adding service contracts to various technologies
+ * like Camel and many others. But rather than the SwitchYard approach of wrapping Camel in SCA,
+ * Camel Bindings provide a way of wrapping Camel endpoints with contracts inside the Camel framework itself;
+ * so you can use them easily inside any Camel route.
+ *
* Applies a {@link org.apache.camel.spi.Binding} to an underlying {@link Endpoint} so that the binding processes messages
* before its sent to the endpoint and processes messages received by the endpoint consumer before its passed
* to the real consumer.
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/browse/BrowseEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/browse/BrowseEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/browse/BrowseEndpoint.java
index 257f67b..786e20e 100644
--- a/camel-core/src/main/java/org/apache/camel/component/browse/BrowseEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/browse/BrowseEndpoint.java
@@ -35,10 +35,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriPath;
/**
- * An endpoint which maintains a {@link List} of {@link Exchange} instances
- * which can be useful for tooling, debugging and visualising routes.
+ * The browse component is used for viewsing the messages received on endpoints that supports {@link BrowsableEndpoint}.
*
- * @version
+ * This can be useful for testing, visualisation tools or debugging. he exchanges sent to the endpoint are all available to be browsed.
*/
@UriEndpoint(scheme = "browse", title = "Browse", syntax = "browse:name", label = "core,monitoring")
public class BrowseEndpoint extends DefaultEndpoint implements BrowsableEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/controlbus/ControlBusEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/controlbus/ControlBusEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/controlbus/ControlBusEndpoint.java
index 6bf67e3..4bdff83 100644
--- a/camel-core/src/main/java/org/apache/camel/component/controlbus/ControlBusEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/controlbus/ControlBusEndpoint.java
@@ -31,7 +31,9 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.util.CamelLogger;
/**
- * The control bus endpoint.
+ * The controlbus component provides easy management of Camel applications based on the Control Bus EIP pattern.
+ *
+ * For example, by sending a message to an Endpoint you can control the lifecycle of routes, or gather performance statistics.
*/
@UriEndpoint(scheme = "controlbus", title = "Control Bus", syntax = "controlbus:command:language", producerOnly = true, label = "core,monitoring")
public class ControlBusEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/dataformat/DataFormatEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/dataformat/DataFormatEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/dataformat/DataFormatEndpoint.java
index 394f718..5db3bfd 100644
--- a/camel-core/src/main/java/org/apache/camel/component/dataformat/DataFormatEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/dataformat/DataFormatEndpoint.java
@@ -32,6 +32,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ServiceHelper;
+/**
+ * The dataformat component is used for working with Data Formats as if it was a regular Component supporting Endpoints and URIs.
+ */
@UriEndpoint(scheme = "dataformat", title = "Data Format", syntax = "dataformat:name:operation", producerOnly = true, label = "core,transformation")
public class DataFormatEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java
index 129196c..10653ec 100644
--- a/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java
@@ -38,9 +38,10 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Endpoint for DataSet.
+ * The DataSet component provides a mechanism to easily perform load & soak testing of your system.
*
- * @version
+ * It works by allowing you to create DataSet instances both as a source of messages and as a way to assert that the data set is received.
+ * Camel will use the throughput logger when sending dataset's.
*/
@UriEndpoint(scheme = "dataset", title = "Dataset", syntax = "dataset:name", consumerClass = DataSetConsumer.class, label = "core,testing")
public class DataSetEndpoint extends MockEndpoint implements Service {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/direct/DirectEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/direct/DirectEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/direct/DirectEndpoint.java
index 52925e7..9512875 100644
--- a/camel-core/src/main/java/org/apache/camel/component/direct/DirectEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/direct/DirectEndpoint.java
@@ -31,10 +31,9 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ObjectHelper;
/**
- * Represents a direct endpoint that synchronously invokes the consumer of the
- * endpoint when a producer sends a message to it.
+ * The direct component provides direct, synchronous call to another endpoint from the same CamelContext.
*
- * @version
+ * This endpoint can be used to connect existing routes in the same CamelContext.
*/
@UriEndpoint(scheme = "direct", title = "Direct", syntax = "direct:name", consumerClass = DirectConsumer.class, label = "core,endpoint")
public class DirectEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/directvm/DirectVmEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/directvm/DirectVmEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/directvm/DirectVmEndpoint.java
index 8489c6c..db5d1c3 100644
--- a/camel-core/src/main/java/org/apache/camel/component/directvm/DirectVmEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/directvm/DirectVmEndpoint.java
@@ -27,7 +27,9 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
- * The direct-vm endpoint.
+ * The direct-vm component provides direct, synchronous call to another endpoint from any CamelContext in the same JVM.
+ *
+ * This endpoint can be used to connect existing routes in the same JVM between different CamelContexts.
*/
@UriEndpoint(scheme = "direct-vm", title = "Direct VM", syntax = "direct-vm:name", consumerClass = DirectConsumer.class, label = "core,endpoint")
public class DirectVmEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/file/FileEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/file/FileEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/file/FileEndpoint.java
index 7a8b273..94802f6 100644
--- a/camel-core/src/main/java/org/apache/camel/component/file/FileEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/file/FileEndpoint.java
@@ -31,7 +31,7 @@ import org.apache.camel.util.FileUtil;
import org.apache.camel.util.ObjectHelper;
/**
- * File endpoint.
+ * The file component is used for reading or writing files.
*/
@UriEndpoint(scheme = "file", title = "File", syntax = "file:directoryName", consumerClass = FileConsumer.class, label = "core,file")
public class FileEndpoint extends GenericFileEndpoint<File> {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/language/LanguageEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/language/LanguageEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/language/LanguageEndpoint.java
index 9a7ec70..851ee50 100644
--- a/camel-core/src/main/java/org/apache/camel/component/language/LanguageEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/language/LanguageEndpoint.java
@@ -38,9 +38,15 @@ import org.apache.camel.util.ObjectHelper;
import org.apache.camel.util.ResourceHelper;
/**
- * Language endpoint.
+ * The language component allows you to send a message to an endpoint which executes a script by any of the supported Languages in Camel.
*
- * @version
+ * By having a component to execute language scripts, it allows more dynamic routing capabilities.
+ * For example by using the Routing Slip or Dynamic Router EIPs you can send messages to language endpoints
+ * where the script is dynamic defined as well.
+ *
+ * This component is provided out of the box in camel-core and hence no additional JARs is needed.
+ * You only have to include additional Camel components if the language of choice mandates it,
+ * such as using Groovy or JavaScript languages.
*/
@UriEndpoint(scheme = "language", title = "Language", syntax = "language:languageName", producerOnly = true, label = "core,script")
public class LanguageEndpoint extends ResourceEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/log/LogEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/log/LogEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/log/LogEndpoint.java
index f89faed..f1e5c10 100644
--- a/camel-core/src/main/java/org/apache/camel/component/log/LogEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/log/LogEndpoint.java
@@ -35,7 +35,9 @@ import org.apache.camel.util.ServiceHelper;
import org.slf4j.Logger;
/**
- * Logger endpoint.
+ * The log component logs message exchanges to the underlying logging mechanism.
+ *
+ * Camel uses sfl4j which allows you to configure logging to the actual logging system.
*/
@UriEndpoint(scheme = "log", title = "Log", syntax = "log:loggerName", producerOnly = true, label = "core,monitoring")
public class LogEndpoint extends ProcessorEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/mock/MockEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/mock/MockEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/mock/MockEndpoint.java
index 672e902..ab4801d 100644
--- a/camel-core/src/main/java/org/apache/camel/component/mock/MockEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/mock/MockEndpoint.java
@@ -64,6 +64,8 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
+ * The mock component is used for testing routes and mediation rules using mocks.
+ * <p/>
* A Mock endpoint which provides a literate, fluent API for testing routes
* using a <a href="http://jmock.org/">JMock style</a> API.
* <p/>
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/ref/RefEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/ref/RefEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/ref/RefEndpoint.java
index d3ca293..d1ca0b6 100644
--- a/camel-core/src/main/java/org/apache/camel/component/ref/RefEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/ref/RefEndpoint.java
@@ -28,6 +28,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriPath;
import org.apache.camel.util.CamelContextHelper;
+/**
+ * The ref component is used for lookup of existing endpoints bound in the Registry.
+ */
@UriEndpoint(scheme = "ref", title = "Ref", syntax = "ref:name", label = "core,endpoint")
public class RefEndpoint extends DefaultEndpoint implements DelegateEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/rest/RestApiEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/rest/RestApiEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/rest/RestApiEndpoint.java
index f2ee48d..274678e 100644
--- a/camel-core/src/main/java/org/apache/camel/component/rest/RestApiEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/rest/RestApiEndpoint.java
@@ -38,6 +38,9 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.util.HostUtils;
import org.apache.camel.util.ObjectHelper;
+/**
+ * The rest-api component is used for providing Swagger API of the REST services which has been defined using the rest-dsl in Camel.
+ */
@UriEndpoint(scheme = "rest-api", title = "REST API", syntax = "rest-api:path/contextId", consumerOnly = true, label = "core,rest")
public class RestApiEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/rest/RestEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/rest/RestEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/rest/RestEndpoint.java
index f17110d..cf97592 100644
--- a/camel-core/src/main/java/org/apache/camel/component/rest/RestEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/rest/RestEndpoint.java
@@ -35,6 +35,9 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.util.HostUtils;
import org.apache.camel.util.ObjectHelper;
+/**
+ * The rest component is used for hosting REST services which has been defined using the rest-dsl in Camel.
+ */
@UriEndpoint(scheme = "rest", title = "REST", syntax = "rest:method:path:uriTemplate", consumerOnly = true, label = "core,rest")
public class RestEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/scheduler/SchedulerEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/scheduler/SchedulerEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/scheduler/SchedulerEndpoint.java
index 13b32c9..8f03af8 100644
--- a/camel-core/src/main/java/org/apache/camel/component/scheduler/SchedulerEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/scheduler/SchedulerEndpoint.java
@@ -27,6 +27,12 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
+/**
+ * The scheduler component is used for generating message exchanges when a scheduler fires.
+ *
+ * This component is similar to the timer component, but it offers more functionality in terms of scheduling.
+ * Also this component uses JDK ScheduledExecutorService. Where as the timer uses a JDK Timer.
+ */
@UriEndpoint(scheme = "scheduler", title = "Scheduler", syntax = "scheduler:name", consumerOnly = true, consumerClass = SchedulerConsumer.class, label = "core,scheduling")
public class SchedulerEndpoint extends ScheduledPollEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/seda/SedaEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/seda/SedaEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/seda/SedaEndpoint.java
index 23f6d91..4d04342 100644
--- a/camel-core/src/main/java/org/apache/camel/component/seda/SedaEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/seda/SedaEndpoint.java
@@ -48,9 +48,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * An implementation of the <a
- * href="http://camel.apache.org/queue.html">Queue components</a> for
- * asynchronous SEDA exchanges on a {@link BlockingQueue} within a CamelContext
+ * The seda component provides asynchronous call to another endpoint from any CamelContext in the same JVM.
*/
@ManagedResource(description = "Managed SedaEndpoint")
@UriEndpoint(scheme = "seda", title = "SEDA", syntax = "seda:name", consumerClass = SedaConsumer.class, label = "core,endpoint")
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/stub/StubEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/stub/StubEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/stub/StubEndpoint.java
index 594437b..abb64e8 100644
--- a/camel-core/src/main/java/org/apache/camel/component/stub/StubEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/stub/StubEndpoint.java
@@ -26,6 +26,16 @@ import org.apache.camel.component.vm.VmConsumer;
import org.apache.camel.component.vm.VmEndpoint;
import org.apache.camel.spi.UriEndpoint;
+/**
+ * The stub: component provides a simple way to stub out any physical endpoints while in development or testing.
+ *
+ * For example to run a route without needing to actually connect to a specific SMTP or Http endpoint.
+ * Just add stub: in front of any endpoint URI to stub out the endpoint.
+ * Internally the Stub component creates VM endpoints. The main difference between Stub and VM is that VM
+ * will validate the URI and parameters you give it, so putting vm: in front of a typical URI with
+ * query arguments will usually fail. Stub won't though, as it basically ignores all query parameters
+ * to let you quickly stub out one or more endpoints in your route temporarily.
+ */
@UriEndpoint(scheme = "stub", title = "Stub", syntax = "stub:name", consumerClass = VmConsumer.class, label = "core,testing")
public class StubEndpoint extends VmEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/test/TestEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/test/TestEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/test/TestEndpoint.java
index a61efd1..3326cb5 100644
--- a/camel-core/src/main/java/org/apache/camel/component/test/TestEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/test/TestEndpoint.java
@@ -33,11 +33,13 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * A <a href="http://camel.apache.org/test.html">Test Endpoint</a> is a
- * <a href="http://camel.apache.org/mock.html">Mock Endpoint</a> for testing but it will
- * pull all messages from the nested endpoint and use those as expected message body assertions.
+ * The test component extends the mock component to support pulling messages from another endpoint on startup to set the expected message bodies.
*
- * @version
+ * That is, you use the test endpoint in a route and messages arriving on it will be implicitly compared to some
+ * expected messages extracted from some other location.
+ * So you can use, for example, an expected set of message bodies as files.
+ * This will then set up a properly configured Mock endpoint, which is only valid if the received messages
+ * match the number of expected messages and their message payloads are equal.
*/
@UriEndpoint(scheme = "test", title = "Test", syntax = "test:name", producerOnly = true, label = "core,testing")
public class TestEndpoint extends MockEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/timer/TimerEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/timer/TimerEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/timer/TimerEndpoint.java
index b88583d..4b0c6b4 100644
--- a/camel-core/src/main/java/org/apache/camel/component/timer/TimerEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/timer/TimerEndpoint.java
@@ -34,9 +34,9 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
- * Represents a timer endpoint that can generate periodic inbound exchanges triggered by a timer.
+ * The timer component is used for generating message exchanges when a timer fires.
*
- * @version
+ * This component is similar to the scheduler component, but has much less functionality.
*/
@ManagedResource(description = "Managed TimerEndpoint")
@UriEndpoint(scheme = "timer", title = "Timer", syntax = "timer:timerName", consumerOnly = true, consumerClass = TimerConsumer.class, label = "core,scheduling")
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorEndpoint.java
index 3eb3fd3..88d4b83 100644
--- a/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorEndpoint.java
@@ -40,6 +40,9 @@ import org.apache.camel.util.ResourceHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Validates the payload of a message using XML Schema and JAXP Validation
+ */
@UriEndpoint(scheme = "validator", title = "Validator", syntax = "validator:resourceUri", producerOnly = true, label = "core,validation")
public class ValidatorEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/vm/VmEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/vm/VmEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/vm/VmEndpoint.java
index b483521..bd5fa0e 100644
--- a/camel-core/src/main/java/org/apache/camel/component/vm/VmEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/vm/VmEndpoint.java
@@ -25,6 +25,9 @@ import org.apache.camel.component.seda.BlockingQueueFactory;
import org.apache.camel.component.seda.SedaEndpoint;
import org.apache.camel.spi.UriEndpoint;
+/**
+ * The vm component provides asynchronous call to another endpoint from the same CamelContext.
+ */
@UriEndpoint(scheme = "vm", title = "VM", syntax = "vm:name", consumerClass = VmConsumer.class, label = "core,endpoint")
public class VmEndpoint extends SedaEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/xslt/XsltEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/xslt/XsltEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/xslt/XsltEndpoint.java
index 7aa5fa5..4eaaf5b 100644
--- a/camel-core/src/main/java/org/apache/camel/component/xslt/XsltEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/xslt/XsltEndpoint.java
@@ -43,6 +43,9 @@ import org.apache.camel.util.ServiceHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Generates a response using an XSLT template
+ */
@ManagedResource(description = "Managed XsltEndpoint")
@UriEndpoint(scheme = "xslt", title = "XSLT", syntax = "xslt:resourceUri", producerOnly = true, label = "core,transformation")
public class XsltEndpoint extends ProcessorEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/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 85e4f76..06e106a 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
@@ -22,9 +22,6 @@ import org.apache.camel.CamelContext;
import org.apache.camel.Endpoint;
import org.apache.camel.impl.UriEndpointComponent;
-/**
- * For working with Amazon's CloudWatch (CW).
- */
public class CwComponent extends UriEndpointComponent {
public CwComponent() {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/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 b33b09d..b26288b 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,6 +32,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.util.ObjectHelper;
+/**
+ * The aws-cw component is used for sending metrics to an Amazon CloudWatch.
+ */
@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/bbbdb64d/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 7523d62..156ff4d 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
@@ -22,9 +22,6 @@ import org.apache.camel.CamelContext;
import org.apache.camel.Endpoint;
import org.apache.camel.impl.UriEndpointComponent;
-/**
- * For working with Amazon's DynamoDB (DDB).
- */
public class DdbComponent extends UriEndpointComponent {
public DdbComponent() {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/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 e238528..d6d3066 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,6 +42,9 @@ import org.apache.camel.util.ObjectHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * The aws-ddb component is used for storing and retrieving data from Amazon's DynamoDB service.
+ */
@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/bbbdb64d/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 b7bad44..ed384e4 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,9 +23,6 @@ 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);
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamEndpoint.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamEndpoint.java
index bc12bc6..6691ad6 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamEndpoint.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamEndpoint.java
@@ -29,6 +29,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
+/**
+ * The aws-ddbstream component is used for working with Amazon DynamoDB Streams
+ */
@UriEndpoint(scheme = "aws-ddbstream", title = "AWS DynamoDB Streams",
consumerOnly = true, syntax = "aws-ddbstream:tableName",
consumerClass = DdbStreamConsumer.class, label = "cloud,messaging,streams")
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/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 6098959..45a7ccb 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,6 +30,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.util.ObjectHelper;
+/**
+ * The aws-ec2 is used for managing Amazon EC2 instances
+ */
@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/bbbdb64d/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 0bcd285..9740600 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,9 +24,6 @@ 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/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisEndpoint.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisEndpoint.java
index b041a85..249944d 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisEndpoint.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisEndpoint.java
@@ -29,6 +29,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
+/**
+ * The aws-kinesis component is for consuming records from Amazon Kinesis Streams
+ */
@UriEndpoint(scheme = "aws-kinesis", title = "AWS Kinesis", syntax = "aws-kinesis:streamName", consumerOnly = true, consumerClass = KinesisConsumer.class, label = "cloud,messaging")
public class KinesisEndpoint extends ScheduledPollEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/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 86cf1e5..aa99b09 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
@@ -22,9 +22,6 @@ import org.apache.camel.CamelContext;
import org.apache.camel.Endpoint;
import org.apache.camel.impl.UriEndpointComponent;
-/**
- * For working with Amazon's Simple Storage Service (S3).
- */
public class S3Component extends UriEndpointComponent {
public S3Component() {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/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 1698c77..82273be 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
@@ -35,7 +35,6 @@ import org.apache.camel.ExchangePattern;
import org.apache.camel.Message;
import org.apache.camel.Processor;
import org.apache.camel.Producer;
-import org.apache.camel.impl.DefaultExchange;
import org.apache.camel.impl.ScheduledPollEndpoint;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
@@ -44,7 +43,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Defines the <a href="http://camel.apache.org/aws.html">AWS S3 Endpoint</a>.
+ * The aws-s3 component is used for storing and retrieving objetc from Amazon S3 Storage Service.
*/
@UriEndpoint(scheme = "aws-s3", title = "AWS S3 Storage Service", syntax = "aws-s3:bucketName", consumerClass = S3Consumer.class, label = "cloud,file")
public class S3Endpoint extends ScheduledPollEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/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 92182f9..18c44d3 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
@@ -22,9 +22,6 @@ import org.apache.camel.CamelContext;
import org.apache.camel.Endpoint;
import org.apache.camel.impl.UriEndpointComponent;
-/**
- * For working with Amazon's SimpleDB (SDB).
- */
public class SdbComponent extends UriEndpointComponent {
public SdbComponent() {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/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 05fc371..f72d1c3 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,6 +38,9 @@ import org.apache.camel.util.ObjectHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * The aws-sdb component is for storing and retrieving data from/to Amazon's SDB service.
+ */
@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/bbbdb64d/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 3afeade..d330533 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
@@ -22,9 +22,6 @@ import org.apache.camel.CamelContext;
import org.apache.camel.Endpoint;
import org.apache.camel.impl.UriEndpointComponent;
-/**
- * For working with Amazon's Simple Email Service (SES).
- */
public class SesComponent extends UriEndpointComponent {
public SesComponent() {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/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 1366cf8..577e19d 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,6 +32,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.util.ObjectHelper;
+/**
+ * The aws-ses component is used for sending emails with Amazon's SES service.
+ */
@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/bbbdb64d/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 1f1eaf3..f3e1812 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
@@ -22,9 +22,6 @@ import org.apache.camel.CamelContext;
import org.apache.camel.Endpoint;
import org.apache.camel.impl.UriEndpointComponent;
-/**
- * For Messaging with Amazon's Simple Notification Service (SNS).
- */
public class SnsComponent extends UriEndpointComponent {
public SnsComponent() {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/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 0458a44..2e295fa 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,6 +37,9 @@ import org.apache.camel.util.ObjectHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * The aws-sns component is used for sending messages to an Amazon Simple Notification Topic
+ */
@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/bbbdb64d/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 df55176..37dcbe3 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
@@ -22,9 +22,6 @@ import org.apache.camel.CamelContext;
import org.apache.camel.Endpoint;
import org.apache.camel.impl.UriEndpointComponent;
-/**
- * For Messaging with Amazon's Simple Queue Service (SQS).
- */
public class SqsComponent extends UriEndpointComponent {
public SqsComponent() {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/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 6872efd..fcfcc3a 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,6 +50,9 @@ import org.apache.camel.util.ObjectHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * The aws-sqs component is used for sending and receiving messages to Amazon's SQS service.
+ */
@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/bbbdb64d/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 7a1a9ae..eadfc02 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
@@ -22,9 +22,6 @@ import org.apache.camel.Endpoint;
import org.apache.camel.impl.UriEndpointComponent;
import org.apache.camel.util.IntrospectionSupport;
-/**
- * For Messaging with Amazon's Simple Workflow Service (SWF).
- */
public class SWFComponent extends UriEndpointComponent {
public SWFComponent() {
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/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 8ecaca3..86bb519 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,6 +32,9 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.util.EndpointHelper;
import org.apache.camel.util.ExchangeHelper;
+/**
+ * The aws-swf component is used for managing workflows from Amazon Simple Workflow.
+ */
@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/bbbdb64d/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
index be4b941..af5cc97 100644
--- 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
@@ -50,6 +50,7 @@ public class CatalogCommandTest {
String out = os.toString();
assertNotNull(out);
LOG.info("\n\n{}\n", out);
+ System.out.println(out);
context.stop();
}
http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/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 61e5dbc..ba05e20 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
@@ -433,12 +433,12 @@ public class EndpointAnnotationProcessor extends AbstractAnnotationProcessor {
Map<String, String> map = parseAsMap(data);
// now we have a lot more data, so we need to load it as key/value
// need to sanitize the description first
- String doc = map.get("projectDescription");
- if (doc != null) {
- model.setDescription(sanitizeDescription(doc, true));
- } else {
+// String doc = map.get("projectDescription");
+// if (doc != null) {
+// model.setDescription(sanitizeDescription(doc, true));
+// } else {
model.setDescription("");
- }
+// }
if (map.containsKey("groupId")) {
model.setGroupId(map.get("groupId"));
} else {
[02/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.
Posted by da...@apache.org.
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/31162f9c
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/31162f9c
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/31162f9c
Branch: refs/heads/master
Commit: 31162f9c0141ae6fe0a67719a90f23ea35fde324
Parents: bbbdb64
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 12:43:59 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:24 2015 +0100
----------------------------------------------------------------------
.../apache/camel/component/dataset/DataSetEndpoint.java | 2 +-
.../org/apache/camel/component/ahc/ws/WsComponent.java | 2 +-
.../org/apache/camel/component/ahc/ws/WsEndpoint.java | 3 +++
.../java/org/apache/camel/component/ahc/AhcEndpoint.java | 3 +++
.../org/apache/camel/component/amqp/AMQPEndpoint.java | 4 +++-
.../org/apache/camel/component/apns/ApnsEndpoint.java | 3 +++
.../component/atmosphere/websocket/WebsocketEndpoint.java | 2 +-
.../org/apache/camel/component/atom/AtomEndpoint.java | 3 +++
.../org/apache/camel/component/avro/AvroComponent.java | 3 ---
.../org/apache/camel/component/avro/AvroEndpoint.java | 3 +++
.../component/bean/validator/BeanValidatorEndpoint.java | 5 +++++
.../camel/component/beanstalk/BeanstalkEndpoint.java | 3 +++
.../java/org/apache/camel/component/box/BoxEndpoint.java | 2 +-
.../org/apache/camel/component/cache/CacheEndpoint.java | 10 ++++++++--
.../camel/component/cassandra/CassandraEndpoint.java | 5 +++--
.../org/apache/camel/component/chunk/ChunkEndpoint.java | 3 +++
.../org/apache/camel/component/cmis/CMISEndpoint.java | 2 +-
.../src/main/java/org/apache/camel/coap/CoAPEndpoint.java | 2 +-
.../org/apache/camel/component/cometd/CometdEndpoint.java | 5 ++++-
.../apache/camel/component/context/ContextEndpoint.java | 9 +++++++++
.../apache/camel/component/couchdb/CouchDbEndpoint.java | 3 +++
.../camel/component/crypto/DigitalSignatureEndpoint.java | 3 +++
.../java/org/apache/camel/component/cxf/CxfEndpoint.java | 7 +------
.../apache/camel/component/cxf/jaxrs/CxfRsEndpoint.java | 3 +++
.../camel/tools/apt/EndpointAnnotationProcessor.java | 2 +-
25 files changed, 70 insertions(+), 22 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java
index 10653ec..7f9d5ca 100644
--- a/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java
@@ -38,7 +38,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * The DataSet component provides a mechanism to easily perform load & soak testing of your system.
+ * The dataset component provides a mechanism to easily perform load & soak testing of your system.
*
* It works by allowing you to create DataSet instances both as a source of messages and as a way to assert that the data set is received.
* Camel will use the throughput logger when sending dataset's.
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/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 7d557a5..6fe85b9 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;
/**
- * To exchange data with external Websocket servers using <a href="http://github.com/sonatype/async-http-client">Async Http Client</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/31162f9c/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 77ed754..7f2c8a3 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
@@ -38,6 +38,9 @@ import org.apache.camel.spi.UriParam;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * To exchange data with external Websocket servers using <a href="http://github.com/sonatype/async-http-client">Async Http Client</a>
+ */
@UriEndpoint(scheme = "ahc-ws,ahc-wss", extendsScheme = "ahc,ahc", title = "AHC Websocket,AHC Secure Websocket",
syntax = "ahc-ws:httpUri", consumerClass = WsConsumer.class, label = "websocket")
public class WsEndpoint extends AhcEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-ahc/src/main/java/org/apache/camel/component/ahc/AhcEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-ahc/src/main/java/org/apache/camel/component/ahc/AhcEndpoint.java b/components/camel-ahc/src/main/java/org/apache/camel/component/ahc/AhcEndpoint.java
index eb42d0a..001740f 100644
--- a/components/camel-ahc/src/main/java/org/apache/camel/component/ahc/AhcEndpoint.java
+++ b/components/camel-ahc/src/main/java/org/apache/camel/component/ahc/AhcEndpoint.java
@@ -34,6 +34,9 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ObjectHelper;
import org.apache.camel.util.jsse.SSLContextParameters;
+/**
+ * To call external HTTP services using <a href="http://github.com/sonatype/async-http-client">Async Http Client</a>
+ */
@UriEndpoint(scheme = "ahc", title = "AHC", syntax = "ahc:httpUri", producerOnly = true, label = "http")
public class AhcEndpoint extends DefaultEndpoint implements HeaderFilterStrategyAware {
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/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 a06fee8..ec6e95a 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
@@ -21,7 +21,9 @@ import org.apache.camel.component.jms.JmsEndpoint;
import org.apache.camel.spi.UriEndpoint;
/**
- * AMQP endpoint. This class extends JmsEndpoint because it uses Apache Qpid JMS-compatible client for
+ * Messaging with AMQP protocol using Apache QPid Client.
+ *
+ * This class extends JmsEndpoint because it uses Apache Qpid JMS-compatible client for
* performing the AMQP connectivity.
*/
@UriEndpoint(scheme = "amqp", extendsScheme = "jms", title = "AMQP",
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-apns/src/main/java/org/apache/camel/component/apns/ApnsEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-apns/src/main/java/org/apache/camel/component/apns/ApnsEndpoint.java b/components/camel-apns/src/main/java/org/apache/camel/component/apns/ApnsEndpoint.java
index e859c01..180b066 100644
--- a/components/camel-apns/src/main/java/org/apache/camel/component/apns/ApnsEndpoint.java
+++ b/components/camel-apns/src/main/java/org/apache/camel/component/apns/ApnsEndpoint.java
@@ -29,6 +29,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
+/**
+ * For sending notifications to Apple iOS devices
+ */
@UriEndpoint(scheme = "apns", title = "APNS", syntax = "apns:name", consumerClass = ApnsConsumer.class, label = "eventbus,mobile")
public class ApnsEndpoint extends ScheduledPollEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-atmosphere-websocket/src/main/java/org/apache/camel/component/atmosphere/websocket/WebsocketEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-atmosphere-websocket/src/main/java/org/apache/camel/component/atmosphere/websocket/WebsocketEndpoint.java b/components/camel-atmosphere-websocket/src/main/java/org/apache/camel/component/atmosphere/websocket/WebsocketEndpoint.java
index cdb7ff2..170658d 100644
--- a/components/camel-atmosphere-websocket/src/main/java/org/apache/camel/component/atmosphere/websocket/WebsocketEndpoint.java
+++ b/components/camel-atmosphere-websocket/src/main/java/org/apache/camel/component/atmosphere/websocket/WebsocketEndpoint.java
@@ -29,7 +29,7 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
- *
+ * To exchange data with external Websocket clients using Atmosphere
*/
@UriEndpoint(scheme = "atmosphere-websocket", extendsScheme = "servlet", title = "Atmosphere Websocket",
syntax = "atmosphere-websocket:servicePath", consumerClass = WebsocketConsumer.class, label = "websocket")
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/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 d5600f4..92dc434 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,6 +26,9 @@ import org.apache.camel.component.feed.FeedEndpoint;
import org.apache.camel.component.feed.FeedPollingConsumer;
import org.apache.camel.spi.UriEndpoint;
+/**
+ * The atom component is used for consuming Atom RSS feeds.
+ */
@UriEndpoint(scheme = "atom", title = "Atom", syntax = "atom:feedUri", consumerOnly = true, consumerClass = FeedPollingConsumer.class, label = "rss")
public class AtomEndpoint extends FeedEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/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 6406af2..108348b 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,9 +30,6 @@ 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/31162f9c/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroEndpoint.java b/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroEndpoint.java
index a24e937..8ea5720 100644
--- a/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroEndpoint.java
+++ b/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroEndpoint.java
@@ -28,6 +28,9 @@ import org.apache.camel.impl.DefaultEndpoint;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
+/**
+ * Working with Apache Avro for data serialization.
+ */
@UriEndpoint(scheme = "avro", title = "Avro", syntax = "avro:transport:host:port/messageName", consumerClass = AvroConsumer.class, label = "messaging,transformation")
public abstract class AvroEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-bean-validator/src/main/java/org/apache/camel/component/bean/validator/BeanValidatorEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-bean-validator/src/main/java/org/apache/camel/component/bean/validator/BeanValidatorEndpoint.java b/components/camel-bean-validator/src/main/java/org/apache/camel/component/bean/validator/BeanValidatorEndpoint.java
index 7faaab4..bec6729 100644
--- a/components/camel-bean-validator/src/main/java/org/apache/camel/component/bean/validator/BeanValidatorEndpoint.java
+++ b/components/camel-bean-validator/src/main/java/org/apache/camel/component/bean/validator/BeanValidatorEndpoint.java
@@ -35,6 +35,11 @@ import org.apache.camel.util.PlatformHelper;
import static org.apache.camel.component.bean.validator.ValidatorFactories.buildValidatorFactory;
+/**
+ * The Validator component performs bean validation of the message body using the Java Bean Validation API.
+ *
+ * Camel uses the reference implementation, which is Hibernate Validator.
+ */
@UriEndpoint(scheme = "bean-validator", title = "Bean Validator", syntax = "bean-validator:label", producerOnly = true, label = "validation")
public class BeanValidatorEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-beanstalk/src/main/java/org/apache/camel/component/beanstalk/BeanstalkEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-beanstalk/src/main/java/org/apache/camel/component/beanstalk/BeanstalkEndpoint.java b/components/camel-beanstalk/src/main/java/org/apache/camel/component/beanstalk/BeanstalkEndpoint.java
index be7bfbe..3fe4f77 100644
--- a/components/camel-beanstalk/src/main/java/org/apache/camel/component/beanstalk/BeanstalkEndpoint.java
+++ b/components/camel-beanstalk/src/main/java/org/apache/camel/component/beanstalk/BeanstalkEndpoint.java
@@ -33,6 +33,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
+/**
+ * The beanstalk component is used for job retrieval and post-processing of Beanstalk jobs.
+ */
@UriEndpoint(scheme = "beanstalk", title = "Beanstalk", syntax = "beanstalk:connectionSettings", consumerClass = BeanstalkConsumer.class, label = "messaging")
public class BeanstalkEndpoint extends ScheduledPollEndpoint {
final ConnectionSettings conn;
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-box/src/main/java/org/apache/camel/component/box/BoxEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-box/src/main/java/org/apache/camel/component/box/BoxEndpoint.java b/components/camel-box/src/main/java/org/apache/camel/component/box/BoxEndpoint.java
index 89219d8..1b987b3 100644
--- a/components/camel-box/src/main/java/org/apache/camel/component/box/BoxEndpoint.java
+++ b/components/camel-box/src/main/java/org/apache/camel/component/box/BoxEndpoint.java
@@ -37,7 +37,7 @@ import org.apache.camel.util.component.ApiMethod;
import org.apache.camel.util.component.ApiMethodPropertiesHelper;
/**
- * Represents a Box endpoint.
+ * For uploading, downloading and managing files, folders, groups, collaborations, etc on box DOT com.
*/
@UriEndpoint(scheme = "box", title = "Box", syntax = "box:apiName/methodName", consumerClass = BoxConsumer.class, consumerPrefix = "consumer", label = "api,file,cloud")
public class BoxEndpoint extends AbstractApiEndpoint<BoxApiName, BoxConfiguration> {
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-cache/src/main/java/org/apache/camel/component/cache/CacheEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-cache/src/main/java/org/apache/camel/component/cache/CacheEndpoint.java b/components/camel-cache/src/main/java/org/apache/camel/component/cache/CacheEndpoint.java
index fd42b57..45335f3 100755
--- a/components/camel-cache/src/main/java/org/apache/camel/component/cache/CacheEndpoint.java
+++ b/components/camel-cache/src/main/java/org/apache/camel/component/cache/CacheEndpoint.java
@@ -28,14 +28,20 @@ import org.apache.camel.Message;
import org.apache.camel.Processor;
import org.apache.camel.Producer;
import org.apache.camel.impl.DefaultEndpoint;
-import org.apache.camel.impl.DefaultExchange;
-import org.apache.camel.impl.DefaultMessage;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.util.ObjectHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * The cache component enables you to perform caching operations using EHCache as the Cache Implementation.
+ *
+ * The cache itself is created on demand or if a cache of that name already exists then it is simply utilized with its original settings.
+ * This component supports producer and event based consumer endpoints.
+ * The Cache consumer is an event based consumer and can be used to listen and respond to specific cache activities.
+ * If you need to perform selections from a pre-existing cache, use the processors defined for the cache component.
+ */
@UriEndpoint(scheme = "cache", title = "EHCache", syntax = "cache:cacheName", consumerClass = CacheConsumer.class, label = "cache")
public class CacheEndpoint extends DefaultEndpoint {
private static final Logger LOG = LoggerFactory.getLogger(CacheEndpoint.class);
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraEndpoint.java b/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraEndpoint.java
index 95ab660..6aa6abf 100644
--- a/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraEndpoint.java
+++ b/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraEndpoint.java
@@ -21,7 +21,6 @@ import com.datastax.driver.core.ConsistencyLevel;
import com.datastax.driver.core.PreparedStatement;
import com.datastax.driver.core.ResultSet;
import com.datastax.driver.core.Session;
-import com.datastax.driver.core.policies.LoadBalancingPolicy;
import org.apache.camel.Component;
import org.apache.camel.Consumer;
@@ -37,7 +36,9 @@ import org.apache.camel.utils.cassandra.CassandraLoadBalancingPolicies;
import org.apache.camel.utils.cassandra.CassandraSessionHolder;
/**
- * Cassandra 2 CQL3 endpoint
+ * The cql component aims at integrating Cassandra 2.0+ using the CQL3 API (not the Thrift API).
+ *
+ * It's based on Cassandra Java Driver provided by DataStax.
*/
@UriEndpoint(scheme = "cql", title = "Cassandra CQL", syntax = "cql:beanRef:hosts:port/keyspace", consumerClass = CassandraConsumer.class, label = "database,nosql")
public class CassandraEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkEndpoint.java b/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkEndpoint.java
index 30edf0f..2d37586 100644
--- a/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkEndpoint.java
+++ b/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkEndpoint.java
@@ -40,6 +40,9 @@ import static org.apache.camel.component.chunk.ChunkConstants.CHUNK_LAYER_SEPARA
import static org.apache.camel.component.chunk.ChunkConstants.CHUNK_RESOURCE_URI;
import static org.apache.camel.component.chunk.ChunkConstants.CHUNK_TEMPLATE;
+/**
+ * Generates a response using a Chunk template
+ */
@UriEndpoint(scheme = "chunk", title = "Chunk", syntax = "chunk:resourceUri", producerOnly = true, label = "transformation")
public class ChunkEndpoint extends ResourceEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-cmis/src/main/java/org/apache/camel/component/cmis/CMISEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-cmis/src/main/java/org/apache/camel/component/cmis/CMISEndpoint.java b/components/camel-cmis/src/main/java/org/apache/camel/component/cmis/CMISEndpoint.java
index bc700cc..c66f7b9 100644
--- a/components/camel-cmis/src/main/java/org/apache/camel/component/cmis/CMISEndpoint.java
+++ b/components/camel-cmis/src/main/java/org/apache/camel/component/cmis/CMISEndpoint.java
@@ -24,7 +24,7 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
/**
- * Represents a CMIS endpoint.
+ * The cmis component uses the Apache Chemistry client API and allows you to add/read nodes to/from a CMIS compliant content repositories.
*/
@UriEndpoint(scheme = "cmis", title = "CMIS", syntax = "cmis:url", consumerClass = CMISConsumer.class, label = "cms,database")
public class CMISEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-coap/src/main/java/org/apache/camel/coap/CoAPEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-coap/src/main/java/org/apache/camel/coap/CoAPEndpoint.java b/components/camel-coap/src/main/java/org/apache/camel/coap/CoAPEndpoint.java
index 758a329..7976d53 100644
--- a/components/camel-coap/src/main/java/org/apache/camel/coap/CoAPEndpoint.java
+++ b/components/camel-coap/src/main/java/org/apache/camel/coap/CoAPEndpoint.java
@@ -28,7 +28,7 @@ import org.apache.camel.spi.UriPath;
import org.eclipse.californium.core.CoapServer;
/**
- * Represents a CoAP endpoint.
+ * The coap component is used for sending and receiving messages from COAP capable devices.
*/
@UriEndpoint(scheme = "coap", title = "CoAP", syntax = "coap:uri", consumerClass = CoAPConsumer.class, label = "iot")
public class CoAPEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java
index 43d2a35..a20b3b4 100644
--- a/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java
+++ b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java
@@ -31,7 +31,10 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ObjectHelper;
/**
- * Endpoint for Camel Cometd.
+ * The cometd component is a transport for working with the Jetty implementation of the cometd/bayeux protocol.
+ *
+ * Using this component in combination with the dojo toolkit library it's possible to push Camel messages directly
+ * into the browser using an AJAX based mechanism.
*/
@UriEndpoint(scheme = "cometd,cometds", title = "CometD", syntax = "cometd:host:port/channelName", consumerClass = CometdConsumer.class, label = "websocket")
public class CometdEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-context/src/main/java/org/apache/camel/component/context/ContextEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-context/src/main/java/org/apache/camel/component/context/ContextEndpoint.java b/components/camel-context/src/main/java/org/apache/camel/component/context/ContextEndpoint.java
index 49dfddd..36ad929 100644
--- a/components/camel-context/src/main/java/org/apache/camel/component/context/ContextEndpoint.java
+++ b/components/camel-context/src/main/java/org/apache/camel/component/context/ContextEndpoint.java
@@ -27,6 +27,15 @@ import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriPath;
+/**
+ * The context component allows to send/receive messages between Camel routes in a black box way.
+ *
+ * The context component allows you to create new Camel Components from a CamelContext with a number of
+ * routes which is then treated as a black box, allowing you to refer to the local endpoints within the component
+ * from other CamelContexts.
+ * It is similar to the Routebox component in idea, though the Context component tries to be really simple for end users;
+ * just a simple convention over configuration approach to refer to local endpoints inside the CamelContext Component.
+ */
@UriEndpoint(scheme = "context", title = "Camel Context", syntax = "context:contextId:localEndpointUrl", label = "endpoint")
public class ContextEndpoint extends DefaultEndpoint implements DelegateEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-couchdb/src/main/java/org/apache/camel/component/couchdb/CouchDbEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-couchdb/src/main/java/org/apache/camel/component/couchdb/CouchDbEndpoint.java b/components/camel-couchdb/src/main/java/org/apache/camel/component/couchdb/CouchDbEndpoint.java
index 231d95a..005ad4d 100644
--- a/components/camel-couchdb/src/main/java/org/apache/camel/component/couchdb/CouchDbEndpoint.java
+++ b/components/camel-couchdb/src/main/java/org/apache/camel/component/couchdb/CouchDbEndpoint.java
@@ -30,6 +30,9 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
import org.lightcouch.CouchDbClient;
+/**
+ * The couchdb component is used for integrate with CouchDB databases.
+ */
@UriEndpoint(scheme = "couchdb", title = "CouchDB", syntax = "couchdb:protocol:hostname:port/database", consumerClass = CouchDbConsumer.class, label = "database,nosql")
public class CouchDbEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java b/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java
index a33dedc..a390e3e 100644
--- a/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java
+++ b/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java
@@ -31,6 +31,9 @@ import org.apache.camel.impl.DefaultEndpoint;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
+/**
+ * The crypto component is used for signing and verifying exchanges using the Signature Service of the Java Cryptographic Extension (JCE).
+ */
@UriEndpoint(scheme = "crypto", title = "Crypto (Java Cryptographic Extension)", syntax = "crypto:cryptoOperation", producerOnly = true, label = "security,transformation")
public class DigitalSignatureEndpoint extends DefaultEndpoint {
@UriParam
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/CxfEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/CxfEndpoint.java b/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/CxfEndpoint.java
index db78e81..c462321 100644
--- a/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/CxfEndpoint.java
+++ b/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/CxfEndpoint.java
@@ -108,13 +108,8 @@ import org.apache.cxf.wsdl.WSDLManager;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-
-
/**
- * Defines the <a href="http://camel.apache.org/cxf.html">CXF Endpoint</a>.
- * It contains a list of properties for CXF endpoint including {@link DataFormat},
- * {@link CxfBinding}, and {@link HeaderFilterStrategy}. The default DataFormat
- * mode is {@link DataFormat#POJO}.
+ * The cxf component is used for SOAP WebServices using Apache CXF.
*/
@UriEndpoint(scheme = "cxf", title = "CXF", syntax = "cxf:beanId:address", consumerClass = CxfConsumer.class, label = "soap,webservice")
public class CxfEndpoint extends DefaultEndpoint implements HeaderFilterStrategyAware, Service, Cloneable {
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/jaxrs/CxfRsEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/jaxrs/CxfRsEndpoint.java b/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/jaxrs/CxfRsEndpoint.java
index c3251fa..21b6ef8 100644
--- a/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/jaxrs/CxfRsEndpoint.java
+++ b/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/jaxrs/CxfRsEndpoint.java
@@ -56,6 +56,9 @@ import org.apache.cxf.message.Message;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * The cxfrs component is used for JAX-RS REST services using Apache CXF.
+ */
@UriEndpoint(scheme = "cxfrs", title = "CXF-RS", syntax = "cxfrs:beanId:address", consumerClass = CxfRsConsumer.class, label = "rest")
public class CxfRsEndpoint extends DefaultEndpoint implements HeaderFilterStrategyAware, Service {
http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/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 ba05e20..b9f4ca6 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
@@ -437,7 +437,7 @@ public class EndpointAnnotationProcessor extends AbstractAnnotationProcessor {
// if (doc != null) {
// model.setDescription(sanitizeDescription(doc, true));
// } else {
- model.setDescription("");
+ model.setDescription("TODO");
// }
if (map.containsKey("groupId")) {
model.setGroupId(map.get("groupId"));
[11/20] camel git commit: camel-kestrel upgraded and use JAR from
maven central
Posted by da...@apache.org.
camel-kestrel upgraded and use JAR from maven central
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/ddbc7b41
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/ddbc7b41
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/ddbc7b41
Branch: refs/heads/master
Commit: ddbc7b41bb6fd1ae4423cc5974db119f0a44d4bd
Parents: e918b75
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 14:52:15 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:27 2015 +0100
----------------------------------------------------------------------
components/camel-kestrel/pom.xml | 17 ++---------------
parent/pom.xml | 2 +-
2 files changed, 3 insertions(+), 16 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/ddbc7b41/components/camel-kestrel/pom.xml
----------------------------------------------------------------------
diff --git a/components/camel-kestrel/pom.xml b/components/camel-kestrel/pom.xml
index 494d12f..e543619 100644
--- a/components/camel-kestrel/pom.xml
+++ b/components/camel-kestrel/pom.xml
@@ -26,7 +26,7 @@
<artifactId>camel-kestrel</artifactId>
<packaging>bundle</packaging>
- <name>Camel :: Kestrel</name>
+ <name>Camel :: Kestrel (deprecated)</name>
<description>Camel Kestrel support</description>
<properties>
@@ -34,19 +34,6 @@
<camel.osgi.export.service>org.apache.camel.spi.ComponentResolver;component=kestrel</camel.osgi.export.service>
</properties>
- <!-- TODO: we should use SMX bundle JAR -->
- <repositories>
- <repository>
- <id>couchbase.repo</id>
- <name>Couchbase Repository</name>
- <layout>default</layout>
- <url>http://files.couchbase.com/maven2/</url>
- <snapshots>
- <enabled>false</enabled>
- </snapshots>
- </repository>
- </repositories>
-
<dependencies>
<dependency>
@@ -55,7 +42,7 @@
</dependency>
<dependency>
- <groupId>spy</groupId>
+ <groupId>net.spy</groupId>
<artifactId>spymemcached</artifactId>
<version>${spymemcached-version}</version>
</dependency>
http://git-wip-us.apache.org/repos/asf/camel/blob/ddbc7b41/parent/pom.xml
----------------------------------------------------------------------
diff --git a/parent/pom.xml b/parent/pom.xml
index 8a330b5..8ec0441 100644
--- a/parent/pom.xml
+++ b/parent/pom.xml
@@ -495,7 +495,7 @@
<spring-ws-bundle-version>2.2.2.RELEASE_1</spring-ws-bundle-version>
<spring-ws-version>2.2.2.RELEASE</spring-ws-version>
<spymemcached-bundle-version>2.5_2</spymemcached-bundle-version> <!-- FIXME cmueller: not in sync! -->
- <spymemcached-version>2.8.4</spymemcached-version>
+ <spymemcached-version>2.12.0</spymemcached-version>
<squareup-okhttp-version>2.6.0</squareup-okhttp-version>
<squareup-okio-version>1.6.0</squareup-okio-version>
<sshd-version>0.14.0</sshd-version>
Re: [06/20] camel git commit: CAMEL-9452: Camel-Elasticsearch:
Support Multisearch operation
Posted by Claus Ibsen <cl...@gmail.com>.
Hi
I only noticed because IDEA said there was a potential issue here,
while I had all the components opened to improve their component docs
descriptions.
On Sun, Dec 27, 2015 at 8:21 PM, Andrea Cosentino
<an...@yahoo.com.invalid> wrote:
> Sorry. My mistake.
>
> Inviato da Yahoo Mail su Android
>
> Il dom, 27 dic, 2015 alle 18:28, davsclaus@apache.org<da...@apache.org> ha scritto: CAMEL-9452: Camel-Elasticsearch: Support Multisearch operation
>
>
> Project: http://git-wip-us.apache.org/repos/asf/camel/repo
> Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/0c1d4b77
> Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/0c1d4b77
> Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/0c1d4b77
>
> Branch: refs/heads/master
> Commit: 0c1d4b77848394d4bf2d681440f1c5334b682ec3
> Parents: 31162f9
> Author: Claus Ibsen <da...@apache.org>
> Authored: Sun Dec 27 13:17:57 2015 +0100
> Committer: Claus Ibsen <da...@apache.org>
> Committed: Sun Dec 27 18:25:25 2015 +0100
>
> ----------------------------------------------------------------------
> .../camel/component/elasticsearch/ElasticsearchProducer.java | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
> ----------------------------------------------------------------------
>
>
> http://git-wip-us.apache.org/repos/asf/camel/blob/0c1d4b77/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchProducer.java
> ----------------------------------------------------------------------
> diff --git a/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchProducer.java b/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchProducer.java
> index 136b610..fede7ee 100644
> --- a/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchProducer.java
> +++ b/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchProducer.java
> @@ -80,7 +80,7 @@ public class ElasticsearchProducer extends DefaultProducer {
> return ElasticsearchConstants.OPERATION_EXISTS;
> } else if (request instanceof SearchRequest) {
> return ElasticsearchConstants.OPERATION_SEARCH;
> - } else if (request instanceof MultiGetRequest) {
> + } else if (request instanceof MultiSearchRequest) {
> return ElasticsearchConstants.OPERATION_MULTISEARCH;
> }
>
>
>
--
Claus Ibsen
-----------------
http://davsclaus.com @davsclaus
Camel in Action 2: https://www.manning.com/ibsen2
R: [06/20] camel git commit: CAMEL-9452: Camel-Elasticsearch:
Support Multisearch operation
Posted by Andrea Cosentino <an...@yahoo.com.INVALID>.
Sorry. My mistake.
Inviato da Yahoo Mail su Android
Il dom, 27 dic, 2015 alle 18:28, davsclaus@apache.org<da...@apache.org> ha scritto: CAMEL-9452: Camel-Elasticsearch: Support Multisearch operation
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/0c1d4b77
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/0c1d4b77
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/0c1d4b77
Branch: refs/heads/master
Commit: 0c1d4b77848394d4bf2d681440f1c5334b682ec3
Parents: 31162f9
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 13:17:57 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:25 2015 +0100
----------------------------------------------------------------------
.../camel/component/elasticsearch/ElasticsearchProducer.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/0c1d4b77/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchProducer.java
----------------------------------------------------------------------
diff --git a/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchProducer.java b/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchProducer.java
index 136b610..fede7ee 100644
--- a/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchProducer.java
+++ b/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchProducer.java
@@ -80,7 +80,7 @@ public class ElasticsearchProducer extends DefaultProducer {
return ElasticsearchConstants.OPERATION_EXISTS;
} else if (request instanceof SearchRequest) {
return ElasticsearchConstants.OPERATION_SEARCH;
- } else if (request instanceof MultiGetRequest) {
+ } else if (request instanceof MultiSearchRequest) {
return ElasticsearchConstants.OPERATION_MULTISEARCH;
}
[06/20] camel git commit: CAMEL-9452: Camel-Elasticsearch: Support
Multisearch operation
Posted by da...@apache.org.
CAMEL-9452: Camel-Elasticsearch: Support Multisearch operation
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/0c1d4b77
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/0c1d4b77
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/0c1d4b77
Branch: refs/heads/master
Commit: 0c1d4b77848394d4bf2d681440f1c5334b682ec3
Parents: 31162f9
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 13:17:57 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:25 2015 +0100
----------------------------------------------------------------------
.../camel/component/elasticsearch/ElasticsearchProducer.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/0c1d4b77/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchProducer.java
----------------------------------------------------------------------
diff --git a/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchProducer.java b/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchProducer.java
index 136b610..fede7ee 100644
--- a/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchProducer.java
+++ b/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchProducer.java
@@ -80,7 +80,7 @@ public class ElasticsearchProducer extends DefaultProducer {
return ElasticsearchConstants.OPERATION_EXISTS;
} else if (request instanceof SearchRequest) {
return ElasticsearchConstants.OPERATION_SEARCH;
- } else if (request instanceof MultiGetRequest) {
+ } else if (request instanceof MultiSearchRequest) {
return ElasticsearchConstants.OPERATION_MULTISEARCH;
}
[15/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.
Posted by da...@apache.org.
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/0549b8d3
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/0549b8d3
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/0549b8d3
Branch: refs/heads/master
Commit: 0549b8d36595b543950b80ed6042ed7dfa565fa0
Parents: ed1223a
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 15:25:34 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:28 2015 +0100
----------------------------------------------------------------------
.../org/apache/camel/component/printer/PrinterEndpoint.java | 9 +++++++++
components/camel-quartz/pom.xml | 2 +-
.../org/apache/camel/component/quartz/QuartzEndpoint.java | 4 +---
.../org/apache/camel/component/quartz2/QuartzEndpoint.java | 4 +---
.../apache/camel/component/quickfixj/QuickfixjEndpoint.java | 3 +++
.../apache/camel/component/rabbitmq/RabbitMQEndpoint.java | 3 +++
.../org/apache/camel/component/restlet/RestletEndpoint.java | 4 +---
.../java/org/apache/camel/component/rmi/RmiEndpoint.java | 2 +-
components/camel-routebox/pom.xml | 2 +-
.../apache/camel/component/routebox/RouteboxEndpoint.java | 3 +++
.../java/org/apache/camel/component/rss/RssEndpoint.java | 2 +-
.../camel/component/salesforce/SalesforceEndpoint.java | 2 +-
.../camel/component/sap/netweaver/NetWeaverEndpoint.java | 3 +++
.../org/apache/camel/component/xquery/XQueryEndpoint.java | 3 +++
.../camel/component/schematron/SchematronEndpoint.java | 2 +-
15 files changed, 33 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-printer/src/main/java/org/apache/camel/component/printer/PrinterEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-printer/src/main/java/org/apache/camel/component/printer/PrinterEndpoint.java b/components/camel-printer/src/main/java/org/apache/camel/component/printer/PrinterEndpoint.java
index 164adf7..d692da6 100644
--- a/components/camel-printer/src/main/java/org/apache/camel/component/printer/PrinterEndpoint.java
+++ b/components/camel-printer/src/main/java/org/apache/camel/component/printer/PrinterEndpoint.java
@@ -24,6 +24,15 @@ import org.apache.camel.impl.DefaultEndpoint;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
+/**
+ * The printer component is used for sending messages to printers as print jobs.
+ *
+ * Obviously the payload has to be a formatted piece of payload in order for the component to appropriately print it.
+ * The objective is to be able to direct specific payloads as jobs to a line printer in a camel flow.
+ *
+ * The functionality allows for the payload to be printed on a default printer, named local, remote or wirelessly
+ * linked printer using the javax printing API under the covers.
+ */
@UriEndpoint(scheme = "lpr", title = "Printer", syntax = "lpr:hostname:port/printername", producerOnly = true, label = "printing")
public class PrinterEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-quartz/pom.xml
----------------------------------------------------------------------
diff --git a/components/camel-quartz/pom.xml b/components/camel-quartz/pom.xml
index f60f073..05e0599 100644
--- a/components/camel-quartz/pom.xml
+++ b/components/camel-quartz/pom.xml
@@ -26,7 +26,7 @@
<artifactId>camel-quartz</artifactId>
<packaging>bundle</packaging>
- <name>Camel :: Quartz</name>
+ <name>Camel :: Quartz (deprecated)</name>
<description>Camel Quartz support</description>
<properties>
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-quartz/src/main/java/org/apache/camel/component/quartz/QuartzEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-quartz/src/main/java/org/apache/camel/component/quartz/QuartzEndpoint.java b/components/camel-quartz/src/main/java/org/apache/camel/component/quartz/QuartzEndpoint.java
index fb569a1..090dcea 100644
--- a/components/camel-quartz/src/main/java/org/apache/camel/component/quartz/QuartzEndpoint.java
+++ b/components/camel-quartz/src/main/java/org/apache/camel/component/quartz/QuartzEndpoint.java
@@ -42,9 +42,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * A <a href="http://activemq.apache.org/quartz.html">Quartz Endpoint</a>
- *
- * @version
+ * Provides a scheduled delivery of messages using the Quartz 1.x scheduler
*/
@UriEndpoint(scheme = "quartz", title = "Quartz", syntax = "quartz:groupName/timerName", consumerOnly = true, consumerClass = QuartzConsumer.class, label = "scheduling")
public class QuartzEndpoint extends DefaultEndpoint implements ShutdownableService {
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-quartz2/src/main/java/org/apache/camel/component/quartz2/QuartzEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-quartz2/src/main/java/org/apache/camel/component/quartz2/QuartzEndpoint.java b/components/camel-quartz2/src/main/java/org/apache/camel/component/quartz2/QuartzEndpoint.java
index e8bb885..54251b8 100644
--- a/components/camel-quartz2/src/main/java/org/apache/camel/component/quartz2/QuartzEndpoint.java
+++ b/components/camel-quartz2/src/main/java/org/apache/camel/component/quartz2/QuartzEndpoint.java
@@ -51,9 +51,7 @@ import static org.quartz.CronScheduleBuilder.cronSchedule;
import static org.quartz.SimpleScheduleBuilder.simpleSchedule;
/**
- * This endpoint represent each job to be created in scheduler. When consumer is started or stopped, it will
- * call back into {@link #onConsumerStart(QuartzConsumer)} to add/resume or {@link #onConsumerStop(QuartzConsumer)}
- * to pause the scheduler trigger.
+ * Provides a scheduled delivery of messages using the Quartz 2.x scheduler
*/
@UriEndpoint(scheme = "quartz2", title = "Quartz2", syntax = "quartz2:groupName/triggerName", consumerOnly = true, consumerClass = QuartzComponent.class, label = "scheduling")
public class QuartzEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-quickfix/src/main/java/org/apache/camel/component/quickfixj/QuickfixjEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-quickfix/src/main/java/org/apache/camel/component/quickfixj/QuickfixjEndpoint.java b/components/camel-quickfix/src/main/java/org/apache/camel/component/quickfixj/QuickfixjEndpoint.java
index 16e459b..dd26444 100644
--- a/components/camel-quickfix/src/main/java/org/apache/camel/component/quickfixj/QuickfixjEndpoint.java
+++ b/components/camel-quickfix/src/main/java/org/apache/camel/component/quickfixj/QuickfixjEndpoint.java
@@ -38,6 +38,9 @@ import org.slf4j.LoggerFactory;
import quickfix.Message;
import quickfix.SessionID;
+/**
+ * The quickfix component allows to send Financial Interchange (FIX) messages to the QuickFix engine.
+ */
@UriEndpoint(scheme = "quickfix", title = "QuickFix", syntax = "quickfix:configurationName", consumerClass = QuickfixjConsumer.class, label = "engine,messaging")
public class QuickfixjEndpoint extends DefaultEndpoint implements QuickfixjEventListener, MultipleConsumersSupport {
public static final String EVENT_CATEGORY_KEY = "EventCategory";
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-rabbitmq/src/main/java/org/apache/camel/component/rabbitmq/RabbitMQEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-rabbitmq/src/main/java/org/apache/camel/component/rabbitmq/RabbitMQEndpoint.java b/components/camel-rabbitmq/src/main/java/org/apache/camel/component/rabbitmq/RabbitMQEndpoint.java
index 8475562..7a6e48c 100644
--- a/components/camel-rabbitmq/src/main/java/org/apache/camel/component/rabbitmq/RabbitMQEndpoint.java
+++ b/components/camel-rabbitmq/src/main/java/org/apache/camel/component/rabbitmq/RabbitMQEndpoint.java
@@ -59,6 +59,9 @@ import org.apache.camel.spi.UriPath;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * The rabbitmq component allows AMQP messages to be sent to (or consumed from) a RabbitMQ broker.
+ */
@UriEndpoint(scheme = "rabbitmq", title = "RabbitMQ", syntax = "rabbitmq:hostname:portNumber/exchangeName", consumerClass = RabbitMQConsumer.class, label = "messaging")
public class RabbitMQEndpoint extends DefaultEndpoint {
private static final Logger LOG = LoggerFactory.getLogger(RabbitMQEndpoint.class);
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-restlet/src/main/java/org/apache/camel/component/restlet/RestletEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-restlet/src/main/java/org/apache/camel/component/restlet/RestletEndpoint.java b/components/camel-restlet/src/main/java/org/apache/camel/component/restlet/RestletEndpoint.java
index 770cb6f..844e7ec 100644
--- a/components/camel-restlet/src/main/java/org/apache/camel/component/restlet/RestletEndpoint.java
+++ b/components/camel-restlet/src/main/java/org/apache/camel/component/restlet/RestletEndpoint.java
@@ -36,9 +36,7 @@ import org.apache.camel.util.jsse.SSLContextParameters;
import org.restlet.data.Method;
/**
- * Represents a <a href="http://www.restlet.org/"> endpoint</a>
- *
- * @version
+ * Component for consuming and producing Restful resources using Restlet
*/
@UriEndpoint(scheme = "restlet", title = "Restlet", syntax = "restlet:protocol:host:port/uriPattern", consumerClass = RestletConsumer.class, label = "rest")
public class RestletEndpoint extends DefaultEndpoint implements HeaderFilterStrategyAware {
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiEndpoint.java b/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiEndpoint.java
index 8c61fa9..d7b4993 100644
--- a/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiEndpoint.java
+++ b/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiEndpoint.java
@@ -35,7 +35,7 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ObjectHelper;
/**
- * @version
+ * The rmi component is for invoking Java RMI beans from Camel.
*/
@UriEndpoint(scheme = "rmi", title = "RMI", syntax = "rmi:hostname:port/name", consumerClass = RmiConsumer.class, label = "messaging")
public class RmiEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-routebox/pom.xml
----------------------------------------------------------------------
diff --git a/components/camel-routebox/pom.xml b/components/camel-routebox/pom.xml
index 1f8b658..d8b35bc 100644
--- a/components/camel-routebox/pom.xml
+++ b/components/camel-routebox/pom.xml
@@ -25,7 +25,7 @@
</parent>
<artifactId>camel-routebox</artifactId>
- <name>Camel :: Routebox </name>
+ <name>Camel :: Routebox (deprecated)</name>
<description>Camel Routebox component to encapsulate routes</description>
<packaging>bundle</packaging>
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-routebox/src/main/java/org/apache/camel/component/routebox/RouteboxEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-routebox/src/main/java/org/apache/camel/component/routebox/RouteboxEndpoint.java b/components/camel-routebox/src/main/java/org/apache/camel/component/routebox/RouteboxEndpoint.java
index e344c47..039a74b 100644
--- a/components/camel-routebox/src/main/java/org/apache/camel/component/routebox/RouteboxEndpoint.java
+++ b/components/camel-routebox/src/main/java/org/apache/camel/component/routebox/RouteboxEndpoint.java
@@ -22,6 +22,9 @@ import org.apache.camel.impl.DefaultEndpoint;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
+/**
+ * The routebox component allows to send/receive messages between Camel routes in a black box way.
+ */
@UriEndpoint(scheme = "routebox", title = "RouteBox", syntax = "routebox:routeboxName", consumerClass = RouteboxConsumer.class, label = "eventbus")
public abstract class RouteboxEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/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 eee6e7e..d5b483a 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
@@ -31,7 +31,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Is used for polling rss feeds.
+ * The rss component is used for consuming RSS feeds.
*/
@UriEndpoint(scheme = "rss", extendsScheme = "atom", title = "RSS",
syntax = "rss:feedUri", consumerOnly = true, consumerClass = RssEntryPollingConsumer.class, label = "rss")
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpoint.java b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpoint.java
index db9d3b6..c0a9dac 100644
--- a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpoint.java
+++ b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpoint.java
@@ -30,7 +30,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Represents a Salesforce endpoint.
+ * The salesforce component is used for integrating Camel with the massive Salesforce API.
*/
@UriEndpoint(scheme = "salesforce", title = "Salesforce", syntax = "salesforce:operationName:topicName", label = "api,cloud,crm", consumerClass = SalesforceConsumer.class)
public class SalesforceEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-sap-netweaver/src/main/java/org/apache/camel/component/sap/netweaver/NetWeaverEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-sap-netweaver/src/main/java/org/apache/camel/component/sap/netweaver/NetWeaverEndpoint.java b/components/camel-sap-netweaver/src/main/java/org/apache/camel/component/sap/netweaver/NetWeaverEndpoint.java
index 0f16085..28d476a 100644
--- a/components/camel-sap-netweaver/src/main/java/org/apache/camel/component/sap/netweaver/NetWeaverEndpoint.java
+++ b/components/camel-sap-netweaver/src/main/java/org/apache/camel/component/sap/netweaver/NetWeaverEndpoint.java
@@ -26,6 +26,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
+/**
+ * The sap-netweaver component integrates with the SAP NetWeaver Gateway using HTTP transports.
+ */
@UriEndpoint(scheme = "sap-netweaver", title = "SAP NetWeaver", syntax = "sap-netweaver:url", producerOnly = true, label = "sap")
public class NetWeaverEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-saxon/src/main/java/org/apache/camel/component/xquery/XQueryEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-saxon/src/main/java/org/apache/camel/component/xquery/XQueryEndpoint.java b/components/camel-saxon/src/main/java/org/apache/camel/component/xquery/XQueryEndpoint.java
index d38c89c..89001b1 100644
--- a/components/camel-saxon/src/main/java/org/apache/camel/component/xquery/XQueryEndpoint.java
+++ b/components/camel-saxon/src/main/java/org/apache/camel/component/xquery/XQueryEndpoint.java
@@ -35,6 +35,9 @@ import org.apache.camel.util.ServiceHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Generates a response using an XQuery template
+ */
@UriEndpoint(scheme = "xquery", title = "XQuery", syntax = "xquery:resourceUri", label = "transformation")
public class XQueryEndpoint extends ProcessorEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-schematron/src/main/java/org/apache/camel/component/schematron/SchematronEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-schematron/src/main/java/org/apache/camel/component/schematron/SchematronEndpoint.java b/components/camel-schematron/src/main/java/org/apache/camel/component/schematron/SchematronEndpoint.java
index 35a9868..ccd6bea 100644
--- a/components/camel-schematron/src/main/java/org/apache/camel/component/schematron/SchematronEndpoint.java
+++ b/components/camel-schematron/src/main/java/org/apache/camel/component/schematron/SchematronEndpoint.java
@@ -42,7 +42,7 @@ import static org.apache.camel.component.schematron.constant.Constants.LINE_NUMB
import static org.apache.camel.component.schematron.constant.Constants.SAXON_TRANSFORMER_FACTORY_CLASS_NAME;
/**
- * Schematron Endpoint.
+ * Validates the payload of a message using the Schematron Library.
*/
@UriEndpoint(scheme = "schematron", title = "Schematron", syntax = "schematron:path", producerOnly = true, label = "validation")
public class SchematronEndpoint extends DefaultEndpoint {
[05/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.
Posted by da...@apache.org.
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/5f269bd8
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/5f269bd8
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/5f269bd8
Branch: refs/heads/master
Commit: 5f269bd8219264a1e3855711b08391209c569c0b
Parents: 0c1d4b7
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 13:20:37 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:25 2015 +0100
----------------------------------------------------------------------
.../java/org/apache/camel/component/bean/BeanEndpoint.java | 2 +-
.../apache/camel/component/disruptor/DisruptorEndpoint.java | 5 ++---
.../java/org/apache/camel/component/dns/DnsEndpoint.java | 3 +++
.../org/apache/camel/component/docker/DockerEndpoint.java | 4 ++--
.../java/org/apache/camel/component/dozer/DozerEndpoint.java | 3 +++
.../org/apache/camel/component/dropbox/DropboxEndpoint.java | 3 +++
.../java/org/apache/camel/component/ejb/EjbEndpoint.java | 3 +++
.../camel/component/elasticsearch/ElasticsearchEndpoint.java | 2 +-
.../java/org/apache/camel/component/elsql/ElsqlEndpoint.java | 3 +++
.../camel/component/eventadmin/EventAdminEndpoint.java | 2 +-
.../java/org/apache/camel/component/exec/ExecEndpoint.java | 8 +-------
11 files changed, 23 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java
index a42f664..2de7d53 100644
--- a/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java
@@ -30,7 +30,7 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
- * The <a href="http://camel.apache.org/bean.html">Bean Component</a> is for invoking Java beans from Camel.
+ * The <a href="http://camel.apache.org/bean.html">bean component</a> is for invoking Java beans from Camel.
*/
@UriEndpoint(scheme = "bean", title = "Bean", syntax = "bean:beanName", producerOnly = true, label = "core,java")
public class BeanEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-disruptor/src/main/java/org/apache/camel/component/disruptor/DisruptorEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-disruptor/src/main/java/org/apache/camel/component/disruptor/DisruptorEndpoint.java b/components/camel-disruptor/src/main/java/org/apache/camel/component/disruptor/DisruptorEndpoint.java
index 33debc7..2ddc6b1 100644
--- a/components/camel-disruptor/src/main/java/org/apache/camel/component/disruptor/DisruptorEndpoint.java
+++ b/components/camel-disruptor/src/main/java/org/apache/camel/component/disruptor/DisruptorEndpoint.java
@@ -43,9 +43,8 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * An implementation of the <a href="https://github.com/sirchia/camel-disruptor">Disruptor component</a>
- * for asynchronous SEDA exchanges on an
- * <a href="https://github.com/LMAX-Exchange/disruptor">LMAX Disruptor</a> within a CamelContext
+ * The disruptor component provides asynchronous SEDA behavior much as the standard SEDA Component,
+ * but utilizes a Disruptor instead of a BlockingQueue utilized by the standard SEDA.
*/
@ManagedResource(description = "Managed Disruptor Endpoint")
@UriEndpoint(scheme = "disruptor,disruptor-vm", title = "Disruptor,Disruptor VM", syntax = "disruptor:name", consumerClass = DisruptorConsumer.class, label = "endpoint")
http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-dns/src/main/java/org/apache/camel/component/dns/DnsEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-dns/src/main/java/org/apache/camel/component/dns/DnsEndpoint.java b/components/camel-dns/src/main/java/org/apache/camel/component/dns/DnsEndpoint.java
index 76778af..bcd27ac 100644
--- a/components/camel-dns/src/main/java/org/apache/camel/component/dns/DnsEndpoint.java
+++ b/components/camel-dns/src/main/java/org/apache/camel/component/dns/DnsEndpoint.java
@@ -25,6 +25,9 @@ import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriPath;
+/**
+ * To lookup domain information and run DNS queries using DNSJava.
+ */
@UriEndpoint(scheme = "dns", title = "DNS", syntax = "dns:dnsType", producerOnly = true, label = "networking")
public class DnsEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java
index de40ca3..09d80f6 100644
--- a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java
+++ b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java
@@ -28,9 +28,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
/**
- * Represents a Docker endpoint.
+ * The docker component is used for managing Docker containers.
*/
-@UriEndpoint(scheme = "docker", title = "Docker", syntax = "docker:operation", consumerClass = DockerEventsConsumer.class, label = "container,cloud,platform")
+@UriEndpoint(scheme = "docker", title = "Docker", syntax = "docker:operation", consumerClass = DockerEventsConsumer.class, label = "container,cloud,management,platform")
public class DockerEndpoint extends DefaultEndpoint {
@UriParam
http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-dozer/src/main/java/org/apache/camel/component/dozer/DozerEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-dozer/src/main/java/org/apache/camel/component/dozer/DozerEndpoint.java b/components/camel-dozer/src/main/java/org/apache/camel/component/dozer/DozerEndpoint.java
index eae218c..2d48d11 100644
--- a/components/camel-dozer/src/main/java/org/apache/camel/component/dozer/DozerEndpoint.java
+++ b/components/camel-dozer/src/main/java/org/apache/camel/component/dozer/DozerEndpoint.java
@@ -35,6 +35,9 @@ import org.dozer.DozerBeanMapper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * The dozer component provides the ability to map between Java beans using the Dozer mapping library.
+ */
@UriEndpoint(scheme = "dozer", title = "Dozer", syntax = "dozer:name", producerOnly = true, label = "transformation")
public class DozerEndpoint extends DefaultEndpoint {
private static final Logger LOG = LoggerFactory.getLogger(DozerEndpoint.class);
http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxEndpoint.java b/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxEndpoint.java
index f8025e6..d796e3c 100755
--- a/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxEndpoint.java
+++ b/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxEndpoint.java
@@ -37,6 +37,9 @@ import org.slf4j.LoggerFactory;
import static org.apache.camel.component.dropbox.util.DropboxConstants.POLL_CONSUMER_DELAY;
+/**
+ * For uploading, downloading and managing files, folders, groups, collaborations, etc on dropbox DOT com.
+ */
@UriEndpoint(scheme = "dropbox", title = "Dropbox", syntax = "dropbox:operation", consumerClass = DropboxScheduledPollConsumer.class, label = "api,file")
public class DropboxEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-ejb/src/main/java/org/apache/camel/component/ejb/EjbEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-ejb/src/main/java/org/apache/camel/component/ejb/EjbEndpoint.java b/components/camel-ejb/src/main/java/org/apache/camel/component/ejb/EjbEndpoint.java
index 417ea94..6a5030f 100644
--- a/components/camel-ejb/src/main/java/org/apache/camel/component/ejb/EjbEndpoint.java
+++ b/components/camel-ejb/src/main/java/org/apache/camel/component/ejb/EjbEndpoint.java
@@ -20,6 +20,9 @@ import org.apache.camel.Component;
import org.apache.camel.component.bean.BeanEndpoint;
import org.apache.camel.spi.UriEndpoint;
+/**
+ * The ejb component is for invoking EJB Java beans from Camel.
+ */
@UriEndpoint(scheme = "ejb", title = "EJB", syntax = "ejb:beanName", producerOnly = true, label = "endpoint,java")
public class EjbEndpoint extends BeanEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchEndpoint.java b/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchEndpoint.java
index 18842b3..6138019 100644
--- a/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchEndpoint.java
+++ b/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchEndpoint.java
@@ -39,7 +39,7 @@ import org.slf4j.LoggerFactory;
import static org.elasticsearch.node.NodeBuilder.nodeBuilder;
/**
- * Represents an Elasticsearch endpoint.
+ * The elasticsearch component is used for interfacing with ElasticSearch server.
*/
@UriEndpoint(scheme = "elasticsearch", title = "Elasticsearch", syntax = "elasticsearch:clusterName", producerOnly = true, label = "monitoring,search")
public class ElasticsearchEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java b/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java
index 80bf8e3..07abfad 100644
--- a/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java
+++ b/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java
@@ -42,6 +42,9 @@ import org.springframework.jdbc.core.namedparam.EmptySqlParameterSource;
import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;
import org.springframework.jdbc.core.namedparam.SqlParameterSource;
+/**
+ * The elsql component is an extension to the existing SQL Component that uses ElSql to define the SQL queries.
+ */
@UriEndpoint(scheme = "elsql", title = "SQL", syntax = "elsql:elsqlName:resourceUri", consumerClass = ElsqlConsumer.class, label = "database,sql")
public class ElsqlEndpoint extends DefaultSqlEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-eventadmin/src/main/java/org/apache/camel/component/eventadmin/EventAdminEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-eventadmin/src/main/java/org/apache/camel/component/eventadmin/EventAdminEndpoint.java b/components/camel-eventadmin/src/main/java/org/apache/camel/component/eventadmin/EventAdminEndpoint.java
index 3970ffc..82659d5 100644
--- a/components/camel-eventadmin/src/main/java/org/apache/camel/component/eventadmin/EventAdminEndpoint.java
+++ b/components/camel-eventadmin/src/main/java/org/apache/camel/component/eventadmin/EventAdminEndpoint.java
@@ -25,7 +25,7 @@ import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
- * EventAdmin endpoint
+ * The eventadmin component can be used in an OSGi environment to receive OSGi EventAdmin events and process them.
*/
@UriEndpoint(scheme = "eventadmin", title = "OSGi EventAdmin", syntax = "eventadmin:topic", consumerClass = EventAdminConsumer.class, label = "eventbus")
public class EventAdminEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-exec/src/main/java/org/apache/camel/component/exec/ExecEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-exec/src/main/java/org/apache/camel/component/exec/ExecEndpoint.java b/components/camel-exec/src/main/java/org/apache/camel/component/exec/ExecEndpoint.java
index e6cf4f2..46dfc18 100644
--- a/components/camel-exec/src/main/java/org/apache/camel/component/exec/ExecEndpoint.java
+++ b/components/camel-exec/src/main/java/org/apache/camel/component/exec/ExecEndpoint.java
@@ -28,13 +28,7 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ObjectHelper;
/**
- * The endpoint utilizes an {@link ExecCommandExecutor} to execute a system
- * command when it receives message exchanges.
- *
- * @see ExecBinding
- * @see ExecCommandExecutor
- * @see ExecCommand
- * @see ExecResult
+ * The exec component can be used to execute OS system commands.
*/
@UriEndpoint(scheme = "exec", title = "Exec", syntax = "exec:executable", producerOnly = true, label = "system")
public class ExecEndpoint extends DefaultEndpoint {
[16/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.
Posted by da...@apache.org.
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/1aca713f
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/1aca713f
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/1aca713f
Branch: refs/heads/master
Commit: 1aca713f4d6d03895b3fa994d0e4b17eb180930f
Parents: 0549b8d
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 16:40:53 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:28 2015 +0100
----------------------------------------------------------------------
.../main/java/org/apache/camel/component/jms/JmsEndpoint.java | 2 ++
.../org/apache/camel/component/servlet/ServletEndpoint.java | 3 +++
.../main/java/org/apache/camel/component/sip/SipEndpoint.java | 5 ++++-
.../java/org/apache/camel/component/sjms/SjmsEndpoint.java | 4 +++-
.../java/org/apache/camel/component/slack/SlackEndpoint.java | 3 +++
.../java/org/apache/camel/component/smpp/SmppEndpoint.java | 6 ++----
.../java/org/apache/camel/component/snmp/SnmpEndpoint.java | 3 +++
.../java/org/apache/camel/component/solr/SolrEndpoint.java | 2 +-
.../org/apache/camel/component/sparkrest/SparkEndpoint.java | 3 +++
.../java/org/apache/camel/component/spark/SparkEndpoint.java | 2 +-
.../java/org/apache/camel/component/splunk/SplunkEndpoint.java | 2 +-
11 files changed, 26 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/1aca713f/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsEndpoint.java b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsEndpoint.java
index bd57c2d..e65762a 100644
--- a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsEndpoint.java
+++ b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsEndpoint.java
@@ -64,6 +64,8 @@ import org.springframework.util.ErrorHandler;
/**
* The jms component allows messages to be sent to (or consumed from) a JMS Queue or Topic.
+ *
+ * This component uses Spring JMS.
*/
@ManagedResource(description = "Managed JMS Endpoint")
@UriEndpoint(scheme = "jms", title = "JMS", syntax = "jms:destinationType:destinationName", consumerClass = JmsConsumer.class, label = "messaging")
http://git-wip-us.apache.org/repos/asf/camel/blob/1aca713f/components/camel-servlet/src/main/java/org/apache/camel/component/servlet/ServletEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-servlet/src/main/java/org/apache/camel/component/servlet/ServletEndpoint.java b/components/camel-servlet/src/main/java/org/apache/camel/component/servlet/ServletEndpoint.java
index e2d4695..5beefc3 100644
--- a/components/camel-servlet/src/main/java/org/apache/camel/component/servlet/ServletEndpoint.java
+++ b/components/camel-servlet/src/main/java/org/apache/camel/component/servlet/ServletEndpoint.java
@@ -28,6 +28,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
+/**
+ * To use a HTTP Servlet as entry for Camel routes when running in a servlet container.
+ */
@UriEndpoint(scheme = "servlet", extendsScheme = "http", title = "Servlet",
syntax = "servlet:contextPath", consumerOnly = true, consumerClass = ServletConsumer.class, label = "http")
public class ServletEndpoint extends HttpCommonEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/1aca713f/components/camel-sip/src/main/java/org/apache/camel/component/sip/SipEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-sip/src/main/java/org/apache/camel/component/sip/SipEndpoint.java b/components/camel-sip/src/main/java/org/apache/camel/component/sip/SipEndpoint.java
index 05e3463..5a59e0c 100644
--- a/components/camel-sip/src/main/java/org/apache/camel/component/sip/SipEndpoint.java
+++ b/components/camel-sip/src/main/java/org/apache/camel/component/sip/SipEndpoint.java
@@ -24,7 +24,10 @@ import org.apache.camel.impl.DefaultEndpoint;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
-@UriEndpoint(scheme = "sip,sips", title = "SIP (Session Initiation Protocol)", syntax = "sip:uri", label = "messaging,mobile")
+/**
+ * To send and receive messages using the SIP protocol (used in telco and mobile).
+ */
+@UriEndpoint(scheme = "sip,sips", title = "SIP (Session Initiation Protocol)", syntax = "sip:uri", label = "mobile")
public class SipEndpoint extends DefaultEndpoint {
@UriParam
private SipConfiguration configuration;
http://git-wip-us.apache.org/repos/asf/camel/blob/1aca713f/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/SjmsEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/SjmsEndpoint.java b/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/SjmsEndpoint.java
index 9061ddd..6a68a34 100644
--- a/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/SjmsEndpoint.java
+++ b/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/SjmsEndpoint.java
@@ -48,7 +48,9 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * A JMS Endpoint
+ * The sjms component (simple jms) allows messages to be sent to (or consumed from) a JMS Queue or Topic.
+ *
+ * This component uses plain JMS API where as the jms component uses Spring JMS.
*/
@UriEndpoint(scheme = "sjms", title = "Simple JMS", syntax = "sjms:destinationType:destinationName", consumerClass = SjmsConsumer.class, label = "messaging")
public class SjmsEndpoint extends DefaultEndpoint implements MultipleConsumersSupport, HeaderFilterStrategyAware {
http://git-wip-us.apache.org/repos/asf/camel/blob/1aca713f/components/camel-slack/src/main/java/org/apache/camel/component/slack/SlackEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-slack/src/main/java/org/apache/camel/component/slack/SlackEndpoint.java b/components/camel-slack/src/main/java/org/apache/camel/component/slack/SlackEndpoint.java
index e3d0d10..3011c4d 100644
--- a/components/camel-slack/src/main/java/org/apache/camel/component/slack/SlackEndpoint.java
+++ b/components/camel-slack/src/main/java/org/apache/camel/component/slack/SlackEndpoint.java
@@ -25,6 +25,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
+/**
+ * The slack component allows you to send messages to Slack.
+ */
@UriEndpoint(scheme = "slack", title = "Slack", syntax = "slack:channel", producerOnly = true, label = "social")
public class SlackEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/1aca713f/components/camel-smpp/src/main/java/org/apache/camel/component/smpp/SmppEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-smpp/src/main/java/org/apache/camel/component/smpp/SmppEndpoint.java b/components/camel-smpp/src/main/java/org/apache/camel/component/smpp/SmppEndpoint.java
index 99cd38f..b98bb26 100644
--- a/components/camel-smpp/src/main/java/org/apache/camel/component/smpp/SmppEndpoint.java
+++ b/components/camel-smpp/src/main/java/org/apache/camel/component/smpp/SmppEndpoint.java
@@ -30,11 +30,9 @@ import org.jsmpp.bean.DataSm;
import org.jsmpp.bean.DeliverSm;
/**
- * A SMPP Endpoint
- *
- * @version
+ * To send and receive SMS using a SMSC (Short Message Service Center).
*/
-@UriEndpoint(scheme = "smpp,smpps", title = "SMPP", syntax = "smpp:host:port", consumerClass = SmppConsumer.class, label = "mobile,messaging")
+@UriEndpoint(scheme = "smpp,smpps", title = "SMPP", syntax = "smpp:host:port", consumerClass = SmppConsumer.class, label = "mobile")
public class SmppEndpoint extends DefaultEndpoint {
private SmppBinding binding;
http://git-wip-us.apache.org/repos/asf/camel/blob/1aca713f/components/camel-snmp/src/main/java/org/apache/camel/component/snmp/SnmpEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-snmp/src/main/java/org/apache/camel/component/snmp/SnmpEndpoint.java b/components/camel-snmp/src/main/java/org/apache/camel/component/snmp/SnmpEndpoint.java
index c7dc15d..bc2f75a 100644
--- a/components/camel-snmp/src/main/java/org/apache/camel/component/snmp/SnmpEndpoint.java
+++ b/components/camel-snmp/src/main/java/org/apache/camel/component/snmp/SnmpEndpoint.java
@@ -34,6 +34,9 @@ import org.snmp4j.PDU;
import org.snmp4j.mp.SnmpConstants;
import org.snmp4j.security.SecurityLevel;
+/**
+ * The snmp component gives you the ability to poll SNMP capable devices or receiving traps.
+ */
@UriEndpoint(scheme = "snmp", title = "SNMP", syntax = "snmp:host:port", consumerOnly = true, label = "monitoring")
public class SnmpEndpoint extends DefaultPollingEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/1aca713f/components/camel-solr/src/main/java/org/apache/camel/component/solr/SolrEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-solr/src/main/java/org/apache/camel/component/solr/SolrEndpoint.java b/components/camel-solr/src/main/java/org/apache/camel/component/solr/SolrEndpoint.java
index 5a48672..8f4055f 100644
--- a/components/camel-solr/src/main/java/org/apache/camel/component/solr/SolrEndpoint.java
+++ b/components/camel-solr/src/main/java/org/apache/camel/component/solr/SolrEndpoint.java
@@ -33,7 +33,7 @@ import org.apache.solr.client.solrj.impl.ConcurrentUpdateSolrClient;
import org.apache.solr.client.solrj.impl.HttpSolrClient;
/**
- * Represents a Solr endpoint.
+ * The solr component allows you to interface with an Apache Lucene Solr server
*/
@UriEndpoint(scheme = "solr,solrs,solrCloud", title = "Solr", syntax = "solr:url", producerOnly = true, label = "monitoring,search")
public class SolrEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/1aca713f/components/camel-spark-rest/src/main/java/org/apache/camel/component/sparkrest/SparkEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-spark-rest/src/main/java/org/apache/camel/component/sparkrest/SparkEndpoint.java b/components/camel-spark-rest/src/main/java/org/apache/camel/component/sparkrest/SparkEndpoint.java
index 0bc818d..af5c9b2 100644
--- a/components/camel-spark-rest/src/main/java/org/apache/camel/component/sparkrest/SparkEndpoint.java
+++ b/components/camel-spark-rest/src/main/java/org/apache/camel/component/sparkrest/SparkEndpoint.java
@@ -28,6 +28,9 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ObjectHelper;
import spark.route.HttpMethod;
+/**
+ * The spark-rest component is used for hosting REST services which has been defined using Camel rest-dsl.
+ */
@UriEndpoint(scheme = "spark-rest", title = "Spark Rest", syntax = "spark-rest:verb:path", consumerOnly = true, consumerClass = SparkConsumer.class, label = "rest")
public class SparkEndpoint extends DefaultEndpoint {
@UriPath(enums = "get,post,put,patch,delete,head,trace,connect,options") @Metadata(required = "true")
http://git-wip-us.apache.org/repos/asf/camel/blob/1aca713f/components/camel-spark/src/main/java/org/apache/camel/component/spark/SparkEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-spark/src/main/java/org/apache/camel/component/spark/SparkEndpoint.java b/components/camel-spark/src/main/java/org/apache/camel/component/spark/SparkEndpoint.java
index 914bb9b..6a5ad91 100644
--- a/components/camel-spark/src/main/java/org/apache/camel/component/spark/SparkEndpoint.java
+++ b/components/camel-spark/src/main/java/org/apache/camel/component/spark/SparkEndpoint.java
@@ -31,7 +31,7 @@ import org.slf4j.Logger;
import static org.slf4j.LoggerFactory.getLogger;
/**
- * Spark endpoint can be used to create various type of producers, including RDD-, DataFrame- and Hive-based.
+ * The spark component can be used to send RDD or DataFrame jobs to Apache Spark cluster.
*/
@UriEndpoint(scheme = "spark", title = "Apache Spark", syntax = "spark:endpointType",
producerOnly = true, label = "bigdata,iot")
http://git-wip-us.apache.org/repos/asf/camel/blob/1aca713f/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkEndpoint.java b/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkEndpoint.java
index a0625fc..2e21432 100644
--- a/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkEndpoint.java
+++ b/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkEndpoint.java
@@ -32,7 +32,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Represents a Splunk endpoint.
+ * The splunk component allows to publish or search for events in Splunk.
*/
@UriEndpoint(scheme = "splunk", title = "Splunk", syntax = "splunk:name", consumerClass = SplunkConsumer.class, label = "monitoring")
public class SplunkEndpoint extends ScheduledPollEndpoint {
[12/20] camel git commit: CAMEL-9454: camel-gora - Should preserve
headers
Posted by da...@apache.org.
CAMEL-9454: camel-gora - Should preserve headers
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/62a7aad6
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/62a7aad6
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/62a7aad6
Branch: refs/heads/master
Commit: 62a7aad6eb30a10b132e5de5f1d794e90a8be8d7
Parents: ddbc7b4
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 14:52:37 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:27 2015 +0100
----------------------------------------------------------------------
.../main/java/org/apache/camel/component/gora/GoraProducer.java | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/62a7aad6/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraProducer.java
----------------------------------------------------------------------
diff --git a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraProducer.java b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraProducer.java
index 8ed67fd..f68daad 100644
--- a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraProducer.java
+++ b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraProducer.java
@@ -114,8 +114,9 @@ public class GoraProducer extends DefaultProducer implements ServicePoolAware {
}
exchange.getOut().setBody(result);
- // preserve headers
+ // preserve headers and attachments
exchange.getOut().setHeaders(exchange.getIn().getHeaders());
+ exchange.getOut().setAttachments(exchange.getIn().getAttachments());
}
}