Repository: camel Updated Branches: refs/heads/master 01f6b12bb -> 3cba6ed05
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/9f1471bc Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/9f1471bc Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/9f1471bc Branch: refs/heads/master Commit: 9f1471bc92c9a08cfea88cc91febe79e4a3b5cbf Parents: 01f6b12 Author: Claus Ibsen <davscl...@apache.org> Authored: Mon Dec 28 12:14:07 2015 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Mon Dec 28 12:28:28 2015 +0100 ---------------------------------------------------------------------- .../java/org/apache/camel/component/stub/StubEndpoint.java | 2 +- .../java/org/apache/camel/component/test/TestEndpoint.java | 2 +- .../java/org/apache/camel/component/xslt/XsltEndpoint.java | 2 +- .../java/org/apache/camel/component/ahc/ws/WsEndpoint.java | 2 +- .../main/java/org/apache/camel/component/ahc/AhcEndpoint.java | 2 +- .../java/org/apache/camel/component/apns/ApnsEndpoint.java | 2 +- .../component/atmosphere/websocket/WebsocketEndpoint.java | 2 +- .../camel/component/aws/ddbstream/DdbStreamEndpoint.java | 2 +- .../java/org/apache/camel/component/aws/ec2/EC2Endpoint.java | 2 +- .../apache/camel/component/aws/kinesis/KinesisEndpoint.java | 2 +- .../java/org/apache/camel/component/aws/sns/SnsEndpoint.java | 2 +- .../java/org/apache/camel/component/chunk/ChunkEndpoint.java | 2 +- .../apache/camel/component/disruptor/DisruptorEndpoint.java | 6 ++++-- .../apache/camel/component/freemarker/FreemarkerEndpoint.java | 2 +- .../apache/camel/component/google/mail/GoogleMailEndpoint.java | 2 +- .../java/org/apache/camel/component/hbase/HBaseEndpoint.java | 2 +- .../java/org/apache/camel/component/hdfs/HdfsEndpoint.java | 2 +- .../java/org/apache/camel/component/hdfs2/HdfsEndpoint.java | 2 +- .../java/org/apache/camel/component/http4/HttpEndpoint.java | 2 +- .../java/org/apache/camel/component/ibatis/IBatisEndpoint.java | 2 +- .../java/org/apache/camel/component/jbpm/JBPMEndpoint.java | 2 +- .../org/apache/camel/component/mybatis/MyBatisEndpoint.java | 2 +- .../java/org/apache/camel/component/nagios/NagiosEndpoint.java | 2 +- .../java/org/apache/camel/component/quartz/QuartzEndpoint.java | 2 +- .../org/apache/camel/component/quartz2/QuartzEndpoint.java | 2 +- .../org/apache/camel/component/restlet/RestletEndpoint.java | 2 +- .../java/org/apache/camel/component/xquery/XQueryEndpoint.java | 2 +- .../java/org/apache/camel/component/solr/SolrEndpoint.java | 2 +- .../camel/component/stringtemplate/StringTemplateEndpoint.java | 2 +- .../org/apache/camel/component/undertow/UndertowEndpoint.java | 2 +- .../org/apache/camel/component/weather/WeatherEndpoint.java | 2 +- 31 files changed, 34 insertions(+), 32 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/9f1471bc/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 abb64e8..cd24eba 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 @@ -27,7 +27,7 @@ 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. + * 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. http://git-wip-us.apache.org/repos/asf/camel/blob/9f1471bc/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 3326cb5..ead1396 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,7 +33,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * The test component extends the mock component to support pulling messages from another endpoint on startup to set the expected message bodies. + * The test component extends the mock component by on startup to pull messages from another endpoint to set the expected message bodies. * * 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. http://git-wip-us.apache.org/repos/asf/camel/blob/9f1471bc/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 4eaaf5b..031c47c 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 @@ -44,7 +44,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Generates a response using an XSLT template + * Generates a response using an XSLT template. */ @ManagedResource(description = "Managed XsltEndpoint") @UriEndpoint(scheme = "xslt", title = "XSLT", syntax = "xslt:resourceUri", producerOnly = true, label = "core,transformation") http://git-wip-us.apache.org/repos/asf/camel/blob/9f1471bc/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 7f2c8a3..a7ec795 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 @@ -39,7 +39,7 @@ 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> + * 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") http://git-wip-us.apache.org/repos/asf/camel/blob/9f1471bc/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 001740f..10a6930 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 @@ -35,7 +35,7 @@ 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> + * 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/9f1471bc/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 180b066..6a8513e 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 @@ -30,7 +30,7 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * For sending notifications to Apple iOS devices + * 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/9f1471bc/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 170658d..1feabef 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 + * 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/9f1471bc/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 6691ad6..383f272 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 @@ -30,7 +30,7 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * The aws-ddbstream component is used for working with Amazon DynamoDB Streams + * 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", http://git-wip-us.apache.org/repos/asf/camel/blob/9f1471bc/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 45a7ccb..c710f26 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 @@ -31,7 +31,7 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.util.ObjectHelper; /** - * The aws-ec2 is used for managing Amazon EC2 instances + * 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/9f1471bc/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 249944d..b3ce926 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 @@ -30,7 +30,7 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * The aws-kinesis component is for consuming records from Amazon Kinesis Streams + * 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/9f1471bc/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 2e295fa..6dfad27 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 @@ -38,7 +38,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * The aws-sns component is used for sending messages to an Amazon Simple Notification Topic + * 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/9f1471bc/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 2d37586..7b3afe0 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 @@ -41,7 +41,7 @@ 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 + * 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/9f1471bc/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 2ddc6b1..f0be8a1 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,8 +43,10 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * 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. + * The disruptor component provides asynchronous SEDA behavior using LMAX Disruptor. + * + * This component works 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/9f1471bc/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 3c2c134..fa27592 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; /** - * Generates a response using a FreeMarker template + * 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/9f1471bc/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 a1333cf..b07cfde 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; /** - * The google-mail component provides access to Google Mail + * 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/9f1471bc/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 2ccfde6..f08ee93 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; /** - * For reading/writing from/to an HBase store (Hadoop database) + * 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/9f1471bc/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 ad02148..bae2b58 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 @@ -28,7 +28,7 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; /** - * For reading/writing from/to an HDFS filesystem using Hadoop 1.x + * 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/9f1471bc/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 f32884d..8bae293 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 @@ -28,7 +28,7 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; /** - * For reading/writing from/to an HDFS filesystem using Hadoop 2.x + * 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/9f1471bc/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 7dfeaf3..874a595 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,7 +42,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * For calling out to external HTTP servers using Apache HTTP Client 4.x + * 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 { http://git-wip-us.apache.org/repos/asf/camel/blob/9f1471bc/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 7e65c3f..14370be 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,7 +32,7 @@ import org.apache.camel.spi.UriPath; import org.apache.camel.util.ObjectHelper; /** - * Performs a query, poll, insert, update or delete in a relational database using Apache iBATIS + * 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/9f1471bc/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 a63e23d..5742299 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 @@ -32,7 +32,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * The jbpm component provides integration with jBPM (Business Process Management) + * 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 { http://git-wip-us.apache.org/repos/asf/camel/blob/9f1471bc/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 e4e1ced..976ae5e 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; /** - * Performs a query, poll, insert, update or delete in a relational database using MyBatis + * 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/9f1471bc/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 107d97b..b64bbd4 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; /** - * To send passive checks to Nagios using JSendNSCA + * 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/9f1471bc/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 090dcea..9682164 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,7 +42,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Provides a scheduled delivery of messages using the Quartz 1.x scheduler + * 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/9f1471bc/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 54251b8..2792c43 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,7 +51,7 @@ import static org.quartz.CronScheduleBuilder.cronSchedule; import static org.quartz.SimpleScheduleBuilder.simpleSchedule; /** - * Provides a scheduled delivery of messages using the Quartz 2.x scheduler + * 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/9f1471bc/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 844e7ec..8c779ca 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,7 +36,7 @@ import org.apache.camel.util.jsse.SSLContextParameters; import org.restlet.data.Method; /** - * Component for consuming and producing Restful resources using Restlet + * 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/9f1471bc/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 89001b1..ee66752 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 @@ -36,7 +36,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Generates a response using an XQuery template + * 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/9f1471bc/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 8f4055f..56f9b3e 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; /** - * The solr component allows you to interface with an Apache Lucene Solr server + * 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/9f1471bc/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 39ab4df..9779257 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; /** - * Generates a response using a String Template + * 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 { http://git-wip-us.apache.org/repos/asf/camel/blob/9f1471bc/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 b41a205..a0b0e1a 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; /** - * The undertow component provides HTTP-based endpoints for consuming and producing HTTP requests + * 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/9f1471bc/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 acff9e6..62edb0b 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; /** - * Polls the weather information from Open Weather Map + * 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 {
