Repository: camel Updated Branches: refs/heads/master c18e435a2 -> 67e4c809d
CAMEL-10379: Improved component description Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/67e4c809 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/67e4c809 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/67e4c809 Branch: refs/heads/master Commit: 67e4c809dc61843abef89e358f86ed958116569f Parents: c18e435 Author: lburgazzoli <lburgazz...@gmail.com> Authored: Tue Oct 11 17:42:34 2016 +0200 Committer: lburgazzoli <lburgazz...@gmail.com> Committed: Wed Oct 12 10:51:06 2016 +0200 ---------------------------------------------------------------------- .../LumberjackComponentConfiguration.java | 3 +- .../springboot/SqlComponentConfiguration.java | 3 +- .../TelegramComponentConfiguration.java | 2 +- .../component/asterisk/AsteriskEndpoint.java | 2 +- .../engine/ChronicleEngineEndpoint.java | 3 ++ .../apache/camel/component/cm/CMEndpoint.java | 3 ++ .../camel/component/consul/ConsulEndpoint.java | 3 ++ .../component/ehcache/EhcacheEndpoint.java | 3 ++ .../component/etcd/AbstractEtcdEndpoint.java | 2 +- .../component/influxdb/InfluxDbEndpoint.java | 3 ++ .../apache/camel/component/irc/IrcEndpoint.java | 5 ++- .../camel/component/ironmq/IronMQEndpoint.java | 2 +- .../camel/component/jcache/JCacheEndpoint.java | 2 +- .../lumberjack/LumberjackEndpoint.java | 6 ++-- .../camel/component/mllp/MllpEndpoint.java | 3 +- .../camel/component/gridfs/GridFsEndpoint.java | 6 ++-- .../camel/component/nats/NatsEndpoint.java | 3 ++ .../component/rabbitmq/RabbitMQEndpoint.java | 3 ++ .../servicenow/ServiceNowEndpoint.java | 2 +- .../apache/camel/component/sql/SqlEndpoint.java | 2 +- .../component/telegram/TelegramEndpoint.java | 2 +- components/readme.adoc | 36 ++++++++++---------- 22 files changed, 63 insertions(+), 36 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components-starter/camel-lumberjack-starter/src/main/java/org/apache/camel/component/lumberjack/springboot/LumberjackComponentConfiguration.java ---------------------------------------------------------------------- diff --git a/components-starter/camel-lumberjack-starter/src/main/java/org/apache/camel/component/lumberjack/springboot/LumberjackComponentConfiguration.java b/components-starter/camel-lumberjack-starter/src/main/java/org/apache/camel/component/lumberjack/springboot/LumberjackComponentConfiguration.java index 242d612..e563fe9 100644 --- a/components-starter/camel-lumberjack-starter/src/main/java/org/apache/camel/component/lumberjack/springboot/LumberjackComponentConfiguration.java +++ b/components-starter/camel-lumberjack-starter/src/main/java/org/apache/camel/component/lumberjack/springboot/LumberjackComponentConfiguration.java @@ -21,7 +21,8 @@ import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.context.properties.NestedConfigurationProperty; /** - * Camel Lumberjack log streaming component + * The lumberjack retrieves logs sent over the network using the Lumberjack + * protocol. * * Generated by camel-package-maven-plugin - do not edit this file! */ http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components-starter/camel-sql-starter/src/main/java/org/apache/camel/component/sql/springboot/SqlComponentConfiguration.java ---------------------------------------------------------------------- diff --git a/components-starter/camel-sql-starter/src/main/java/org/apache/camel/component/sql/springboot/SqlComponentConfiguration.java b/components-starter/camel-sql-starter/src/main/java/org/apache/camel/component/sql/springboot/SqlComponentConfiguration.java index 42e0745..19a7196 100644 --- a/components-starter/camel-sql-starter/src/main/java/org/apache/camel/component/sql/springboot/SqlComponentConfiguration.java +++ b/components-starter/camel-sql-starter/src/main/java/org/apache/camel/component/sql/springboot/SqlComponentConfiguration.java @@ -20,7 +20,8 @@ import javax.sql.DataSource; import org.springframework.boot.context.properties.ConfigurationProperties; /** - * The sql component can be used to perform SQL query to a database. + * The sql component allows you to work with databases using JDBC Stored + * Procedure queries. * * Generated by camel-package-maven-plugin - do not edit this file! */ http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components-starter/camel-telegram-starter/src/main/java/org/apache/camel/component/telegram/springboot/TelegramComponentConfiguration.java ---------------------------------------------------------------------- diff --git a/components-starter/camel-telegram-starter/src/main/java/org/apache/camel/component/telegram/springboot/TelegramComponentConfiguration.java b/components-starter/camel-telegram-starter/src/main/java/org/apache/camel/component/telegram/springboot/TelegramComponentConfiguration.java index bfc18f8..435bf3f 100644 --- a/components-starter/camel-telegram-starter/src/main/java/org/apache/camel/component/telegram/springboot/TelegramComponentConfiguration.java +++ b/components-starter/camel-telegram-starter/src/main/java/org/apache/camel/component/telegram/springboot/TelegramComponentConfiguration.java @@ -19,7 +19,7 @@ package org.apache.camel.component.telegram.springboot; import org.springframework.boot.context.properties.ConfigurationProperties; /** - * The Camel endpoint for a telegram bot. + * The telegram component provides access to the Telegram Bot API. * * Generated by camel-package-maven-plugin - do not edit this file! */ http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components/camel-asterisk/src/main/java/org/apache/camel/component/asterisk/AsteriskEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-asterisk/src/main/java/org/apache/camel/component/asterisk/AsteriskEndpoint.java b/components/camel-asterisk/src/main/java/org/apache/camel/component/asterisk/AsteriskEndpoint.java index 8d25b5f..3b76a15 100644 --- a/components/camel-asterisk/src/main/java/org/apache/camel/component/asterisk/AsteriskEndpoint.java +++ b/components/camel-asterisk/src/main/java/org/apache/camel/component/asterisk/AsteriskEndpoint.java @@ -37,7 +37,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Represents a Asterisk endpoint. + * The asterisk component is used to interact with Asterisk PBX Server <a href="http://www.asterisk.org";>Asterisk PBX Server</a>. */ @UriEndpoint(scheme = "asterisk", title = "Asterisk", syntax = "asterisk:name", consumerClass = AsteriskConsumer.class, label = "voip") public class AsteriskEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components/camel-chronicle/src/main/java/org/apache/camel/component/chronicle/engine/ChronicleEngineEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-chronicle/src/main/java/org/apache/camel/component/chronicle/engine/ChronicleEngineEndpoint.java b/components/camel-chronicle/src/main/java/org/apache/camel/component/chronicle/engine/ChronicleEngineEndpoint.java index 8387474..cab5de2 100644 --- a/components/camel-chronicle/src/main/java/org/apache/camel/component/chronicle/engine/ChronicleEngineEndpoint.java +++ b/components/camel-chronicle/src/main/java/org/apache/camel/component/chronicle/engine/ChronicleEngineEndpoint.java @@ -27,6 +27,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; +/** + * The camel chronicle-engine component let you leverage the power of OpenHFT's <a href="https://github.com/OpenHFT/Chronicle-Engine";>Chronicle-Engine</a>. + */ @UriEndpoint(scheme = "chronicle-engine", title = "Chronicle Engine", syntax = "chronicle-engine:addresses/path", consumerClass = ChronicleEngineConsumer.class, label = "Chronicle") public class ChronicleEngineEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components/camel-cm-sms/src/main/java/org/apache/camel/component/cm/CMEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-cm-sms/src/main/java/org/apache/camel/component/cm/CMEndpoint.java b/components/camel-cm-sms/src/main/java/org/apache/camel/component/cm/CMEndpoint.java index b290801..67bbb0e 100644 --- a/components/camel-cm-sms/src/main/java/org/apache/camel/component/cm/CMEndpoint.java +++ b/components/camel-cm-sms/src/main/java/org/apache/camel/component/cm/CMEndpoint.java @@ -29,6 +29,9 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; import org.apache.camel.util.ObjectHelper; +/** + * The influxdb component allows to integrate with <a href="https://www.cmtelecom.com/";>CM SMS Gateway</a>. + */ @UriEndpoint(scheme = "cm-sms", title = "CM SMS Gateway", syntax = "cm-sms:host", label = "mobile", producerOnly = true) public class CMEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components/camel-consul/src/main/java/org/apache/camel/component/consul/ConsulEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-consul/src/main/java/org/apache/camel/component/consul/ConsulEndpoint.java b/components/camel-consul/src/main/java/org/apache/camel/component/consul/ConsulEndpoint.java index 9bc32d3..3844acd 100644 --- a/components/camel-consul/src/main/java/org/apache/camel/component/consul/ConsulEndpoint.java +++ b/components/camel-consul/src/main/java/org/apache/camel/component/consul/ConsulEndpoint.java @@ -27,6 +27,9 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; import org.apache.camel.util.ObjectHelper; +/** + * The camel consul component allows you to work with <a href="https://www.consul.io/";>Consul</a>, a distributed, highly available, datacenter-aware, service discovery and configuration system. + */ @UriEndpoint(scheme = "consul", title = "Consul", syntax = "consul:apiEndpoint", label = "api,cloud") public class ConsulEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components/camel-ehcache/src/main/java/org/apache/camel/component/ehcache/EhcacheEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-ehcache/src/main/java/org/apache/camel/component/ehcache/EhcacheEndpoint.java b/components/camel-ehcache/src/main/java/org/apache/camel/component/ehcache/EhcacheEndpoint.java index d2b019b..5f7ea5e 100644 --- a/components/camel-ehcache/src/main/java/org/apache/camel/component/ehcache/EhcacheEndpoint.java +++ b/components/camel-ehcache/src/main/java/org/apache/camel/component/ehcache/EhcacheEndpoint.java @@ -24,6 +24,9 @@ import org.apache.camel.spi.Metadata; import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriPath; +/** + * The ehcache component enables you to perform caching operations using <a href="http://www.ehcache.org";>Ehcache</a> as cache implementation. + */ @UriEndpoint(scheme = "ehcache", title = "Ehcache", syntax = "ehcache:cacheName", consumerClass = EhcacheConsumer.class, label = "cache,datagrid,clustering") public class EhcacheEndpoint extends DefaultEndpoint { @UriPath(description = "the cache name") http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/AbstractEtcdEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/AbstractEtcdEndpoint.java b/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/AbstractEtcdEndpoint.java index 423d482..5eb095e 100644 --- a/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/AbstractEtcdEndpoint.java +++ b/components/camel-etcd/src/main/java/org/apache/camel/component/etcd/AbstractEtcdEndpoint.java @@ -24,7 +24,7 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * Represents a etcd endpoint. + * The camel etcd component allows you to work with <a href="https://coreos.com/etcd";>Etcd</a>, a distributed, A distributed, reliable key-value store. */ @UriEndpoint(scheme = "etcd", title = "etcd", syntax = "etcd:namespace/path", consumerClass = AbstractEtcdConsumer.class, label = "etcd") public abstract class AbstractEtcdEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components/camel-influxdb/src/main/java/org/apache/camel/component/influxdb/InfluxDbEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-influxdb/src/main/java/org/apache/camel/component/influxdb/InfluxDbEndpoint.java b/components/camel-influxdb/src/main/java/org/apache/camel/component/influxdb/InfluxDbEndpoint.java index 50d1f09..cbac656 100644 --- a/components/camel-influxdb/src/main/java/org/apache/camel/component/influxdb/InfluxDbEndpoint.java +++ b/components/camel-influxdb/src/main/java/org/apache/camel/component/influxdb/InfluxDbEndpoint.java @@ -28,6 +28,9 @@ import org.influxdb.InfluxDB; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * The influxdb component allows you to interact with <a href="https://influxdata.com/time-series-platform/influxdb/";>InfluxDB</a>, a time series database. + */ @UriEndpoint(scheme = "influxdb", title = "InfluxDB", syntax = "influxdb:connectionBean", label = "database,ticks", producerOnly = true) public class InfluxDbEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/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 1f88cc0..9dc627e 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,10 +32,9 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * For IRC chat communication. + * The irc component implements an <a href="https://en.wikipedia.org/wiki/Internet_Relay_Chat";>IRC</a> (Internet Relay Chat) transport. */ -@UriEndpoint(scheme = "irc", title = "IRC", syntax = "irc:hostname:port", alternativeSyntax = "irc:username:password@hostname:port", - consumerClass = IrcConsumer.class, label = "chat") +@UriEndpoint(scheme = "irc", title = "IRC", syntax = "irc:hostname:port", alternativeSyntax = "irc:username:password@hostname:port", consumerClass = IrcConsumer.class, label = "chat") public class IrcEndpoint extends DefaultEndpoint { private static final Logger LOG = LoggerFactory.getLogger(IrcEndpoint.class); http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components/camel-ironmq/src/main/java/org/apache/camel/component/ironmq/IronMQEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-ironmq/src/main/java/org/apache/camel/component/ironmq/IronMQEndpoint.java b/components/camel-ironmq/src/main/java/org/apache/camel/component/ironmq/IronMQEndpoint.java index 2090262..71cd4f0 100644 --- a/components/camel-ironmq/src/main/java/org/apache/camel/component/ironmq/IronMQEndpoint.java +++ b/components/camel-ironmq/src/main/java/org/apache/camel/component/ironmq/IronMQEndpoint.java @@ -36,7 +36,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Represents a IronMQ endpoint. + * The ironmq provides integration with <a href="https://www.iron.io/";>IronMQ</a> an elastic and durable hosted message queue as a service. */ @UriEndpoint(scheme = "ironmq", syntax = "ironmq:queueName", title = "ironmq", consumerClass = IronMQConsumer.class, label = "cloud,messaging") public class IronMQEndpoint extends ScheduledPollEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components/camel-jcache/src/main/java/org/apache/camel/component/jcache/JCacheEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-jcache/src/main/java/org/apache/camel/component/jcache/JCacheEndpoint.java b/components/camel-jcache/src/main/java/org/apache/camel/component/jcache/JCacheEndpoint.java index 079ab12..56cdffb 100644 --- a/components/camel-jcache/src/main/java/org/apache/camel/component/jcache/JCacheEndpoint.java +++ b/components/camel-jcache/src/main/java/org/apache/camel/component/jcache/JCacheEndpoint.java @@ -26,7 +26,7 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * Represents a JCache endpoint. + * The jcache component enables you to perform caching operations using JSR107/JCache as cache implementation. */ @UriEndpoint(scheme = "jcache", title = "JCache", syntax = "jcache:cacheName", consumerClass = JCacheConsumer.class, label = "cache,datagrid,clustering") public class JCacheEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components/camel-lumberjack/src/main/java/org/apache/camel/component/lumberjack/LumberjackEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-lumberjack/src/main/java/org/apache/camel/component/lumberjack/LumberjackEndpoint.java b/components/camel-lumberjack/src/main/java/org/apache/camel/component/lumberjack/LumberjackEndpoint.java index 8c9d23d..eb4c064 100644 --- a/components/camel-lumberjack/src/main/java/org/apache/camel/component/lumberjack/LumberjackEndpoint.java +++ b/components/camel-lumberjack/src/main/java/org/apache/camel/component/lumberjack/LumberjackEndpoint.java @@ -29,8 +29,10 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; import org.apache.camel.util.jsse.SSLContextParameters; -@UriEndpoint(scheme = "lumberjack", title = "Lumberjack", syntax = "lumberjack:host:port", - consumerOnly = true, consumerClass = LumberjackConsumer.class, label = "log") +/** + * The lumberjack retrieves logs sent over the network using the Lumberjack protocol. + */ +@UriEndpoint(scheme = "lumberjack", title = "Lumberjack", syntax = "lumberjack:host:port", consumerOnly = true, consumerClass = LumberjackConsumer.class, label = "log") public class LumberjackEndpoint extends DefaultEndpoint { @UriPath(description = "Network interface on which to listen for Lumberjack") @Metadata(required = "true") http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components/camel-mllp/src/main/java/org/apache/camel/component/mllp/MllpEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-mllp/src/main/java/org/apache/camel/component/mllp/MllpEndpoint.java b/components/camel-mllp/src/main/java/org/apache/camel/component/mllp/MllpEndpoint.java index 1fc0ec7..ae2e01f 100644 --- a/components/camel-mllp/src/main/java/org/apache/camel/component/mllp/MllpEndpoint.java +++ b/components/camel-mllp/src/main/java/org/apache/camel/component/mllp/MllpEndpoint.java @@ -30,7 +30,8 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Represents a MLLP endpoint. + * The MLLP component is designed to handle the MLLP protocol and provide the functionality required by Healthcare providers to communicate with other systems using the MLLP protocol. + * * <p/> * NOTE: MLLP payloads are not logged unless the logging level is set to DEBUG or TRACE to avoid introducing PHI * into the log files. Logging of PHI can be globally disabled by setting the org.apache.camel.mllp.logPHI system http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components/camel-mongodb-gridfs/src/main/java/org/apache/camel/component/gridfs/GridFsEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-mongodb-gridfs/src/main/java/org/apache/camel/component/gridfs/GridFsEndpoint.java b/components/camel-mongodb-gridfs/src/main/java/org/apache/camel/component/gridfs/GridFsEndpoint.java index cfd8831..13aa862 100644 --- a/components/camel-mongodb-gridfs/src/main/java/org/apache/camel/component/gridfs/GridFsEndpoint.java +++ b/components/camel-mongodb-gridfs/src/main/java/org/apache/camel/component/gridfs/GridFsEndpoint.java @@ -33,8 +33,10 @@ import org.apache.camel.spi.UriPath; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -@UriEndpoint(scheme = "gridfs", title = "MongoDBGridFS", syntax = "gridfs:connectionBean", - label = "database,nosql") +/** + * Component for working with MongoDB GridFS. + */ +@UriEndpoint(scheme = "gridfs", title = "MongoDBGridFS", syntax = "gridfs:connectionBean", label = "database,nosql") public class GridFsEndpoint extends DefaultEndpoint { public enum QueryStrategy { http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components/camel-nats/src/main/java/org/apache/camel/component/nats/NatsEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-nats/src/main/java/org/apache/camel/component/nats/NatsEndpoint.java b/components/camel-nats/src/main/java/org/apache/camel/component/nats/NatsEndpoint.java index 160b8ee..3cf9611 100644 --- a/components/camel-nats/src/main/java/org/apache/camel/component/nats/NatsEndpoint.java +++ b/components/camel-nats/src/main/java/org/apache/camel/component/nats/NatsEndpoint.java @@ -25,6 +25,9 @@ import org.apache.camel.impl.DefaultEndpoint; import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; +/** + * The nats component allows you produce and consume messages from <a href="http://nats.io/";>NATS</a>. + */ @UriEndpoint(scheme = "nats", title = "Nats", syntax = "nats:servers", label = "messaging", consumerClass = NatsConsumer.class) public class NatsEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/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 c5ef6c5..7ac249a 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 @@ -45,6 +45,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; +/** + * The rabbitmq component allows you produce and consume messages from <a href="http://www.rabbitmq.com/";>RabbitMQ</a> instances. + */ @UriEndpoint(scheme = "rabbitmq", title = "RabbitMQ", syntax = "rabbitmq:hostname:portNumber/exchangeName", consumerClass = RabbitMQConsumer.class, label = "messaging") public class RabbitMQEndpoint extends DefaultEndpoint implements AsyncEndpoint { // header to indicate that the message body needs to be de-serialized http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components/camel-servicenow/src/main/java/org/apache/camel/component/servicenow/ServiceNowEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-servicenow/src/main/java/org/apache/camel/component/servicenow/ServiceNowEndpoint.java b/components/camel-servicenow/src/main/java/org/apache/camel/component/servicenow/ServiceNowEndpoint.java index 8234482..c9bd9f2 100644 --- a/components/camel-servicenow/src/main/java/org/apache/camel/component/servicenow/ServiceNowEndpoint.java +++ b/components/camel-servicenow/src/main/java/org/apache/camel/component/servicenow/ServiceNowEndpoint.java @@ -28,7 +28,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Represents a ServiceNow endpoint. + * The servicenow component is used to integrate Camel with <a href="http://www.servicenow.com/";>ServiceNow</a> cloud services. */ @UriEndpoint(scheme = "servicenow", title = "ServiceNow", syntax = "servicenow:instanceName", producerOnly = true, label = "api,cloud,management") public class ServiceNowEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/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 d9e6751..d88048f 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,7 +27,7 @@ import org.apache.camel.util.UnsafeUriCharactersEncoder; import org.springframework.jdbc.core.JdbcTemplate; /** - * The sql component can be used to perform SQL query to a database. + * The sql component allows you to work with databases using JDBC Stored Procedure queries. */ @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/67e4c809/components/camel-telegram/src/main/java/org/apache/camel/component/telegram/TelegramEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-telegram/src/main/java/org/apache/camel/component/telegram/TelegramEndpoint.java b/components/camel-telegram/src/main/java/org/apache/camel/component/telegram/TelegramEndpoint.java index e0fa237..9d1fdb4 100644 --- a/components/camel-telegram/src/main/java/org/apache/camel/component/telegram/TelegramEndpoint.java +++ b/components/camel-telegram/src/main/java/org/apache/camel/component/telegram/TelegramEndpoint.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; /** - * The Camel endpoint for a telegram bot. + * The telegram component provides access to the <a href="https://core.telegram.org/bots/api";>Telegram Bot API</a>. */ @UriEndpoint(scheme = "telegram", title = "Telegram", syntax = "telegram:type/authorizationToken", consumerClass = TelegramConsumer.class, label = "chat") public class TelegramEndpoint extends ScheduledPollEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/67e4c809/components/readme.adoc ---------------------------------------------------------------------- diff --git a/components/readme.adoc b/components/readme.adoc index 6b7a1e2..e9a0949 100644 --- a/components/readme.adoc +++ b/components/readme.adoc @@ -25,7 +25,7 @@ Components `apns:name` | For sending notifications to Apple iOS devices. | link:camel-asterisk/src/main/docs/asterisk-component.adoc[Asterisk] (camel-asterisk) + -`asterisk:name` | Represents a Asterisk endpoint. +`asterisk:name` | The asterisk component is used to interact with Asterisk PBX Server Asterisk PBX Server. | link:camel-atmos/src/main/docs/atmos-component.adoc[Atmos] (camel-atmos) + `atmos:name/operation` | The atmos component is used for integrating with EMC's Atomos Storage. @@ -91,13 +91,13 @@ Components `cql:beanRef:hosts:port/keyspace` | The cql component aims at integrating Cassandra 2.0 using the CQL3 API (not the Thrift API). | link:camel-chronicle/src/main/docs/chronicle-engine-component.adoc[Chronicle Engine] (camel-chronicle) + -`chronicle-engine:addresses/path` | Camel Chronicle support +`chronicle-engine:addresses/path` | The camel chronicle-engine component let you leverage the power of OpenHFT's Chronicle-Engine. | link:camel-chunk/src/main/docs/chunk-component.adoc[Chunk] (camel-chunk) + `chunk:resourceUri` | Transforms the message using a Chunk template. | link:camel-cm-sms/src/main/docs/cm-sms-component.adoc[CM SMS Gateway] (camel-cm-sms) + -`cm-sms:host` | Camel CM SMS Gateway Component +`cm-sms:host` | The influxdb component allows to integrate with CM SMS Gateway. | link:camel-cmis/src/main/docs/cmis-component.adoc[CMIS] (camel-cmis) + `cmis:url` | The cmis component uses the Apache Chemistry client API and allows you to add/read nodes to/from a CMIS compliant content repositories. @@ -109,7 +109,7 @@ Components `cometd:host:port/channelName` | The cometd component is a transport for working with the Jetty implementation of the cometd/bayeux protocol. | link:camel-consul/src/main/docs/consul-component.adoc[Consul] (camel-consul) + -`consul:apiEndpoint` | Camel Consul support +`consul:apiEndpoint` | The camel consul component allows you to work with Consul a distributed highly available datacenter-aware service discovery and configuration system. | link:camel-couchdb/src/main/docs/couchdb-component.adoc[CouchDB] (camel-couchdb) + `couchdb:protocol:hostname:port/database` | The couchdb component is used for integrate with CouchDB databases. @@ -142,7 +142,7 @@ Components `cache:cacheName` | *deprecated* The cache component enables you to perform caching operations using EHCache as the Cache Implementation. | link:camel-ehcache/src/main/docs/ehcache-component.adoc[Ehcache] (camel-ehcache) + -`ehcache:cacheName` | Camel Ehcache support +`ehcache:cacheName` | The ehcache component enables you to perform caching operations using Ehcache as cache implementation. | link:camel-ejb/src/main/docs/ejb-component.adoc[EJB] (camel-ejb) + `ejb:beanName` | The ejb component is for invoking EJB Java beans from Camel. @@ -154,7 +154,7 @@ Components `elsql:elsqlName:resourceUri` | The elsql component is an extension to the existing SQL Component that uses ElSql to define the SQL queries. | link:camel-etcd/src/main/docs/etcd-component.adoc[etcd] (camel-etcd) + -`etcd:namespace/path` | Represents a etcd endpoint. +`etcd:namespace/path` | The camel etcd component allows you to work with Etcd a distributed A distributed reliable key-value store. | link:camel-exec/src/main/docs/exec-component.adoc[Exec] (camel-exec) + `exec:executable` | The exec component can be used to execute OS system commands. @@ -238,13 +238,13 @@ Components `infinispan:host` | For reading/writing from/to Infinispan distributed key/value store and data grid. | link:camel-influxdb/src/main/docs/influxdb-component.adoc[InfluxDB] (camel-influxdb) + -`influxdb:connectionBean` | Camel InfluxDB component +`influxdb:connectionBean` | The influxdb component allows you to interact with InfluxDB a time series database. | link:camel-irc/src/main/docs/irc-component.adoc[IRC] (camel-irc) + -`irc:hostname:port` | For IRC chat communication. +`irc:hostname:port` | The irc component implements an IRC (Internet Relay Chat) transport. | link:camel-ironmq/src/main/docs/ironmq-component.adoc[ironmq] (camel-ironmq) + -`ironmq:queueName` | Represents a IronMQ endpoint. +`ironmq:queueName` | The ironmq provides integration with IronMQ an elastic and durable hosted message queue as a service. | link:camel-javaspace/src/main/docs/javaspace-component.adoc[JavaSpace] (camel-javaspace) + `javaspace:url` | *deprecated* Sending and receiving messages through JavaSpace. @@ -253,7 +253,7 @@ Components `jbpm:connectionURL` | The jbpm component provides integration with jBPM (Business Process Management). | link:camel-jcache/src/main/docs/jcache-component.adoc[JCache] (camel-jcache) + -`jcache:cacheName` | Represents a JCache endpoint. +`jcache:cacheName` | The jcache component enables you to perform caching operations using JSR107/JCache as cache implementation. | link:camel-jclouds/src/main/docs/jclouds-component.adoc[JClouds] (camel-jclouds) + `jclouds:command:providerId` | For interacting with cloud compute & blobstore service via jclouds. @@ -316,7 +316,7 @@ Components `lucene:host:operation` | To insert or query from Apache Lucene databases. | link:camel-lumberjack/src/main/docs/lumberjack-component.adoc[Lumberjack] (camel-lumberjack) + -`lumberjack:host:port` | Camel Lumberjack log streaming component +`lumberjack:host:port` | The lumberjack retrieves logs sent over the network using the Lumberjack protocol. | link:camel-metrics/src/main/docs/metrics-component.adoc[Metrics] (camel-metrics) + `metrics:metricsType:metricsName` | To collect various metrics directly from Camel routes using the DropWizard metrics library. @@ -328,13 +328,13 @@ Components `mina2:protocol:host:port` | Socket level networking using TCP or UDP with the Apache Mina 2.x library. | link:camel-mllp/src/main/docs/mllp-component.adoc[MLLP] (camel-mllp) + -`mllp:hostname:port` | Represents a MLLP endpoint. +`mllp:hostname:port` | The MLLP component is designed to handle the MLLP protocol and provide the functionality required by Healthcare providers to communicate with other systems using the MLLP protocol. | link:camel-mongodb/src/main/docs/mongodb-component.adoc[MongoDB] (camel-mongodb) + `mongodb:connectionBean` | Component for working with documents stored in MongoDB database. | link:camel-mongodb-gridfs/src/main/docs/gridfs-component.adoc[MongoDBGridFS] (camel-mongodb-gridfs) + -`gridfs:connectionBean` | Camel MongoDB GridFS component +`gridfs:connectionBean` | Component for working with MongoDB GridFS. | link:camel-mqtt/src/main/docs/mqtt-component.adoc[MQTT] (camel-mqtt) + `mqtt:name` | Component for communicating with MQTT M2M message brokers using FuseSource MQTT Client. @@ -355,7 +355,7 @@ Components `nagios:host:port` | To send passive checks to Nagios using JSendNSCA. | link:camel-nats/src/main/docs/nats-component.adoc[Nats] (camel-nats) + -`nats:servers` | Camel Components +`nats:servers` | The nats component allows you produce and consume messages from NATS. | link:camel-netty/src/main/docs/netty-component.adoc[Netty] (camel-netty) + `netty:protocol:host:port` | *deprecated* Socket level networking using TCP or UDP with the Netty 3.x library. @@ -403,7 +403,7 @@ Components `quickfix:configurationName` | The quickfix component allows to send Financial Interchange (FIX) messages to the QuickFix engine. | link:camel-rabbitmq/src/main/docs/rabbitmq-component.adoc[RabbitMQ] (camel-rabbitmq) + -`rabbitmq:hostname:portNumber/exchangeName` | Camel RabbitMQ Component +`rabbitmq:hostname:portNumber/exchangeName` | The rabbitmq component allows you produce and consume messages from RabbitMQ instances. | link:camel-restlet/src/main/docs/restlet-component.adoc[Restlet] (camel-restlet) + `restlet:protocol:host:port/uriPattern` | Component for consuming and producing Restful resources using Restlet. @@ -430,7 +430,7 @@ Components `scp:host:port/directoryName` | To copy files using the secure copy protocol (SCP). | link:camel-servicenow/src/main/docs/servicenow-component.adoc[ServiceNow] (camel-servicenow) + -`servicenow:instanceName` | Represents a ServiceNow endpoint. +`servicenow:instanceName` | The servicenow component is used to integrate Camel with ServiceNow cloud services. | link:camel-servlet/src/main/docs/servlet-component.adoc[Servlet] (camel-servlet) + `servlet:contextPath` | To use a HTTP Servlet as entry for Camel routes when running in a servlet container. @@ -484,7 +484,7 @@ Components `spring-ws:type:lookupKey:webServiceEndpointUri` | The spring-ws component is used for SOAP WebServices using Spring WebServices. | link:camel-sql/src/main/docs/sql-component.adoc[SQL] (camel-sql) + -`sql:query` | The sql component can be used to perform SQL query to a database. +`sql:query` | The sql component allows you to work with databases using JDBC Stored Procedure queries. | link:camel-sql/src/main/docs/sql-stored-component.adoc[SQL StoredProcedure] (camel-sql) + `sql-stored:template` | Camel SQL support @@ -505,7 +505,7 @@ Components `string-template:resourceUri` | Transforms the message using a String template. | link:camel-telegram/src/main/docs/telegram-component.adoc[Telegram] (camel-telegram) + -`telegram:type/authorizationToken` | The Camel endpoint for a telegram bot. +`telegram:type/authorizationToken` | The telegram component provides access to the Telegram Bot API. | link:camel-twitter/src/main/docs/twitter-component.adoc[Twitter] (camel-twitter) + `twitter:kind` | This component integrates with Twitter to send tweets or search for tweets and more.
