You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2015/12/27 18:28:45 UTC
[15/20] camel git commit: 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.
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/0549b8d3
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/0549b8d3
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/0549b8d3
Branch: refs/heads/master
Commit: 0549b8d36595b543950b80ed6042ed7dfa565fa0
Parents: ed1223a
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Dec 27 15:25:34 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Dec 27 18:25:28 2015 +0100
----------------------------------------------------------------------
.../org/apache/camel/component/printer/PrinterEndpoint.java | 9 +++++++++
components/camel-quartz/pom.xml | 2 +-
.../org/apache/camel/component/quartz/QuartzEndpoint.java | 4 +---
.../org/apache/camel/component/quartz2/QuartzEndpoint.java | 4 +---
.../apache/camel/component/quickfixj/QuickfixjEndpoint.java | 3 +++
.../apache/camel/component/rabbitmq/RabbitMQEndpoint.java | 3 +++
.../org/apache/camel/component/restlet/RestletEndpoint.java | 4 +---
.../java/org/apache/camel/component/rmi/RmiEndpoint.java | 2 +-
components/camel-routebox/pom.xml | 2 +-
.../apache/camel/component/routebox/RouteboxEndpoint.java | 3 +++
.../java/org/apache/camel/component/rss/RssEndpoint.java | 2 +-
.../camel/component/salesforce/SalesforceEndpoint.java | 2 +-
.../camel/component/sap/netweaver/NetWeaverEndpoint.java | 3 +++
.../org/apache/camel/component/xquery/XQueryEndpoint.java | 3 +++
.../camel/component/schematron/SchematronEndpoint.java | 2 +-
15 files changed, 33 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-printer/src/main/java/org/apache/camel/component/printer/PrinterEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-printer/src/main/java/org/apache/camel/component/printer/PrinterEndpoint.java b/components/camel-printer/src/main/java/org/apache/camel/component/printer/PrinterEndpoint.java
index 164adf7..d692da6 100644
--- a/components/camel-printer/src/main/java/org/apache/camel/component/printer/PrinterEndpoint.java
+++ b/components/camel-printer/src/main/java/org/apache/camel/component/printer/PrinterEndpoint.java
@@ -24,6 +24,15 @@ import org.apache.camel.impl.DefaultEndpoint;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
+/**
+ * The printer component is used for sending messages to printers as print jobs.
+ *
+ * Obviously the payload has to be a formatted piece of payload in order for the component to appropriately print it.
+ * The objective is to be able to direct specific payloads as jobs to a line printer in a camel flow.
+ *
+ * The functionality allows for the payload to be printed on a default printer, named local, remote or wirelessly
+ * linked printer using the javax printing API under the covers.
+ */
@UriEndpoint(scheme = "lpr", title = "Printer", syntax = "lpr:hostname:port/printername", producerOnly = true, label = "printing")
public class PrinterEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-quartz/pom.xml
----------------------------------------------------------------------
diff --git a/components/camel-quartz/pom.xml b/components/camel-quartz/pom.xml
index f60f073..05e0599 100644
--- a/components/camel-quartz/pom.xml
+++ b/components/camel-quartz/pom.xml
@@ -26,7 +26,7 @@
<artifactId>camel-quartz</artifactId>
<packaging>bundle</packaging>
- <name>Camel :: Quartz</name>
+ <name>Camel :: Quartz (deprecated)</name>
<description>Camel Quartz support</description>
<properties>
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/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 fb569a1..090dcea 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,9 +42,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * A <a href="http://activemq.apache.org/quartz.html">Quartz Endpoint</a>
- *
- * @version
+ * 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/0549b8d3/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 e8bb885..54251b8 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,9 +51,7 @@ import static org.quartz.CronScheduleBuilder.cronSchedule;
import static org.quartz.SimpleScheduleBuilder.simpleSchedule;
/**
- * This endpoint represent each job to be created in scheduler. When consumer is started or stopped, it will
- * call back into {@link #onConsumerStart(QuartzConsumer)} to add/resume or {@link #onConsumerStop(QuartzConsumer)}
- * to pause the scheduler trigger.
+ * 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/0549b8d3/components/camel-quickfix/src/main/java/org/apache/camel/component/quickfixj/QuickfixjEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-quickfix/src/main/java/org/apache/camel/component/quickfixj/QuickfixjEndpoint.java b/components/camel-quickfix/src/main/java/org/apache/camel/component/quickfixj/QuickfixjEndpoint.java
index 16e459b..dd26444 100644
--- a/components/camel-quickfix/src/main/java/org/apache/camel/component/quickfixj/QuickfixjEndpoint.java
+++ b/components/camel-quickfix/src/main/java/org/apache/camel/component/quickfixj/QuickfixjEndpoint.java
@@ -38,6 +38,9 @@ import org.slf4j.LoggerFactory;
import quickfix.Message;
import quickfix.SessionID;
+/**
+ * The quickfix component allows to send Financial Interchange (FIX) messages to the QuickFix engine.
+ */
@UriEndpoint(scheme = "quickfix", title = "QuickFix", syntax = "quickfix:configurationName", consumerClass = QuickfixjConsumer.class, label = "engine,messaging")
public class QuickfixjEndpoint extends DefaultEndpoint implements QuickfixjEventListener, MultipleConsumersSupport {
public static final String EVENT_CATEGORY_KEY = "EventCategory";
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-rabbitmq/src/main/java/org/apache/camel/component/rabbitmq/RabbitMQEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-rabbitmq/src/main/java/org/apache/camel/component/rabbitmq/RabbitMQEndpoint.java b/components/camel-rabbitmq/src/main/java/org/apache/camel/component/rabbitmq/RabbitMQEndpoint.java
index 8475562..7a6e48c 100644
--- a/components/camel-rabbitmq/src/main/java/org/apache/camel/component/rabbitmq/RabbitMQEndpoint.java
+++ b/components/camel-rabbitmq/src/main/java/org/apache/camel/component/rabbitmq/RabbitMQEndpoint.java
@@ -59,6 +59,9 @@ import org.apache.camel.spi.UriPath;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * The rabbitmq component allows AMQP messages to be sent to (or consumed from) a RabbitMQ broker.
+ */
@UriEndpoint(scheme = "rabbitmq", title = "RabbitMQ", syntax = "rabbitmq:hostname:portNumber/exchangeName", consumerClass = RabbitMQConsumer.class, label = "messaging")
public class RabbitMQEndpoint extends DefaultEndpoint {
private static final Logger LOG = LoggerFactory.getLogger(RabbitMQEndpoint.class);
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/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 770cb6f..844e7ec 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,9 +36,7 @@ import org.apache.camel.util.jsse.SSLContextParameters;
import org.restlet.data.Method;
/**
- * Represents a <a href="http://www.restlet.org/"> endpoint</a>
- *
- * @version
+ * 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/0549b8d3/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiEndpoint.java b/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiEndpoint.java
index 8c61fa9..d7b4993 100644
--- a/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiEndpoint.java
+++ b/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiEndpoint.java
@@ -35,7 +35,7 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.util.ObjectHelper;
/**
- * @version
+ * The rmi component is for invoking Java RMI beans from Camel.
*/
@UriEndpoint(scheme = "rmi", title = "RMI", syntax = "rmi:hostname:port/name", consumerClass = RmiConsumer.class, label = "messaging")
public class RmiEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-routebox/pom.xml
----------------------------------------------------------------------
diff --git a/components/camel-routebox/pom.xml b/components/camel-routebox/pom.xml
index 1f8b658..d8b35bc 100644
--- a/components/camel-routebox/pom.xml
+++ b/components/camel-routebox/pom.xml
@@ -25,7 +25,7 @@
</parent>
<artifactId>camel-routebox</artifactId>
- <name>Camel :: Routebox </name>
+ <name>Camel :: Routebox (deprecated)</name>
<description>Camel Routebox component to encapsulate routes</description>
<packaging>bundle</packaging>
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-routebox/src/main/java/org/apache/camel/component/routebox/RouteboxEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-routebox/src/main/java/org/apache/camel/component/routebox/RouteboxEndpoint.java b/components/camel-routebox/src/main/java/org/apache/camel/component/routebox/RouteboxEndpoint.java
index e344c47..039a74b 100644
--- a/components/camel-routebox/src/main/java/org/apache/camel/component/routebox/RouteboxEndpoint.java
+++ b/components/camel-routebox/src/main/java/org/apache/camel/component/routebox/RouteboxEndpoint.java
@@ -22,6 +22,9 @@ import org.apache.camel.impl.DefaultEndpoint;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
+/**
+ * The routebox component allows to send/receive messages between Camel routes in a black box way.
+ */
@UriEndpoint(scheme = "routebox", title = "RouteBox", syntax = "routebox:routeboxName", consumerClass = RouteboxConsumer.class, label = "eventbus")
public abstract class RouteboxEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssEndpoint.java b/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssEndpoint.java
index eee6e7e..d5b483a 100644
--- a/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssEndpoint.java
+++ b/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssEndpoint.java
@@ -31,7 +31,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Is used for polling rss feeds.
+ * The rss component is used for consuming RSS feeds.
*/
@UriEndpoint(scheme = "rss", extendsScheme = "atom", title = "RSS",
syntax = "rss:feedUri", consumerOnly = true, consumerClass = RssEntryPollingConsumer.class, label = "rss")
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpoint.java b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpoint.java
index db9d3b6..c0a9dac 100644
--- a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpoint.java
+++ b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpoint.java
@@ -30,7 +30,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Represents a Salesforce endpoint.
+ * The salesforce component is used for integrating Camel with the massive Salesforce API.
*/
@UriEndpoint(scheme = "salesforce", title = "Salesforce", syntax = "salesforce:operationName:topicName", label = "api,cloud,crm", consumerClass = SalesforceConsumer.class)
public class SalesforceEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/components/camel-sap-netweaver/src/main/java/org/apache/camel/component/sap/netweaver/NetWeaverEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-sap-netweaver/src/main/java/org/apache/camel/component/sap/netweaver/NetWeaverEndpoint.java b/components/camel-sap-netweaver/src/main/java/org/apache/camel/component/sap/netweaver/NetWeaverEndpoint.java
index 0f16085..28d476a 100644
--- a/components/camel-sap-netweaver/src/main/java/org/apache/camel/component/sap/netweaver/NetWeaverEndpoint.java
+++ b/components/camel-sap-netweaver/src/main/java/org/apache/camel/component/sap/netweaver/NetWeaverEndpoint.java
@@ -26,6 +26,9 @@ import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
+/**
+ * The sap-netweaver component integrates with the SAP NetWeaver Gateway using HTTP transports.
+ */
@UriEndpoint(scheme = "sap-netweaver", title = "SAP NetWeaver", syntax = "sap-netweaver:url", producerOnly = true, label = "sap")
public class NetWeaverEndpoint extends DefaultEndpoint {
http://git-wip-us.apache.org/repos/asf/camel/blob/0549b8d3/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 d38c89c..89001b1 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
@@ -35,6 +35,9 @@ import org.apache.camel.util.ServiceHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * 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/0549b8d3/components/camel-schematron/src/main/java/org/apache/camel/component/schematron/SchematronEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-schematron/src/main/java/org/apache/camel/component/schematron/SchematronEndpoint.java b/components/camel-schematron/src/main/java/org/apache/camel/component/schematron/SchematronEndpoint.java
index 35a9868..ccd6bea 100644
--- a/components/camel-schematron/src/main/java/org/apache/camel/component/schematron/SchematronEndpoint.java
+++ b/components/camel-schematron/src/main/java/org/apache/camel/component/schematron/SchematronEndpoint.java
@@ -42,7 +42,7 @@ import static org.apache.camel.component.schematron.constant.Constants.LINE_NUMB
import static org.apache.camel.component.schematron.constant.Constants.SAXON_TRANSFORMER_FACTORY_CLASS_NAME;
/**
- * Schematron Endpoint.
+ * Validates the payload of a message using the Schematron Library.
*/
@UriEndpoint(scheme = "schematron", title = "Schematron", syntax = "schematron:path", producerOnly = true, label = "validation")
public class SchematronEndpoint extends DefaultEndpoint {