CAMEL-8561: Better component docs summary of components - we use javadoc from the endpoint class instead of component so its in the same source file as @UriEndpoint.
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/bbbdb64d Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/bbbdb64d Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/bbbdb64d Branch: refs/heads/master Commit: bbbdb64d302f49dd73e42b44670994ca32cd9b23 Parents: 3ebf187 Author: Claus Ibsen <[email protected]> Authored: Sun Dec 27 11:45:23 2015 +0100 Committer: Claus Ibsen <[email protected]> Committed: Sun Dec 27 18:25:24 2015 +0100 ---------------------------------------------------------------------- .../org/apache/camel/component/bean/BeanComponent.java | 2 -- .../org/apache/camel/component/bean/BeanEndpoint.java | 4 +--- .../apache/camel/component/beanclass/ClassEndpoint.java | 2 +- .../apache/camel/component/binding/BindingEndpoint.java | 10 ++++++++++ .../org/apache/camel/component/browse/BrowseEndpoint.java | 5 ++--- .../camel/component/controlbus/ControlBusEndpoint.java | 4 +++- .../camel/component/dataformat/DataFormatEndpoint.java | 3 +++ .../apache/camel/component/dataset/DataSetEndpoint.java | 5 +++-- .../org/apache/camel/component/direct/DirectEndpoint.java | 5 ++--- .../apache/camel/component/directvm/DirectVmEndpoint.java | 4 +++- .../org/apache/camel/component/file/FileEndpoint.java | 2 +- .../apache/camel/component/language/LanguageEndpoint.java | 10 ++++++++-- .../java/org/apache/camel/component/log/LogEndpoint.java | 4 +++- .../org/apache/camel/component/mock/MockEndpoint.java | 2 ++ .../java/org/apache/camel/component/ref/RefEndpoint.java | 3 +++ .../org/apache/camel/component/rest/RestApiEndpoint.java | 3 +++ .../org/apache/camel/component/rest/RestEndpoint.java | 3 +++ .../camel/component/scheduler/SchedulerEndpoint.java | 6 ++++++ .../org/apache/camel/component/seda/SedaEndpoint.java | 4 +--- .../org/apache/camel/component/stub/StubEndpoint.java | 10 ++++++++++ .../org/apache/camel/component/test/TestEndpoint.java | 10 ++++++---- .../org/apache/camel/component/timer/TimerEndpoint.java | 4 ++-- .../camel/component/validator/ValidatorEndpoint.java | 3 +++ .../java/org/apache/camel/component/vm/VmEndpoint.java | 3 +++ .../org/apache/camel/component/xslt/XsltEndpoint.java | 3 +++ .../org/apache/camel/component/aws/cw/CwComponent.java | 3 --- .../org/apache/camel/component/aws/cw/CwEndpoint.java | 3 +++ .../org/apache/camel/component/aws/ddb/DdbComponent.java | 3 --- .../org/apache/camel/component/aws/ddb/DdbEndpoint.java | 3 +++ .../camel/component/aws/ddbstream/DdbStreamComponent.java | 3 --- .../camel/component/aws/ddbstream/DdbStreamEndpoint.java | 3 +++ .../org/apache/camel/component/aws/ec2/EC2Endpoint.java | 3 +++ .../camel/component/aws/kinesis/KinesisComponent.java | 3 --- .../camel/component/aws/kinesis/KinesisEndpoint.java | 3 +++ .../org/apache/camel/component/aws/s3/S3Component.java | 3 --- .../org/apache/camel/component/aws/s3/S3Endpoint.java | 3 +-- .../org/apache/camel/component/aws/sdb/SdbComponent.java | 3 --- .../org/apache/camel/component/aws/sdb/SdbEndpoint.java | 3 +++ .../org/apache/camel/component/aws/ses/SesComponent.java | 3 --- .../org/apache/camel/component/aws/ses/SesEndpoint.java | 3 +++ .../org/apache/camel/component/aws/sns/SnsComponent.java | 3 --- .../org/apache/camel/component/aws/sns/SnsEndpoint.java | 3 +++ .../org/apache/camel/component/aws/sqs/SqsComponent.java | 3 --- .../org/apache/camel/component/aws/sqs/SqsEndpoint.java | 3 +++ .../org/apache/camel/component/aws/swf/SWFComponent.java | 3 --- .../org/apache/camel/component/aws/swf/SWFEndpoint.java | 3 +++ .../org/apache/camel/commands/CatalogCommandTest.java | 1 + .../camel/tools/apt/EndpointAnnotationProcessor.java | 10 +++++----- 48 files changed, 122 insertions(+), 66 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/bean/BeanComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/bean/BeanComponent.java b/camel-core/src/main/java/org/apache/camel/component/bean/BeanComponent.java index 24d04c8..6e54402 100644 --- a/camel-core/src/main/java/org/apache/camel/component/bean/BeanComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/bean/BeanComponent.java @@ -26,8 +26,6 @@ import org.slf4j.LoggerFactory; /** * The <a href="http://camel.apache.org/bean.html";>Bean Component</a> is for invoking Java beans from Camel. - * - * @version */ public class BeanComponent extends UriEndpointComponent { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java index 5a7c880..a42f664 100644 --- a/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java @@ -30,9 +30,7 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * Endpoint for the bean component. - * - * @version + * The <a href="http://camel.apache.org/bean.html";>Bean Component</a> is for invoking Java beans from Camel. */ @UriEndpoint(scheme = "bean", title = "Bean", syntax = "bean:beanName", producerOnly = true, label = "core,java") public class BeanEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/beanclass/ClassEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/beanclass/ClassEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/beanclass/ClassEndpoint.java index 577091c..23b1807 100644 --- a/camel-core/src/main/java/org/apache/camel/component/beanclass/ClassEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/beanclass/ClassEndpoint.java @@ -21,7 +21,7 @@ import org.apache.camel.component.bean.BeanEndpoint; import org.apache.camel.spi.UriEndpoint; /** - * Endpoint for the class component. + * The <a href="http://camel.apache.org/class.html";>Class Component</a> is for invoking Java Classes (Java beans) from Camel. */ @UriEndpoint(scheme = "class", title = "Class", syntax = "class:beanName", label = "core,java") public class ClassEndpoint extends BeanEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/binding/BindingEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/binding/BindingEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/binding/BindingEndpoint.java index 228d05b..10032a8 100644 --- a/camel-core/src/main/java/org/apache/camel/component/binding/BindingEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/binding/BindingEndpoint.java @@ -36,6 +36,16 @@ import org.apache.camel.util.ServiceHelper; import static org.apache.camel.util.CamelContextHelper.getMandatoryEndpoint; /** + * The binding component is used for as a of wrapping an Endpoint in a contract with a data format. + * + * In Camel terms a binding is a way of wrapping an Endpoint in a contract; such as a Data Format, + * a Content Enricher or validation step. Bindings are completely optional and you can choose to use + * them on any camel endpoint. + * Bindings are inspired by the work of SwitchYard project adding service contracts to various technologies + * like Camel and many others. But rather than the SwitchYard approach of wrapping Camel in SCA, + * Camel Bindings provide a way of wrapping Camel endpoints with contracts inside the Camel framework itself; + * so you can use them easily inside any Camel route. + * * Applies a {@link org.apache.camel.spi.Binding} to an underlying {@link Endpoint} so that the binding processes messages * before its sent to the endpoint and processes messages received by the endpoint consumer before its passed * to the real consumer. http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/browse/BrowseEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/browse/BrowseEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/browse/BrowseEndpoint.java index 257f67b..786e20e 100644 --- a/camel-core/src/main/java/org/apache/camel/component/browse/BrowseEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/browse/BrowseEndpoint.java @@ -35,10 +35,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriPath; /** - * An endpoint which maintains a {@link List} of {@link Exchange} instances - * which can be useful for tooling, debugging and visualising routes. + * The browse component is used for viewsing the messages received on endpoints that supports {@link BrowsableEndpoint}. * - * @version + * This can be useful for testing, visualisation tools or debugging. he exchanges sent to the endpoint are all available to be browsed. */ @UriEndpoint(scheme = "browse", title = "Browse", syntax = "browse:name", label = "core,monitoring") public class BrowseEndpoint extends DefaultEndpoint implements BrowsableEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/controlbus/ControlBusEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/controlbus/ControlBusEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/controlbus/ControlBusEndpoint.java index 6bf67e3..4bdff83 100644 --- a/camel-core/src/main/java/org/apache/camel/component/controlbus/ControlBusEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/controlbus/ControlBusEndpoint.java @@ -31,7 +31,9 @@ import org.apache.camel.spi.UriPath; import org.apache.camel.util.CamelLogger; /** - * The control bus endpoint. + * The controlbus component provides easy management of Camel applications based on the Control Bus EIP pattern. + * + * For example, by sending a message to an Endpoint you can control the lifecycle of routes, or gather performance statistics. */ @UriEndpoint(scheme = "controlbus", title = "Control Bus", syntax = "controlbus:command:language", producerOnly = true, label = "core,monitoring") public class ControlBusEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/dataformat/DataFormatEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/dataformat/DataFormatEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/dataformat/DataFormatEndpoint.java index 394f718..5db3bfd 100644 --- a/camel-core/src/main/java/org/apache/camel/component/dataformat/DataFormatEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/dataformat/DataFormatEndpoint.java @@ -32,6 +32,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriPath; import org.apache.camel.util.ServiceHelper; +/** + * The dataformat component is used for working with Data Formats as if it was a regular Component supporting Endpoints and URIs. + */ @UriEndpoint(scheme = "dataformat", title = "Data Format", syntax = "dataformat:name:operation", producerOnly = true, label = "core,transformation") public class DataFormatEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java index 129196c..10653ec 100644 --- a/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java @@ -38,9 +38,10 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Endpoint for DataSet. + * The DataSet component provides a mechanism to easily perform load & soak testing of your system. * - * @version + * It works by allowing you to create DataSet instances both as a source of messages and as a way to assert that the data set is received. + * Camel will use the throughput logger when sending dataset's. */ @UriEndpoint(scheme = "dataset", title = "Dataset", syntax = "dataset:name", consumerClass = DataSetConsumer.class, label = "core,testing") public class DataSetEndpoint extends MockEndpoint implements Service { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/direct/DirectEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/direct/DirectEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/direct/DirectEndpoint.java index 52925e7..9512875 100644 --- a/camel-core/src/main/java/org/apache/camel/component/direct/DirectEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/direct/DirectEndpoint.java @@ -31,10 +31,9 @@ import org.apache.camel.spi.UriPath; import org.apache.camel.util.ObjectHelper; /** - * Represents a direct endpoint that synchronously invokes the consumer of the - * endpoint when a producer sends a message to it. + * The direct component provides direct, synchronous call to another endpoint from the same CamelContext. * - * @version + * This endpoint can be used to connect existing routes in the same CamelContext. */ @UriEndpoint(scheme = "direct", title = "Direct", syntax = "direct:name", consumerClass = DirectConsumer.class, label = "core,endpoint") public class DirectEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/directvm/DirectVmEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/directvm/DirectVmEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/directvm/DirectVmEndpoint.java index 8489c6c..db5d1c3 100644 --- a/camel-core/src/main/java/org/apache/camel/component/directvm/DirectVmEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/directvm/DirectVmEndpoint.java @@ -27,7 +27,9 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * The direct-vm endpoint. + * The direct-vm component provides direct, synchronous call to another endpoint from any CamelContext in the same JVM. + * + * This endpoint can be used to connect existing routes in the same JVM between different CamelContexts. */ @UriEndpoint(scheme = "direct-vm", title = "Direct VM", syntax = "direct-vm:name", consumerClass = DirectConsumer.class, label = "core,endpoint") public class DirectVmEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/file/FileEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/file/FileEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/file/FileEndpoint.java index 7a8b273..94802f6 100644 --- a/camel-core/src/main/java/org/apache/camel/component/file/FileEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/file/FileEndpoint.java @@ -31,7 +31,7 @@ import org.apache.camel.util.FileUtil; import org.apache.camel.util.ObjectHelper; /** - * File endpoint. + * The file component is used for reading or writing files. */ @UriEndpoint(scheme = "file", title = "File", syntax = "file:directoryName", consumerClass = FileConsumer.class, label = "core,file") public class FileEndpoint extends GenericFileEndpoint<File> { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/language/LanguageEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/language/LanguageEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/language/LanguageEndpoint.java index 9a7ec70..851ee50 100644 --- a/camel-core/src/main/java/org/apache/camel/component/language/LanguageEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/language/LanguageEndpoint.java @@ -38,9 +38,15 @@ import org.apache.camel.util.ObjectHelper; import org.apache.camel.util.ResourceHelper; /** - * Language endpoint. + * The language component allows you to send a message to an endpoint which executes a script by any of the supported Languages in Camel. * - * @version + * By having a component to execute language scripts, it allows more dynamic routing capabilities. + * For example by using the Routing Slip or Dynamic Router EIPs you can send messages to language endpoints + * where the script is dynamic defined as well. + * + * This component is provided out of the box in camel-core and hence no additional JARs is needed. + * You only have to include additional Camel components if the language of choice mandates it, + * such as using Groovy or JavaScript languages. */ @UriEndpoint(scheme = "language", title = "Language", syntax = "language:languageName", producerOnly = true, label = "core,script") public class LanguageEndpoint extends ResourceEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/log/LogEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/log/LogEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/log/LogEndpoint.java index f89faed..f1e5c10 100644 --- a/camel-core/src/main/java/org/apache/camel/component/log/LogEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/log/LogEndpoint.java @@ -35,7 +35,9 @@ import org.apache.camel.util.ServiceHelper; import org.slf4j.Logger; /** - * Logger endpoint. + * The log component logs message exchanges to the underlying logging mechanism. + * + * Camel uses sfl4j which allows you to configure logging to the actual logging system. */ @UriEndpoint(scheme = "log", title = "Log", syntax = "log:loggerName", producerOnly = true, label = "core,monitoring") public class LogEndpoint extends ProcessorEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/mock/MockEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/mock/MockEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/mock/MockEndpoint.java index 672e902..ab4801d 100644 --- a/camel-core/src/main/java/org/apache/camel/component/mock/MockEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/mock/MockEndpoint.java @@ -64,6 +64,8 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** + * The mock component is used for testing routes and mediation rules using mocks. + * <p/> * A Mock endpoint which provides a literate, fluent API for testing routes * using a <a href="http://jmock.org/";>JMock style</a> API. * <p/> http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/ref/RefEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/ref/RefEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/ref/RefEndpoint.java index d3ca293..d1ca0b6 100644 --- a/camel-core/src/main/java/org/apache/camel/component/ref/RefEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/ref/RefEndpoint.java @@ -28,6 +28,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriPath; import org.apache.camel.util.CamelContextHelper; +/** + * The ref component is used for lookup of existing endpoints bound in the Registry. + */ @UriEndpoint(scheme = "ref", title = "Ref", syntax = "ref:name", label = "core,endpoint") public class RefEndpoint extends DefaultEndpoint implements DelegateEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/rest/RestApiEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/rest/RestApiEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/rest/RestApiEndpoint.java index f2ee48d..274678e 100644 --- a/camel-core/src/main/java/org/apache/camel/component/rest/RestApiEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/rest/RestApiEndpoint.java @@ -38,6 +38,9 @@ import org.apache.camel.spi.UriPath; import org.apache.camel.util.HostUtils; import org.apache.camel.util.ObjectHelper; +/** + * The rest-api component is used for providing Swagger API of the REST services which has been defined using the rest-dsl in Camel. + */ @UriEndpoint(scheme = "rest-api", title = "REST API", syntax = "rest-api:path/contextId", consumerOnly = true, label = "core,rest") public class RestApiEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/rest/RestEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/rest/RestEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/rest/RestEndpoint.java index f17110d..cf97592 100644 --- a/camel-core/src/main/java/org/apache/camel/component/rest/RestEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/rest/RestEndpoint.java @@ -35,6 +35,9 @@ import org.apache.camel.spi.UriPath; import org.apache.camel.util.HostUtils; import org.apache.camel.util.ObjectHelper; +/** + * The rest component is used for hosting REST services which has been defined using the rest-dsl in Camel. + */ @UriEndpoint(scheme = "rest", title = "REST", syntax = "rest:method:path:uriTemplate", consumerOnly = true, label = "core,rest") public class RestEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/scheduler/SchedulerEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/scheduler/SchedulerEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/scheduler/SchedulerEndpoint.java index 13b32c9..8f03af8 100644 --- a/camel-core/src/main/java/org/apache/camel/component/scheduler/SchedulerEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/scheduler/SchedulerEndpoint.java @@ -27,6 +27,12 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; +/** + * The scheduler component is used for generating message exchanges when a scheduler fires. + * + * This component is similar to the timer component, but it offers more functionality in terms of scheduling. + * Also this component uses JDK ScheduledExecutorService. Where as the timer uses a JDK Timer. + */ @UriEndpoint(scheme = "scheduler", title = "Scheduler", syntax = "scheduler:name", consumerOnly = true, consumerClass = SchedulerConsumer.class, label = "core,scheduling") public class SchedulerEndpoint extends ScheduledPollEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/seda/SedaEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/seda/SedaEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/seda/SedaEndpoint.java index 23f6d91..4d04342 100644 --- a/camel-core/src/main/java/org/apache/camel/component/seda/SedaEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/seda/SedaEndpoint.java @@ -48,9 +48,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * An implementation of the <a - * href="http://camel.apache.org/queue.html";>Queue components</a> for - * asynchronous SEDA exchanges on a {@link BlockingQueue} within a CamelContext + * The seda component provides asynchronous call to another endpoint from any CamelContext in the same JVM. */ @ManagedResource(description = "Managed SedaEndpoint") @UriEndpoint(scheme = "seda", title = "SEDA", syntax = "seda:name", consumerClass = SedaConsumer.class, label = "core,endpoint") http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/stub/StubEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/stub/StubEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/stub/StubEndpoint.java index 594437b..abb64e8 100644 --- a/camel-core/src/main/java/org/apache/camel/component/stub/StubEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/stub/StubEndpoint.java @@ -26,6 +26,16 @@ import org.apache.camel.component.vm.VmConsumer; import org.apache.camel.component.vm.VmEndpoint; import org.apache.camel.spi.UriEndpoint; +/** + * The stub: component provides a simple way to stub out any physical endpoints while in development or testing. + * + * For example to run a route without needing to actually connect to a specific SMTP or Http endpoint. + * Just add stub: in front of any endpoint URI to stub out the endpoint. + * Internally the Stub component creates VM endpoints. The main difference between Stub and VM is that VM + * will validate the URI and parameters you give it, so putting vm: in front of a typical URI with + * query arguments will usually fail. Stub won't though, as it basically ignores all query parameters + * to let you quickly stub out one or more endpoints in your route temporarily. + */ @UriEndpoint(scheme = "stub", title = "Stub", syntax = "stub:name", consumerClass = VmConsumer.class, label = "core,testing") public class StubEndpoint extends VmEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/test/TestEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/test/TestEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/test/TestEndpoint.java index a61efd1..3326cb5 100644 --- a/camel-core/src/main/java/org/apache/camel/component/test/TestEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/test/TestEndpoint.java @@ -33,11 +33,13 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * A <a href="http://camel.apache.org/test.html";>Test Endpoint</a> is a - * <a href="http://camel.apache.org/mock.html";>Mock Endpoint</a> for testing but it will - * pull all messages from the nested endpoint and use those as expected message body assertions. + * The test component extends the mock component to support pulling messages from another endpoint on startup to set the expected message bodies. * - * @version + * That is, you use the test endpoint in a route and messages arriving on it will be implicitly compared to some + * expected messages extracted from some other location. + * So you can use, for example, an expected set of message bodies as files. + * This will then set up a properly configured Mock endpoint, which is only valid if the received messages + * match the number of expected messages and their message payloads are equal. */ @UriEndpoint(scheme = "test", title = "Test", syntax = "test:name", producerOnly = true, label = "core,testing") public class TestEndpoint extends MockEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/timer/TimerEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/timer/TimerEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/timer/TimerEndpoint.java index b88583d..4b0c6b4 100644 --- a/camel-core/src/main/java/org/apache/camel/component/timer/TimerEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/timer/TimerEndpoint.java @@ -34,9 +34,9 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * Represents a timer endpoint that can generate periodic inbound exchanges triggered by a timer. + * The timer component is used for generating message exchanges when a timer fires. * - * @version + * This component is similar to the scheduler component, but has much less functionality. */ @ManagedResource(description = "Managed TimerEndpoint") @UriEndpoint(scheme = "timer", title = "Timer", syntax = "timer:timerName", consumerOnly = true, consumerClass = TimerConsumer.class, label = "core,scheduling") http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorEndpoint.java index 3eb3fd3..88d4b83 100644 --- a/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorEndpoint.java @@ -40,6 +40,9 @@ import org.apache.camel.util.ResourceHelper; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * Validates the payload of a message using XML Schema and JAXP Validation + */ @UriEndpoint(scheme = "validator", title = "Validator", syntax = "validator:resourceUri", producerOnly = true, label = "core,validation") public class ValidatorEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/vm/VmEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/vm/VmEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/vm/VmEndpoint.java index b483521..bd5fa0e 100644 --- a/camel-core/src/main/java/org/apache/camel/component/vm/VmEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/vm/VmEndpoint.java @@ -25,6 +25,9 @@ import org.apache.camel.component.seda.BlockingQueueFactory; import org.apache.camel.component.seda.SedaEndpoint; import org.apache.camel.spi.UriEndpoint; +/** + * The vm component provides asynchronous call to another endpoint from the same CamelContext. + */ @UriEndpoint(scheme = "vm", title = "VM", syntax = "vm:name", consumerClass = VmConsumer.class, label = "core,endpoint") public class VmEndpoint extends SedaEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/camel-core/src/main/java/org/apache/camel/component/xslt/XsltEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/xslt/XsltEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/xslt/XsltEndpoint.java index 7aa5fa5..4eaaf5b 100644 --- a/camel-core/src/main/java/org/apache/camel/component/xslt/XsltEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/xslt/XsltEndpoint.java @@ -43,6 +43,9 @@ import org.apache.camel.util.ServiceHelper; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * Generates a response using an XSLT template + */ @ManagedResource(description = "Managed XsltEndpoint") @UriEndpoint(scheme = "xslt", title = "XSLT", syntax = "xslt:resourceUri", producerOnly = true, label = "core,transformation") public class XsltEndpoint extends ProcessorEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwComponent.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwComponent.java index 85e4f76..06e106a 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwComponent.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwComponent.java @@ -22,9 +22,6 @@ import org.apache.camel.CamelContext; import org.apache.camel.Endpoint; import org.apache.camel.impl.UriEndpointComponent; -/** - * For working with Amazon's CloudWatch (CW). - */ public class CwComponent extends UriEndpointComponent { public CwComponent() { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwEndpoint.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwEndpoint.java index b33b09d..b26288b 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwEndpoint.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwEndpoint.java @@ -32,6 +32,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.camel.util.ObjectHelper; +/** + * The aws-cw component is used for sending metrics to an Amazon CloudWatch. + */ @UriEndpoint(scheme = "aws-cw", title = "AWS CloudWatch", syntax = "aws-cw:namespace", producerOnly = true, label = "cloud,monitoring") public class CwEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbComponent.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbComponent.java index 7523d62..156ff4d 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbComponent.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbComponent.java @@ -22,9 +22,6 @@ import org.apache.camel.CamelContext; import org.apache.camel.Endpoint; import org.apache.camel.impl.UriEndpointComponent; -/** - * For working with Amazon's DynamoDB (DDB). - */ public class DdbComponent extends UriEndpointComponent { public DdbComponent() { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbEndpoint.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbEndpoint.java index e238528..d6d3066 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbEndpoint.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbEndpoint.java @@ -42,6 +42,9 @@ import org.apache.camel.util.ObjectHelper; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * The aws-ddb component is used for storing and retrieving data from Amazon's DynamoDB service. + */ @UriEndpoint(scheme = "aws-ddb", title = "AWS DynamoDB", syntax = "aws-ddb:tableName", producerOnly = true, label = "cloud,database,nosql") public class DdbEndpoint extends ScheduledPollEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamComponent.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamComponent.java index b7bad44..ed384e4 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamComponent.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamComponent.java @@ -23,9 +23,6 @@ import org.apache.camel.impl.UriEndpointComponent; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -/** - * For working with Amazon's DynamoDB (DDB) Streams. - */ public class DdbStreamComponent extends UriEndpointComponent { private static final Logger LOG = LoggerFactory.getLogger(DdbStreamComponent.class); http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamEndpoint.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamEndpoint.java index bc12bc6..6691ad6 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamEndpoint.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddbstream/DdbStreamEndpoint.java @@ -29,6 +29,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; +/** + * The aws-ddbstream component is used for working with Amazon DynamoDB Streams + */ @UriEndpoint(scheme = "aws-ddbstream", title = "AWS DynamoDB Streams", consumerOnly = true, syntax = "aws-ddbstream:tableName", consumerClass = DdbStreamConsumer.class, label = "cloud,messaging,streams") http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Endpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Endpoint.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Endpoint.java index 6098959..45a7ccb 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Endpoint.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Endpoint.java @@ -30,6 +30,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.camel.util.ObjectHelper; +/** + * The aws-ec2 is used for managing Amazon EC2 instances + */ @UriEndpoint(scheme = "aws-ec2", title = "AWS EC2", syntax = "aws-ec2:label", producerOnly = true, label = "cloud,management") public class EC2Endpoint extends ScheduledPollEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisComponent.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisComponent.java index 0bcd285..9740600 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisComponent.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisComponent.java @@ -24,9 +24,6 @@ import org.apache.camel.impl.UriEndpointComponent; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -/** - * For working with Amazon's Kinesis Streams. - */ public class KinesisComponent extends UriEndpointComponent { private static final Logger LOG = LoggerFactory.getLogger(KinesisComponent.class); http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisEndpoint.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisEndpoint.java index b041a85..249944d 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisEndpoint.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/kinesis/KinesisEndpoint.java @@ -29,6 +29,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; +/** + * The aws-kinesis component is for consuming records from Amazon Kinesis Streams + */ @UriEndpoint(scheme = "aws-kinesis", title = "AWS Kinesis", syntax = "aws-kinesis:streamName", consumerOnly = true, consumerClass = KinesisConsumer.class, label = "cloud,messaging") public class KinesisEndpoint extends ScheduledPollEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Component.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Component.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Component.java index 86cf1e5..aa99b09 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Component.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Component.java @@ -22,9 +22,6 @@ import org.apache.camel.CamelContext; import org.apache.camel.Endpoint; import org.apache.camel.impl.UriEndpointComponent; -/** - * For working with Amazon's Simple Storage Service (S3). - */ public class S3Component extends UriEndpointComponent { public S3Component() { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Endpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Endpoint.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Endpoint.java index 1698c77..82273be 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Endpoint.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/s3/S3Endpoint.java @@ -35,7 +35,6 @@ import org.apache.camel.ExchangePattern; import org.apache.camel.Message; import org.apache.camel.Processor; import org.apache.camel.Producer; -import org.apache.camel.impl.DefaultExchange; import org.apache.camel.impl.ScheduledPollEndpoint; import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; @@ -44,7 +43,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Defines the <a href="http://camel.apache.org/aws.html";>AWS S3 Endpoint</a>. + * The aws-s3 component is used for storing and retrieving objetc from Amazon S3 Storage Service. */ @UriEndpoint(scheme = "aws-s3", title = "AWS S3 Storage Service", syntax = "aws-s3:bucketName", consumerClass = S3Consumer.class, label = "cloud,file") public class S3Endpoint extends ScheduledPollEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbComponent.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbComponent.java index 92182f9..18c44d3 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbComponent.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbComponent.java @@ -22,9 +22,6 @@ import org.apache.camel.CamelContext; import org.apache.camel.Endpoint; import org.apache.camel.impl.UriEndpointComponent; -/** - * For working with Amazon's SimpleDB (SDB). - */ public class SdbComponent extends UriEndpointComponent { public SdbComponent() { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbEndpoint.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbEndpoint.java index 05fc371..f72d1c3 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbEndpoint.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbEndpoint.java @@ -38,6 +38,9 @@ import org.apache.camel.util.ObjectHelper; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * The aws-sdb component is for storing and retrieving data from/to Amazon's SDB service. + */ @UriEndpoint(scheme = "aws-sdb", title = "AWS SimpleDB", syntax = "aws-sdb:domainName", producerOnly = true, label = "cloud,database,nosql") public class SdbEndpoint extends ScheduledPollEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesComponent.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesComponent.java index 3afeade..d330533 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesComponent.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesComponent.java @@ -22,9 +22,6 @@ import org.apache.camel.CamelContext; import org.apache.camel.Endpoint; import org.apache.camel.impl.UriEndpointComponent; -/** - * For working with Amazon's Simple Email Service (SES). - */ public class SesComponent extends UriEndpointComponent { public SesComponent() { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesEndpoint.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesEndpoint.java index 1366cf8..577e19d 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesEndpoint.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesEndpoint.java @@ -32,6 +32,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.camel.util.ObjectHelper; +/** + * The aws-ses component is used for sending emails with Amazon's SES service. + */ @UriEndpoint(scheme = "aws-ses", title = "AWS Simple Email Service", syntax = "aws-ses:from", producerOnly = true, label = "cloud,mail") public class SesEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsComponent.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsComponent.java index 1f1eaf3..f3e1812 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsComponent.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsComponent.java @@ -22,9 +22,6 @@ import org.apache.camel.CamelContext; import org.apache.camel.Endpoint; import org.apache.camel.impl.UriEndpointComponent; -/** - * For Messaging with Amazon's Simple Notification Service (SNS). - */ public class SnsComponent extends UriEndpointComponent { public SnsComponent() { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsEndpoint.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsEndpoint.java index 0458a44..2e295fa 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsEndpoint.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsEndpoint.java @@ -37,6 +37,9 @@ import org.apache.camel.util.ObjectHelper; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * The aws-sns component is used for sending messages to an Amazon Simple Notification Topic + */ @UriEndpoint(scheme = "aws-sns", title = "AWS Simple Notification System", syntax = "aws-sns:topicName", producerOnly = true, label = "cloud,mobile,messaging") public class SnsEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsComponent.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsComponent.java index df55176..37dcbe3 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsComponent.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsComponent.java @@ -22,9 +22,6 @@ import org.apache.camel.CamelContext; import org.apache.camel.Endpoint; import org.apache.camel.impl.UriEndpointComponent; -/** - * For Messaging with Amazon's Simple Queue Service (SQS). - */ public class SqsComponent extends UriEndpointComponent { public SqsComponent() { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsEndpoint.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsEndpoint.java index 6872efd..fcfcc3a 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsEndpoint.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsEndpoint.java @@ -50,6 +50,9 @@ import org.apache.camel.util.ObjectHelper; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * The aws-sqs component is used for sending and receiving messages to Amazon's SQS service. + */ @UriEndpoint(scheme = "aws-sqs", title = "AWS Simple Queue Service", syntax = "aws-sqs:queueName", consumerClass = SqsConsumer.class, label = "cloud,messaging") public class SqsEndpoint extends ScheduledPollEndpoint implements HeaderFilterStrategyAware { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFComponent.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFComponent.java index 7a1a9ae..eadfc02 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFComponent.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFComponent.java @@ -22,9 +22,6 @@ import org.apache.camel.Endpoint; import org.apache.camel.impl.UriEndpointComponent; import org.apache.camel.util.IntrospectionSupport; -/** - * For Messaging with Amazon's Simple Workflow Service (SWF). - */ public class SWFComponent extends UriEndpointComponent { public SWFComponent() { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFEndpoint.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFEndpoint.java index 8ecaca3..86bb519 100644 --- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFEndpoint.java +++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFEndpoint.java @@ -32,6 +32,9 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.util.EndpointHelper; import org.apache.camel.util.ExchangeHelper; +/** + * The aws-swf component is used for managing workflows from Amazon Simple Workflow. + */ @UriEndpoint(scheme = "aws-swf", title = "AWS Simple Workflow", syntax = "aws-swf:type", consumerClass = SWFWorkflowConsumer.class, label = "cloud,workflow") public class SWFEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/platforms/commands/commands-core/src/test/java/org/apache/camel/commands/CatalogCommandTest.java ---------------------------------------------------------------------- diff --git a/platforms/commands/commands-core/src/test/java/org/apache/camel/commands/CatalogCommandTest.java b/platforms/commands/commands-core/src/test/java/org/apache/camel/commands/CatalogCommandTest.java index be4b941..af5cc97 100644 --- a/platforms/commands/commands-core/src/test/java/org/apache/camel/commands/CatalogCommandTest.java +++ b/platforms/commands/commands-core/src/test/java/org/apache/camel/commands/CatalogCommandTest.java @@ -50,6 +50,7 @@ public class CatalogCommandTest { String out = os.toString(); assertNotNull(out); LOG.info("\n\n{}\n", out); + System.out.println(out); context.stop(); } http://git-wip-us.apache.org/repos/asf/camel/blob/bbbdb64d/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java ---------------------------------------------------------------------- diff --git a/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java b/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java index 61e5dbc..ba05e20 100644 --- a/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java +++ b/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java @@ -433,12 +433,12 @@ public class EndpointAnnotationProcessor extends AbstractAnnotationProcessor { Map<String, String> map = parseAsMap(data); // now we have a lot more data, so we need to load it as key/value // need to sanitize the description first - String doc = map.get("projectDescription"); - if (doc != null) { - model.setDescription(sanitizeDescription(doc, true)); - } else { +// String doc = map.get("projectDescription"); +// if (doc != null) { +// model.setDescription(sanitizeDescription(doc, true)); +// } else { model.setDescription(""); - } +// } if (map.containsKey("groupId")) { model.setGroupId(map.get("groupId")); } else {
