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/cfc1f1f3 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/cfc1f1f3 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/cfc1f1f3 Branch: refs/heads/master Commit: cfc1f1f334fb878f63fa5a1e02bebb51c2186b05 Parents: 5f269bd Author: Claus Ibsen <[email protected]> Authored: Sun Dec 27 13:44:44 2015 +0100 Committer: Claus Ibsen <[email protected]> Committed: Sun Dec 27 18:25:25 2015 +0100 ---------------------------------------------------------------------- .../crypto/DigitalSignatureEndpoint.java | 2 +- .../camel/component/docker/DockerEndpoint.java | 2 +- .../camel/component/elsql/ElsqlEndpoint.java | 2 +- .../component/facebook/FacebookEndpoint.java | 5 +++- .../component/flatpack/FlatpackEndpoint.java | 4 +-- .../apache/camel/component/fop/FopEndpoint.java | 2 +- .../freemarker/FreemarkerEndpoint.java | 2 +- .../component/file/remote/FtpEndpoint.java | 2 +- .../component/file/remote/FtpsEndpoint.java | 4 +-- .../component/file/remote/SftpEndpoint.java | 2 +- .../camel/component/gae/auth/GAuthEndpoint.java | 4 ++- .../camel/component/gae/http/GHttpEndpoint.java | 5 ++-- .../component/gae/login/GLoginEndpoint.java | 5 ++-- .../camel/component/gae/mail/GMailEndpoint.java | 4 +-- .../camel/component/gae/task/GTaskEndpoint.java | 4 +-- .../component/ganglia/GangliaEndpoint.java | 3 +++ .../component/geocoder/GeoCoderEndpoint.java | 2 +- .../apache/camel/component/git/GitEndpoint.java | 3 +++ .../camel/component/github/GitHubEndpoint.java | 2 ++ .../google/calendar/GoogleCalendarEndpoint.java | 2 +- .../google/drive/GoogleDriveEndpoint.java | 2 +- .../google/mail/GoogleMailEndpoint.java | 2 +- .../camel/component/gora/GoraEndpoint.java | 28 +------------------- .../kubernetes/KubernetesEndpoint.java | 2 +- .../component/openshift/OpenShiftEndpoint.java | 2 +- 25 files changed, 39 insertions(+), 58 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java b/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java index a390e3e..1560bc5 100644 --- a/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java +++ b/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java @@ -34,7 +34,7 @@ import org.apache.camel.spi.UriParam; /** * The crypto component is used for signing and verifying exchanges using the Signature Service of the Java Cryptographic Extension (JCE). */ -@UriEndpoint(scheme = "crypto", title = "Crypto (Java Cryptographic Extension)", syntax = "crypto:cryptoOperation", producerOnly = true, label = "security,transformation") +@UriEndpoint(scheme = "crypto", title = "Crypto (JCE)", syntax = "crypto:cryptoOperation", producerOnly = true, label = "security,transformation") public class DigitalSignatureEndpoint extends DefaultEndpoint { @UriParam private DigitalSignatureConfiguration configuration; http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java index 09d80f6..62bdb6a 100644 --- a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java +++ b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java @@ -30,7 +30,7 @@ import org.apache.camel.spi.UriParam; /** * The docker component is used for managing Docker containers. */ -@UriEndpoint(scheme = "docker", title = "Docker", syntax = "docker:operation", consumerClass = DockerEventsConsumer.class, label = "container,cloud,management,platform") +@UriEndpoint(scheme = "docker", title = "Docker", syntax = "docker:operation", consumerClass = DockerEventsConsumer.class, label = "container,cloud,paas") public class DockerEndpoint extends DefaultEndpoint { @UriParam http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java b/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java index 07abfad..ab09ab0 100644 --- a/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java +++ b/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java @@ -45,7 +45,7 @@ import org.springframework.jdbc.core.namedparam.SqlParameterSource; /** * The elsql component is an extension to the existing SQL Component that uses ElSql to define the SQL queries. */ -@UriEndpoint(scheme = "elsql", title = "SQL", syntax = "elsql:elsqlName:resourceUri", consumerClass = ElsqlConsumer.class, label = "database,sql") +@UriEndpoint(scheme = "elsql", title = "ElSQL", syntax = "elsql:elsqlName:resourceUri", consumerClass = ElsqlConsumer.class, label = "database,sql") public class ElsqlEndpoint extends DefaultSqlEndpoint { private static final Logger LOG = LoggerFactory.getLogger(ElsqlEndpoint.class); http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java index 740ce85..905d0c1 100644 --- a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java +++ b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java @@ -48,7 +48,10 @@ import static org.apache.camel.component.facebook.data.FacebookMethodsTypeHelper import static org.apache.camel.component.facebook.data.FacebookPropertiesHelper.getEndpointPropertyNames; /** - * Represents a Facebook endpoint. + * The Facebook component provides access to all of the Facebook APIs accessible using Facebook4J. + * + * It allows producing messages to retrieve, add, and delete posts, likes, comments, photos, albums, videos, photos, + * checkins, locations, links, etc. It also supports APIs that allow polling for posts, users, checkins, groups, locations, etc. */ @UriEndpoint(scheme = "facebook", title = "Facebook", syntax = "facebook:methodName", consumerClass = FacebookConsumer.class, label = "social") public class FacebookEndpoint extends DefaultEndpoint implements FacebookConstants { http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-flatpack/src/main/java/org/apache/camel/component/flatpack/FlatpackEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-flatpack/src/main/java/org/apache/camel/component/flatpack/FlatpackEndpoint.java b/components/camel-flatpack/src/main/java/org/apache/camel/component/flatpack/FlatpackEndpoint.java index 8c5cabe..080c5b4 100644 --- a/components/camel-flatpack/src/main/java/org/apache/camel/component/flatpack/FlatpackEndpoint.java +++ b/components/camel-flatpack/src/main/java/org/apache/camel/component/flatpack/FlatpackEndpoint.java @@ -44,9 +44,7 @@ import org.apache.camel.util.ObjectHelper; import org.apache.camel.util.ResourceHelper; /** - * Processing fixed width or delimited files or messages using the FlatPack library. - * - * @version + * The flatpack component supports fixed width and delimited file parsing via the FlatPack library. */ @UriEndpoint(scheme = "flatpack", title = "Flatpack", syntax = "flatpack:type:resourceUri", consumerClass = FlatpackConsumer.class, label = "transformation") public class FlatpackEndpoint extends DefaultPollingEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-fop/src/main/java/org/apache/camel/component/fop/FopEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-fop/src/main/java/org/apache/camel/component/fop/FopEndpoint.java b/components/camel-fop/src/main/java/org/apache/camel/component/fop/FopEndpoint.java index 2cffd26..42df6ef 100644 --- a/components/camel-fop/src/main/java/org/apache/camel/component/fop/FopEndpoint.java +++ b/components/camel-fop/src/main/java/org/apache/camel/component/fop/FopEndpoint.java @@ -32,7 +32,7 @@ import org.apache.camel.util.ResourceHelper; import org.apache.fop.apps.FopFactory; /** - * Represents a Fop endpoint. + * The fop component allows you to render a message into different output formats using Apache FOP. */ @UriEndpoint(scheme = "fop", title = "FOP", syntax = "fop:outputType", producerOnly = true, label = "transformation") public class FopEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/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 8f63376..3c2c134 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; /** - * Freemarker endpoint + * 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/cfc1f1f3/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpEndpoint.java b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpEndpoint.java index 6f1b025..0b2e56d 100644 --- a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpEndpoint.java +++ b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpEndpoint.java @@ -34,7 +34,7 @@ import org.apache.commons.net.ftp.FTPClientConfig; import org.apache.commons.net.ftp.FTPFile; /** - * FTP endpoint + * The ftp component is used for uploading or downloading files from FTP servers. */ @UriEndpoint(scheme = "ftp", extendsScheme = "file", title = "FTP", syntax = "ftp:host:port/directoryName", consumerClass = FtpConsumer.class, label = "file") http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpsEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpsEndpoint.java b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpsEndpoint.java index 3dfa806..036d281 100644 --- a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpsEndpoint.java +++ b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpsEndpoint.java @@ -37,9 +37,7 @@ import org.apache.commons.net.ftp.FTPFile; import org.apache.commons.net.ftp.FTPSClient; /** - * FTP Secure (FTP over SSL/TLS) endpoint - * - * @version + * The ftps (FTP secure SSL/TLS) component is used for uploading or downloading files from FTP servers. */ @UriEndpoint(scheme = "ftps", extendsScheme = "file", title = "FTPS", syntax = "ftps:host:port/directoryName", consumerClass = FtpConsumer.class, label = "file") http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/SftpEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/SftpEndpoint.java b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/SftpEndpoint.java index 5859aa4..12af0f8 100644 --- a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/SftpEndpoint.java +++ b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/SftpEndpoint.java @@ -25,7 +25,7 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; /** - * Secure FTP endpoint + * The sftp (FTP over SSH) component is used for uploading or downloading files from SFTP servers. */ @UriEndpoint(scheme = "sftp", extendsScheme = "file", title = "SFTP", syntax = "sftp:host:port/directoryName", consumerClass = SftpConsumer.class, label = "file") http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-gae/src/main/java/org/apache/camel/component/gae/auth/GAuthEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-gae/src/main/java/org/apache/camel/component/gae/auth/GAuthEndpoint.java b/components/camel-gae/src/main/java/org/apache/camel/component/gae/auth/GAuthEndpoint.java index 7385570..5e4f9ff 100644 --- a/components/camel-gae/src/main/java/org/apache/camel/component/gae/auth/GAuthEndpoint.java +++ b/components/camel-gae/src/main/java/org/apache/camel/component/gae/auth/GAuthEndpoint.java @@ -37,6 +37,8 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** + * The gauth component is used by web applications to implement a Google-specific OAuth consumer. + * * Represents a <a href="http://camel.apache.org/gauth.html";>GAuth Endpoint</a>. * Instances can have one of two names, either <code>authorize</code> for * requesting an unauthorized request token or <code>upgrade</code> for @@ -44,7 +46,7 @@ import org.apache.camel.spi.UriPath; * endpoint URIs are <code>gauth:authorize</code> and <code>gauth:upgrade</code> * , respectively. */ -@UriEndpoint(scheme = "gauth", title = "Google GAuth", syntax = "gauth:name", producerOnly = true, label = "cloud") +@UriEndpoint(scheme = "gauth", title = "Google GAuth", syntax = "gauth:name", producerOnly = true, label = "cloud,paas") public class GAuthEndpoint extends DefaultEndpoint { public static enum Name { http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-gae/src/main/java/org/apache/camel/component/gae/http/GHttpEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-gae/src/main/java/org/apache/camel/component/gae/http/GHttpEndpoint.java b/components/camel-gae/src/main/java/org/apache/camel/component/gae/http/GHttpEndpoint.java index 75e3cf7..c205ece 100644 --- a/components/camel-gae/src/main/java/org/apache/camel/component/gae/http/GHttpEndpoint.java +++ b/components/camel-gae/src/main/java/org/apache/camel/component/gae/http/GHttpEndpoint.java @@ -42,11 +42,10 @@ import org.apache.camel.util.URISupport; import org.apache.camel.util.UnsafeUriCharactersEncoder; /** - * Represents a <a href="http://camel.apache.org/ghttp.html";>Google App Engine - * HTTP endpoint</a>. + * The ghttp component provides HTTP connectivity to the GAE. */ @UriEndpoint(scheme = "ghttp", extendsScheme = "servlet", title = "Google HTTP", - syntax = "ghttp:httpUri", producerOnly = true, label = "cloud") + syntax = "ghttp:httpUri", producerOnly = true, label = "cloud,paas") public class GHttpEndpoint extends ServletEndpoint implements OutboundBindingSupport<GHttpEndpoint, HTTPRequest, HTTPResponse> { public static final String GHTTP_SCHEME = "ghttp"; http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-gae/src/main/java/org/apache/camel/component/gae/login/GLoginEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-gae/src/main/java/org/apache/camel/component/gae/login/GLoginEndpoint.java b/components/camel-gae/src/main/java/org/apache/camel/component/gae/login/GLoginEndpoint.java index d0ba8f0..cfc3f23 100644 --- a/components/camel-gae/src/main/java/org/apache/camel/component/gae/login/GLoginEndpoint.java +++ b/components/camel-gae/src/main/java/org/apache/camel/component/gae/login/GLoginEndpoint.java @@ -28,10 +28,9 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * Represents a <a href="http://camel.apache.org/glogin.html";>GLogin - * Endpoint</a>. + * The glogin component is used by Camel applications outside Google App Engine (GAE) for programmatic login to GAE applications. */ -@UriEndpoint(scheme = "glogin", title = "Google Login", syntax = "glogin:hostName", producerOnly = true, label = "cloud") +@UriEndpoint(scheme = "glogin", title = "Google Login", syntax = "glogin:hostName", producerOnly = true, label = "cloud,paas") public class GLoginEndpoint extends DefaultEndpoint { private OutboundBinding<GLoginEndpoint, GLoginData, GLoginData> outboundBinding; http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-gae/src/main/java/org/apache/camel/component/gae/mail/GMailEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-gae/src/main/java/org/apache/camel/component/gae/mail/GMailEndpoint.java b/components/camel-gae/src/main/java/org/apache/camel/component/gae/mail/GMailEndpoint.java index 1562601..246711c 100644 --- a/components/camel-gae/src/main/java/org/apache/camel/component/gae/mail/GMailEndpoint.java +++ b/components/camel-gae/src/main/java/org/apache/camel/component/gae/mail/GMailEndpoint.java @@ -33,9 +33,9 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * Represents a <a href="http://camel.apache.org/gmail.html";>Google App Engine Mail endpoint</a>. + * The gmail component is used for sending emails to GAE. */ -@UriEndpoint(scheme = "gmail", title = "Google mail", syntax = "gmail:sender", producerOnly = true, label = "cloud,mail") +@UriEndpoint(scheme = "gmail", title = "Google mail", syntax = "gmail:sender", producerOnly = true, label = "cloud,mail,paas") public class GMailEndpoint extends DefaultEndpoint implements OutboundBindingSupport<GMailEndpoint, Message, Void> { private OutboundBinding<GMailEndpoint, Message, Void> outboundBinding; http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-gae/src/main/java/org/apache/camel/component/gae/task/GTaskEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-gae/src/main/java/org/apache/camel/component/gae/task/GTaskEndpoint.java b/components/camel-gae/src/main/java/org/apache/camel/component/gae/task/GTaskEndpoint.java index e688d67..2128711 100644 --- a/components/camel-gae/src/main/java/org/apache/camel/component/gae/task/GTaskEndpoint.java +++ b/components/camel-gae/src/main/java/org/apache/camel/component/gae/task/GTaskEndpoint.java @@ -39,10 +39,10 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * Represents a <a href="http://camel.apache.org/gtask.html";>Google App Engine Task Queueing endpoint</a>. + * The gtask component is used for sending messages to GAE task queue service. */ @UriEndpoint(scheme = "gtask", extendsScheme = "servlet", title = "Google Task", - syntax = "gtask:queueName", producerOnly = true, label = "cloud") + syntax = "gtask:queueName", producerOnly = true, label = "cloud,paas") public class GTaskEndpoint extends ServletEndpoint implements OutboundBindingSupport<GTaskEndpoint, TaskOptions, Void> { private OutboundBinding<GTaskEndpoint, TaskOptions, Void> outboundBinding; http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-ganglia/src/main/java/org/apache/camel/component/ganglia/GangliaEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-ganglia/src/main/java/org/apache/camel/component/ganglia/GangliaEndpoint.java b/components/camel-ganglia/src/main/java/org/apache/camel/component/ganglia/GangliaEndpoint.java index 529b272..847e724 100644 --- a/components/camel-ganglia/src/main/java/org/apache/camel/component/ganglia/GangliaEndpoint.java +++ b/components/camel-ganglia/src/main/java/org/apache/camel/component/ganglia/GangliaEndpoint.java @@ -28,6 +28,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.camel.util.ObjectHelper; +/** + * The ganglia component is used for sending metrics to the Ganglia monitoring system. + */ @UriEndpoint(scheme = "ganglia", title = "Ganglia", syntax = "ganglia:host:port", producerOnly = true, label = "monitoring") public class GangliaEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-geocoder/src/main/java/org/apache/camel/component/geocoder/GeoCoderEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-geocoder/src/main/java/org/apache/camel/component/geocoder/GeoCoderEndpoint.java b/components/camel-geocoder/src/main/java/org/apache/camel/component/geocoder/GeoCoderEndpoint.java index a4c07d5..bf65e7b 100644 --- a/components/camel-geocoder/src/main/java/org/apache/camel/component/geocoder/GeoCoderEndpoint.java +++ b/components/camel-geocoder/src/main/java/org/apache/camel/component/geocoder/GeoCoderEndpoint.java @@ -25,7 +25,7 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * Represents a GeoCoder endpoint. + * The geocoder component is used for looking up geocodes (latitude and longitude) for a given address, or reverse lookup. */ @UriEndpoint(scheme = "geocoder", title = "Geocoder", syntax = "geocoder:address:latlng", producerOnly = true, label = "api,location") public class GeoCoderEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-git/src/main/java/org/apache/camel/component/git/GitEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-git/src/main/java/org/apache/camel/component/git/GitEndpoint.java b/components/camel-git/src/main/java/org/apache/camel/component/git/GitEndpoint.java index 2b11d10..505aa3f 100644 --- a/components/camel-git/src/main/java/org/apache/camel/component/git/GitEndpoint.java +++ b/components/camel-git/src/main/java/org/apache/camel/component/git/GitEndpoint.java @@ -30,6 +30,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; +/** + * The git component is used for working with git repositories. + */ @UriEndpoint(scheme = "git", title = "Git", syntax = "git:localpath", label = "file") public class GitEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java b/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java index e2edcf3..a76fee4 100644 --- a/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java +++ b/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java @@ -36,6 +36,8 @@ import org.apache.camel.spi.UriPath; import org.apache.camel.util.ObjectHelper; /** + * The github component is used for integrating Camel with github. + * * The endpoint encapsulates portions of the GitHub API, relying on the org.eclipse.egit.github.core Java SDK. * Available endpoint URIs include: * http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/GoogleCalendarEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/GoogleCalendarEndpoint.java b/components/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/GoogleCalendarEndpoint.java index 13c3c87..e955f6c 100644 --- a/components/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/GoogleCalendarEndpoint.java +++ b/components/camel-google-calendar/src/main/java/org/apache/camel/component/google/calendar/GoogleCalendarEndpoint.java @@ -34,7 +34,7 @@ import org.apache.camel.util.component.ApiMethod; import org.apache.camel.util.component.ApiMethodPropertiesHelper; /** - * Represents a GoogleCalendar endpoint. + * The google-calendar component provides access to Google Calendar. */ @UriEndpoint(scheme = "google-calendar", title = "Google Calendar", syntax = "google-calendar:apiName/methodName", consumerClass = GoogleCalendarConsumer.class, consumerPrefix = "consumer", label = "api,cloud") http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-google-drive/src/main/java/org/apache/camel/component/google/drive/GoogleDriveEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-google-drive/src/main/java/org/apache/camel/component/google/drive/GoogleDriveEndpoint.java b/components/camel-google-drive/src/main/java/org/apache/camel/component/google/drive/GoogleDriveEndpoint.java index d6e509c..c6769f2 100644 --- a/components/camel-google-drive/src/main/java/org/apache/camel/component/google/drive/GoogleDriveEndpoint.java +++ b/components/camel-google-drive/src/main/java/org/apache/camel/component/google/drive/GoogleDriveEndpoint.java @@ -33,7 +33,7 @@ import org.apache.camel.util.component.ApiMethod; import org.apache.camel.util.component.ApiMethodPropertiesHelper; /** - * Represents a GoogleDrive endpoint. + * The google-driverr component provides access to Google Drive file storage service. */ @UriEndpoint(scheme = "google-drive", title = "Google Drive", syntax = "google:drive:apiName/methodName", consumerClass = GoogleDriveConsumer.class, consumerPrefix = "consumer", label = "api,cloud,file") http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/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 55a580a..a1333cf 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; /** - * Represents a GoogleMail endpoint. + * 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/cfc1f1f3/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraEndpoint.java b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraEndpoint.java index 238786d..f72960f 100644 --- a/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraEndpoint.java +++ b/components/camel-gora/src/main/java/org/apache/camel/component/gora/GoraEndpoint.java @@ -14,7 +14,6 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - package org.apache.camel.component.gora; import org.apache.camel.Consumer; @@ -25,21 +24,14 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.gora.persistency.Persistent; import org.apache.gora.store.DataStore; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; /** - * Gora endpoint + * The gora component allows you to work with NoSQL databases using the Apache Gora framework. */ @UriEndpoint(scheme = "gora", title = "Gora", syntax = "gora:name", consumerClass = GoraConsumer.class, label = "database,hadoop,nosql") public class GoraEndpoint extends DefaultEndpoint { /** - * logger - */ - private static final Logger LOG = LoggerFactory.getLogger(GoraEndpoint.class); - - /** * Gora DataStore */ private final DataStore<Object, Persistent> dataStore; @@ -68,39 +60,21 @@ public class GoraEndpoint extends DefaultEndpoint { this.dataStore = dataStore; } - /** - * {@inheritDoc} - */ @Override public Producer createProducer() throws Exception { - return new GoraProducer(this, this.configuration, this.dataStore); } - /** - * {@inheritDoc} - */ - @Override public Consumer createConsumer(final Processor processor) throws Exception { - return new GoraConsumer(this, processor, this.configuration, this.dataStore); } - /** - * Get Configutation - * - * @return - */ public GoraConfiguration getConfiguration() { return configuration; } - /** - * {@inheritDoc} - */ @Override public boolean isSingleton() { - return true; } http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java b/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java index 2f45522..188640f 100644 --- a/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java +++ b/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java @@ -47,7 +47,7 @@ import org.apache.camel.util.ObjectHelper; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -@UriEndpoint(scheme = "kubernetes", title = "Kubernetes", syntax = "kubernetes:master", label = "cloud,paas") +@UriEndpoint(scheme = "kubernetes", title = "Kubernetes", syntax = "kubernetes:master", label = "container,cloud,paas") public class KubernetesEndpoint extends DefaultEndpoint { private static final Logger LOG = LoggerFactory.getLogger(KubernetesEndpoint.class); http://git-wip-us.apache.org/repos/asf/camel/blob/cfc1f1f3/components/camel-openshift/src/main/java/org/apache/camel/component/openshift/OpenShiftEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-openshift/src/main/java/org/apache/camel/component/openshift/OpenShiftEndpoint.java b/components/camel-openshift/src/main/java/org/apache/camel/component/openshift/OpenShiftEndpoint.java index fb57ae9..03166bf 100644 --- a/components/camel-openshift/src/main/java/org/apache/camel/component/openshift/OpenShiftEndpoint.java +++ b/components/camel-openshift/src/main/java/org/apache/camel/component/openshift/OpenShiftEndpoint.java @@ -29,7 +29,7 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; import org.apache.camel.util.ObjectHelper; -@UriEndpoint(scheme = "openshift", title = "OpenShift", syntax = "openshift:clientId", consumerClass = OpenShiftConsumer.class, label = "cloud") +@UriEndpoint(scheme = "openshift", title = "OpenShift", syntax = "openshift:clientId", consumerClass = OpenShiftConsumer.class, label = "cloud,paas") public class OpenShiftEndpoint extends ScheduledPollEndpoint { @UriPath @Metadata(required = "true")
