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:48 UTC
[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.
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 {