Skip to content

Commit

Permalink
point to current version, not latest from eip docs
Browse files Browse the repository at this point in the history
update to new indexer and jsonpath syntax

fix avra-rpc and paho-mqtt5 spring boot metadata

fix case of jsonapi in camel-spring-boot-name
  • Loading branch information
djencks committed Oct 22, 2021
1 parent b9c3deb commit 96488ad
Show file tree
Hide file tree
Showing 89 changed files with 317 additions and 327 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
:component-header: Both producer and consumer are supported
include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/avro.adoc[opts=optional]
//Manually maintained attributes
:camel-spring-boot-name: avro
:camel-spring-boot-name: avro-rpc

*Since Camel {since}*

Expand Down
2 changes: 1 addition & 1 deletion components/camel-aws/src/main/docs/aws-summary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ storage service, email and queue services. The main reason to use AWS is its clo

See the following for usage of each component:

indexDescriptionList::[attributes='group={doctitle}',descAttribute=description]
indexDescriptionList::[attributes='group={doctitle}',descriptionformat=description]
2 changes: 1 addition & 1 deletion components/camel-azure/src/main/docs/azure-summary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ provide connectivity to Azure services from Camel.

See the following for usage of each component:

indexDescriptionList::[attributes='group={doctitle}',descAttribute=description]
indexDescriptionList::[attributes='group={doctitle}',descriptionformat=description]

Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Camel includes individual components for each Debezium connector which allows fo

See the following for usage of each component:

indexDescriptionList::[attributes='group={doctitle}',descAttribute=description]
indexDescriptionList::[attributes='group={doctitle}',descriptionformat=description]
2 changes: 1 addition & 1 deletion components/camel-google/src/main/docs/google-summary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ drive . The main reason to use Google is the G Suite features.

See the following for usage of each component:

indexDescriptionList::[attributes='group={doctitle}',descAttribute=description]
indexDescriptionList::[attributes='group={doctitle}',descriptionformat=description]
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ http://www.hazelcast.com/docs.jsp[http://www.hazelcast.com/docs.jsp].

See the following for usage of each component:

indexDescriptionList::[attributes='group={doctitle}',descAttribute=description]
indexDescriptionList::[attributes='group={doctitle}',descriptionformat=description]

== Installation

Expand Down
2 changes: 1 addition & 1 deletion components/camel-huawei/src/main/docs/hwcloud-summary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ The Camel components for https://www.huaweicloud.com/intl/en-us/[Huawei Cloud Se

See the following for usage of each component:

indexDescriptionList::[attributes='group={doctitle}',descAttribute=description]
indexDescriptionList::[attributes='group={doctitle}',descriptionformat=description]
2 changes: 1 addition & 1 deletion components/camel-ignite/src/main/docs/ignite-summary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ image::apache-ignite.png[]

See the following for usage of each component:

indexDescriptionList::[attributes='group={doctitle}',descAttribute=description]
indexDescriptionList::[attributes='group={doctitle}',descriptionformat=description]

== Installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
:supportlevel: Stable
include::{cq-version}@camel-quarkus:ROOT:partial$reference/dataformats/jsonApi.adoc[opts=optional]
//Manually maintained attributes
:camel-spring-boot-name: jsonApi
:camel-spring-boot-name: jsonapi

*Since Camel {since}*

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The Kubernetes components integrate your application with Kubernetes standalone

See the following for usage of each component:

indexDescriptionList::[attributes='group={doctitle}',descAttribute=description]
indexDescriptionList::[attributes='group={doctitle}',descriptionformat=description]

== Installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ https://www.openstack.org//[OpenStack] applications.

See the following for usage of each component:

indexDescriptionList::[attributes='group={doctitle}',descAttribute=description]
indexDescriptionList::[attributes='group={doctitle}',descriptionformat=description]

== Installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
:component-header: Both producer and consumer are supported
include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/paho-mqtt5.adoc[opts=optional]
//Manually maintained attributes
:camel-spring-boot-name: paho
:camel-spring-boot-name: paho-mqtt5

*Since Camel {since}*

Expand Down
2 changes: 1 addition & 1 deletion components/camel-spring/src/main/docs/spring-summary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

See the following for usage of each component:

indexDescriptionList::[attributes='group={doctitle}',descAttribute=description]
indexDescriptionList::[attributes='group={doctitle}',descriptionformat=description]

Apache Camel is designed to work nicely with the
Spring Framework in a number of ways.
Expand Down
4 changes: 0 additions & 4 deletions core/camel-core-engine/src/main/docs/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,4 @@
#

