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 <[email protected]> Authored: Sun Dec 27 16:40:53 2015 +0100 Committer: Claus Ibsen <[email protected]> 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 {
