This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new e10124e CAMEL-14482: Fix broken Javadocs on Camel Components (#3561)
e10124e is described below
commit e10124e5220886296db9bf19d71e60d4f7c45dcb
Author: Praveen Kottarathil <praveenkottarat...@gmail.com>
AuthorDate: Tue Feb 11 08:21:00 2020 +0100
CAMEL-14482: Fix broken Javadocs on Camel Components (#3561)
---
docs/components/modules/ROOT/pages/bean-component.adoc | 2 +-
.../components/modules/ROOT/pages/cxfrs-component.adoc | 10 +++++-----
.../modules/ROOT/pages/dataset-component.adoc | 4 ++--
.../modules/ROOT/pages/dataset-test-component.adoc | 2 +-
docs/components/modules/ROOT/pages/jpa-component.adoc | 4 ++--
docs/components/modules/ROOT/pages/log-component.adoc | 2 +-
docs/components/modules/ROOT/pages/mock-component.adoc | 18 +++++++++---------
docs/components/modules/ROOT/pages/scp-component.adoc | 2 +-
.../components/modules/ROOT/pages/stomp-component.adoc | 16 ++++++++--------
docs/components/modules/ROOT/pages/xpath-language.adoc | 2 +-
.../modules/ROOT/pages/eventDrivenConsumer-eip.adoc | 4 ++--
docs/user-manual/modules/ROOT/pages/process-eip.adoc | 6 +++---
docs/user-manual/modules/ROOT/pages/rollback-eip.adoc | 4 ++--
13 files changed, 38 insertions(+), 38 deletions(-)
diff --git a/docs/components/modules/ROOT/pages/bean-component.adoc
b/docs/components/modules/ROOT/pages/bean-component.adoc
index 89af1e0..610e626 100644
--- a/docs/components/modules/ROOT/pages/bean-component.adoc
+++ b/docs/components/modules/ROOT/pages/bean-component.adoc
@@ -97,7 +97,7 @@ Endpoint to the bean endpoint as output. So consider
using a *direct:* or *queue:* endpoint as the input.
You can use the `createProxy()` methods on
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/bean/ProxyHelper.html[ProxyHelper]
+https://www.javadoc.io/doc/org.apache.camel/camel-bean/current/org/apache/camel/component/bean/ProxyHelper.html[ProxyHelper]
to create a proxy that will generate exchanges and send them to any
endpoint:
diff --git a/docs/components/modules/ROOT/pages/cxfrs-component.adoc
b/docs/components/modules/ROOT/pages/cxfrs-component.adoc
index 9d4933d..1a81847 100644
--- a/docs/components/modules/ROOT/pages/cxfrs-component.adoc
+++ b/docs/components/modules/ROOT/pages/cxfrs-component.adoc
@@ -434,15 +434,15 @@ provides
http://cxf.apache.org/docs/jax-rs-client-api.html#JAX-RSClientAPI-CXFWebClientAPI[a
http centric client API]. You can also invoke this API from
`camel-cxfrs` producer. You need to specify the
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Exchange.html#HTTP_PATH[HTTP_PATH]
+https://www.javadoc.io/doc/org.apache.camel/camel-api/current/org/apache/camel/Exchange.html#HTTP_PATH[HTTP_PATH]
and
-the
http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Exchange.html#HTTP_METHOD[HTTP_METHOD]
and
+the
https://www.javadoc.io/doc/org.apache.camel/camel-api/current/org/apache/camel/Exchange.html#HTTP_METHOD[HTTP_METHOD]
and
let the producer use the http centric client API by using the URI option
*httpClientAPI* or by setting the message header
-http://camel.apache.org/maven/current/camel-cxf/apidocs/org/apache/camel/component/cxf/CxfConstants.html#CAMEL_CXF_RS_USING_HTTP_API[CxfConstants.CAMEL_CXF_RS_USING_HTTP_API].
+https://www.javadoc.io/doc/org.apache.camel/camel-cxf-transport/current/org/apache/camel/component/cxf/common/message/CxfConstants.html#CAMEL_CXF_RS_USING_HTTP_API[CxfConstants.CAMEL_CXF_RS_USING_HTTP_API].
You can turn the response object to the type class specified with the
message
-header
http://camel.apache.org/maven/current/camel-cxf/apidocs/org/apache/camel/component/cxf/CxfConstants.html#CAMEL_CXF_RS_RESPONSE_CLASS[CxfConstants.CAMEL_CXF_RS_RESPONSE_CLASS].
+header
https://www.javadoc.io/doc/org.apache.camel/camel-cxf-transport/current/org/apache/camel/component/cxf/common/message/CxfConstants.html#CAMEL_CXF_RS_RESPONSE_CLASS[CxfConstants.CAMEL_CXF_RS_RESPONSE_CLASS].
[source,java]
----
Exchange exchange = template.send("direct://http", new Processor() {
@@ -471,7 +471,7 @@ cxfrs URI for the CXFRS http centric client.
Exchange exchange =
template.send("cxfrs://http://localhost:9003/testQuery?httpClientAPI=true&q1=12&q2=13";
----
To support the Dynamical routing, you can override the URI's query
-parameters by using the
http://camel.apache.org/maven/current/camel-cxf/apidocs/org/apache/camel/component/cxf/CxfConstants.html#CAMEL_CXF_RS_QUERY_MAP[CxfConstants.CAMEL_CXF_RS_QUERY_MAP]
+parameters by using the
https://www.javadoc.io/doc/org.apache.camel/camel-cxf-transport/current/org/apache/camel/component/cxf/common/message/CxfConstants.html#CAMEL_CXF_RS_QUERY_MAP[CxfConstants.CAMEL_CXF_RS_QUERY_MAP]
header to set the parameter map for it.
[source,java]
----
diff --git a/docs/components/modules/ROOT/pages/dataset-component.adoc
b/docs/components/modules/ROOT/pages/dataset-component.adoc
index bbfc9e2..073a870 100644
--- a/docs/components/modules/ROOT/pages/dataset-component.adoc
+++ b/docs/components/modules/ROOT/pages/dataset-component.adoc
@@ -19,7 +19,7 @@ together with the powerful Bean Integration.
The DataSet component provides a mechanism to easily perform load & soak
testing of your system. It works by allowing you to create
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/dataset/DataSet.html[DataSet
+https://www.javadoc.io/doc/org.apache.camel/camel-dataset/current/org/apache/camel/component/dataset/DataSet.html[DataSet
instances] both as a source of messages and as a way to assert that the
data set is received.
@@ -34,7 +34,7 @@ dataset:name[?options]
----
Where *name* is used to find the
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/dataset/DataSet.html[DataSet
+https://www.javadoc.io/doc/org.apache.camel/camel-dataset/current/org/apache/camel/component/dataset/DataSet.html[DataSet
instance] in the Registry
Camel ships with a support implementation of
diff --git a/docs/components/modules/ROOT/pages/dataset-test-component.adoc
b/docs/components/modules/ROOT/pages/dataset-test-component.adoc
index f3bae56..8706758 100644
--- a/docs/components/modules/ROOT/pages/dataset-test-component.adoc
+++ b/docs/components/modules/ROOT/pages/dataset-test-component.adoc
@@ -116,7 +116,7 @@ from("seda:someEndpoint").
----
If your test then invokes the
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/mock/MockEndpoint.html#assertIsSatisfied(org.apache.camel.CamelContext)[MockEndpoint.assertIsSatisfied(camelContext)
+https://www.javadoc.io/doc/org.apache.camel/camel-mock/current/org/apache/camel/component/mock/MockEndpoint.html#assertIsSatisfied-org.apache.camel.CamelContext-[MockEndpoint.assertIsSatisfied(camelContext)
method], your test case will perform the necessary assertions.
To see how you can set other expectations on the test endpoint, see the
diff --git a/docs/components/modules/ROOT/pages/jpa-component.adoc
b/docs/components/modules/ROOT/pages/jpa-component.adoc
index b232899..a689a36 100644
--- a/docs/components/modules/ROOT/pages/jpa-component.adoc
+++ b/docs/components/modules/ROOT/pages/jpa-component.adoc
@@ -66,11 +66,11 @@ URI. This will result in the entity being processed each
poll.
If you would rather perform some update on the entity to mark it as
processed (such as to exclude it from a future query) then you can
annotate a method with
-http://camel.apache.org/maven/current/camel-jpa/apidocs/org/apache/camel/component/jpa/Consumed.html[@Consumed]
+https://www.javadoc.io/doc/org.apache.camel/camel-jpa/current/org/apache/camel/component/jpa/Consumed.html[@Consumed]
which will be invoked on your entity bean when the entity bean when it
has been processed (and when routing is done).
-You can use
http://camel.apache.org/maven/current/camel-jpa/apidocs/org/apache/camel/component/jpa/PreConsumed.html[@PreConsumed]
+You can use
https://www.javadoc.io/doc/org.apache.camel/camel-jpa/current/org/apache/camel/component/jpa/PreConsumed.html[@PreConsumed]
which will be invoked on your entity bean before it has been processed
(before routing).
diff --git a/docs/components/modules/ROOT/pages/log-component.adoc
b/docs/components/modules/ROOT/pages/log-component.adoc
index dc46807..4985909 100644
--- a/docs/components/modules/ROOT/pages/log-component.adoc
+++ b/docs/components/modules/ROOT/pages/log-component.adoc
@@ -270,7 +270,7 @@ Splunk.
Whenever you require absolute customization, you can create a class that
implements the
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/spi/ExchangeFormatter.html[`ExchangeFormatter`]
+https://www.javadoc.io/doc/org.apache.camel/camel-api/current/org/apache/camel/spi/ExchangeFormatter.html[`ExchangeFormatter`]
interface. Within the `format(Exchange)` method you have access to the
full Exchange, so you can select and extract the precise information you
need, format it in a custom manner and return it. The return value will
diff --git a/docs/components/modules/ROOT/pages/mock-component.adoc
b/docs/components/modules/ROOT/pages/mock-component.adoc
index 989db4f..fd06dfc 100644
--- a/docs/components/modules/ROOT/pages/mock-component.adoc
+++ b/docs/components/modules/ROOT/pages/mock-component.adoc
@@ -163,7 +163,7 @@ resultEndpoint.assertIsSatisfied();
----
You typically always call the
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/mock/MockEndpoint.html#assertIsSatisfied()[`assertIsSatisfied()`]
+https://www.javadoc.io/doc/org.apache.camel/camel-mock/latest/org/apache/camel/component/mock/MockEndpoint.html#assertIsSatisfied--[`assertIsSatisfied()`]
method to test that the expectations were met after running a test.
Camel will by default wait 10 seconds when the `assertIsSatisfied()` is
@@ -194,34 +194,34 @@ resultEndpoint.assertIsSatisfied();
== Setting expectations
You can see from the Javadoc of
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/mock/MockEndpoint.html[MockEndpoint]
+https://www.javadoc.io/doc/org.apache.camel/camel-mock/current/org/apache/camel/component/mock/MockEndpoint.html[MockEndpoint]
the various helper methods you can use to set expectations. The main
methods are as follows:
[width="100%",cols="1m,1",options="header",]
|===
|Method |Description
-|http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/mock/MockEndpoint.html#expectedMessageCount(int)[expectedMessageCount(int)]
+|https://www.javadoc.io/doc/org.apache.camel/camel-mock/current/org/apache/camel/component/mock/MockEndpoint.html#expectedMessageCount-int-[expectedMessageCount(int)]
|To define the expected message count on the endpoint.
-|http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/mock/MockEndpoint.html#expectedMinimumMessageCount(int)[expectedMinimumMessageCount(int)]
+|https://www.javadoc.io/doc/org.apache.camel/camel-mock/current/org/apache/camel/component/mock/MockEndpoint.html#expectedMinimumMessageCount-int-[expectedMinimumMessageCount(int)]
|To define the minimum number of expected messages on the endpoint.
-|http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/mock/MockEndpoint.html#expectedBodiesReceived(java.lang.Object...)[expectedBodiesReceived(...)]
+|https://www.javadoc.io/doc/org.apache.camel/camel-mock/current/org/apache/camel/component/mock/MockEndpoint.html#expectedBodiesReceived-java.lang.Object...-[expectedBodiesReceived(...)]
|To define the expected bodies that should be received (in order).
-|http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/mock/MockEndpoint.html#expectedHeaderReceived(java.lang.String,%20java.lang.String)[expectedHeaderReceived(...)]
+|https://www.javadoc.io/doc/org.apache.camel/camel-mock/current/org/apache/camel/component/mock/MockEndpoint.html#expectedHeaderReceived-java.lang.String-java.lang.Object-[expectedHeaderReceived(...)]
|To define the expected header that should be received
-|http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/mock/MockEndpoint.html#expectsAscending(org.apache.camel.Expression)[expectsAscending(Expression)]
+|https://www.javadoc.io/doc/org.apache.camel/camel-mock/current/org/apache/camel/component/mock/MockEndpoint.html#expectsAscending-org.apache.camel.Expression-[expectsAscending(Expression)]
|To add an expectation that messages are received in order, using the
given Expression to compare messages.
-|http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/mock/MockEndpoint.html#expectsDescending(org.apache.camel.Expression)[expectsDescending(Expression)]
+|https://www.javadoc.io/doc/org.apache.camel/camel-mock/current/org/apache/camel/component/mock/MockEndpoint.html#expectsDescending-org.apache.camel.Expression-[expectsDescending(Expression)]
|To add an expectation that messages are received in order, using the
given Expression to compare messages.
-|http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/mock/MockEndpoint.html#expectsNoDuplicates(org.apache.camel.Expression)[expectsNoDuplicates(Expression)]
+|https://www.javadoc.io/doc/org.apache.camel/camel-mock/current/org/apache/camel/component/mock/MockEndpoint.html#expectsNoDuplicates-org.apache.camel.Expression-[expectsNoDuplicates(Expression)]
|To add an expectation that no duplicate messages are received; using an
Expression to calculate a unique identifier for
each message. This could be something like the `JMSMessageID` if using
diff --git a/docs/components/modules/ROOT/pages/scp-component.adoc
b/docs/components/modules/ROOT/pages/scp-component.adoc
index 0282149..4242d21 100644
--- a/docs/components/modules/ROOT/pages/scp-component.adoc
+++ b/docs/components/modules/ROOT/pages/scp-component.adoc
@@ -129,6 +129,6 @@ with the following path and query parameters:
== Limitations
Currently camel-jsch only supports a
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Producer.html[Producer]
+https://www.javadoc.io/doc/org.apache.camel/camel-api/current/org/apache/camel/Producer.html[Producer]
(i.e. copy files to another host).
diff --git a/docs/components/modules/ROOT/pages/stomp-component.adoc
b/docs/components/modules/ROOT/pages/stomp-component.adoc
index 1200125..9202ba4 100644
--- a/docs/components/modules/ROOT/pages/stomp-component.adoc
+++ b/docs/components/modules/ROOT/pages/stomp-component.adoc
@@ -135,7 +135,7 @@
from("stomp:queue:test").transform(body().convertToString()).to("mock:result")
Camel supports the Message Endpoint pattern
using the
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Endpoint.html[Endpoint]
+https://www.javadoc.io/doc/org.apache.camel/camel-api/current/org/apache/camel/Endpoint.html[Endpoint]
interface. Endpoints are usually created by a
Component and Endpoints are usually referred to in
the DSL via their URIs.
@@ -143,20 +143,20 @@ the DSL via their URIs.
From an Endpoint you can use the following methods
*
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Endpoint.html#createProducer()[createProducer()]
+https://www.javadoc.io/doc/org.apache.camel/camel-api/current/org/apache/camel/Endpoint.html#createProducer--[createProducer()]
will create a
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Producer.html[Producer]
+https://www.javadoc.io/doc/org.apache.camel/camel-api/current/org/apache/camel/Producer.html[Producer]
for sending message exchanges to the endpoint
*
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Endpoint.html#createConsumer(org.apache.camel.Processor)[createConsumer()]
+https://www.javadoc.io/doc/org.apache.camel/camel-api/current/org/apache/camel/Endpoint.html#createConsumer-org.apache.camel.Processor-[createConsumer()]
implements the Event Driven Consumer
pattern for consuming message exchanges from the endpoint via a
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Processor.html[Processor]
+https://www.javadoc.io/doc/org.apache.camel/camel-api/current/org/apache/camel/Processor.html[Processor]
when creating a
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Consumer.html[Consumer]
+https://www.javadoc.io/doc/org.apache.camel/camel-api/current/org/apache/camel/Consumer.html[Consumer]
*
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Endpoint.html#createPollingConsumer()[createPollingConsumer()]
+https://www.javadoc.io/doc/org.apache.camel/camel-api/current/org/apache/camel/Endpoint.html#createPollingConsumer--[createPollingConsumer()]
implements the Polling Consumer pattern for
consuming message exchanges from the endpoint via a
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/PollingConsumer.html[PollingConsumer]
+https://www.javadoc.io/doc/org.apache.camel/camel-api/current/org/apache/camel/PollingConsumer.html[PollingConsumer]
diff --git a/docs/components/modules/ROOT/pages/xpath-language.adoc
b/docs/components/modules/ROOT/pages/xpath-language.adoc
index ab73ea1..b05dcee 100644
--- a/docs/components/modules/ROOT/pages/xpath-language.adoc
+++ b/docs/components/modules/ROOT/pages/xpath-language.adoc
@@ -249,7 +249,7 @@ value from the message and bind it to a method parameter.
The default XPath annotation has SOAP and XML namespaces available. If
you want to use your own namespace URIs in an XPath expression you can
use your own copy of the
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/language/XPath.html[XPath
+https://www.javadoc.io/doc/org.apache.camel/camel-xpath/current/org/apache/camel/language/xpath/XPath.html[XPath
annotation] to create whatever namespace prefixes you want to use.
i.e. cut and paste upper code to your own project in a different package
diff --git a/docs/user-manual/modules/ROOT/pages/eventDrivenConsumer-eip.adoc
b/docs/user-manual/modules/ROOT/pages/eventDrivenConsumer-eip.adoc
index af93dbd..88512c1 100644
--- a/docs/user-manual/modules/ROOT/pages/eventDrivenConsumer-eip.adoc
+++ b/docs/user-manual/modules/ROOT/pages/eventDrivenConsumer-eip.adoc
@@ -13,7 +13,7 @@ threading and concurrency for you in a declarative manner.
image::eip/EventDrivenConsumerSolution.gif[image]
The Event Driven Consumer is implemented by consumers implementing the
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Processor.html[Processor]
+https://www.javadoc.io/doc/org.apache.camel/camel-api/current/org/apache/camel/Processor.html[Processor]
interface which is invoked by the xref:message-endpoint.adoc[Message Endpoint]
when a xref:message.adoc[Message] is available for processing.
@@ -21,7 +21,7 @@ when a xref:message.adoc[Message] is available for processing.
== Example
The following demonstrates a
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Processor.html[Processor]
+https://www.javadoc.io/doc/org.apache.camel/camel-api/current/org/apache/camel/Processor.html[Processor]
defined in the Camel xref:registry.adoc[Registry] which is
invoked when an event occurs from a xref:components::jms-component.adoc[JMS]
queue.
diff --git a/docs/user-manual/modules/ROOT/pages/process-eip.adoc
b/docs/user-manual/modules/ROOT/pages/process-eip.adoc
index 6b4c3c6..febc699 100644
--- a/docs/user-manual/modules/ROOT/pages/process-eip.adoc
+++ b/docs/user-manual/modules/ROOT/pages/process-eip.adoc
@@ -2,7 +2,7 @@
= Process EIP
:page-source: core/camel-core-engine/src/main/docs/eips/process-eip.adoc
-The
http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Processor.html[Processor]
interface is used to implement consumers of message exchanges or to implement
a xref:message-translator.adoc[Message Translator]
+The
https://www.javadoc.io/doc/org.apache.camel/camel-api/current/org/apache/camel/Processor.html[Processor]
interface is used to implement consumers of message exchanges or to implement
a xref:message-translator.adoc[Message Translator]
== Options
@@ -89,13 +89,13 @@ refactor it into a separate class.
== Turning your processor into a full Component
There is a base class called
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/impl/ProcessorEndpoint.html[ProcessorEndpoint]
+https://www.javadoc.io/doc/org.apache.camel/camel-support/current/org/apache/camel/support/ProcessorEndpoint.html[ProcessorEndpoint]
which supports the full xref:endpoint.adoc[Endpoint] semantics given a
Processor instance.
So you just need to create a
https://github.com/apache/camel/tree/master/components[Component] class by
deriving from
-http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/impl/DefaultComponent.html[DefaultComponent]
+https://www.javadoc.io/doc/org.apache.camel/camel-support/current/org/apache/camel/support/DefaultComponent.html[DefaultComponent]
which returns instances of ProcessorEndpoint. For more details see
xref:writing-components.adoc[Writing Components]
diff --git a/docs/user-manual/modules/ROOT/pages/rollback-eip.adoc
b/docs/user-manual/modules/ROOT/pages/rollback-eip.adoc
index 767fa07..13796f8 100644
--- a/docs/user-manual/modules/ROOT/pages/rollback-eip.adoc
+++ b/docs/user-manual/modules/ROOT/pages/rollback-eip.adoc
@@ -22,7 +22,7 @@ backing system (the transaction manager). In such cases you
should
resort to the backing system how to configure the redelivery.
You should use the
-http://camel.apache.org/maven/current/camel-spring/apidocs/org/apache/camel/spring/SpringRouteBuilder.html[SpringRouteBuilder]
+https://www.javadoc.io/doc/org.apache.camel/camel-spring/current/org/apache/camel/spring/SpringRouteBuilder.html[SpringRouteBuilder]
to setup the routes since you will need to setup the spring context with
the TransactionTemplates that will define the transaction manager
configuration and policies.
@@ -91,7 +91,7 @@ to your spring xml:
--------------------------------------------------------
Then in your
-http://camel.apache.org/maven/current/camel-spring/apidocs/org/apache/camel/spring/SpringRouteBuilder.html[SpringRouteBuilder],
+https://www.javadoc.io/doc/org.apache.camel/camel-spring/current/org/apache/camel/spring/SpringRouteBuilder.html[SpringRouteBuilder],
you just need to create new SpringTransactionPolicy objects for each of
the templates.