name: components
#title: Enterprise Integration Patterns
version: latest
#start_page: eips:enterprise-integration-patterns.adoc
#nav:
#- modules/eips/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -174,18 +174,18 @@ The aggregator provides a pluggable repository which you can implement
your own `org.apache.camel.spi.AggregationRepository`.

If you need persistent repository then Camel provides numerous implementations, such as from the
xref:components::caffeine-cache-component.adoc[Caffeine],
xref:components::cql-component.adoc[CassandraQL],
xref:components::ehcache-component.adoc[EHCache],
xref:components::infinispan-component.adoc[Infinispan],
xref:components::jcache-component.adoc[JCache],
xref:components:others:leveldb.adoc[LevelDB],
xref:components:others:redis.adoc[Redis],
or xref:components::sql-component.adoc[SQL] components.
xref:ROOT:caffeine-cache-component.adoc[Caffeine],
xref:ROOT:cql-component.adoc[CassandraQL],
xref:ROOT:ehcache-component.adoc[EHCache],
xref:ROOT:infinispan-component.adoc[Infinispan],
xref:ROOT:jcache-component.adoc[JCache],
xref:others:leveldb.adoc[LevelDB],
xref:others:redis.adoc[Redis],
or xref:ROOT:sql-component.adoc[SQL] components.

== Completion

When aggregation xref:latest@manual:ROOT:exchange.adoc[Exchange]s at some point you need to
When aggregation xref:manual::exchange.adoc[Exchange]s at some point you need to
indicate that the aggregated exchanges is complete, so they can be sent
out of the aggregator. Camel allows you to indicate completion in
various ways as follows:
Expand All @@ -197,7 +197,7 @@ key within the period.
exchanges are completed.
* _completionSize_ - Is a number indicating that after X aggregated
exchanges its complete.
* _completionPredicate_ - Runs a xref:latest@manual:ROOT:predicate.adoc[Predicate] when a new
* _completionPredicate_ - Runs a xref:manual::predicate.adoc[Predicate] when a new
exchange is aggregated to determine if we are complete or not.
The configured aggregationStrategy can implement the
Predicate interface and will be used as the completionPredicate if no
Expand All @@ -206,7 +206,7 @@ override the `preComplete` method and will be used as
the completionPredicate in pre-complete check mode. See further below
for more details.
* _completionFromBatchConsumer_ - Special option for
xref:latest@manual:ROOT:batch-consumer.adoc[Batch Consumer] which allows you to complete
xref:manual::batch-consumer.adoc[Batch Consumer] which allows you to complete
when all the messages from the batch has been aggregated.
* _forceCompletionOnStop_ - Indicates to complete all current
aggregated exchanges when the context is stopped
Expand All @@ -224,9 +224,9 @@ Completion is mandatory and must be configured on the aggregation.
=== Pre-completion mode

There can be use-cases where you want the incoming
xref:latest@manual:ROOT:exchange.adoc[Exchange] to determine if the correlation group
xref:manual::exchange.adoc[Exchange] to determine if the correlation group
should pre-complete, and then the incoming
xref:latest@manual:ROOT:exchange.adoc[Exchange] is starting a new group from scratch.
xref:manual::exchange.adoc[Exchange] is starting a new group from scratch.
The pre-completion mode must be enabled by the `AggregationStrategy` by overriding the `canPreComplete` method
to return a `true` value.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
The Bean EIP is used for invoking a method on a bean, and the returned value
is the new message body.

The Bean EIP is similar to the xref:components::bean-component.adoc[Bean] component
The Bean EIP is similar to the xref:ROOT:bean-component.adoc[Bean] component
which also is used for invoking beans, but in the form as a Camel component.

== URI Format
Expand All @@ -19,7 +19,7 @@ bean:beanID[?options]
----

Where *beanID* can be any string which is used to look up the bean in
the xref:latest@manual:ROOT:registry.adoc[Registry].
the xref:manual::registry.adoc[Registry].

== EIP options

Expand Down Expand Up @@ -115,6 +115,6 @@ In XML DSL this is also possible using `beanType`:
How bean methods to be invoked are chosen (if they are not specified
explicitly through the *method* parameter) and how parameter values are
constructed from the xref:message.adoc[Message] are all defined by the
xref:latest@manual:ROOT:bean-binding.adoc[Bean Binding] mechanism which is used throughout
all the various xref:latest@manual:ROOT:bean-integration.adoc[Bean Integration]
xref:manual::bean-binding.adoc[Bean Binding] mechanism which is used throughout
all the various xref:manual::bean-integration.adoc[Bean Integration]
mechanisms in Camel.
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ of the component, which allows applications to easily send and receive data.
== Example

An application must receive messages from a Kafka topic, which can be done by using the
xref:components::kafka-component.adoc[Kafka] component.
xref:ROOT:kafka-component.adoc[Kafka] component.

One solution is to use a Camel route which consumes from the Kafka topic which calls a bean with the data.

Expand All @@ -41,7 +41,7 @@ public class CheeseBean {
}
----

You can also use xref:latest@manual:ROOT:pojo-consuming.adoc[POJO consuming] with `@Consume` annotation.
You can also use xref:manual::pojo-consuming.adoc[POJO consuming] with `@Consume` annotation.

[source,java]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ include::partial$eip-options.adoc[]

== Example

The Camel xref:components:languages:simple-language.adoc[Simple] language
The Camel xref:languages:simple-language.adoc[Simple] language
is great to use with the Choice EIP when routing is based on the content of the message,
such as checking message headers.

Expand Down Expand Up @@ -106,7 +106,7 @@ from("direct:start")
However, the code will still not compile.

The reason is we have stretched how far we can take the good old Java language in terms of
xref:latest@manual:ROOT:dsl.adoc[DSL]. In a more dynamic or modern language such as Kotlin or Groovy
xref:manual::dsl.adoc[DSL]. In a more dynamic or modern language such as Kotlin or Groovy
you would be able to let it be stack based, so the `.end()` will pop the last type of the
stack, and you would return to the scope of the Choice EIP.

Expand Down Expand Up @@ -137,7 +137,7 @@ to the Choice EIP.
==== Still problems

If there are still problems, then you can split your route into multiple
routes, and link them together using the xref:components::direct-component.adoc[Direct]
routes, and link them together using the xref:ROOT:direct-component.adoc[Direct]
component.

There can be some combinations of xref:eips:enterprise-integration-patterns.adoc[EIP]s
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ For example from SEDA, JMS, Kafka, and various AWS components.

image::eip/CompetingConsumers.gif[image]

- xref:components::seda-component.adoc[SEDA] for SEDA based concurrent processing using a thread pool
- xref:components::jms-component.adoc[JMS] for distributed SEDA based concurrent processing with queues which support reliable load balancing, failover and clustering.
- xref:ROOT:seda-component.adoc[SEDA] for SEDA based concurrent processing using a thread pool
- xref:ROOT:jms-component.adoc[JMS] for distributed SEDA based concurrent processing with queues which support reliable load balancing, failover and clustering.
For components which does not allow concurrent consumers, then Camel allows routeing from the consumer
to a thread-pool which can then further process the message concurrently,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In Camel the Content Enricher can be done in several ways:

* Using xref:enrich-eip.adoc[Enrich] EIP
* Using a xref:message-translator.adoc[Message Translator]
* Using a xref:latest@manual:ROOT:processor.adoc[Processor] with the enrichment programmed in Java
* Using a xref:manual::processor.adoc[Processor] with the enrichment programmed in Java
* Using a xref:bean-eip.adoc[Bean] EIP with the enrichment programmed in Java
The most natural Camel approach is using xref:enrich-eip.adoc[Enrich] EIP.
Expand All @@ -21,8 +21,8 @@ The most natural Camel approach is using xref:enrich-eip.adoc[Enrich] EIP.

You can consume a message from
one destination, transform it with something like
xref:components::velocity-component.adoc[Velocity], xref:components::xquery-component.adoc[XQuery],
or xref:components::atlasmap-component.adoc[AtlasMap]
xref:ROOT:velocity-component.adoc[Velocity], xref:ROOT:xquery-component.adoc[XQuery],
or xref:ROOT:atlasmap-component.adoc[AtlasMap]
and then send it on to another destination.

[source,java]
Expand All @@ -44,7 +44,7 @@ And in XML
----

You can also enrich the message in Java DSL directly (using fluent builder) as an
xref:latest@manual:ROOT:expression.adoc[Expression]. In the example below the message
xref:manual::expression.adoc[Expression]. In the example below the message
is enriched by appending ` World!` to the message body:

[source,java]
Expand All @@ -55,7 +55,7 @@ from("direct:start")
----

The fluent builder is not available in XML or YAML DSL, instead you can use
xref:components:languages:simple-language.adoc[Simple] language:
xref:languages:simple-language.adoc[Simple] language:

[source,xml]
----
Expand All @@ -70,7 +70,7 @@ xref:components:languages:simple-language.adoc[Simple] language:

== Content enrichment using a Processor

In this example we add our own xref:latest@manual:ROOT:processor.adoc[Processor] using
In this example we add our own xref:manual::processor.adoc[Processor] using
explicit Java to enrich the message:

[source,java]
Expand Down Expand Up @@ -118,6 +118,6 @@ It is usually used for xref:requestReply-eip.adoc[Request Reply] messaging, for
* xref:pollEnrich-eip.adoc[Poll Enrich] EIP - Uses a xref:polling-consumer.adoc[Polling
Consumer] to obtain the additional data. It is usually used for
xref:event-message.adoc[Event Message] messaging, for instance to read a
file or download a xref:components::ftp-component.adoc[FTP] file.
file or download a xref:ROOT:ftp-component.adoc[FTP] file.

For more details see xref:enrich-eip.adoc[Enrich] EIP and xref:pollEnrich-eip.adoc[Poll Enrich] EIP.
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ image::eip/ContentFilter.gif[image]

* Using a xref:message-translator.adoc[Message Translator]
* Invoking a xref:bean-eip.adoc[Bean] with the filtering programmed in Java
* Using a xref:latest@manual:ROOT:processor.adoc[Processor] with the filtering programmed in Java
* Using an xref:latest@manual:ROOT:expression.adoc[Expression]
* Using a xref:manual::processor.adoc[Processor] with the filtering programmed in Java
* Using an xref:manual::expression.adoc[Expression]
== Message Content filtering using a Processor

In this example we add our own xref:latest@manual:ROOT:processor.adoc[Processor] using
In this example we add our own xref:manual::processor.adoc[Processor] using
explicit Java to filter the message:

[source,java]
Expand Down Expand Up @@ -58,7 +58,7 @@ And in XML DSL:

== Message Content filtering using expression

Some languages like xref:components:languages:xpath-language.adoc[XPath], and xref:components:languages:xquery-language.adoc[XQuery]
Some languages like xref:languages:xpath-language.adoc[XPath], and xref:languages:xquery-language.adoc[XQuery]
can be used to transform and filter content from messages.

In the example we use xpath to filter a XML message to select all the `<foo><bar>` elements:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ http://www.enterpriseintegrationpatterns.com/CorrelationIdentifier.html[Correlat
Identifier] from the xref:enterprise-integration-patterns.adoc[EIP
patterns] by getting or setting a header on the xref:message.adoc[Message].

When working with the xref:components::activemq-component.adoc[ActiveMQ] or xref:components::jms-component.adoc[JMS]
When working with the xref:ROOT:activemq-component.adoc[ActiveMQ] or xref:ROOT:jms-component.adoc[JMS]
components the correlation identifier header is called
*JMSCorrelationID*, and they handle the correlation automatically.

Other messaging systems, such as xref:components::rabbitmq-component.adoc[RabbitMQ] also handles this automatic,
Other messaging systems, such as xref:ROOT:rabbitmq-component.adoc[RabbitMQ] also handles this automatic,
and you should generally not have a need for using custom correlation IDs with these systems.

image::eip/CorrelationIdentifierSolution.gif[image]
Expand All @@ -18,18 +18,18 @@ You can use your own correlation identifier to any
message exchange to help correlate messages together to a single
conversation (or business process). For example if you need to correlation messages when using web services.

The use of a correlation identifier is key to working with xref:components:others:tracing.adoc[Distributed Tracing]
The use of a correlation identifier is key to working with xref:others:tracing.adoc[Distributed Tracing]
and be useful when using xref:latest@manual::tracer.adoc[Tracer] messages to log,
or testing with simulation or canned data such as with the xref:components::mock-component.adoc[Mock] testing framework.
or testing with simulation or canned data such as with the xref:ROOT:mock-component.adoc[Mock] testing framework.


== EIPs using correlation identifiers

Some xref:enterprise-integration-patterns.adoc[EIP] patterns will spin off a sub message, and in
those cases, Camel will add a correlation id on the
xref:latest@manual:ROOT:exchange.adoc[Exchange] as a property with they key
xref:manual::exchange.adoc[Exchange] as a property with they key
`Exchange.CORRELATION_ID`, which links back to the source
xref:latest@manual:ROOT:exchange.adoc[Exchange] and its exchange id.
xref:manual::exchange.adoc[Exchange] and its exchange id.

The following EIPs does this:

Expand All @@ -42,7 +42,7 @@ The following EIPs does this:
== Example

The following example uses a request/reply pattern in
the xref:components::jms-component.adoc[JMS] component, where correlation identifiers are automatically handled:
the xref:ROOT:jms-component.adoc[JMS] component, where correlation identifiers are automatically handled:

[source,java]
----
Expand Down
Loading

0 comments on commit 96488ad

Please sign in to comment.