diff --git a/catalog/camel-catalog/pom.xml b/catalog/camel-catalog/pom.xml index 1eaed8e5bcfb5..9f2ad47cafb19 100644 --- a/catalog/camel-catalog/pom.xml +++ b/catalog/camel-catalog/pom.xml @@ -134,8 +134,6 @@ prepare-catalog - prepare-user-guide - update-doc-component-list prepare-parent-pom prepare-release-pom diff --git a/components/camel-activemq/src/main/docs/activemq-component.adoc b/components/camel-activemq/src/main/docs/activemq-component.adoc index edb949fbc2cfb..8faede30dbf5a 100644 --- a/components/camel-activemq/src/main/docs/activemq-component.adoc +++ b/components/camel-activemq/src/main/docs/activemq-component.adoc @@ -1,11 +1,15 @@ [[activemq-component]] = ActiveMQ Component +:docTitle: ActiveMQ +:artifactId: camel-activemq +:description: The activemq component allows messages to be sent to (or consumed from) Apache ActiveMQ. This component extends the Camel JMS component. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The ActiveMQ component is an extension to the JMS component and has been pre-configured for using Apache ActiveMQ 5.x (not Artemis). Users of Apache ActiveMQ Artemis should use the JMS component. diff --git a/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc b/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc index 96d49660aca04..9e869cb6130da 100644 --- a/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc +++ b/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc @@ -1,11 +1,15 @@ [[ahc-ws-component]] = AHC Websocket Component +:docTitle: AHC Websocket +:artifactId: camel-ahc-ws +:description: To exchange data with external Websocket servers using Async Http Client. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The AHC-WS component provides Websocket based endpoints for a client communicating with diff --git a/components/camel-ahc/src/main/docs/ahc-component.adoc b/components/camel-ahc/src/main/docs/ahc-component.adoc index df81c793dc48b..a4d31bccac059 100644 --- a/components/camel-ahc/src/main/docs/ahc-component.adoc +++ b/components/camel-ahc/src/main/docs/ahc-component.adoc @@ -1,11 +1,15 @@ [[ahc-component]] = AHC Component +:docTitle: AHC +:artifactId: camel-ahc +:description: To call external HTTP services using Async Http Client. +:since: 2.8 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.8* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The AHC component provides HTTP based endpoints for consuming external HTTP resources (as a client to call external diff --git a/components/camel-amqp/src/main/docs/amqp-component.adoc b/components/camel-amqp/src/main/docs/amqp-component.adoc index ba03871629865..8dd09c08075e9 100644 --- a/components/camel-amqp/src/main/docs/amqp-component.adoc +++ b/components/camel-amqp/src/main/docs/amqp-component.adoc @@ -1,11 +1,15 @@ [[amqp-component]] = AMQP Component +:docTitle: AMQP +:artifactId: camel-amqp +:description: Messaging with AMQP protocol using Apache QPid Client. +:since: 1.2 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.2* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The AMQP component supports the http://www.amqp.org/[AMQP 1.0 protocol] diff --git a/components/camel-any23/src/main/docs/any23-dataformat.adoc b/components/camel-any23/src/main/docs/any23-dataformat.adoc index c5fae04cc2dd0..a896c9b2781ac 100644 --- a/components/camel-any23/src/main/docs/any23-dataformat.adoc +++ b/components/camel-any23/src/main/docs/any23-dataformat.adoc @@ -1,11 +1,15 @@ [[any23-dataformat]] = Any23 DataFormat -Camel Any23 is a DataFormat that uses the Apache Anything To Triples (Any23) library to extract structured data in RDF from a variety of documents on the web. -*Since Camel 3.0* +:docTitle: Any23 +:artifactId: camel-any23 +:description: Any23 data format is used for parsing data to RDF. +:since: 3.0 +:supportLevel: Stable -*Since Camel 3.0* +*Since Camel {since}* +Camel Any23 is a DataFormat that uses the Apache Anything To Triples (Any23) library to extract structured data in RDF from a variety of documents on the web. The main functionality of this DataFormat focuses on its Unmarshal method which extracts RDF triplets from compatible pages, in a wide variety of RDF syntaxes. Any23 is a Data Format that is intended to convert HTML from a site (or file) into rdf. diff --git a/components/camel-apns/src/main/docs/apns-component.adoc b/components/camel-apns/src/main/docs/apns-component.adoc index ec4991c52f97c..55746f188f694 100644 --- a/components/camel-apns/src/main/docs/apns-component.adoc +++ b/components/camel-apns/src/main/docs/apns-component.adoc @@ -1,11 +1,15 @@ [[apns-component]] = APNS Component +:docTitle: APNS +:artifactId: camel-apns +:description: For sending notifications to Apple iOS devices. +:since: 2.8 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.8* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The APNS component is used for sending notifications to iOS devices. The APNS components use https://github.com/notnoop/java-apns[javapns] diff --git a/components/camel-as2/camel-as2-component/src/main/docs/as2-component.adoc b/components/camel-as2/camel-as2-component/src/main/docs/as2-component.adoc index 95468fc528f7e..8fe7aecaf0f79 100644 --- a/components/camel-as2/camel-as2-component/src/main/docs/as2-component.adoc +++ b/components/camel-as2/camel-as2-component/src/main/docs/as2-component.adoc @@ -1,11 +1,15 @@ [[as2-component]] = AS2 Component +:docTitle: AS2 +:artifactId: camel-as2 +:description: Component used for transferring data secure and reliable over the internet using the AS2 protocol. +:since: 2.22 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.22* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The AS2 component provides transport of EDI messages using the HTTP transfer protocol as specified in https://tools.ietf.org/html/rfc4130[RFC4130]. @@ -259,4 +263,3 @@ URI Options for _server_ |=== include::camel-spring-boot::page$as2-starter.adoc[] - diff --git a/components/camel-asn1/src/main/docs/asn1-dataformat.adoc b/components/camel-asn1/src/main/docs/asn1-dataformat.adoc index ccfec69f5ce13..d9b79f44ac2d2 100644 --- a/components/camel-asn1/src/main/docs/asn1-dataformat.adoc +++ b/components/camel-asn1/src/main/docs/asn1-dataformat.adoc @@ -1,7 +1,12 @@ [[asn1-dataformat]] = ASN.1 File DataFormat +:docTitle: ASN.1 File +:artifactId: camel-asn1 +:description: The ASN.1 data format is used for file transfer with telecommunications protocols. +:since: 2.20 +:supportLevel: Stable -*Since Camel 2.20* +*Since Camel {since}* The ASN.1 Data Format Data Format [Intoduction to ASN.1](https://www.itu.int/en/ITU-T/asn1/Pages/introduction.aspx) is a Camel Frameworks's data format implementation based on Bouncy Castle's bcprov-jdk15on library and jASN.1's java compiler for the formal notation used for describing data transmitted by telecommunications protocols, regardless of language implementation and physical representation of these data, whatever the application, whether complex or very simple. Messages can be unmarshalled (conversion to simple Java POJO(s)) to plain Java objects. By the help of Camel's routing engine and data transformations you can then play with POJO(s) and apply customised formatting and call other Camel Component's to convert and send messages to upstream systems. diff --git a/components/camel-asterisk/src/main/docs/asterisk-component.adoc b/components/camel-asterisk/src/main/docs/asterisk-component.adoc index 10378e7f1278d..65620d7ca5ed4 100644 --- a/components/camel-asterisk/src/main/docs/asterisk-component.adoc +++ b/components/camel-asterisk/src/main/docs/asterisk-component.adoc @@ -1,11 +1,15 @@ [[asterisk-component]] = Asterisk Component +:docTitle: Asterisk +:artifactId: camel-asterisk +:description: The asterisk component is used to interact with Asterisk PBX Server. +:since: 2.18 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Asterisk component allows you to work easily with an Asterisk PBX Server http://www.asterisk.org/ using https://asterisk-java.org/[asterisk-java] diff --git a/components/camel-atmos/src/main/docs/atmos-component.adoc b/components/camel-atmos/src/main/docs/atmos-component.adoc index b9b328c90dc52..b067aa02205d1 100644 --- a/components/camel-atmos/src/main/docs/atmos-component.adoc +++ b/components/camel-atmos/src/main/docs/atmos-component.adoc @@ -1,11 +1,15 @@ [[atmos-component]] = Atmos Component +:docTitle: Atmos +:artifactId: camel-atmos +:description: The atmos component is used for integrating with EMC's Atomos Storage. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Camel-Atmos is an http://camel.apache.org/[Apache Camel] component that allows you to work with ViPR object data services using the diff --git a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc index 96b07d8180b10..6651bcd3b4216 100644 --- a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc +++ b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc @@ -1,11 +1,15 @@ [[atmosphere-websocket-component]] = Atmosphere Websocket Component +:docTitle: Atmosphere Websocket +:artifactId: camel-atmosphere-websocket +:description: To exchange data with external Websocket clients using Atmosphere. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Atmosphere-Websocket component provides Websocket based endpoints for a servlet communicating with diff --git a/components/camel-atom/src/main/docs/atom-component.adoc b/components/camel-atom/src/main/docs/atom-component.adoc index dafd966659602..0325ffd1c4258 100644 --- a/components/camel-atom/src/main/docs/atom-component.adoc +++ b/components/camel-atom/src/main/docs/atom-component.adoc @@ -1,11 +1,15 @@ [[atom-component]] = Atom Component +:docTitle: Atom +:artifactId: camel-atom +:description: The atom component is used for consuming Atom RSS feeds. +:since: 1.2 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 1.2* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Atom component is used for polling Atom feeds. diff --git a/components/camel-atomix/src/main/docs/atomix-map-component.adoc b/components/camel-atomix/src/main/docs/atomix-map-component.adoc index 6a44844be54e7..44c025d904bcb 100644 --- a/components/camel-atomix/src/main/docs/atomix-map-component.adoc +++ b/components/camel-atomix/src/main/docs/atomix-map-component.adoc @@ -1,11 +1,15 @@ [[atomix-map-component]] = Atomix Map Component +:docTitle: Atomix Map +:artifactId: camel-atomix +:description: The atomix-map component is used to access Atomix's distributed map. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The camel Atomix-Map component allows you to work with http://atomix.io[Atomix's] https://atomix.io/docs/latest/user-manual/primitives/DistributedMap/[Distributed Map] collection. diff --git a/components/camel-atomix/src/main/docs/atomix-messaging-component.adoc b/components/camel-atomix/src/main/docs/atomix-messaging-component.adoc index 783ac544abdd7..62a10562748cb 100644 --- a/components/camel-atomix/src/main/docs/atomix-messaging-component.adoc +++ b/components/camel-atomix/src/main/docs/atomix-messaging-component.adoc @@ -1,11 +1,15 @@ [[atomix-messaging-component]] = Atomix Messaging Component +:docTitle: Atomix Messaging +:artifactId: camel-atomix +:description: The atomix-messaging component is used to access Atomix's group messaging. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The camel Atomix-Messaging component allows you to work with http://atomix.io[Atomix's] https://atomix.io/docs/latest/user-manual/cluster-communication/direct-messaging[Group Messaging]. diff --git a/components/camel-atomix/src/main/docs/atomix-multimap-component.adoc b/components/camel-atomix/src/main/docs/atomix-multimap-component.adoc index 0a8a2bc6f19b4..7d501ccbd5e22 100644 --- a/components/camel-atomix/src/main/docs/atomix-multimap-component.adoc +++ b/components/camel-atomix/src/main/docs/atomix-multimap-component.adoc @@ -1,11 +1,15 @@ [[atomix-multimap-component]] = Atomix MultiMap Component +:docTitle: Atomix MultiMap +:artifactId: camel-atomix +:description: The atomix-multimap component is used to access Atomix's distributed multi map. +:since: 2.20 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The camel Atomix-Multimap component allows you to work with http://atomix.io[Atomix's] https://atomix.io/docs/latest/user-manual/primitives/DistributedMultimap/[Distributed MultiMap] collection. diff --git a/components/camel-atomix/src/main/docs/atomix-queue-component.adoc b/components/camel-atomix/src/main/docs/atomix-queue-component.adoc index ae4c0435899a3..b15cc2b843de1 100644 --- a/components/camel-atomix/src/main/docs/atomix-queue-component.adoc +++ b/components/camel-atomix/src/main/docs/atomix-queue-component.adoc @@ -1,11 +1,15 @@ [[atomix-queue-component]] = Atomix Queue Component +:docTitle: Atomix Queue +:artifactId: camel-atomix +:description: The atomix-queue component is used to access Atomix's distributed queue. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The camel Atomix-Queue component allows you to work with http://atomix.io[Atomix's] https://atomix.io/docs/latest/user-manual/primitives/DistributedQueue/[Distributed Queue] collection. diff --git a/components/camel-atomix/src/main/docs/atomix-set-component.adoc b/components/camel-atomix/src/main/docs/atomix-set-component.adoc index 807118cc480f1..a9bbd49d34f5d 100644 --- a/components/camel-atomix/src/main/docs/atomix-set-component.adoc +++ b/components/camel-atomix/src/main/docs/atomix-set-component.adoc @@ -1,11 +1,15 @@ [[atomix-set-component]] = Atomix Set Component +:docTitle: Atomix Set +:artifactId: camel-atomix +:description: The atomix-set component is used to access Atomix's distributed set. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The camel Atomix-Set component allows you to work with http://atomix.io[Atomix's] https://atomix.io/docs/latest/user-manual/primitives/DistributedSet/[Distributed Set] collection. diff --git a/components/camel-atomix/src/main/docs/atomix-value-component.adoc b/components/camel-atomix/src/main/docs/atomix-value-component.adoc index e62e6448d2000..d65b0ad0ee9c7 100644 --- a/components/camel-atomix/src/main/docs/atomix-value-component.adoc +++ b/components/camel-atomix/src/main/docs/atomix-value-component.adoc @@ -1,11 +1,15 @@ [[atomix-value-component]] = Atomix Value Component +:docTitle: Atomix Value +:artifactId: camel-atomix +:description: The atomix-value component is used to access Atomix's distributed value. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The camel Atomix-Value component allows you to work with http://atomix.io[Atomix's] https://atomix.io/docs/latest/user-manual/primitives/DistributedValue/[Distributed Value]. diff --git a/components/camel-attachments/src/main/docs/attachments.adoc b/components/camel-attachments/src/main/docs/attachments.adoc index 85dcbce3cf413..9088cbe9bbcc8 100644 --- a/components/camel-attachments/src/main/docs/attachments.adoc +++ b/components/camel-attachments/src/main/docs/attachments.adoc @@ -1,4 +1,12 @@ +[[attachments-component]] = Attachments Component +:docTitle: Attachments +:artifactId: camel-attachments +:description: Java Attachments support for Camel Message +:since: 3.0 +:supportLevel: Stable + +*Since Camel {since}* The attachments component provides the `javax.attachments` API support for Apache Camel. A few Camel component uses attachments such as mail and web-service components. diff --git a/components/camel-avro-rpc/src/main/docs/avro-component.adoc b/components/camel-avro-rpc/src/main/docs/avro-component.adoc index a13ddaa3cd30a..bb214345e3c10 100644 --- a/components/camel-avro-rpc/src/main/docs/avro-component.adoc +++ b/components/camel-avro-rpc/src/main/docs/avro-component.adoc @@ -1,11 +1,15 @@ [[avro-component]] = Avro Component +:docTitle: Avro +:artifactId: camel-avro-rpc +:description: Working with Apache Avro for data serialization. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component provides a support for Apache Avro's rpc, by providing producers and consumers endpoint for using avro over netty or @@ -270,4 +274,4 @@ is used and `getProcessor` will receive Value class directly in body, while `putProcessor` will receive an array of size 2 with String key and Value value filled as array contents. -include::camel-spring-boot::page$avro-starter.adoc[] \ No newline at end of file +include::camel-spring-boot::page$avro-starter.adoc[] diff --git a/components/camel-avro/src/main/docs/avro-dataformat.adoc b/components/camel-avro/src/main/docs/avro-dataformat.adoc index f783613105bad..f12bb99fb52c5 100644 --- a/components/camel-avro/src/main/docs/avro-dataformat.adoc +++ b/components/camel-avro/src/main/docs/avro-dataformat.adoc @@ -1,7 +1,12 @@ [[avro-dataformat]] = Avro DataFormat +:docTitle: Avro +:artifactId: camel-avro +:description: The Avro data format is used for serialization and deserialization of messages using Apache Avro binary dataformat. +:since: 2.14 +:supportLevel: Stable -*Since Camel 2.14* +*Since Camel {since}* This component provides a dataformat for avro, which allows serialization and deserialization of messages using Apache Avro's binary diff --git a/components/camel-aws-cw/src/main/docs/aws-cw-component.adoc b/components/camel-aws-cw/src/main/docs/aws-cw-component.adoc index 1642b0f311d42..14433011e8e45 100644 --- a/components/camel-aws-cw/src/main/docs/aws-cw-component.adoc +++ b/components/camel-aws-cw/src/main/docs/aws-cw-component.adoc @@ -1,11 +1,15 @@ [[aws-cw-component]] = AWS CloudWatch Component +:docTitle: AWS CloudWatch +:artifactId: camel-aws-cw +:description: The aws-cw component is used for sending metrics to an Amazon CloudWatch. +:since: 2.11 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.11* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The CW component allows messages to be sent to an https://aws.amazon.com/cloudwatch/[Amazon CloudWatch] metrics. The diff --git a/components/camel-aws-ddb/src/main/docs/aws-ddb-component.adoc b/components/camel-aws-ddb/src/main/docs/aws-ddb-component.adoc index d305f83173121..60aa20a3d2726 100644 --- a/components/camel-aws-ddb/src/main/docs/aws-ddb-component.adoc +++ b/components/camel-aws-ddb/src/main/docs/aws-ddb-component.adoc @@ -1,11 +1,15 @@ [[aws-ddb-component]] = AWS DynamoDB Component +:docTitle: AWS DynamoDB +:artifactId: camel-aws-ddb +:description: The aws-ddb component is used for storing and retrieving data from Amazon's DynamoDB service. +:since: 2.10 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The DynamoDB component supports storing and retrieving data from/to https://aws.amazon.com/dynamodb[Amazon's DynamoDB] service. diff --git a/components/camel-aws-ddb/src/main/docs/aws-ddbstream-component.adoc b/components/camel-aws-ddb/src/main/docs/aws-ddbstream-component.adoc index b2c42fb5a24fa..dca90c088d423 100644 --- a/components/camel-aws-ddb/src/main/docs/aws-ddbstream-component.adoc +++ b/components/camel-aws-ddb/src/main/docs/aws-ddbstream-component.adoc @@ -1,11 +1,15 @@ [[aws-ddbstream-component]] = AWS DynamoDB Streams Component +:docTitle: AWS DynamoDB Streams +:artifactId: camel-aws-ddb +:description: The aws-ddbstream component is used for working with Amazon DynamoDB Streams. +:since: 2.17 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The DynamoDB Stream component supports receiving messages from Amazon DynamoDB Stream service. diff --git a/components/camel-aws-ec2/src/main/docs/aws-ec2-component.adoc b/components/camel-aws-ec2/src/main/docs/aws-ec2-component.adoc index 36420b7d52916..576646f53aae5 100644 --- a/components/camel-aws-ec2/src/main/docs/aws-ec2-component.adoc +++ b/components/camel-aws-ec2/src/main/docs/aws-ec2-component.adoc @@ -1,11 +1,15 @@ [[aws-ec2-component]] = AWS EC2 Component +:docTitle: AWS EC2 +:artifactId: camel-aws-ec2 +:description: The aws-ec2 is used for managing Amazon EC2 instances. +:since: 2.16 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The EC2 component supports the ability to create, run, start, stop and terminate https://aws.amazon.com/ec2/[AWS EC2] instances. diff --git a/components/camel-aws-ecs/src/main/docs/aws-ecs-component.adoc b/components/camel-aws-ecs/src/main/docs/aws-ecs-component.adoc index c18f353c95aae..164cb788a0e0f 100644 --- a/components/camel-aws-ecs/src/main/docs/aws-ecs-component.adoc +++ b/components/camel-aws-ecs/src/main/docs/aws-ecs-component.adoc @@ -1,11 +1,15 @@ [[aws-ecs-component]] = AWS ECS Component +:docTitle: AWS ECS +:artifactId: camel-aws-ecs +:description: The aws-ecs is used for managing Amazon ECS +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The ECS component supports create, delete, describe and list https://aws.amazon.com/ecs/[AWS ECS] clusters instances. diff --git a/components/camel-aws-eks/src/main/docs/aws-eks-component.adoc b/components/camel-aws-eks/src/main/docs/aws-eks-component.adoc index 14152c96f9e10..796970c6621c8 100644 --- a/components/camel-aws-eks/src/main/docs/aws-eks-component.adoc +++ b/components/camel-aws-eks/src/main/docs/aws-eks-component.adoc @@ -1,11 +1,15 @@ [[aws-eks-component]] = AWS EKS Component +:docTitle: AWS EKS +:artifactId: camel-aws-eks +:description: The aws-eks is used for managing Amazon EKS +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The EKS component supports create, delete, describe and list https://aws.amazon.com/eks/[AWS EKS] clusters instances. diff --git a/components/camel-aws-iam/src/main/docs/aws-iam-component.adoc b/components/camel-aws-iam/src/main/docs/aws-iam-component.adoc index 82093c8727e5e..a910058501d78 100644 --- a/components/camel-aws-iam/src/main/docs/aws-iam-component.adoc +++ b/components/camel-aws-iam/src/main/docs/aws-iam-component.adoc @@ -1,11 +1,15 @@ [[aws-iam-component]] = AWS IAM Component +:docTitle: AWS IAM +:artifactId: camel-aws-iam +:description: The aws-iam is used for managing Amazon IAM +:since: 2.23 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The KMS component supports create, run, start, stop and terminate https://aws.amazon.com/iam/[AWS IAM] instances. diff --git a/components/camel-aws-kinesis/src/main/docs/aws-kinesis-component.adoc b/components/camel-aws-kinesis/src/main/docs/aws-kinesis-component.adoc index 117d331e9482c..7e9bb697a253d 100644 --- a/components/camel-aws-kinesis/src/main/docs/aws-kinesis-component.adoc +++ b/components/camel-aws-kinesis/src/main/docs/aws-kinesis-component.adoc @@ -1,11 +1,15 @@ [[aws-kinesis-component]] = AWS Kinesis Component +:docTitle: AWS Kinesis +:artifactId: camel-aws-kinesis +:description: The aws-kinesis component is for consuming and producing records from Amazon Kinesis Streams. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Kinesis component supports receiving messages from and sending messages to Amazon Kinesis service. diff --git a/components/camel-aws-kinesis/src/main/docs/aws-kinesis-firehose-component.adoc b/components/camel-aws-kinesis/src/main/docs/aws-kinesis-firehose-component.adoc index c8b84d30fdc4e..9e640d787d1c8 100644 --- a/components/camel-aws-kinesis/src/main/docs/aws-kinesis-firehose-component.adoc +++ b/components/camel-aws-kinesis/src/main/docs/aws-kinesis-firehose-component.adoc @@ -1,11 +1,15 @@ [[aws-kinesis-firehose-component]] = AWS Kinesis Firehose Component +:docTitle: AWS Kinesis Firehose +:artifactId: camel-aws-kinesis +:description: The aws-kinesis-firehose component is used for producing Amazon's Kinesis Firehose streams. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Kinesis Firehose component supports sending messages to Amazon Kinesis Firehose service. diff --git a/components/camel-aws-kms/src/main/docs/aws-kms-component.adoc b/components/camel-aws-kms/src/main/docs/aws-kms-component.adoc index f5352942aacfc..88d9e09d5b18a 100644 --- a/components/camel-aws-kms/src/main/docs/aws-kms-component.adoc +++ b/components/camel-aws-kms/src/main/docs/aws-kms-component.adoc @@ -1,11 +1,15 @@ [[aws-kms-component]] = AWS KMS Component +:docTitle: AWS KMS +:artifactId: camel-aws-kms +:description: The aws-kms is used for managing Amazon KMS +:since: 2.21 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.21* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The KMS component supports the ability to work with keys stored in https://aws.amazon.com/kms/[AWS KMS] instances. diff --git a/components/camel-aws-lambda/src/main/docs/aws-lambda-component.adoc b/components/camel-aws-lambda/src/main/docs/aws-lambda-component.adoc index 176e971257c9b..2f73925abf88a 100644 --- a/components/camel-aws-lambda/src/main/docs/aws-lambda-component.adoc +++ b/components/camel-aws-lambda/src/main/docs/aws-lambda-component.adoc @@ -1,11 +1,15 @@ [[aws-lambda-component]] = AWS Lambda Component +:docTitle: AWS Lambda +:artifactId: camel-aws-lambda +:description: The aws-lambda is used for managing and invoking functions from Amazon Lambda. +:since: 2.20 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Lambda component supports create, get, list, delete and invoke https://aws.amazon.com/lambda/[AWS Lambda] functions. diff --git a/components/camel-aws-mq/src/main/docs/aws-mq-component.adoc b/components/camel-aws-mq/src/main/docs/aws-mq-component.adoc index 9f3acdbff7efd..51232545b3078 100644 --- a/components/camel-aws-mq/src/main/docs/aws-mq-component.adoc +++ b/components/camel-aws-mq/src/main/docs/aws-mq-component.adoc @@ -1,11 +1,15 @@ [[aws-mq-component]] = AWS MQ Component +:docTitle: AWS MQ +:artifactId: camel-aws-mq +:description: The aws-mq is used for managing Amazon MQ instances. +:since: 2.21 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.21* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The MQ component supports create, run, start, stop and terminate https://aws.amazon.com/amazon-mq/[AWS MQ] instances. diff --git a/components/camel-aws-msk/src/main/docs/aws-msk-component.adoc b/components/camel-aws-msk/src/main/docs/aws-msk-component.adoc index d647cc340dca4..1448711ebb925 100644 --- a/components/camel-aws-msk/src/main/docs/aws-msk-component.adoc +++ b/components/camel-aws-msk/src/main/docs/aws-msk-component.adoc @@ -1,11 +1,15 @@ [[aws-msk-component]] = AWS MSK Component +:docTitle: AWS MSK +:artifactId: camel-aws-msk +:description: The aws-msk is used for managing Amazon MSK +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The AWS MSK component supports create, run, start, stop and terminate https://aws.amazon.com/msk/[AWS MSK] instances. diff --git a/components/camel-aws-s3/src/main/docs/aws-s3-component.adoc b/components/camel-aws-s3/src/main/docs/aws-s3-component.adoc index 10ea7f1774167..f88b6ba1f4e30 100644 --- a/components/camel-aws-s3/src/main/docs/aws-s3-component.adoc +++ b/components/camel-aws-s3/src/main/docs/aws-s3-component.adoc @@ -1,11 +1,15 @@ [[aws-s3-component]] = AWS S3 Storage Service Component +:docTitle: AWS S3 Storage Service +:artifactId: camel-aws-s3 +:description: The aws-s3 component is used for storing and retrieving object from Amazon S3 Storage Service. +:since: 2.8 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.8* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The S3 component supports storing and retrieving objects from/to https://aws.amazon.com/s3[Amazon's S3] service. diff --git a/components/camel-aws-sdb/src/main/docs/aws-sdb-component.adoc b/components/camel-aws-sdb/src/main/docs/aws-sdb-component.adoc index 2e4c8abe82520..ce02b8f4993f6 100644 --- a/components/camel-aws-sdb/src/main/docs/aws-sdb-component.adoc +++ b/components/camel-aws-sdb/src/main/docs/aws-sdb-component.adoc @@ -1,11 +1,15 @@ [[aws-sdb-component]] = AWS SimpleDB Component +:docTitle: AWS SimpleDB +:artifactId: camel-aws-sdb +:description: The aws-sdb component is for storing and retrieving data from/to Amazon's SDB service. +:since: 2.9 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.9* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The sdb component supports storing and retrieving data from/to https://aws.amazon.com/sdb[Amazon's SDB] service. diff --git a/components/camel-aws-ses/src/main/docs/aws-ses-component.adoc b/components/camel-aws-ses/src/main/docs/aws-ses-component.adoc index 49fcf9cd0d52e..05c1853fc6de5 100644 --- a/components/camel-aws-ses/src/main/docs/aws-ses-component.adoc +++ b/components/camel-aws-ses/src/main/docs/aws-ses-component.adoc @@ -1,11 +1,15 @@ [[aws-ses-component]] = AWS Simple Email Service Component +:docTitle: AWS Simple Email Service +:artifactId: camel-aws-ses +:description: The aws-ses component is used for sending emails with Amazon's SES service. +:since: 2.9 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.9* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The ses component supports sending emails with https://aws.amazon.com/ses[Amazon's SES] service. diff --git a/components/camel-aws-sns/src/main/docs/aws-sns-component.adoc b/components/camel-aws-sns/src/main/docs/aws-sns-component.adoc index 82097ddfe3eaa..f9bf3dae160c5 100644 --- a/components/camel-aws-sns/src/main/docs/aws-sns-component.adoc +++ b/components/camel-aws-sns/src/main/docs/aws-sns-component.adoc @@ -1,11 +1,15 @@ [[aws-sns-component]] = AWS Simple Notification System Component +:docTitle: AWS Simple Notification System +:artifactId: camel-aws-sns +:description: The aws-sns component is used for sending messages to an Amazon Simple Notification Topic. +:since: 2.8 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.8* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The SNS component allows messages to be sent to an https://aws.amazon.com/sns[Amazon Simple Notification] Topic. The diff --git a/components/camel-aws-sqs/src/main/docs/aws-sqs-component.adoc b/components/camel-aws-sqs/src/main/docs/aws-sqs-component.adoc index 4e2e5f2ccd7c7..c967902a96721 100644 --- a/components/camel-aws-sqs/src/main/docs/aws-sqs-component.adoc +++ b/components/camel-aws-sqs/src/main/docs/aws-sqs-component.adoc @@ -1,11 +1,15 @@ [[aws-sqs-component]] = AWS Simple Queue Service Component +:docTitle: AWS Simple Queue Service +:artifactId: camel-aws-sqs +:description: The aws-sqs component is used for sending and receiving messages to Amazon's SQS service. +:since: 2.6 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.6* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The sqs component supports sending and receiving messages to https://aws.amazon.com/sqs[Amazon's SQS] service. diff --git a/components/camel-aws-swf/src/main/docs/aws-swf-component.adoc b/components/camel-aws-swf/src/main/docs/aws-swf-component.adoc index 1c63a8ee2e4f4..519e900f60a53 100644 --- a/components/camel-aws-swf/src/main/docs/aws-swf-component.adoc +++ b/components/camel-aws-swf/src/main/docs/aws-swf-component.adoc @@ -1,11 +1,15 @@ [[aws-swf-component]] = AWS Simple Workflow Component +:docTitle: AWS Simple Workflow +:artifactId: camel-aws-swf +:description: The aws-swf component is used for managing workflows from Amazon Simple Workflow. +:since: 2.13 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.13* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Simple Workflow component supports managing workflows from https://aws.amazon.com/swf/[Amazon's Simple Workflow] service. diff --git a/components/camel-aws-translate/src/main/docs/aws-translate-component.adoc b/components/camel-aws-translate/src/main/docs/aws-translate-component.adoc index 47b84718e4935..17e867be8c5f0 100644 --- a/components/camel-aws-translate/src/main/docs/aws-translate-component.adoc +++ b/components/camel-aws-translate/src/main/docs/aws-translate-component.adoc @@ -1,11 +1,15 @@ [[aws-translate-component]] = AWS Translate Component +:docTitle: AWS Translate +:artifactId: camel-aws-translate +:description: The aws-translate component is used for managing Amazon Translate +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Translate component supports translate a text in multiple languages. https://aws.amazon.com/translate/[AWS Translate] clusters instances. diff --git a/components/camel-aws-xray/src/main/docs/aws-xray.adoc b/components/camel-aws-xray/src/main/docs/aws-xray.adoc index 6e8c5ea21e47a..096f2d036120b 100644 --- a/components/camel-aws-xray/src/main/docs/aws-xray.adoc +++ b/components/camel-aws-xray/src/main/docs/aws-xray.adoc @@ -1,7 +1,12 @@ -[[AWSXRay-AWSXRayComponent]] +[[aws-xray-component]] = AWS XRay Component +:docTitle: AWS XRay +:artifactId: camel-aws-xray +:description: Distributed tracing using AWS XRay +:since: 2.21 +:supportLevel: Stable -*Since Camel 2.21* +*Since Camel {since}* The camel-aws-xray component is used for tracing and timing incoming and outgoing Camel messages using https://aws.amazon.com/xray/[AWS XRay]. diff --git a/components/camel-aws2-cw/src/main/docs/aws2-cw-component.adoc b/components/camel-aws2-cw/src/main/docs/aws2-cw-component.adoc index 792ac111df1b3..10cb30cda5419 100644 --- a/components/camel-aws2-cw/src/main/docs/aws2-cw-component.adoc +++ b/components/camel-aws2-cw/src/main/docs/aws2-cw-component.adoc @@ -1,11 +1,15 @@ [[aws2-cw-component]] = AWS 2 CloudWatch Component +:docTitle: AWS 2 CloudWatch +:artifactId: camel-aws2-cw +:description: The aws2-cw component is used for sending metrics to an Amazon CloudWatch. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The CW component allows messages to be sent to an https://aws.amazon.com/cloudwatch/[Amazon CloudWatch] metrics. The diff --git a/components/camel-aws2-ddb/src/main/docs/aws2-ddb-component.adoc b/components/camel-aws2-ddb/src/main/docs/aws2-ddb-component.adoc index 1c601ca64dc5e..cfe7160607ac7 100644 --- a/components/camel-aws2-ddb/src/main/docs/aws2-ddb-component.adoc +++ b/components/camel-aws2-ddb/src/main/docs/aws2-ddb-component.adoc @@ -1,11 +1,15 @@ [[aws2-ddb-component]] = AWS 2 DynamoDB Component +:docTitle: AWS 2 DynamoDB +:artifactId: camel-aws2-ddb +:description: The aws2-ddb component is used for storing and retrieving data from Amazon's DynamoDB service. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The DynamoDB component supports storing and retrieving data from/to https://aws.amazon.com/dynamodb[Amazon's DynamoDB] service. diff --git a/components/camel-aws2-ddb/src/main/docs/aws2-ddbstream-component.adoc b/components/camel-aws2-ddb/src/main/docs/aws2-ddbstream-component.adoc index feb0561dd1c30..bc0267c434896 100644 --- a/components/camel-aws2-ddb/src/main/docs/aws2-ddbstream-component.adoc +++ b/components/camel-aws2-ddb/src/main/docs/aws2-ddbstream-component.adoc @@ -1,11 +1,15 @@ [[aws2-ddbstream-component]] = AWS 2 DynamoDB Streams Component +:docTitle: AWS 2 DynamoDB Streams +:artifactId: camel-aws2-ddb +:description: The aws2-ddbstream component is used for working with Amazon DynamoDB Streams. +:since: 3.1 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The DynamoDB Stream component supports receiving messages from Amazon DynamoDB Stream service. diff --git a/components/camel-aws2-ec2/src/main/docs/aws2-ec2-component.adoc b/components/camel-aws2-ec2/src/main/docs/aws2-ec2-component.adoc index e0937d9bf4a48..e3b5c350a8d64 100644 --- a/components/camel-aws2-ec2/src/main/docs/aws2-ec2-component.adoc +++ b/components/camel-aws2-ec2/src/main/docs/aws2-ec2-component.adoc @@ -1,11 +1,15 @@ [[aws2-ec2-component]] = AWS 2 EC2 Component +:docTitle: AWS 2 EC2 +:artifactId: camel-aws2-ec2 +:description: The aws2-ec2 is used for managing Amazon EC2 instances. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The EC2 component supports the ability to create, run, start, stop and terminate https://aws.amazon.com/ec2/[AWS EC2] instances. diff --git a/components/camel-aws2-ecs/src/main/docs/aws2-ecs-component.adoc b/components/camel-aws2-ecs/src/main/docs/aws2-ecs-component.adoc index 9351490daa2d8..1377ef0a108bf 100644 --- a/components/camel-aws2-ecs/src/main/docs/aws2-ecs-component.adoc +++ b/components/camel-aws2-ecs/src/main/docs/aws2-ecs-component.adoc @@ -1,14 +1,18 @@ [[aws2-ecs-component]] = AWS 2 ECS Component +:docTitle: AWS 2 ECS +:artifactId: camel-aws2-ecs +:description: The aws2-ecs is used for managing Amazon ECS +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* *Since Camel 3.1* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The ECS component supports create, delete, describe and list https://aws.amazon.com/ecs/[AWS ECS] clusters instances. diff --git a/components/camel-aws2-eks/src/main/docs/aws2-eks-component.adoc b/components/camel-aws2-eks/src/main/docs/aws2-eks-component.adoc index 12d2a5e7aaf29..c7c904ed44fc8 100644 --- a/components/camel-aws2-eks/src/main/docs/aws2-eks-component.adoc +++ b/components/camel-aws2-eks/src/main/docs/aws2-eks-component.adoc @@ -1,14 +1,18 @@ [[aws2-eks-component]] = AWS 2 EKS Component +:docTitle: AWS 2 EKS +:artifactId: camel-aws2-eks +:description: The aws2-eks is used for managing Amazon EKS +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* *Since Camel 3.1* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The EKS component supports create, delete, describe and list https://aws.amazon.com/eks/[AWS EKS] clusters instances. diff --git a/components/camel-aws2-iam/src/main/docs/aws2-iam-component.adoc b/components/camel-aws2-iam/src/main/docs/aws2-iam-component.adoc index db62f44365581..9177255f78442 100644 --- a/components/camel-aws2-iam/src/main/docs/aws2-iam-component.adoc +++ b/components/camel-aws2-iam/src/main/docs/aws2-iam-component.adoc @@ -1,14 +1,18 @@ [[aws2-iam-component]] = AWS 2 IAM Component +:docTitle: AWS 2 IAM +:artifactId: camel-aws2-iam +:description: The aws2-iam is used for managing Amazon IAM +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* *Since Camel 3.1* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The KMS component supports create, run, start, stop and terminate https://aws.amazon.com/iam/[AWS IAM] instances. diff --git a/components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-component.adoc b/components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-component.adoc index fdc35610aa81f..51c8f5e831bd8 100644 --- a/components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-component.adoc +++ b/components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-component.adoc @@ -1,11 +1,15 @@ [[aws2-kinesis-component]] = AWS 2 Kinesis Component +:docTitle: AWS 2 Kinesis +:artifactId: camel-aws2-kinesis +:description: The aws2-kinesis component is for consuming and producing records from Amazon Kinesis Streams. +:since: 3.2 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.2* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Kinesis component supports receiving messages from and sending messages to Amazon Kinesis service. diff --git a/components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-firehose-component.adoc b/components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-firehose-component.adoc index f703c7316d2e9..f4c0053acb40a 100644 --- a/components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-firehose-component.adoc +++ b/components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-firehose-component.adoc @@ -1,11 +1,15 @@ [[aws2-kinesis-firehose-component]] = AWS 2 Kinesis Firehose Component +:docTitle: AWS 2 Kinesis Firehose +:artifactId: camel-aws2-kinesis +:description: The aws2-kinesis-firehose component is used for producing Amazon's Kinesis Firehose streams. +:since: 3.2 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.2* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Kinesis Firehose component supports sending messages to Amazon Kinesis Firehose service. diff --git a/components/camel-aws2-kms/src/main/docs/aws2-kms-component.adoc b/components/camel-aws2-kms/src/main/docs/aws2-kms-component.adoc index 19d6f3bcd2176..19dcb9b9fbf76 100644 --- a/components/camel-aws2-kms/src/main/docs/aws2-kms-component.adoc +++ b/components/camel-aws2-kms/src/main/docs/aws2-kms-component.adoc @@ -1,14 +1,18 @@ [[aws2-kms-component]] = AWS 2 KMS Component +:docTitle: AWS 2 KMS +:artifactId: camel-aws2-kms +:description: The aws2-kms is used for managing Amazon KMS +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* *Since Camel 3.1* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The KMS component supports the ability to work with keys stored in https://aws.amazon.com/kms/[AWS KMS] instances. diff --git a/components/camel-aws2-lambda/src/main/docs/aws2-lambda-component.adoc b/components/camel-aws2-lambda/src/main/docs/aws2-lambda-component.adoc index 13cbbd4059ab5..203912d750a46 100644 --- a/components/camel-aws2-lambda/src/main/docs/aws2-lambda-component.adoc +++ b/components/camel-aws2-lambda/src/main/docs/aws2-lambda-component.adoc @@ -1,11 +1,15 @@ [[aws2-lambda-component]] = AWS Lambda Component +:docTitle: AWS Lambda +:artifactId: camel-aws2-lambda +:description: The aws2-lambda is used for managing and invoking functions from Amazon Lambda. +:since: 3.2 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.2* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Lambda component supports create, get, list, delete and invoke https://aws.amazon.com/lambda/[AWS Lambda] functions. diff --git a/components/camel-aws2-mq/src/main/docs/aws2-mq-component.adoc b/components/camel-aws2-mq/src/main/docs/aws2-mq-component.adoc index fe62f6a857797..ad85cdeb9bbbc 100644 --- a/components/camel-aws2-mq/src/main/docs/aws2-mq-component.adoc +++ b/components/camel-aws2-mq/src/main/docs/aws2-mq-component.adoc @@ -1,11 +1,15 @@ [[aws2-mq-component]] = AWS 2 MQ Component +:docTitle: AWS 2 MQ +:artifactId: camel-aws2-mq +:description: The aws2-mq is used for managing Amazon MQ instances. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The MQ component supports create, run, start, stop and terminate https://aws.amazon.com/amazon-mq/[AWS MQ] instances. diff --git a/components/camel-aws2-msk/src/main/docs/aws2-msk-component.adoc b/components/camel-aws2-msk/src/main/docs/aws2-msk-component.adoc index f60cadad91f41..1f1344c55a668 100644 --- a/components/camel-aws2-msk/src/main/docs/aws2-msk-component.adoc +++ b/components/camel-aws2-msk/src/main/docs/aws2-msk-component.adoc @@ -1,14 +1,18 @@ [[aws2-msk-component]] = AWS 2 MSK Component +:docTitle: AWS 2 MSK +:artifactId: camel-aws2-msk +:description: The aws2-msk is used for managing Amazon MSK +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* *Since Camel 3.1* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The AWS MSK component supports create, run, start, stop and terminate https://aws.amazon.com/msk/[AWS MSK] instances. diff --git a/components/camel-aws2-s3/src/main/docs/aws2-s3-component.adoc b/components/camel-aws2-s3/src/main/docs/aws2-s3-component.adoc index a0108cafa332b..699387766a4a7 100644 --- a/components/camel-aws2-s3/src/main/docs/aws2-s3-component.adoc +++ b/components/camel-aws2-s3/src/main/docs/aws2-s3-component.adoc @@ -1,14 +1,18 @@ [[aws2-s3-component]] = AWS2 S3 Storage Service Component +:docTitle: AWS2 S3 Storage Service +:artifactId: camel-aws2-s3 +:description: The aws2-s3 component is used for storing and retrieving object from Amazon S3 Storage Service. +:since: 3.2 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.2* +*Since Camel {since}* *Since Camel 3.2* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The S3 component supports storing and retrieving objects from/to https://aws.amazon.com/s3[Amazon's S3] service. diff --git a/components/camel-aws2-ses/src/main/docs/aws2-ses-component.adoc b/components/camel-aws2-ses/src/main/docs/aws2-ses-component.adoc index 69f6af7e64af9..f90e812b1ab0f 100644 --- a/components/camel-aws2-ses/src/main/docs/aws2-ses-component.adoc +++ b/components/camel-aws2-ses/src/main/docs/aws2-ses-component.adoc @@ -1,11 +1,15 @@ [[aws2-ses-component]] = AWS 2 Simple Email Service Component +:docTitle: AWS 2 Simple Email Service +:artifactId: camel-aws2-ses +:description: The aws2-ses component is used for sending emails with Amazon's SES service. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The ses component supports sending emails with https://aws.amazon.com/ses[Amazon's SES] service. diff --git a/components/camel-aws2-sns/src/main/docs/aws2-sns-component.adoc b/components/camel-aws2-sns/src/main/docs/aws2-sns-component.adoc index 730642d28785f..7f010f784543d 100644 --- a/components/camel-aws2-sns/src/main/docs/aws2-sns-component.adoc +++ b/components/camel-aws2-sns/src/main/docs/aws2-sns-component.adoc @@ -1,14 +1,18 @@ [[aws2-sns-component]] = AWS 2 Simple Notification System Component +:docTitle: AWS 2 Simple Notification System +:artifactId: camel-aws2-sns +:description: The aws2-sns component is used for sending messages to an Amazon Simple Notification Topic. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* *Since Camel 3.1* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The SNS component allows messages to be sent to an https://aws.amazon.com/sns[Amazon Simple Notification] Topic. The diff --git a/components/camel-aws2-sqs/src/main/docs/aws2-sqs-component.adoc b/components/camel-aws2-sqs/src/main/docs/aws2-sqs-component.adoc index 792b629231c5a..d90858fd51c12 100644 --- a/components/camel-aws2-sqs/src/main/docs/aws2-sqs-component.adoc +++ b/components/camel-aws2-sqs/src/main/docs/aws2-sqs-component.adoc @@ -1,11 +1,15 @@ [[aws2-sqs-component]] = AWS 2 Simple Queue Service Component +:docTitle: AWS 2 Simple Queue Service +:artifactId: camel-aws2-sqs +:description: The aws2-sqs component is used for sending and receiving messages to Amazon's SQS service. +:since: 3.1 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The sqs component supports sending and receiving messages to https://aws.amazon.com/sqs[Amazon's SQS] service. diff --git a/components/camel-aws2-translate/src/main/docs/aws2-translate-component.adoc b/components/camel-aws2-translate/src/main/docs/aws2-translate-component.adoc index 99010a7def600..0e486158dcb52 100644 --- a/components/camel-aws2-translate/src/main/docs/aws2-translate-component.adoc +++ b/components/camel-aws2-translate/src/main/docs/aws2-translate-component.adoc @@ -1,12 +1,16 @@ [[aws2-translate-component]] = AWS 2 Translate Component +:docTitle: AWS 2 Translate +:artifactId: camel-aws2-translate +:description: The aws2-translate component is used for managing Amazon Translate +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Translate component supports translate a text in multiple languages. https://aws.amazon.com/translate/[AWS Translate] clusters instances. diff --git a/components/camel-azure-storage-blob/src/main/docs/azure-storage-blob-component.adoc b/components/camel-azure-storage-blob/src/main/docs/azure-storage-blob-component.adoc index 948479fe49006..05cc92ed53a93 100644 --- a/components/camel-azure-storage-blob/src/main/docs/azure-storage-blob-component.adoc +++ b/components/camel-azure-storage-blob/src/main/docs/azure-storage-blob-component.adoc @@ -1,11 +1,15 @@ [[azure-storage-blob-component]] = Azure Storage Blob Service Component +:docTitle: Azure Storage Blob Service +:artifactId: camel-azure-storage-blob +:description: The azure-storage-blob component is used for storing and retrieving blobs from Azure Storage Blob Service using SDK v12. +:since: 3.3 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.3* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Azure Storage Blob component is used for storing and retrieving blobs from https://azure.microsoft.com/services/storage/blobs/[Azure Storage Blob] Service using *Azure APIs v12*. However in case of versions above v12, we will see if this component can adopt these changes depending on how much breaking changes can result. diff --git a/components/camel-azure/src/main/docs/azure-blob-component.adoc b/components/camel-azure/src/main/docs/azure-blob-component.adoc index 726acfa8fe735..50582a7eec883 100644 --- a/components/camel-azure/src/main/docs/azure-blob-component.adoc +++ b/components/camel-azure/src/main/docs/azure-blob-component.adoc @@ -1,11 +1,15 @@ [[azure-blob-component]] = Azure Storage Blob Service Component +:docTitle: Azure Storage Blob Service +:artifactId: camel-azure +:description: The azure-blob component is used for storing and retrieving blobs from Azure Storage Blob Service. +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Azure Blob component supports storing and retrieving the blobs to/from https://azure.microsoft.com/services/storage/blobs/[Azure Storage Blob] service. diff --git a/components/camel-azure/src/main/docs/azure-queue-component.adoc b/components/camel-azure/src/main/docs/azure-queue-component.adoc index e3533108b19aa..8e34ee35365fe 100644 --- a/components/camel-azure/src/main/docs/azure-queue-component.adoc +++ b/components/camel-azure/src/main/docs/azure-queue-component.adoc @@ -1,11 +1,15 @@ [[azure-queue-component]] = Azure Storage Queue Service Component +:docTitle: Azure Storage Queue Service +:artifactId: camel-azure +:description: The azure-queue component is used for storing and retrieving messages from Azure Storage Queue Service. +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Azure Queue component supports storing and retrieving the messages to/from https://azure.microsoft.com/services/storage/queues/[Azure Storage Queue] service. diff --git a/components/camel-azure/src/main/docs/azure.adoc b/components/camel-azure/src/main/docs/azure-summary.adoc similarity index 93% rename from components/camel-azure/src/main/docs/azure.adoc rename to components/camel-azure/src/main/docs/azure-summary.adoc index 9e9022f93ac69..5fd8abd5aeedd 100644 --- a/components/camel-azure/src/main/docs/azure.adoc +++ b/components/camel-azure/src/main/docs/azure-summary.adoc @@ -1,5 +1,7 @@ [[Azure-CamelComponentsforWindowsAzureServices]] = Camel Components for Windows Azure Services +//attributes written by hand, not generated +:docTitle: Azure The Camel Components for https://azure.microsoft.com/[Windows Azure Services] provide connectivity to Azure services from Camel. diff --git a/components/camel-barcode/src/main/docs/barcode-dataformat.adoc b/components/camel-barcode/src/main/docs/barcode-dataformat.adoc index 5b0085b03daaf..da0f33372805d 100644 --- a/components/camel-barcode/src/main/docs/barcode-dataformat.adoc +++ b/components/camel-barcode/src/main/docs/barcode-dataformat.adoc @@ -1,7 +1,12 @@ [[barcode-dataformat]] = Barcode DataFormat +:docTitle: Barcode +:artifactId: camel-barcode +:description: The Barcode data format is used for creating barccode images (such as QR-Code) +:since: 2.14 +:supportLevel: Stable -*Since Camel 2.14* +*Since Camel {since}* The Barcode data format is based on the https://github.com/zxing/zxing[zxing library]. The goal of this diff --git a/components/camel-base64/src/main/docs/base64-dataformat.adoc b/components/camel-base64/src/main/docs/base64-dataformat.adoc index 6334f51c56f94..40b1fda7ce10a 100644 --- a/components/camel-base64/src/main/docs/base64-dataformat.adoc +++ b/components/camel-base64/src/main/docs/base64-dataformat.adoc @@ -1,7 +1,12 @@ [[base64-dataformat]] = Base64 DataFormat +:docTitle: Base64 +:artifactId: camel-base64 +:description: The Base64 data format is used for base64 encoding and decoding. +:since: 2.11 +:supportLevel: Stable -*Since Camel 2.11* +*Since Camel {since}* The Base64 data format is used for base64 encoding and decoding. diff --git a/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc b/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc index cda98e64286ae..a9a922273cb09 100644 --- a/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc +++ b/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc @@ -1,11 +1,15 @@ [[bean-validator-component]] = Bean Validator Component +:docTitle: Bean Validator +:artifactId: camel-bean-validator +:description: The Validator component performs bean validation of the message body using the Java Bean Validation API. +:since: 2.3 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.3* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Validator component performs bean validation of the message body using the Java Bean Validation API diff --git a/components/camel-bean/src/main/docs/bean-component.adoc b/components/camel-bean/src/main/docs/bean-component.adoc index fad62539a7dad..fd76a1f74c925 100644 --- a/components/camel-bean/src/main/docs/bean-component.adoc +++ b/components/camel-bean/src/main/docs/bean-component.adoc @@ -1,11 +1,16 @@ [[bean-component]] = Bean Component +:docTitle: Bean +:artifactId: camel-bean +:description: The bean component is for invoking Java beans from Camel. +:since: 1.0 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Bean component binds beans to Camel message exchanges. diff --git a/components/camel-bean/src/main/docs/bean-language.adoc b/components/camel-bean/src/main/docs/bean-language.adoc index 2891f1c90ea0d..7d0edd093dac7 100644 --- a/components/camel-bean/src/main/docs/bean-language.adoc +++ b/components/camel-bean/src/main/docs/bean-language.adoc @@ -1,12 +1,17 @@ [[bean-language]] = Bean method Language -== Bean Language -*Since Camel 1.3* +:docTitle: Bean method +:artifactId: camel-bean +:description: To use a Java bean (aka method call) in Camel expressions or predicates. +:since: 1.3 +:supportLevel: Stable + +*Since Camel {since}* The purpose of the Bean Language is to be able to implement an xref:manual::expression.adoc[Expression] or xref:manual::predicate.adoc[Predicate] using a simple method on a bean. The bean name is resolved using a xref:manual::registry.adoc[Registry], such as the -xref:manual::spring.adoc[Spring] *`ApplicationContext`*, then a method is +xref:ROOT:spring-summary.adoc[Spring] *`ApplicationContext`*, then a method is invoked to evaluate the xref:manual::expression.adoc[Expression] or xref:manual::predicate.adoc[Predicate]. If no method name is provided then one is chosen using the rules for xref:manual::bean-binding.adoc[Bean Binding]; @@ -116,7 +121,7 @@ The xref:bean-language.adoc[Bean Language] also supports invoking beans that isn't registered in the xref:manual::registry.adoc[Registry]. This is usable for quickly to invoke a bean from Java DSL where you don't need to register the bean in the xref:manual::registry.adoc[Registry] such as the -xref:ROOT:spring.adoc[Spring] *`ApplicationContext`*. Camel can instantiate +xref:ROOT:spring-summary.adoc[Spring] *`ApplicationContext`*. Camel can instantiate the bean and invoke the method if given a class or invoke an already existing instance. diff --git a/components/camel-bean/src/main/docs/class-component.adoc b/components/camel-bean/src/main/docs/class-component.adoc index 8b7b8ea141c1f..f9693d75a25c5 100644 --- a/components/camel-bean/src/main/docs/class-component.adoc +++ b/components/camel-bean/src/main/docs/class-component.adoc @@ -1,11 +1,16 @@ [[class-component]] = Class Component +:docTitle: Class +:artifactId: camel-bean +:description: The Class component is for invoking Java classes (Java beans) from Camel. +:since: 2.4 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 2.4* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Class component binds beans to Camel message exchanges. It works in the same way as the xref:bean-component.adoc[Bean] component but instead of diff --git a/components/camel-beanio/src/main/docs/beanio-dataformat.adoc b/components/camel-beanio/src/main/docs/beanio-dataformat.adoc index 4b0560fcfb77c..b935d54b0224e 100644 --- a/components/camel-beanio/src/main/docs/beanio-dataformat.adoc +++ b/components/camel-beanio/src/main/docs/beanio-dataformat.adoc @@ -1,7 +1,12 @@ [[beanio-dataformat]] = BeanIO DataFormat +:docTitle: BeanIO +:artifactId: camel-beanio +:description: The BeanIO data format is used for working with flat payloads (such as CSV, delimited, or fixed length formats). +:since: 2.10 +:supportLevel: Stable -*Since Camel 2.10* +*Since Camel {since}* The BeanIO Data Format uses http://beanio.org/[BeanIO] to handle flat payloads (such as XML, CSV, diff --git a/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc b/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc index 1d4864cab0f0d..fdc0d4826120b 100644 --- a/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc +++ b/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc @@ -1,11 +1,15 @@ [[beanstalk-component]] = Beanstalk Component +:docTitle: Beanstalk +:artifactId: camel-beanstalk +:description: The beanstalk component is used for job retrieval and post-processing of Beanstalk jobs. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Camel Beanstalk project provides a Camel component for job retrieval and post-processing of Beanstalk jobs. diff --git a/components/camel-bindy/src/main/docs/bindy-dataformat.adoc b/components/camel-bindy/src/main/docs/bindy-dataformat.adoc index 785e45b038ad6..0e23e4b1645d6 100644 --- a/components/camel-bindy/src/main/docs/bindy-dataformat.adoc +++ b/components/camel-bindy/src/main/docs/bindy-dataformat.adoc @@ -1,7 +1,12 @@ [[bindy-dataformat]] = Bindy DataFormat +:docTitle: Bindy +:artifactId: camel-bindy +:description: The Bindy data format is used for working with flat payloads (such as CSV, delimited, fixed length formats, or FIX messages). +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* The goal of this component is to allow the parsing/binding of non-structured data (or to be more precise non-XML data) + diff --git a/components/camel-bonita/src/main/docs/bonita-component.adoc b/components/camel-bonita/src/main/docs/bonita-component.adoc index 15c46b10ae7c7..2cb6d9d0fc43a 100644 --- a/components/camel-bonita/src/main/docs/bonita-component.adoc +++ b/components/camel-bonita/src/main/docs/bonita-component.adoc @@ -1,11 +1,15 @@ [[bonita-component]] = Bonita Component +:docTitle: Bonita +:artifactId: camel-bonita +:description: Used for communicating with a remote Bonita BPM process engine. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* Used for communicating with a remote Bonita BPM process engine. diff --git a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc index 6098aa81e9cee..9ce91cbd006e0 100644 --- a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc +++ b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc @@ -1,11 +1,15 @@ [[box-component]] = Box Component +:docTitle: Box +:artifactId: camel-box +:description: For uploading downloading and managing files folders groups collaborations etc on box DOT com. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Box component provides access to all of the Box.com APIs accessible using https://github.com/box/box-java-sdk/[https://github.com/box/box-java-sdk]. It @@ -811,4 +815,3 @@ from("direct:foo") ---- include::camel-spring-boot::page$box-starter.adoc[] - diff --git a/components/camel-braintree/src/main/docs/braintree-component.adoc b/components/camel-braintree/src/main/docs/braintree-component.adoc index 85cdd6b6636db..c9b44cc31a238 100644 --- a/components/camel-braintree/src/main/docs/braintree-component.adoc +++ b/components/camel-braintree/src/main/docs/braintree-component.adoc @@ -1,11 +1,15 @@ [[braintree-component]] = Braintree Component +:docTitle: Braintree +:artifactId: camel-braintree +:description: The braintree component is used for integrating with the Braintree Payment System. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Braintree component provides access to https://www.braintreepayments.com/[Braintree Payments] trough through diff --git a/components/camel-browse/src/main/docs/browse-component.adoc b/components/camel-browse/src/main/docs/browse-component.adoc index b0d7ecb6d5394..4cdb057c60eaa 100644 --- a/components/camel-browse/src/main/docs/browse-component.adoc +++ b/components/camel-browse/src/main/docs/browse-component.adoc @@ -1,11 +1,16 @@ [[browse-component]] = Browse Component +:docTitle: Browse +:artifactId: camel-browse +:description: The browse component is used for viewing the messages received on endpoints that supports BrowsableEndpoint. +:since: 1.3 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 1.3* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Browse component provides a simple BrowsableEndpoint which can be useful for diff --git a/components/camel-caffeine/src/main/docs/caffeine-cache-component.adoc b/components/camel-caffeine/src/main/docs/caffeine-cache-component.adoc index 4999af787ceb5..27c0dac982ee5 100644 --- a/components/camel-caffeine/src/main/docs/caffeine-cache-component.adoc +++ b/components/camel-caffeine/src/main/docs/caffeine-cache-component.adoc @@ -1,11 +1,15 @@ [[caffeine-cache-component]] = Caffeine Cache Component +:docTitle: Caffeine Cache +:artifactId: camel-caffeine +:description: The caffeine-cache component is used for integration with Caffeine Cache. +:since: 2.20 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Caffeine Cache component enables you to perform caching operations using the simple cache from Caffeine. diff --git a/components/camel-caffeine/src/main/docs/caffeine-loadcache-component.adoc b/components/camel-caffeine/src/main/docs/caffeine-loadcache-component.adoc index 9f3ed6faccc16..66703842d0cd4 100644 --- a/components/camel-caffeine/src/main/docs/caffeine-loadcache-component.adoc +++ b/components/camel-caffeine/src/main/docs/caffeine-loadcache-component.adoc @@ -1,11 +1,15 @@ [[caffeine-loadcache-component]] = Caffeine LoadCache Component +:docTitle: Caffeine LoadCache +:artifactId: camel-caffeine +:description: The caffeine-loadcache component is used for integration with Caffeine Load Cache. +:since: 2.20 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Caffeine Loadcache component enables you to perform caching operations using The Load cache from Caffeine. diff --git a/components/camel-cassandraql/src/main/docs/cql-component.adoc b/components/camel-cassandraql/src/main/docs/cql-component.adoc index 13b99acbe93e6..acdbfdf56685b 100644 --- a/components/camel-cassandraql/src/main/docs/cql-component.adoc +++ b/components/camel-cassandraql/src/main/docs/cql-component.adoc @@ -1,11 +1,15 @@ [[cql-component]] = Cassandra CQL Component +:docTitle: Cassandra CQL +:artifactId: camel-cassandraql +:description: The cql component aims at integrating Cassandra 2.0 using the CQL3 API (not the Thrift API). It's based on Cassandra Java Driver provided by DataStax. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* http://cassandra.apache.org[Apache Cassandra] is an open source NoSQL database designed to handle large amounts on commodity hardware. Like diff --git a/components/camel-cbor/src/main/docs/cbor-dataformat.adoc b/components/camel-cbor/src/main/docs/cbor-dataformat.adoc index 06467199a1f07..091be99c53fee 100644 --- a/components/camel-cbor/src/main/docs/cbor-dataformat.adoc +++ b/components/camel-cbor/src/main/docs/cbor-dataformat.adoc @@ -1,7 +1,12 @@ [[cbor-dataformat]] = CBOR DataFormat +:docTitle: CBOR +:artifactId: camel-cbor +:description: CBOR data format is used for unmarshal a CBOR payload to POJO or to marshal POJO back to CBOR payload. +:since: 3.0 +:supportLevel: Stable -*Since Camel 3.0* +*Since Camel {since}* CBOR is a Data Format which uses the http://wiki.fasterxml.com/JacksonHome/[Jackson library] with the diff --git a/components/camel-cdi/src/main/docs/cdi.adoc b/components/camel-cdi/src/main/docs/cdi.adoc index 0f5024dbe977c..6a36d634f5722 100644 --- a/components/camel-cdi/src/main/docs/cdi.adoc +++ b/components/camel-cdi/src/main/docs/cdi.adoc @@ -1,5 +1,12 @@ [[cdi-component]] -= Camel CDI += CDI Component +:docTitle: CDI +:artifactId: camel-cdi +:description: Using Camel with CDI +:since: 2.10 +:supportLevel: Stable + +*Since Camel {since}* The Camel CDI component provides auto-configuration for Apache Camel using CDI as dependency injection framework based @@ -840,5 +847,3 @@ a Camel CDI Maven project, e.g.: ---- mvn archetype:generate -DarchetypeGroupId=org.apache.camel.archetypes -DarchetypeArtifactId=camel-archetype-cdi ---- - - diff --git a/components/camel-chatscript/src/main/docs/chatscript-component.adoc b/components/camel-chatscript/src/main/docs/chatscript-component.adoc index 25390404646e8..746f1f11e062a 100644 --- a/components/camel-chatscript/src/main/docs/chatscript-component.adoc +++ b/components/camel-chatscript/src/main/docs/chatscript-component.adoc @@ -1,11 +1,15 @@ [[chatscript-component]] = ChatScript Component +:docTitle: ChatScript +:artifactId: camel-chatscript +:description: Represents a ChatScript endpoint. +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The ChatScript component allows you to interact with ChatScript Server and have conversations. This component is stateless and relies on ChatScript to maintain chat history. diff --git a/components/camel-chunk/src/main/docs/chunk-component.adoc b/components/camel-chunk/src/main/docs/chunk-component.adoc index 29062522a2b6d..6387f68b2032f 100644 --- a/components/camel-chunk/src/main/docs/chunk-component.adoc +++ b/components/camel-chunk/src/main/docs/chunk-component.adoc @@ -1,11 +1,15 @@ [[chunk-component]] = Chunk Component +:docTitle: Chunk +:artifactId: camel-chunk +:description: Transforms the message using a Chunk template. +:since: 2.15 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Chunk component allows for processing a message using a http://www.x5software.com/chunk/examples/ChunkExample?loc=en_US[Chunk] template. diff --git a/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc b/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc index 232e6f9e3f61d..abe5142c1548a 100644 --- a/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc +++ b/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc @@ -1,11 +1,15 @@ [[cm-sms-component]] = CM SMS Gateway Component +:docTitle: CM SMS Gateway +:artifactId: camel-cm-sms +:description: The cm-sms component allows to integrate with CM SMS Gateway. +:since: 2.18 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* *Camel-Cm-Sms* is an http://camel.apache.org/[Apache Camel] component for the [CM SMS Gateway](https://www.cmtelecom.com). diff --git a/components/camel-cmis/src/main/docs/cmis-component.adoc b/components/camel-cmis/src/main/docs/cmis-component.adoc index 905798a73170b..c54c54719266b 100644 --- a/components/camel-cmis/src/main/docs/cmis-component.adoc +++ b/components/camel-cmis/src/main/docs/cmis-component.adoc @@ -1,11 +1,15 @@ [[cmis-component]] = CMIS Component +:docTitle: CMIS +:artifactId: camel-cmis +:description: The cmis component uses the Apache Chemistry client API and allows you to add/read nodes to/from a CMIS compliant content repositories. +:since: 2.11 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.11* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The cmis component uses the http://chemistry.apache.org/java/opencmis.html[Apache Chemistry] client diff --git a/components/camel-coap/src/main/docs/coap-component.adoc b/components/camel-coap/src/main/docs/coap-component.adoc index d01973a9953aa..f507810e629b3 100644 --- a/components/camel-coap/src/main/docs/coap-component.adoc +++ b/components/camel-coap/src/main/docs/coap-component.adoc @@ -1,11 +1,15 @@ [[coap-component]] = CoAP Component +:docTitle: CoAP +:artifactId: camel-coap +:description: The coap component is used for sending and receiving messages from COAP capable devices. +:since: 2.16 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Camel-CoAP is an http://camel.apache.org/[Apache Camel] component that allows you to work with CoAP, a lightweight REST-type protocol for machine-to-machine operation. diff --git a/components/camel-cometd/src/main/docs/cometd-component.adoc b/components/camel-cometd/src/main/docs/cometd-component.adoc index 6acee3d991267..138fc71bbca47 100644 --- a/components/camel-cometd/src/main/docs/cometd-component.adoc +++ b/components/camel-cometd/src/main/docs/cometd-component.adoc @@ -1,11 +1,15 @@ [[cometd-component]] = CometD Component +:docTitle: CometD +:artifactId: camel-cometd +:description: The cometd component is a transport for working with the Jetty implementation of the cometd/bayeux protocol. +:since: 2.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Cometd component is a transport for working with the http://www.mortbay.org/jetty[jetty] implementation of the diff --git a/components/camel-consul/src/main/docs/consul-component.adoc b/components/camel-consul/src/main/docs/consul-component.adoc index 5a6e87c082f8f..95fb3145cb510 100644 --- a/components/camel-consul/src/main/docs/consul-component.adoc +++ b/components/camel-consul/src/main/docs/consul-component.adoc @@ -1,11 +1,15 @@ [[consul-component]] = Consul Component +:docTitle: Consul +:artifactId: camel-consul +:description: The camel consul component allows you to work with Consul, a distributed, highly available, datacenter-aware, service discovery and configuration system. +:since: 2.18 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Consul**** component is a component for integrating your application with Consul. diff --git a/components/camel-controlbus/src/main/docs/controlbus-component.adoc b/components/camel-controlbus/src/main/docs/controlbus-component.adoc index c14935ad5e814..06b1e877b7593 100644 --- a/components/camel-controlbus/src/main/docs/controlbus-component.adoc +++ b/components/camel-controlbus/src/main/docs/controlbus-component.adoc @@ -1,11 +1,16 @@ [[controlbus-component]] = Control Bus Component +:docTitle: Control Bus +:artifactId: camel-controlbus +:description: The controlbus component provides easy management of Camel applications based on the Control Bus EIP pattern. +:since: 2.11 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 2.11* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The http://www.eaipatterns.com/ControlBus.html[Control Bus] from the EIP patterns allows for the diff --git a/components/camel-corda/src/main/docs/corda-component.adoc b/components/camel-corda/src/main/docs/corda-component.adoc index bc5653cbf0eb8..6c2514bc8aa43 100644 --- a/components/camel-corda/src/main/docs/corda-component.adoc +++ b/components/camel-corda/src/main/docs/corda-component.adoc @@ -1,15 +1,17 @@ [[corda-component]] = Corda Component -*Since Camel 2.23* -*Since Camel 2.23* +:docTitle: Corda +:artifactId: camel-corda +:description: The corda component uses corda-rpc to interact with corda nodes. +:since: 2.23 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -*Since Camel 2.23* +*Since Camel {since}* Camel connector for R3's https://www.corda.net/[corda] blockchain platform using corda-rpc library. This component uses the corda rpc client. diff --git a/components/camel-couchbase/src/main/docs/couchbase-component.adoc b/components/camel-couchbase/src/main/docs/couchbase-component.adoc index ce60c77d8b807..ea821f7fec529 100644 --- a/components/camel-couchbase/src/main/docs/couchbase-component.adoc +++ b/components/camel-couchbase/src/main/docs/couchbase-component.adoc @@ -1,11 +1,15 @@ [[couchbase-component]] = Couchbase Component +:docTitle: Couchbase +:artifactId: camel-couchbase +:description: Represents a Couchbase endpoint that can query Views with a Poll strategy and/or produce various type of operations. +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The *couchbase:* component allows you to treat https://www.couchbase.com/[CouchBase] instances as a producer or consumer diff --git a/components/camel-couchdb/src/main/docs/couchdb-component.adoc b/components/camel-couchdb/src/main/docs/couchdb-component.adoc index 7fa3985308c5c..45898159689f7 100644 --- a/components/camel-couchdb/src/main/docs/couchdb-component.adoc +++ b/components/camel-couchdb/src/main/docs/couchdb-component.adoc @@ -1,11 +1,15 @@ [[couchdb-component]] = CouchDB Component +:docTitle: CouchDB +:artifactId: camel-couchdb +:description: The couchdb component is used for integrate with CouchDB databases. +:since: 2.11 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.11* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The *couchdb:* component allows you to treat http://couchdb.apache.org/[CouchDB] instances as a producer or consumer diff --git a/components/camel-cron/src/main/docs/cron-component.adoc b/components/camel-cron/src/main/docs/cron-component.adoc index 164c0d718dd5d..5bc418da0f376 100644 --- a/components/camel-cron/src/main/docs/cron-component.adoc +++ b/components/camel-cron/src/main/docs/cron-component.adoc @@ -1,11 +1,15 @@ [[cron-component]] = Cron Component +:docTitle: Cron +:artifactId: camel-cron +:description: Camel Cron Component +:since: 3.1 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Cron component is a generic interface component that allows triggering events at specific time interval specified using the Unix cron syntax (e.g. `0/2 * * * * ?` to trigger an event every two seconds). diff --git a/components/camel-crypto-cms/src/main/docs/crypto-cms-component.adoc b/components/camel-crypto-cms/src/main/docs/crypto-cms-component.adoc index 11c44110d0350..479daa9de303d 100644 --- a/components/camel-crypto-cms/src/main/docs/crypto-cms-component.adoc +++ b/components/camel-crypto-cms/src/main/docs/crypto-cms-component.adoc @@ -1,14 +1,19 @@ [[crypto-cms-component]] = Crypto CMS Component (deprecated) +:docTitle: Crypto CMS +:artifactId: camel-crypto-cms +:description: The crypto cms component is used for encrypting data in CMS Enveloped Data format, decrypting CMS Enveloped Data, signing data in CMS Signed Data format, and verifying CMS Signed Data. +:since: 2.20 +:supportLevel: Stable-deprecated +:deprecated: *deprecated* +:component-header: Only producer is supported -*Since Camel 2.20* +*Since Camel {since}* *Since Camel 2.20* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* http://tools.ietf.org/html/rfc5652[Cryptographic Message Syntax (CMS)] is a well established standard for signing and encrypting messages. The Apache Crypto CMS component supports the following parts of this standard: * Content Type "Enveloped Data" with Key Transport (asymmetric key), diff --git a/components/camel-crypto/src/main/docs/crypto-component.adoc b/components/camel-crypto/src/main/docs/crypto-component.adoc index 475ca05bbc52f..bd609f86aa290 100644 --- a/components/camel-crypto/src/main/docs/crypto-component.adoc +++ b/components/camel-crypto/src/main/docs/crypto-component.adoc @@ -1,11 +1,15 @@ [[crypto-component]] = Crypto (JCE) Component +:docTitle: Crypto (JCE) +:artifactId: camel-crypto +:description: The crypto component is used for signing and verifying exchanges using the Signature Service of the Java Cryptographic Extension (JCE). +:since: 2.3 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.3* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* With Camel cryptographic endpoints and Java's Cryptographic extension it is easy to create Digital Signatures for Exchanges. diff --git a/components/camel-crypto/src/main/docs/crypto-dataformat.adoc b/components/camel-crypto/src/main/docs/crypto-dataformat.adoc index eb430ebebd219..2050deacc28af 100644 --- a/components/camel-crypto/src/main/docs/crypto-dataformat.adoc +++ b/components/camel-crypto/src/main/docs/crypto-dataformat.adoc @@ -1,7 +1,12 @@ [[crypto-dataformat]] = Crypto (Java Cryptographic Extension) DataFormat +:docTitle: Crypto (Java Cryptographic Extension) +:artifactId: camel-crypto +:description: Crypto data format is used for encrypting and decrypting of messages using Java Cryptographic Extension. +:since: 2.3 +:supportLevel: Stable -*Since Camel 2.3* +*Since Camel {since}* The Crypto Data Format integrates the Java Cryptographic Extension into Camel, allowing simple and flexible diff --git a/components/camel-crypto/src/main/docs/pgp-dataformat.adoc b/components/camel-crypto/src/main/docs/pgp-dataformat.adoc index 574994ab2c8b1..1f9b925ffece2 100644 --- a/components/camel-crypto/src/main/docs/pgp-dataformat.adoc +++ b/components/camel-crypto/src/main/docs/pgp-dataformat.adoc @@ -1,7 +1,12 @@ [[pgp-dataformat]] = PGP DataFormat +:docTitle: PGP +:artifactId: camel-crypto +:description: PGP data format is used for encrypting and decrypting of messages using Java Cryptographic Extension and PGP. +:since: 2.9 +:supportLevel: Stable -*Since Camel 2.9* +*Since Camel {since}* The PGP Data Format integrates the Java Cryptographic Extension into Camel, allowing simple and flexible diff --git a/components/camel-csv/src/main/docs/csv-dataformat.adoc b/components/camel-csv/src/main/docs/csv-dataformat.adoc index c9021892746d5..312eea3f31a90 100644 --- a/components/camel-csv/src/main/docs/csv-dataformat.adoc +++ b/components/camel-csv/src/main/docs/csv-dataformat.adoc @@ -1,7 +1,12 @@ [[csv-dataformat]] = CSV DataFormat +:docTitle: CSV +:artifactId: camel-csv +:description: The CSV data format is used for handling CSV payloads. +:since: 1.3 +:supportLevel: Stable -*Since Camel 1.3* +*Since Camel {since}* The CSV Data Format uses http://commons.apache.org/proper/commons-csv/[Apache Commons CSV] to diff --git a/components/camel-cxf-transport/src/main/docs/cxf-transport.adoc b/components/camel-cxf-transport/src/main/docs/cxf-transport.adoc index f0fbdef2af6ed..d5949152e8f4e 100644 --- a/components/camel-cxf-transport/src/main/docs/cxf-transport.adoc +++ b/components/camel-cxf-transport/src/main/docs/cxf-transport.adoc @@ -1,4 +1,12 @@ +[[cxf-transport-component]] = CXF Transport Component +:docTitle: CXF Transport +:artifactId: camel-cxf-transport +:description: Camel Transport for Apache CXF +:since: 2.8 +:supportLevel: Stable + +*Since Camel {since}* [[CamelTransportforCXF-WhatstheCamelTransportforCXF]] == What's the Camel Transport for CXF @@ -252,4 +260,3 @@ context in the camel destination. This example shows how to use the camel load balancing feature in CXF. You need to load the configuration file in CXF and publish the endpoints on the address "camel://direct:EndpointA" and "camel://direct:EndpointB" - diff --git a/components/camel-cxf/src/main/docs/cxf-component.adoc b/components/camel-cxf/src/main/docs/cxf-component.adoc index 5c666a56d6221..9c6ae79051254 100644 --- a/components/camel-cxf/src/main/docs/cxf-component.adoc +++ b/components/camel-cxf/src/main/docs/cxf-component.adoc @@ -1,11 +1,15 @@ [[cxf-component]] = CXF Component +:docTitle: CXF +:artifactId: camel-cxf +:description: The cxf component is used for SOAP WebServices using Apache CXF. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* [TIP] ==== diff --git a/components/camel-cxf/src/main/docs/cxfrs-component.adoc b/components/camel-cxf/src/main/docs/cxfrs-component.adoc index 2f0b823154920..94caacacd1218 100644 --- a/components/camel-cxf/src/main/docs/cxfrs-component.adoc +++ b/components/camel-cxf/src/main/docs/cxfrs-component.adoc @@ -1,11 +1,15 @@ [[cxfrs-component]] = CXF-RS Component +:docTitle: CXF-RS +:artifactId: camel-cxf +:description: The cxfrs component is used for JAX-RS REST services using Apache CXF. +:since: 2.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The CXFRS component provides integration with http://cxf.apache.org[Apache CXF] for connecting to JAX-RS 1.1 and 2.0 diff --git a/components/camel-dataformat/src/main/docs/dataformat-component.adoc b/components/camel-dataformat/src/main/docs/dataformat-component.adoc index adcc90b2a2dcd..2c54cd2bc38a1 100644 --- a/components/camel-dataformat/src/main/docs/dataformat-component.adoc +++ b/components/camel-dataformat/src/main/docs/dataformat-component.adoc @@ -1,11 +1,16 @@ [[dataformat-component]] = Data Format Component +:docTitle: Data Format +:artifactId: camel-dataformat +:description: The dataformat component is used for working with Data Formats as if it was a regular Component supporting Endpoints and URIs. +:since: 2.12 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Dataformat component allows to use xref:manual::data-format.adoc[Data Format] as a Camel Component. diff --git a/components/camel-dataset/src/main/docs/dataset-component.adoc b/components/camel-dataset/src/main/docs/dataset-component.adoc index 55e4e48a1b390..476fb578a86fb 100644 --- a/components/camel-dataset/src/main/docs/dataset-component.adoc +++ b/components/camel-dataset/src/main/docs/dataset-component.adoc @@ -1,11 +1,16 @@ [[dataset-component]] = Dataset Component +:docTitle: Dataset +:artifactId: camel-dataset +:description: The dataset component provides a mechanism to easily perform load & soak testing of your system. +:since: 1.3 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 1.3* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Testing of distributed and asynchronous processing is notoriously difficult. The xref:mock-component.adoc[Mock], xref:mock-component.adoc[Test] diff --git a/components/camel-dataset/src/main/docs/dataset-test-component.adoc b/components/camel-dataset/src/main/docs/dataset-test-component.adoc index a15b55672b010..60b7155d25960 100644 --- a/components/camel-dataset/src/main/docs/dataset-test-component.adoc +++ b/components/camel-dataset/src/main/docs/dataset-test-component.adoc @@ -1,11 +1,16 @@ [[dataset-test-component]] = DataSet Test Component +:docTitle: DataSet Test +:artifactId: camel-dataset +:description: The dataset-test component extends the mock component by on startup to pull messages from another endpoint to set the expected message bodies. +:since: 1.3 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 1.3* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* Testing of distributed and asynchronous processing is notoriously difficult. The xref:mock-component.adoc[Mock], xref:mock-component.adoc[Test] @@ -28,7 +33,7 @@ This will then set up a properly configured xref:mock-component.adoc[Mock] endpoint, which is only valid if the received messages match the number of expected messages and their message payloads are equal. -The xref:test.adoc[Test] component is provided +The xref:others:test.adoc[Test] component is provided directly in the camel-core. == URI format diff --git a/components/camel-debezium-mongodb/src/main/docs/debezium-mongodb-component.adoc b/components/camel-debezium-mongodb/src/main/docs/debezium-mongodb-component.adoc index e0442e5a61a82..76aa649695027 100644 --- a/components/camel-debezium-mongodb/src/main/docs/debezium-mongodb-component.adoc +++ b/components/camel-debezium-mongodb/src/main/docs/debezium-mongodb-component.adoc @@ -1,11 +1,15 @@ [[debezium-mongodb-component]] = Debezium MongoDB Connector Component +:docTitle: Debezium MongoDB Connector +:artifactId: camel-debezium-mongodb +:description: Represents a Debezium MongoDB endpoint which is used to capture changes in MongoDB database so that that applications can see those changes and respond to them. +:since: 3.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Debezium MongoDB component is wrapper around https://debezium.io/[Debezium] using https://debezium.io/documentation/reference/0.9/operations/embedded.html[Debezium Embedded], which enables Change Data Capture from MongoDB database using Debezium without the need for Kafka or Kafka Connect. diff --git a/components/camel-debezium-mysql/src/main/docs/debezium-mysql-component.adoc b/components/camel-debezium-mysql/src/main/docs/debezium-mysql-component.adoc index 53df7d1f95c61..690d726d058c8 100644 --- a/components/camel-debezium-mysql/src/main/docs/debezium-mysql-component.adoc +++ b/components/camel-debezium-mysql/src/main/docs/debezium-mysql-component.adoc @@ -1,11 +1,15 @@ [[debezium-mysql-component]] = Debezium MySQL Connector Component +:docTitle: Debezium MySQL Connector +:artifactId: camel-debezium-mysql +:description: Represents a Debezium MySQL endpoint which is used to capture changes in MySQL database so that that applications can see those changes and respond to them. +:since: 3.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Debezium MySQL component is wrapper around https://debezium.io/[Debezium] using https://debezium.io/documentation/reference/0.9/operations/embedded.html[Debezium Embedded], which enables Change Data Capture from MySQL database using Debezium without the need for Kafka or Kafka Connect. diff --git a/components/camel-debezium-postgres/src/main/docs/debezium-postgres-component.adoc b/components/camel-debezium-postgres/src/main/docs/debezium-postgres-component.adoc index 5845ef69fb3e1..5a5efee8a68b7 100644 --- a/components/camel-debezium-postgres/src/main/docs/debezium-postgres-component.adoc +++ b/components/camel-debezium-postgres/src/main/docs/debezium-postgres-component.adoc @@ -1,11 +1,15 @@ [[debezium-postgres-component]] = Debezium PostgresSQL Connector Component +:docTitle: Debezium PostgresSQL Connector +:artifactId: camel-debezium-postgres +:description: Represents a Debezium PostgresSQL endpoint which is used to capture changes in PostgresSQL database so that that applications can see those changes and respond to them. +:since: 3.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Debezium PostgresSQL component is wrapper around https://debezium.io/[Debezium] using https://debezium.io/documentation/reference/0.9/operations/embedded.html[Debezium Embedded], which enables Change Data Capture from PostgresSQL database using Debezium without the need for Kafka or Kafka Connect. diff --git a/components/camel-debezium-sqlserver/src/main/docs/debezium-sqlserver-component.adoc b/components/camel-debezium-sqlserver/src/main/docs/debezium-sqlserver-component.adoc index 016a22a4bbd15..5b38e3ff6e883 100644 --- a/components/camel-debezium-sqlserver/src/main/docs/debezium-sqlserver-component.adoc +++ b/components/camel-debezium-sqlserver/src/main/docs/debezium-sqlserver-component.adoc @@ -1,11 +1,15 @@ [[debezium-sqlserver-component]] = Debezium SQL Server Connector Component +:docTitle: Debezium SQL Server Connector +:artifactId: camel-debezium-sqlserver +:description: Represents a Debezium SQL Server endpoint which is used to capture changes in SQL Server database so that that applications can see those changes and respond to them. +:since: 3.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Debezium SQL Server component is wrapper around https://debezium.io/[Debezium] using https://debezium.io/documentation/reference/0.10/operations/embedded.html[Debezium Embedded], which enables Change Data Capture from SQL Server database using Debezium without the need for Kafka or Kafka Connect. diff --git a/components/camel-digitalocean/src/main/docs/digitalocean-component.adoc b/components/camel-digitalocean/src/main/docs/digitalocean-component.adoc index 4455fb9486a63..948af12def307 100644 --- a/components/camel-digitalocean/src/main/docs/digitalocean-component.adoc +++ b/components/camel-digitalocean/src/main/docs/digitalocean-component.adoc @@ -1,11 +1,15 @@ [[digitalocean-component]] = DigitalOcean Component +:docTitle: DigitalOcean +:artifactId: camel-digitalocean +:description: The DigitalOcean component allows you to manage Droplets and resources within the DigitalOcean cloud. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The DigitalOcean component allows you to manage Droplets and resources within the DigitalOcean cloud with **Camel** by encapsulating https://www.digitalocean.com/community/projects/api-client-in-java[digitalocean-api-java]. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through this Camel component. diff --git a/components/camel-direct/src/main/docs/direct-component.adoc b/components/camel-direct/src/main/docs/direct-component.adoc index e08d76b204302..65fceb589f208 100644 --- a/components/camel-direct/src/main/docs/direct-component.adoc +++ b/components/camel-direct/src/main/docs/direct-component.adoc @@ -1,11 +1,16 @@ [[direct-component]] = Direct Component +:docTitle: Direct +:artifactId: camel-direct +:description: The direct component provides direct, synchronous call to another endpoint from the same CamelContext. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Direct component provides direct, synchronous invocation of any consumers when a producer sends a message exchange. + diff --git a/components/camel-directvm/src/main/docs/direct-vm-component.adoc b/components/camel-directvm/src/main/docs/direct-vm-component.adoc index dcbb7818af7e8..b3d9f2a49ba9c 100644 --- a/components/camel-directvm/src/main/docs/direct-vm-component.adoc +++ b/components/camel-directvm/src/main/docs/direct-vm-component.adoc @@ -1,11 +1,16 @@ [[direct-vm-component]] = Direct VM Component +:docTitle: Direct VM +:artifactId: camel-directvm +:description: The direct-vm component provides direct, synchronous call to another endpoint from any CamelContext in the same JVM. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Direct-Vm component provides direct, synchronous invocation of any consumers in the JVM when a producer sends a message exchange. + diff --git a/components/camel-disruptor/src/main/docs/disruptor-component.adoc b/components/camel-disruptor/src/main/docs/disruptor-component.adoc index 92001d144d3bc..78fd64d04d3c9 100644 --- a/components/camel-disruptor/src/main/docs/disruptor-component.adoc +++ b/components/camel-disruptor/src/main/docs/disruptor-component.adoc @@ -1,11 +1,15 @@ [[disruptor-component]] = Disruptor Component +:docTitle: Disruptor +:artifactId: camel-disruptor +:description: The disruptor component provides asynchronous SEDA behavior using LMAX Disruptor. +:since: 2.12 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Disruptor component provides asynchronous https://en.wikipedia.org/wiki/Staged_event-driven_architecture[SEDA] behavior much as the diff --git a/components/camel-djl/src/main/docs/djl-component.adoc b/components/camel-djl/src/main/docs/djl-component.adoc index c9bcc43be4a04..17e5d02cd8343 100644 --- a/components/camel-djl/src/main/docs/djl-component.adoc +++ b/components/camel-djl/src/main/docs/djl-component.adoc @@ -1,12 +1,17 @@ [[djl-component]] = Deep Java Library Component +:docTitle: Deep Java Library +:artifactId: camel-djl +:description: The Deep Java Library component is used to infer deep learning models. +:since: 3.3 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.3* +*Since Camel {since}* +*{component-header}* -// HEADER START -*Only producer is supported* -// HEADER END +== Deep Java Library The *Deep Java Library* component is used to infer Deep Learning models from message exchanges data. This component uses https://djl.ai/[Deep Java Library] as underlying library. @@ -209,4 +214,4 @@ context.getRegistry().bind("MyTranslator", translator); from("file:/data/mnist/0/10.png") .to("djl:cv/image_classification?model=MyModel&translator=MyTranslator"); ----- \ No newline at end of file +---- diff --git a/components/camel-dns/src/main/docs/dns-component.adoc b/components/camel-dns/src/main/docs/dns-component.adoc index 2e46f83dbfc42..1bbfc340a195e 100644 --- a/components/camel-dns/src/main/docs/dns-component.adoc +++ b/components/camel-dns/src/main/docs/dns-component.adoc @@ -1,11 +1,15 @@ [[dns-component]] = DNS Component +:docTitle: DNS +:artifactId: camel-dns +:description: To lookup domain information and run DNS queries using DNSJava. +:since: 2.7 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* This is an additional component for Camel to run DNS queries, using DNSJava. The component is a thin layer on top of diff --git a/components/camel-docker/src/main/docs/docker-component.adoc b/components/camel-docker/src/main/docs/docker-component.adoc index 5a9482c7cc842..f2bced0c7f9e1 100644 --- a/components/camel-docker/src/main/docs/docker-component.adoc +++ b/components/camel-docker/src/main/docs/docker-component.adoc @@ -1,11 +1,15 @@ [[docker-component]] = Docker Component +:docTitle: Docker +:artifactId: camel-docker +:description: The docker component is used for managing Docker containers. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Camel component for communicating with Docker. diff --git a/components/camel-dozer/src/main/docs/dozer-component.adoc b/components/camel-dozer/src/main/docs/dozer-component.adoc index 4ac2c5d79ac5f..ccd459ad3c448 100644 --- a/components/camel-dozer/src/main/docs/dozer-component.adoc +++ b/components/camel-dozer/src/main/docs/dozer-component.adoc @@ -1,11 +1,15 @@ [[dozer-component]] = Dozer Component +:docTitle: Dozer +:artifactId: camel-dozer +:description: The dozer component provides the ability to map between Java beans using the Dozer mapping library. +:since: 2.15 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Dozer component provides the ability to map between Java beans using the http://camel.apache.org/dozer-type-conversion.html[Dozer] diff --git a/components/camel-drill/src/main/docs/drill-component.adoc b/components/camel-drill/src/main/docs/drill-component.adoc index 807cbb38a2986..53314a5e3d04a 100644 --- a/components/camel-drill/src/main/docs/drill-component.adoc +++ b/components/camel-drill/src/main/docs/drill-component.adoc @@ -1,11 +1,15 @@ [[drill-component]] = Drill Component +:docTitle: Drill +:artifactId: camel-drill +:description: The drill component gives you the ability to quering into apache drill cluster. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Drill component gives you the ability to querying to https://drill.apache.org/[Apache Drill Cluster] diff --git a/components/camel-dropbox/src/main/docs/dropbox-component.adoc b/components/camel-dropbox/src/main/docs/dropbox-component.adoc index 7c26311908604..8a9c30e919726 100644 --- a/components/camel-dropbox/src/main/docs/dropbox-component.adoc +++ b/components/camel-dropbox/src/main/docs/dropbox-component.adoc @@ -1,11 +1,15 @@ [[dropbox-component]] = Dropbox Component +:docTitle: Dropbox +:artifactId: camel-dropbox +:description: For uploading, downloading and managing files, folders, groups, collaborations, etc on dropbox DOT com. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Dropbox component allows you to treat https://www.dropbox.com[Dropbox] remote folders as a producer or diff --git a/components/camel-ehcache/src/main/docs/ehcache-component.adoc b/components/camel-ehcache/src/main/docs/ehcache-component.adoc index d043d816dd352..6c6ecb6038388 100644 --- a/components/camel-ehcache/src/main/docs/ehcache-component.adoc +++ b/components/camel-ehcache/src/main/docs/ehcache-component.adoc @@ -1,11 +1,15 @@ [[ehcache-component]] = Ehcache Component +:docTitle: Ehcache +:artifactId: camel-ehcache +:description: The ehcache component enables you to perform caching operations using Ehcache as cache implementation. +:since: 2.18 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Ehcache component enables you to perform caching operations using Ehcache 3 as the Cache Implementation. diff --git a/components/camel-elasticsearch-rest/src/main/docs/elasticsearch-rest-component.adoc b/components/camel-elasticsearch-rest/src/main/docs/elasticsearch-rest-component.adoc index 32158cc9c3e1a..0b772c8f00636 100644 --- a/components/camel-elasticsearch-rest/src/main/docs/elasticsearch-rest-component.adoc +++ b/components/camel-elasticsearch-rest/src/main/docs/elasticsearch-rest-component.adoc @@ -1,11 +1,15 @@ [[elasticsearch-rest-component]] = Elastichsearch Rest Component +:docTitle: Elastichsearch Rest +:artifactId: camel-elasticsearch-rest +:description: The elasticsearch component is used for interfacing with ElasticSearch server using REST API. +:since: 2.21 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.21* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* *Since Camel 2.21* diff --git a/components/camel-elsql/src/main/docs/elsql-component.adoc b/components/camel-elsql/src/main/docs/elsql-component.adoc index 994fa5706eb6d..70a22649d1901 100644 --- a/components/camel-elsql/src/main/docs/elsql-component.adoc +++ b/components/camel-elsql/src/main/docs/elsql-component.adoc @@ -1,11 +1,15 @@ [[elsql-component]] = ElSQL Component +:docTitle: ElSQL +:artifactId: camel-elsql +:description: The elsql component is an extension to the existing SQL Component that uses ElSql to define the SQL queries. +:since: 2.16 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The ELSQL component is an extension to the existing xref:sql-component.adoc[SQL Component] that uses @@ -44,7 +48,7 @@ The parameters to the SQL queries are named parameters in the elsql mapping files, and maps to corresponding keys from the Camel message, in the given precedence: -1. from message body if xref:components:languages:simple-language.adoc[Simple] +1. from message body if xref:languages:simple-language.adoc[Simple] expression. 2. from message body if its a `java.util.Map` diff --git a/components/camel-elytron/src/main/docs/elytron-component.adoc b/components/camel-elytron/src/main/docs/elytron-component.adoc index d28d9b03ae8da..a1be496812d1e 100644 --- a/components/camel-elytron/src/main/docs/elytron-component.adoc +++ b/components/camel-elytron/src/main/docs/elytron-component.adoc @@ -1,11 +1,11 @@ [[elytron-component]] = Undertow Elytron Security Provider +//by hand +:since: 3.2 -*Since Camel 3.2* +*Since Camel {since}* -// HEADER START *Replaces component camel-elytron* -// HEADER END *OSGi is not supported* diff --git a/components/camel-etcd/src/main/docs/etcd-keys-component.adoc b/components/camel-etcd/src/main/docs/etcd-keys-component.adoc index 8f6524ad22bec..0adc6aaebf06c 100644 --- a/components/camel-etcd/src/main/docs/etcd-keys-component.adoc +++ b/components/camel-etcd/src/main/docs/etcd-keys-component.adoc @@ -1,11 +1,15 @@ [[etcd-keys-component]] = Etcd Keys Component +:docTitle: Etcd Keys +:artifactId: camel-etcd +:description: Camel Etcd support +:since: 2.18 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* *Since Camel 2.18* diff --git a/components/camel-etcd/src/main/docs/etcd-stats-component.adoc b/components/camel-etcd/src/main/docs/etcd-stats-component.adoc index 21b40ed1945bd..9b185bd97d03a 100644 --- a/components/camel-etcd/src/main/docs/etcd-stats-component.adoc +++ b/components/camel-etcd/src/main/docs/etcd-stats-component.adoc @@ -1,11 +1,15 @@ [[etcd-stats-component]] = Etcd Stats Component +:docTitle: Etcd Stats +:artifactId: camel-etcd +:description: The camel etcd component allows you to work with Etcd, a distributed reliable key-value store. +:since: 2.18 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* *Since Camel 2.18* diff --git a/components/camel-etcd/src/main/docs/etcd-watch-component.adoc b/components/camel-etcd/src/main/docs/etcd-watch-component.adoc index a973f47acaf5e..2f5c8a9898494 100644 --- a/components/camel-etcd/src/main/docs/etcd-watch-component.adoc +++ b/components/camel-etcd/src/main/docs/etcd-watch-component.adoc @@ -1,11 +1,15 @@ [[etcd-watch-component]] = Etcd Watch Component +:docTitle: Etcd Watch +:artifactId: camel-etcd +:description: The camel etcd component allows you to work with Etcd, a distributed reliable key-value store. +:since: 2.18 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* *Since Camel 2.18* diff --git a/components/camel-exec/src/main/docs/exec-component.adoc b/components/camel-exec/src/main/docs/exec-component.adoc index 0c7e84e99a194..d5824835d2994 100644 --- a/components/camel-exec/src/main/docs/exec-component.adoc +++ b/components/camel-exec/src/main/docs/exec-component.adoc @@ -1,11 +1,15 @@ [[exec-component]] = Exec Component +:docTitle: Exec +:artifactId: camel-exec +:description: The exec component can be used to execute OS system commands. +:since: 2.3 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.3* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Exec component can be used to execute system commands. diff --git a/components/camel-facebook/src/main/docs/facebook-component.adoc b/components/camel-facebook/src/main/docs/facebook-component.adoc index 4992f4bccdcf1..cfcba96b981b7 100644 --- a/components/camel-facebook/src/main/docs/facebook-component.adoc +++ b/components/camel-facebook/src/main/docs/facebook-component.adoc @@ -1,11 +1,15 @@ [[facebook-component]] = Facebook Component +:docTitle: Facebook +:artifactId: camel-facebook +:description: The Facebook component provides access to all of the Facebook APIs accessible using Facebook4J. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Facebook component provides access to all of the Facebook APIs accessible using https://facebook4j.github.io/en/index.html[Facebook4J]. It diff --git a/components/camel-fastjson/src/main/docs/json-fastjson-dataformat.adoc b/components/camel-fastjson/src/main/docs/json-fastjson-dataformat.adoc index 259bda73974be..fe92bf7721901 100644 --- a/components/camel-fastjson/src/main/docs/json-fastjson-dataformat.adoc +++ b/components/camel-fastjson/src/main/docs/json-fastjson-dataformat.adoc @@ -1,7 +1,12 @@ [[json-fastjson-dataformat]] = JSon Fastjson DataFormat +:docTitle: JSon Fastjson +:artifactId: camel-fastjson +:description: JSon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload. +:since: 2.20 +:supportLevel: Stable -*Since Camel 2.20* +*Since Camel {since}* Fastjson is a Data Format which uses the https://github.com/alibaba/fastjson[Fastjson Library] diff --git a/components/camel-fhir/camel-fhir-component/src/main/docs/fhir-component.adoc b/components/camel-fhir/camel-fhir-component/src/main/docs/fhir-component.adoc index 7ca2956647dc2..013d06f1388dc 100644 --- a/components/camel-fhir/camel-fhir-component/src/main/docs/fhir-component.adoc +++ b/components/camel-fhir/camel-fhir-component/src/main/docs/fhir-component.adoc @@ -1,11 +1,15 @@ [[fhir-component]] = FHIR Component +:docTitle: FHIR +:artifactId: camel-fhir +:description: The fhir component is used for working with the FHIR protocol (health care). +:since: 2.23 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The FHIR component integrates with the http://hapifhir.io/[HAPI-FHIR] library which is an open-source implementation of the @@ -165,4 +169,3 @@ with the following path and query parameters: // endpoint options: END include::camel-spring-boot::page$fhir-starter.adoc[] - diff --git a/components/camel-fhir/camel-fhir-component/src/main/docs/fhirJson-dataformat.adoc b/components/camel-fhir/camel-fhir-component/src/main/docs/fhirJson-dataformat.adoc index ec53ef9fd7044..1a1393bd36923 100644 --- a/components/camel-fhir/camel-fhir-component/src/main/docs/fhirJson-dataformat.adoc +++ b/components/camel-fhir/camel-fhir-component/src/main/docs/fhirJson-dataformat.adoc @@ -1,7 +1,12 @@ [[fhirJson-dataformat]] = FHIR JSon DataFormat +:docTitle: FHIR JSon +:artifactId: camel-fhir +:description: The FHIR JSon data format is used to marshall/unmarshall to/from FHIR objects to/from JSON. +:since: 2.21 +:supportLevel: Stable -*Since Camel 2.21* +*Since Camel {since}* The FHIR-JSON Data Format leverages https://github.com/jamesagnew/hapi-fhir/blob/master/hapi-fhir-base/src/main/java/ca/uhn/fhir/parser/JsonParser.java[HAPI-FHIR's] diff --git a/components/camel-fhir/camel-fhir-component/src/main/docs/fhirXml-dataformat.adoc b/components/camel-fhir/camel-fhir-component/src/main/docs/fhirXml-dataformat.adoc index 740f9f9f7c589..1ebb9b97d9ae5 100644 --- a/components/camel-fhir/camel-fhir-component/src/main/docs/fhirXml-dataformat.adoc +++ b/components/camel-fhir/camel-fhir-component/src/main/docs/fhirXml-dataformat.adoc @@ -1,7 +1,12 @@ [[fhirXml-dataformat]] = FHIR XML DataFormat +:docTitle: FHIR XML +:artifactId: camel-fhir +:description: The FHIR XML data format is used to marshall/unmarshall from/to FHIR objects to/from XML. +:since: 2.21 +:supportLevel: Stable -*Since Camel 2.21* +*Since Camel {since}* The FHIR-XML Data Format leverages https://github.com/jamesagnew/hapi-fhir/blob/master/hapi-fhir-base/src/main/java/ca/uhn/fhir/parser/XmlParser.java[HAPI-FHIR's] diff --git a/components/camel-file-watch/src/main/docs/file-watch-component.adoc b/components/camel-file-watch/src/main/docs/file-watch-component.adoc index d2e17140bd2a3..17a85489c6791 100644 --- a/components/camel-file-watch/src/main/docs/file-watch-component.adoc +++ b/components/camel-file-watch/src/main/docs/file-watch-component.adoc @@ -1,14 +1,18 @@ [[file-watch-component]] = File Watch Component +:docTitle: File Watch +:artifactId: camel-file-watch +:description: The file-watch is used to monitor file events in directory using java.nio.file.WatchService +:since: 3.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.0* +*Since Camel {since}* *Since Camel 3.0* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* This component can be used to watch file modification events in folder. It is based on https://github.com/gmethvin/directory-watcher[gmethvin/directory-watcher]. diff --git a/components/camel-file/src/main/docs/file-component.adoc b/components/camel-file/src/main/docs/file-component.adoc index 2b0b4de5ef049..4c8d8c2cfbc8e 100644 --- a/components/camel-file/src/main/docs/file-component.adoc +++ b/components/camel-file/src/main/docs/file-component.adoc @@ -1,11 +1,16 @@ [[file-component]] = File Component +:docTitle: File +:artifactId: camel-file +:description: The file component is used for reading or writing files. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The File component provides access to file systems, allowing files to be processed by any other Camel Components or @@ -220,7 +225,7 @@ bean completes, and thus the route is completed, the file consumer will perform the move operation and move the file to the `.done` sub-folder. The *move* and the *preMove* options are considered as a directory name -(though if you use an expression such as xref:components:languages:file-language.adoc[File Language], or xref:components:languages:simple-language.adoc[Simple] then the result of the expression +(though if you use an expression such as xref:languages:file-language.adoc[File Language], or xref:languages:simple-language.adoc[Simple] then the result of the expression evaluation is the file name to be used - eg if you set [source] @@ -228,7 +233,7 @@ evaluation is the file name to be used - eg if you set move=../backup/copy-of-${file:name} ---- -then that's using the xref:components:languages:file-language.adoc[File Language] which we +then that's using the xref:languages:file-language.adoc[File Language] which we use return the file name to be used), which can be either relative or absolute. If relative, the directory is created as a sub-folder from within the folder where the file was consumed. @@ -266,10 +271,10 @@ processed and after it's processed, it's moved to the `.done` folder. The *move* and *preMove* options are Expression-based, so we have the full power of -the xref:components:languages:file-language.adoc[File Language] to do advanced configuration +the xref:languages:file-language.adoc[File Language] to do advanced configuration of the directory and name pattern. + Camel will, in fact, internally convert the directory name you enter -into a xref:components:languages:file-language.adoc[File Language] expression. So when we +into a xref:languages:file-language.adoc[File Language] expression. So when we enter `move=.done` Camel will convert this into: `\${file:parent}/.done/${file:onlyname}`. This is only done if Camel detects that you have not provided a $\{ } in the option value @@ -292,7 +297,7 @@ choice. For example to move the files in an error folder with a timestamp you can use `moveFailed=/error/${``file:name.noext``}-${date:now:yyyyMMddHHmmssSSS}.${``file:ext`}. -See more examples at xref:components:languages:file-language.adoc[File Language] +See more examples at xref:languages:file-language.adoc[File Language] == Message Headers @@ -306,7 +311,7 @@ The following headers are supported by this component: |`CamelFileName` |Specifies the name of the file to write (relative to the endpoint directory). This name can be a `String`; a `String` with a -xref:components:languages:file-language.adoc[File Language] or xref:components:languages:simple-language.adoc[Simple] +xref:languages:file-language.adoc[File Language] or xref:languages:simple-language.adoc[Simple] expression; or an Expression object. If it's `null` then Camel will auto-generate a filename based on the message unique ID. @@ -513,8 +518,8 @@ from("direct:report").to("file:target/reports/?fileName=report.txt"); == Filename Expression Filename can be set either using the *expression* option or as a -string-based xref:components:languages:file-language.adoc[File Language] expression in the -`CamelFileName` header. See the xref:components:languages:file-language.adoc[File Language] +string-based xref:languages:file-language.adoc[File Language] expression in the +`CamelFileName` header. See the xref:languages:file-language.adoc[File Language] for syntax and samples. [[File2-Consumingfilesfromfolderswhereothersdropfilesdirectly]] @@ -797,7 +802,7 @@ today's date as a sub-folder name: from("file://inbox?move=backup/${date:now:yyyyMMdd}/${file:name}").to("..."); ---- -See xref:components:languages:file-language.adoc[File Language] for more samples. +See xref:languages:file-language.adoc[File Language] for more samples. == Avoiding reading the same file more than once (idempotent consumer) @@ -998,7 +1003,7 @@ Registry for a bean with the ID, `mySorter`. === Sorting using sortBy Camel supports pluggable sorting strategies. This strategy it to use the -xref:components:languages:file-language.adoc[File Language] to configure the sorting. The +xref:languages:file-language.adoc[File Language] to configure the sorting. The `sortBy` option is configured as follows: [source] @@ -1022,7 +1027,7 @@ This will sort by file name, you can reverse the order by prefixing sortBy=reverse:file:name ---- -As we have the full power of xref:components:languages:file-language.adoc[File Language] we +As we have the full power of xref:languages:file-language.adoc[File Language] we can use some of the other parameters, so if we want to sort by file size we do: @@ -1066,7 +1071,7 @@ sortBy=file:modified;file:name Now there is an issue here, can you spot it? Well the modified timestamp of the file is too fine as it will be in milliseconds, but what if we want to sort by date only and then subgroup by name? + - Well as we have the true power of xref:components:languages:file-language.adoc[File Language] we can use its date command that supports patterns. So this + Well as we have the true power of xref:languages:file-language.adoc[File Language] we can use its date command that supports patterns. So this can be solved as: [source] diff --git a/components/camel-flatpack/src/main/docs/flatpack-component.adoc b/components/camel-flatpack/src/main/docs/flatpack-component.adoc index 43826fa1a8885..47f66464000ba 100644 --- a/components/camel-flatpack/src/main/docs/flatpack-component.adoc +++ b/components/camel-flatpack/src/main/docs/flatpack-component.adoc @@ -1,11 +1,15 @@ [[flatpack-component]] = Flatpack Component +:docTitle: Flatpack +:artifactId: camel-flatpack +:description: The flatpack component supports fixed width and delimited file parsing via the FlatPack library. +:since: 1.4 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.4* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Flatpack component supports fixed width and delimited file parsing via the http://flatpack.sourceforge.net[FlatPack library]. + diff --git a/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc b/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc index 387148503324a..fe7c3008c23d5 100644 --- a/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc +++ b/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc @@ -1,7 +1,12 @@ [[flatpack-dataformat]] = Flatpack DataFormat +:docTitle: Flatpack +:artifactId: camel-flatpack +:description: The Flatpack data format is used for working with flat payloads (such as CSV, delimited, or fixed length formats). +:since: 2.1 +:supportLevel: Stable -*Since Camel 2.1* +*Since Camel {since}* The xref:ROOT:flatpack-component.adoc[Flatpack] component ships with the Flatpack data format that can be used to format between fixed width or delimited text diff --git a/components/camel-flink/src/main/docs/flink-component.adoc b/components/camel-flink/src/main/docs/flink-component.adoc index 6eb91b5533be0..96f7c4193dfd4 100644 --- a/components/camel-flink/src/main/docs/flink-component.adoc +++ b/components/camel-flink/src/main/docs/flink-component.adoc @@ -1,11 +1,15 @@ [[flink-component]] = Flink Component +:docTitle: Flink +:artifactId: camel-flink +:description: The flink component can be used to send DataSet jobs to Apache Flink cluster. +:since: 2.18 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* *Since Camel 2.18* diff --git a/components/camel-fop/src/main/docs/fop-component.adoc b/components/camel-fop/src/main/docs/fop-component.adoc index 245eb5749203f..8e2733067135a 100644 --- a/components/camel-fop/src/main/docs/fop-component.adoc +++ b/components/camel-fop/src/main/docs/fop-component.adoc @@ -1,11 +1,15 @@ [[fop-component]] = FOP Component +:docTitle: FOP +:artifactId: camel-fop +:description: The fop component allows you to render a message into different output formats using Apache FOP. +:since: 2.10 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The FOP component allows you to render a message into different output formats using http://xmlgraphics.apache.org/fop/index.html[Apache FOP]. diff --git a/components/camel-freemarker/src/main/docs/freemarker-component.adoc b/components/camel-freemarker/src/main/docs/freemarker-component.adoc index 9d5f8eb8f085a..a4b89d076a799 100644 --- a/components/camel-freemarker/src/main/docs/freemarker-component.adoc +++ b/components/camel-freemarker/src/main/docs/freemarker-component.adoc @@ -1,11 +1,15 @@ [[freemarker-component]] = Freemarker Component +:docTitle: Freemarker +:artifactId: camel-freemarker +:description: Transforms the message using a FreeMarker template. +:since: 2.10 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The *freemarker:* component allows for processing a message using a http://freemarker.org/[FreeMarker] template. This can be ideal when diff --git a/components/camel-ftp/src/main/docs/ftp-component.adoc b/components/camel-ftp/src/main/docs/ftp-component.adoc index b9c720faf5b3e..be20e12a398bd 100644 --- a/components/camel-ftp/src/main/docs/ftp-component.adoc +++ b/components/camel-ftp/src/main/docs/ftp-component.adoc @@ -1,11 +1,15 @@ [[ftp-component]] = FTP Component +:docTitle: FTP +:artifactId: camel-ftp +:description: The ftp component is used for uploading or downloading files from FTP servers. +:since: 1.1 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component provides access to remote file systems over the FTP and SFTP protocols. diff --git a/components/camel-ftp/src/main/docs/ftps-component.adoc b/components/camel-ftp/src/main/docs/ftps-component.adoc index eae9c9427406d..42038b5735e2e 100644 --- a/components/camel-ftp/src/main/docs/ftps-component.adoc +++ b/components/camel-ftp/src/main/docs/ftps-component.adoc @@ -1,11 +1,15 @@ [[ftps-component]] = FTPS Component +:docTitle: FTPS +:artifactId: camel-ftp +:description: The ftps (FTP secure SSL/TLS) component is used for uploading or downloading files from FTP servers. +:since: 2.2 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.2* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component provides access to remote file systems over the FTP and SFTP protocols. diff --git a/components/camel-ftp/src/main/docs/sftp-component.adoc b/components/camel-ftp/src/main/docs/sftp-component.adoc index fb7b257f21e50..f3ab51e072d0e 100644 --- a/components/camel-ftp/src/main/docs/sftp-component.adoc +++ b/components/camel-ftp/src/main/docs/sftp-component.adoc @@ -1,11 +1,15 @@ [[sftp-component]] = SFTP Component +:docTitle: SFTP +:artifactId: camel-ftp +:description: The sftp (FTP over SSH) component is used for uploading or downloading files from SFTP servers. +:since: 1.1 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component provides access to remote file systems over the FTP and SFTP protocols. diff --git a/components/camel-ganglia/src/main/docs/ganglia-component.adoc b/components/camel-ganglia/src/main/docs/ganglia-component.adoc index 6500f753cc365..9789ff6591ac7 100644 --- a/components/camel-ganglia/src/main/docs/ganglia-component.adoc +++ b/components/camel-ganglia/src/main/docs/ganglia-component.adoc @@ -1,11 +1,15 @@ [[ganglia-component]] = Ganglia Component +:docTitle: Ganglia +:artifactId: camel-ganglia +:description: The ganglia component is used for sending metrics to the Ganglia monitoring system. +:since: 2.15 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* Provides a mechanism to send a value (the message body) as a metric to the http://ganglia.info[Ganglia] monitoring system. Uses the gmetric4j diff --git a/components/camel-geocoder/src/main/docs/geocoder-component.adoc b/components/camel-geocoder/src/main/docs/geocoder-component.adoc index e03dbdc0fdbe2..2a46af67fe5a5 100644 --- a/components/camel-geocoder/src/main/docs/geocoder-component.adoc +++ b/components/camel-geocoder/src/main/docs/geocoder-component.adoc @@ -1,11 +1,15 @@ [[geocoder-component]] = Geocoder Component +:docTitle: Geocoder +:artifactId: camel-geocoder +:description: The geocoder component is used for looking up geocodes (latitude and longitude) for a given address, or reverse lookup. +:since: 2.12 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Geocoder component is used for looking up geocodes (latitude and longitude) for a given address, or reverse lookup. The component uses diff --git a/components/camel-git/src/main/docs/git-component.adoc b/components/camel-git/src/main/docs/git-component.adoc index 578ea29e502aa..33b3c782b78bf 100644 --- a/components/camel-git/src/main/docs/git-component.adoc +++ b/components/camel-git/src/main/docs/git-component.adoc @@ -1,11 +1,15 @@ [[git-component]] = Git Component +:docTitle: Git +:artifactId: camel-git +:description: The git component is used for working with git repositories. +:since: 2.16 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Git component allows you to work with a generic Git repository. diff --git a/components/camel-github/src/main/docs/github-component.adoc b/components/camel-github/src/main/docs/github-component.adoc index ecd22d8852df6..ceb4ff734f76a 100644 --- a/components/camel-github/src/main/docs/github-component.adoc +++ b/components/camel-github/src/main/docs/github-component.adoc @@ -1,11 +1,15 @@ [[github-component]] = GitHub Component +:docTitle: GitHub +:artifactId: camel-github +:description: The github component is used for integrating Camel with github. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The GitHub component interacts with the GitHub API by encapsulating http://org.eclipse.egit.github.core[egit-github]. It diff --git a/components/camel-google-bigquery/src/main/docs/google-bigquery-component.adoc b/components/camel-google-bigquery/src/main/docs/google-bigquery-component.adoc index 9b7481f177e25..5081b575449e9 100644 --- a/components/camel-google-bigquery/src/main/docs/google-bigquery-component.adoc +++ b/components/camel-google-bigquery/src/main/docs/google-bigquery-component.adoc @@ -1,11 +1,15 @@ [[google-bigquery-component]] = Google BigQuery Component +:docTitle: Google BigQuery +:artifactId: camel-google-bigquery +:description: Google BigQuery data warehouse for analytics. +:since: 2.20 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Google Bigquery component provides access to https://cloud.google.com/bigquery/[Cloud BigQuery Infrastructure] via diff --git a/components/camel-google-bigquery/src/main/docs/google-bigquery-sql-component.adoc b/components/camel-google-bigquery/src/main/docs/google-bigquery-sql-component.adoc index 20d637e564322..f3bc576db1616 100644 --- a/components/camel-google-bigquery/src/main/docs/google-bigquery-sql-component.adoc +++ b/components/camel-google-bigquery/src/main/docs/google-bigquery-sql-component.adoc @@ -1,11 +1,15 @@ [[google-bigquery-sql-component]] = Google BigQuery Standard SQL Component +:docTitle: Google BigQuery Standard SQL +:artifactId: camel-google-bigquery +:description: Google BigQuery data warehouse for analytics (using SQL queries). +:since: 2.23 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Google BigQuery SQL component provides access to https://cloud.google.com/bigquery/[Cloud BigQuery Infrastructure] via diff --git a/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc b/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc index d6cb6fe946156..6f4cc6826ced0 100644 --- a/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc +++ b/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc @@ -1,11 +1,15 @@ [[google-calendar-component]] = Google Calendar Component +:docTitle: Google Calendar +:artifactId: camel-google-calendar +:description: The google-calendar component provides access to Google Calendar. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Google Calendar component provides access to http://google.com/calendar[Google Calendar] via diff --git a/components/camel-google-calendar/src/main/docs/google-calendar-stream-component.adoc b/components/camel-google-calendar/src/main/docs/google-calendar-stream-component.adoc index 0772731e028e1..ad9205af68cb6 100644 --- a/components/camel-google-calendar/src/main/docs/google-calendar-stream-component.adoc +++ b/components/camel-google-calendar/src/main/docs/google-calendar-stream-component.adoc @@ -1,11 +1,15 @@ [[google-calendar-stream-component]] = Google Calendar Stream Component +:docTitle: Google Calendar Stream +:artifactId: camel-google-calendar +:description: The google-calendar-stream component provides access to Google Calendar in a streaming mode. +:since: 2.23 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Google Calendar component provides access to https://calendar.google.com[Calendar] via diff --git a/components/camel-google-drive/src/main/docs/google-drive-component.adoc b/components/camel-google-drive/src/main/docs/google-drive-component.adoc index 029b94625876a..a57f2bd54c529 100644 --- a/components/camel-google-drive/src/main/docs/google-drive-component.adoc +++ b/components/camel-google-drive/src/main/docs/google-drive-component.adoc @@ -1,11 +1,15 @@ [[google-drive-component]] = Google Drive Component +:docTitle: Google Drive +:artifactId: camel-google-drive +:description: The google-drive component provides access to Google Drive file storage service. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Google Drive component provides access to the http://drive.google.com[Google Drive file storage service] via the diff --git a/components/camel-google-mail/src/main/docs/google-mail-component.adoc b/components/camel-google-mail/src/main/docs/google-mail-component.adoc index d5f7f39b07049..a38dea25707b8 100644 --- a/components/camel-google-mail/src/main/docs/google-mail-component.adoc +++ b/components/camel-google-mail/src/main/docs/google-mail-component.adoc @@ -1,11 +1,15 @@ [[google-mail-component]] = Google Mail Component +:docTitle: Google Mail +:artifactId: camel-google-mail +:description: The google-mail component provides access to Google Mail. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Google Mail component provides access to http://gmail.com/[Gmail] via diff --git a/components/camel-google-mail/src/main/docs/google-mail-stream-component.adoc b/components/camel-google-mail/src/main/docs/google-mail-stream-component.adoc index 61ae7913bd432..9dd877ba678e9 100644 --- a/components/camel-google-mail/src/main/docs/google-mail-stream-component.adoc +++ b/components/camel-google-mail/src/main/docs/google-mail-stream-component.adoc @@ -1,11 +1,15 @@ [[google-mail-stream-component]] = Google Mail Stream Component +:docTitle: Google Mail Stream +:artifactId: camel-google-mail +:description: The google-mail component provides access to Google Mail. +:since: 2.22 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.22* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Google Mail component provides access to http://gmail.com/[Gmail] via diff --git a/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc b/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc index 5fab27eb21ab2..41fcd3e867f99 100644 --- a/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc +++ b/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc @@ -1,11 +1,15 @@ [[google-pubsub-component]] = Google Pubsub Component +:docTitle: Google Pubsub +:artifactId: camel-google-pubsub +:description: Messaging client for Google Cloud Platform PubSub Service Built on top of the Google Cloud Pub/Sub libraries. +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Google Pubsub component provides access to https://cloud.google.com/pubsub/[Cloud Pub/Sub Infrastructure] via diff --git a/components/camel-google-sheets/src/main/docs/google-sheets-component.adoc b/components/camel-google-sheets/src/main/docs/google-sheets-component.adoc index 144cce3fb711f..f91a532dcea8b 100644 --- a/components/camel-google-sheets/src/main/docs/google-sheets-component.adoc +++ b/components/camel-google-sheets/src/main/docs/google-sheets-component.adoc @@ -1,11 +1,15 @@ [[google-sheets-component]] = Google Sheets Component +:docTitle: Google Sheets +:artifactId: camel-google-sheets +:description: The google-sheets component provides access to Google Sheets. +:since: 2.23 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Google Sheets component provides access to http://google.com/sheets[Google Sheets] via diff --git a/components/camel-google-sheets/src/main/docs/google-sheets-stream-component.adoc b/components/camel-google-sheets/src/main/docs/google-sheets-stream-component.adoc index 7bc76e59b55c0..214bfc20dd594 100644 --- a/components/camel-google-sheets/src/main/docs/google-sheets-stream-component.adoc +++ b/components/camel-google-sheets/src/main/docs/google-sheets-stream-component.adoc @@ -1,11 +1,15 @@ [[google-sheets-stream-component]] = Google Sheets Stream Component +:docTitle: Google Sheets Stream +:artifactId: camel-google-sheets +:description: The google-sheets-stream component provides access to Google Sheets. +:since: 2.23 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Google Sheets component provides access to https://sheets.google.com/[Sheets] via diff --git a/components/camel-gora/src/main/docs/gora-component.adoc b/components/camel-gora/src/main/docs/gora-component.adoc index 3f900d5443bd8..a76662ae712dd 100644 --- a/components/camel-gora/src/main/docs/gora-component.adoc +++ b/components/camel-gora/src/main/docs/gora-component.adoc @@ -1,11 +1,15 @@ [[gora-component]] = Gora Component +:docTitle: Gora +:artifactId: camel-gora +:description: The gora component allows you to work with NoSQL databases using the Apache Gora framework. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* *Camel-Gora* is an http://camel.apache.org/[Apache Camel] component that allows you to work with NoSQL databases using the diff --git a/components/camel-grape/src/main/docs/grape-component.adoc b/components/camel-grape/src/main/docs/grape-component.adoc index 09567bc396eab..a3a63ed13100f 100644 --- a/components/camel-grape/src/main/docs/grape-component.adoc +++ b/components/camel-grape/src/main/docs/grape-component.adoc @@ -1,11 +1,15 @@ [[grape-component]] = Grape Component +:docTitle: Grape +:artifactId: camel-grape +:description: The grape component allows you to fetch, load and manage additional jars when CamelContext is running. +:since: 2.16 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* http://docs.groovy-lang.org/latest/html/documentation/grape.html[Grape] component allows you to fetch, load and manage additional jars when @@ -248,4 +252,3 @@ command: setHeader(GrapeConstats.GRAPE_COMMAND, constant(CamelGrapeCommand.clearPatches)). setBody().constant("Installed patches have been deleted."); ----------------------------------------------------------------------------------------- - diff --git a/components/camel-graphql/src/main/docs/graphql-component.adoc b/components/camel-graphql/src/main/docs/graphql-component.adoc index dcab145e5e61a..5e024b5c42ee4 100644 --- a/components/camel-graphql/src/main/docs/graphql-component.adoc +++ b/components/camel-graphql/src/main/docs/graphql-component.adoc @@ -1,11 +1,15 @@ [[graphql-component]] = GraphQL Component +:docTitle: GraphQL +:artifactId: camel-graphql +:description: A Camel GraphQL Component +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The GraphQL component is a GraphQL client that communicates over HTTP and supports queries and mutations, but not subscriptions. It uses the https://hc.apache.org/httpcomponents-client-4.5.x/index.html[Apache HttpClient] library. diff --git a/components/camel-grok/src/main/docs/grok-dataformat.adoc b/components/camel-grok/src/main/docs/grok-dataformat.adoc index f936c9067cce3..ace1cd3c9fcd5 100644 --- a/components/camel-grok/src/main/docs/grok-dataformat.adoc +++ b/components/camel-grok/src/main/docs/grok-dataformat.adoc @@ -1,7 +1,12 @@ [[grok-dataformat]] = Grok DataFormat +:docTitle: Grok +:artifactId: camel-grok +:description: The Grok data format is used for unmarshalling unstructured data to objects using Logstash based Grok patterns. +:since: 3.0 +:supportLevel: Stable -*Since Camel 3.0* +*Since Camel {since}* This component provides dataformat for processing inputs with grok patterns. Grok patterns are used to process unstructured data into structured objects - `List>`. diff --git a/components/camel-groovy/src/main/docs/groovy-language.adoc b/components/camel-groovy/src/main/docs/groovy-language.adoc index 6abcf408a52bd..b82ce6f89bd83 100644 --- a/components/camel-groovy/src/main/docs/groovy-language.adoc +++ b/components/camel-groovy/src/main/docs/groovy-language.adoc @@ -1,7 +1,12 @@ [[groovy-language]] = Groovy Language +:docTitle: Groovy +:artifactId: camel-groovy +:description: To use Groovy scripts in Camel expressions or predicates. +:since: 1.3 +:supportLevel: Stable -*Since Camel 1.3* +*Since Camel {since}* Camel supports http://groovy.codehaus.org/[Groovy] among other Scripting Languages to allow an diff --git a/components/camel-grpc/src/main/docs/grpc-component.adoc b/components/camel-grpc/src/main/docs/grpc-component.adoc index 05a19a9bdae4f..744b01fa705c8 100644 --- a/components/camel-grpc/src/main/docs/grpc-component.adoc +++ b/components/camel-grpc/src/main/docs/grpc-component.adoc @@ -1,11 +1,15 @@ [[grpc-component]] = gRPC Component +:docTitle: gRPC +:artifactId: camel-grpc +:description: The gRPC component allows to call and expose remote procedures via HTTP/2 with protobuf dataformat +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The gRPC component allows you to call or expose Remote Procedure Call (RPC) services using https://developers.google.com/protocol-buffers/docs/overview[Protocol Buffers (protobuf)] diff --git a/components/camel-gson/src/main/docs/json-gson-dataformat.adoc b/components/camel-gson/src/main/docs/json-gson-dataformat.adoc index 217397403a797..1aaf3fa69d63c 100644 --- a/components/camel-gson/src/main/docs/json-gson-dataformat.adoc +++ b/components/camel-gson/src/main/docs/json-gson-dataformat.adoc @@ -1,7 +1,12 @@ [[json-gson-dataformat]] = JSon GSon DataFormat +:docTitle: JSon GSon +:artifactId: camel-gson +:description: JSon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload. +:since: 2.10 +:supportLevel: Stable -*Since Camel 2.10* +*Since Camel {since}* Gson is a Data Format which uses the https://github.com/google/gson[Gson Library] diff --git a/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc b/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc index a3550a3af9dc5..61d9044a64aa9 100644 --- a/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc +++ b/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc @@ -1,11 +1,15 @@ [[guava-eventbus-component]] = Guava EventBus Component +:docTitle: Guava EventBus +:artifactId: camel-guava-eventbus +:description: The guava-eventbus component provides integration bridge between Camel and Google Guava EventBus. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The https://google.github.io/guava/releases/19.0/api/docs/com/google/common/eventbus/EventBus.html[Google diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-atomicvalue-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-atomicvalue-component.adoc index fb846230252f9..476013e872ae1 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-atomicvalue-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-atomicvalue-component.adoc @@ -1,11 +1,15 @@ [[hazelcast-atomicvalue-component]] = Hazelcast Atomic Number Component +:docTitle: Hazelcast Atomic Number +:artifactId: camel-hazelcast +:description: The hazelcast-atomicvalue component is used to access Hazelcast atomic number, which is an object that simply provides a grid wide number (long). +:since: 2.7 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] atomic number component is one of Camel Hazelcast Components which allows you to access Hazelcast atomic number. An atomic number is an object that simply provides a grid wide number (long). diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-instance-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-instance-component.adoc index b35aff07ef100..fff3e13ce3bb7 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-instance-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-instance-component.adoc @@ -1,11 +1,15 @@ [[hazelcast-instance-component]] = Hazelcast Instance Component +:docTitle: Hazelcast Instance +:artifactId: camel-hazelcast +:description: The hazelcast-instance component is used to consume join/leave events of the cache instance in the cluster. +:since: 2.7 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] instance component is one of Camel Hazelcast Components which allows you to consume join/leave events of the cache instance in the cluster. Hazelcast makes sense in one single "server node", but it's extremly powerful in a clustered environment. diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-list-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-list-component.adoc index 5f1274d8338af..b0922070e8803 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-list-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-list-component.adoc @@ -1,11 +1,15 @@ [[hazelcast-list-component]] = Hazelcast List Component +:docTitle: Hazelcast List +:artifactId: camel-hazelcast +:description: The hazelcast-list component is used to access Hazelcast distributed list. +:since: 2.7 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] List component is one of Camel Hazelcast Components which allows you to access Hazelcast distributed list. diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-map-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-map-component.adoc index 9a6de8d4fc204..1dc77592585b2 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-map-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-map-component.adoc @@ -1,11 +1,15 @@ [[hazelcast-map-component]] = Hazelcast Map Component +:docTitle: Hazelcast Map +:artifactId: camel-hazelcast +:description: The hazelcast-map component is used to access Hazelcast distributed map. +:since: 2.7 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] Map component is one of Camel Hazelcast Components which allows you to access Hazelcast distributed map. diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-multimap-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-multimap-component.adoc index 2488f26ba6e2d..63710d8e8c921 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-multimap-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-multimap-component.adoc @@ -1,11 +1,15 @@ [[hazelcast-multimap-component]] = Hazelcast Multimap Component +:docTitle: Hazelcast Multimap +:artifactId: camel-hazelcast +:description: The hazelcast-multimap component is used to to access Hazelcast distributed multimap. +:since: 2.7 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] Multimap component is one of Camel Hazelcast Components which allows you to access Hazelcast distributed multimap. diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-queue-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-queue-component.adoc index 14c8adfe8d9b0..f0e831ac3fd9d 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-queue-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-queue-component.adoc @@ -1,11 +1,15 @@ [[hazelcast-queue-component]] = Hazelcast Queue Component +:docTitle: Hazelcast Queue +:artifactId: camel-hazelcast +:description: The hazelcast-queue component is used to access Hazelcast distributed queue. +:since: 2.7 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] Queue component is one of Camel Hazelcast Components which allows you to access Hazelcast distributed queue. diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-replicatedmap-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-replicatedmap-component.adoc index b1c13fac8ab7b..94b05c3ebba01 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-replicatedmap-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-replicatedmap-component.adoc @@ -1,11 +1,15 @@ [[hazelcast-replicatedmap-component]] = Hazelcast Replicated Map Component +:docTitle: Hazelcast Replicated Map +:artifactId: camel-hazelcast +:description: The hazelcast-replicatedmap component is used to access Hazelcast replicated map. +:since: 2.16 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] instance component is one of Camel Hazelcast Components which allows you to consume join/leave events of the cache instance in the cluster. A replicated map is a weakly consistent, distributed key-value data structure with no data partition. diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-ringbuffer-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-ringbuffer-component.adoc index f7a4e7259f397..7603cc8f65975 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-ringbuffer-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-ringbuffer-component.adoc @@ -1,11 +1,15 @@ [[hazelcast-ringbuffer-component]] = Hazelcast Ringbuffer Component +:docTitle: Hazelcast Ringbuffer +:artifactId: camel-hazelcast +:description: The hazelcast-ringbuffer component is used to access Hazelcast distributed ringbuffer. +:since: 2.16 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] ringbuffer component is one of Camel Hazelcast Components which allows you to access Hazelcast ringbuffer. Ringbuffer is a distributed data structure where the data is stored in a ring-like structure. You can think of it as a circular array with a certain capacity. diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-seda-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-seda-component.adoc index 02befcea67619..daba37931528b 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-seda-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-seda-component.adoc @@ -1,11 +1,15 @@ [[hazelcast-seda-component]] = Hazelcast SEDA Component +:docTitle: Hazelcast SEDA +:artifactId: camel-hazelcast +:description: The hazelcast-seda component is used to access Hazelcast BlockingQueue. +:since: 2.7 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] SEDA component is one of Camel Hazelcast Components which allows you to access Hazelcast BlockingQueue. SEDA component differs from the rest components provided. It implements a work-queue in order to support asynchronous SEDA architectures, similar to the core "SEDA" component. diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-set-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-set-component.adoc index 0f41d71fde2fc..bf973b5eb4f64 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-set-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-set-component.adoc @@ -1,11 +1,15 @@ [[hazelcast-set-component]] = Hazelcast Set Component +:docTitle: Hazelcast Set +:artifactId: camel-hazelcast +:description: The hazelcast-set component is used to access Hazelcast distributed set. +:since: 2.7 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] Set component is one of Camel Hazelcast Components which allows you to access Hazelcast distributed set. diff --git a/components/camel-hazelcast/src/main/docs/hazelcast.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-summary.adoc similarity index 98% rename from components/camel-hazelcast/src/main/docs/hazelcast.adoc rename to components/camel-hazelcast/src/main/docs/hazelcast-summary.adoc index a5830f0663d7a..7d4d57e6f60de 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-summary.adoc @@ -1,6 +1,9 @@ = Hazelcast Component +//attributes written by hand, not generated +:docTitle: Hazelcast +:since: 2.7 -*Since Camel 2.7* +*Since Camel {since}* The *hazelcast-* component allows you to work with the http://www.hazelcast.com[Hazelcast] distributed data grid / cache. @@ -30,7 +33,9 @@ for this component: == Hazelcast components -See followings for each component usage: + +See the following for each component usage: + * xref:hazelcast-map-component.adoc[map] * xref:hazelcast-multimap-component.adoc[multimap] * xref:hazelcast-queue-component.adoc[queue] diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-topic-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-topic-component.adoc index 5194d2fa25ba1..5a2aef0cb3fe0 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-topic-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-topic-component.adoc @@ -1,11 +1,15 @@ [[hazelcast-topic-component]] = Hazelcast Topic Component +:docTitle: Hazelcast Topic +:artifactId: camel-hazelcast +:description: The hazelcast-topic component is used to access Hazelcast distributed topic. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] Topic component is one of Camel Hazelcast Components which allows you to access Hazelcast distributed topic. diff --git a/components/camel-hbase/src/main/docs/hbase-component.adoc b/components/camel-hbase/src/main/docs/hbase-component.adoc index 86a91dd8741fb..4f401af9b55a5 100644 --- a/components/camel-hbase/src/main/docs/hbase-component.adoc +++ b/components/camel-hbase/src/main/docs/hbase-component.adoc @@ -1,11 +1,15 @@ [[hbase-component]] = HBase Component +:docTitle: HBase +:artifactId: camel-hbase +:description: For reading/writing from/to an HBase store (Hadoop database). +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component provides an idemptotent repository, producers and consumers for http://hbase.apache.org/[Apache HBase]. diff --git a/components/camel-hdfs/src/main/docs/hdfs-component.adoc b/components/camel-hdfs/src/main/docs/hdfs-component.adoc index 9bef0973f246e..107a5341ec649 100644 --- a/components/camel-hdfs/src/main/docs/hdfs-component.adoc +++ b/components/camel-hdfs/src/main/docs/hdfs-component.adoc @@ -1,11 +1,15 @@ [[hdfs-component]] = HDFS Component +:docTitle: HDFS +:artifactId: camel-hdfs +:description: For reading/writing from/to an HDFS filesystem using Hadoop 2.x. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The HDFS component enables you to read and write messages from/to an HDFS file system using Hadoop 2.x. HDFS is the distributed file system diff --git a/components/camel-hipchat/src/main/docs/hipchat-component.adoc b/components/camel-hipchat/src/main/docs/hipchat-component.adoc index afa2430f30732..ca3f79e59d325 100644 --- a/components/camel-hipchat/src/main/docs/hipchat-component.adoc +++ b/components/camel-hipchat/src/main/docs/hipchat-component.adoc @@ -1,11 +1,15 @@ [[hipchat-component]] = Hipchat Component +:docTitle: Hipchat +:artifactId: camel-hipchat +:description: The hipchat component supports producing and consuming messages from/to Hipchat service. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Hipchat component supports producing and consuming messages from/to https://www.hipchat.com[Hipchat] service. diff --git a/components/camel-hl7/src/main/docs/hl7-dataformat.adoc b/components/camel-hl7/src/main/docs/hl7-dataformat.adoc index a912bf293574a..bde61f4530d65 100644 --- a/components/camel-hl7/src/main/docs/hl7-dataformat.adoc +++ b/components/camel-hl7/src/main/docs/hl7-dataformat.adoc @@ -1,7 +1,12 @@ [[hl7-dataformat]] = HL7 DataFormat +:docTitle: HL7 +:artifactId: camel-hl7 +:description: The HL7 data format can be used to marshal or unmarshal HL7 (Health Care) model objects. +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* The HL7 component is used for working with the HL7 MLLP protocol and http://www.hl7.org/implement/standards/product_brief.cfm?product_id=185[HL7 diff --git a/components/camel-hl7/src/main/docs/hl7terser-language.adoc b/components/camel-hl7/src/main/docs/hl7terser-language.adoc index f87ea8d58c880..dc0fa4667d31f 100644 --- a/components/camel-hl7/src/main/docs/hl7terser-language.adoc +++ b/components/camel-hl7/src/main/docs/hl7terser-language.adoc @@ -1,7 +1,12 @@ [[hl7terser-language]] = HL7 Terser Language +:docTitle: HL7 Terser +:artifactId: camel-hl7 +:description: To use HL7 terser scripts in Camel expressions or predicates. +:since: 2.11 +:supportLevel: Stable -*Since Camel 2.11* +*Since Camel {since}* http://hl7api.sourceforge.net[HAPI] provides a http://hl7api.sourceforge.net/base/apidocs/ca/uhn/hl7v2/util/Terser.html[Terser] diff --git a/components/camel-http/src/main/docs/http-component.adoc b/components/camel-http/src/main/docs/http-component.adoc index 70239b83cccec..8be4df4a3b0b5 100644 --- a/components/camel-http/src/main/docs/http-component.adoc +++ b/components/camel-http/src/main/docs/http-component.adoc @@ -1,11 +1,15 @@ [[http-component]] = HTTP Component +:docTitle: HTTP +:artifactId: camel-http +:description: For calling out to external HTTP servers using Apache HTTP Client 4.x. +:since: 2.3 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.3* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The HTTP component provides HTTP based endpoints for calling external HTTP resources (as a client to call external diff --git a/components/camel-hystrix/src/main/docs/hystrix.adoc b/components/camel-hystrix/src/main/docs/hystrix.adoc index 27b8550da6f6c..80ba9afdb9730 100644 --- a/components/camel-hystrix/src/main/docs/hystrix.adoc +++ b/components/camel-hystrix/src/main/docs/hystrix.adoc @@ -1,6 +1,12 @@ +[[hystrix-component]] = Hystrix Component +:docTitle: Hystrix +:artifactId: camel-hystrix +:description: Circuit Breaker EIP using Netflix Hystrix +:since: 2.18 +:supportLevel: Stable -*Since Camel 2.18* +*Since Camel {since}* The Hystrix component integrates Netflix Hystrix circuit breaker in Camel routes. diff --git a/components/camel-ical/src/main/docs/ical-dataformat.adoc b/components/camel-ical/src/main/docs/ical-dataformat.adoc index aac77fc485b63..c88a3892cf4f3 100644 --- a/components/camel-ical/src/main/docs/ical-dataformat.adoc +++ b/components/camel-ical/src/main/docs/ical-dataformat.adoc @@ -1,7 +1,12 @@ [[ical-dataformat]] = iCal DataFormat +:docTitle: iCal +:artifactId: camel-ical +:description: The iCal dataformat is used for working with iCalendar messages. +:since: 2.12 +:supportLevel: Stable -*Since Camel 2.12* +*Since Camel {since}* The ICal dataformat is used for working with http://en.wikipedia.org/wiki/ICalendar[iCalendar] messages. diff --git a/components/camel-iec60870/src/main/docs/iec60870-client-component.adoc b/components/camel-iec60870/src/main/docs/iec60870-client-component.adoc index d8ec4eee697c2..902b25c78cda3 100644 --- a/components/camel-iec60870/src/main/docs/iec60870-client-component.adoc +++ b/components/camel-iec60870/src/main/docs/iec60870-client-component.adoc @@ -1,11 +1,15 @@ [[iec60870-client-component]] = IEC 60870 Client Component +:docTitle: IEC 60870 Client +:artifactId: camel-iec60870 +:description: IEC 60870 component used for telecontrol (supervisory control and data acquisition) such as controlling electric power transmission grids and other geographically widespread control systems. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The IEC 60870-5-104 Client component provides access to IEC 60870 servers using the http://eclipse.org/eclipsescada[Eclipse NeoSCADAâ„¢] implementation. diff --git a/components/camel-iec60870/src/main/docs/iec60870-server-component.adoc b/components/camel-iec60870/src/main/docs/iec60870-server-component.adoc index 65df12051f879..30823233fbf28 100644 --- a/components/camel-iec60870/src/main/docs/iec60870-server-component.adoc +++ b/components/camel-iec60870/src/main/docs/iec60870-server-component.adoc @@ -1,11 +1,15 @@ [[iec60870-server-component]] = IEC 60870 Server Component +:docTitle: IEC 60870 Server +:artifactId: camel-iec60870 +:description: IEC 60870 component used for telecontrol (supervisory control and data acquisition) such as controlling electric power transmission grids and other geographically widespread control systems. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The *IEC 60870-5-104 Server* component provides access to IEC 60870 servers using the http://eclipse.org/eclipsescada[Eclipse NeoSCADAâ„¢] implementation. diff --git a/components/camel-ignite/src/main/docs/ignite-cache-component.adoc b/components/camel-ignite/src/main/docs/ignite-cache-component.adoc index c21cdb2f35bcb..2c033a037f202 100644 --- a/components/camel-ignite/src/main/docs/ignite-cache-component.adoc +++ b/components/camel-ignite/src/main/docs/ignite-cache-component.adoc @@ -1,11 +1,15 @@ [[ignite-cache-component]] = Ignite Cache Component +:docTitle: Ignite Cache +:artifactId: camel-ignite +:description: The Ignite Cache endpoint is one of camel-ignite endpoints which allows you to interact with an Ignite Cache. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Ignite Cache endpoint is one of camel-ignite endpoints which allows you to interact with an https://apacheignite.readme.io/docs/data-grid[Ignite Cache]. This offers both a Producer (to invoke cache operations on an Ignite cache) and a Consumer (to consume changes from a continuous query). diff --git a/components/camel-ignite/src/main/docs/ignite-compute-component.adoc b/components/camel-ignite/src/main/docs/ignite-compute-component.adoc index f06e4985ca74c..63da8164b59f5 100644 --- a/components/camel-ignite/src/main/docs/ignite-compute-component.adoc +++ b/components/camel-ignite/src/main/docs/ignite-compute-component.adoc @@ -1,11 +1,15 @@ [[ignite-compute-component]] = Ignite Compute Component +:docTitle: Ignite Compute +:artifactId: camel-ignite +:description: The Ignite Compute endpoint is one of camel-ignite endpoints which allows you to run compute operations on the cluster by passing in an IgniteCallable, an IgniteRunnable, an IgniteClosure, or collections of them, along with their parameters if necessary. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Ignite Compute endpoint is one of camel-ignite endpoints which allows you to run https://apacheignite.readme.io/docs/compute-grid[compute operations] on the cluster by passing in an IgniteCallable, an IgniteRunnable, an IgniteClosure, or collections of them, along with their parameters if necessary. diff --git a/components/camel-ignite/src/main/docs/ignite-events-component.adoc b/components/camel-ignite/src/main/docs/ignite-events-component.adoc index 22762215cc474..b988419f2c92d 100644 --- a/components/camel-ignite/src/main/docs/ignite-events-component.adoc +++ b/components/camel-ignite/src/main/docs/ignite-events-component.adoc @@ -1,11 +1,15 @@ [[ignite-events-component]] = Ignite Events Component +:docTitle: Ignite Events +:artifactId: camel-ignite +:description: The Ignite Events endpoint is one of camel-ignite endpoints which allows you to receive events from the Ignite cluster by creating a local event listener. +:since: 2.17 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Ignite Events endpoint is one of camel-ignite endpoints which allows you to https://apacheignite.readme.io/docs/events[receive events] from the Ignite cluster by creating a local event listener. diff --git a/components/camel-ignite/src/main/docs/ignite-idgen-component.adoc b/components/camel-ignite/src/main/docs/ignite-idgen-component.adoc index 602fb9eb82133..5a38c1f11928c 100644 --- a/components/camel-ignite/src/main/docs/ignite-idgen-component.adoc +++ b/components/camel-ignite/src/main/docs/ignite-idgen-component.adoc @@ -1,11 +1,15 @@ [[ignite-idgen-component]] = Ignite ID Generator Component +:docTitle: Ignite ID Generator +:artifactId: camel-ignite +:description: The Ignite ID Generator endpoint is one of camel-ignite endpoints which allows you to interact with Ignite Atomic Sequences and ID Generators. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Ignite ID Generator endpoint is one of camel-ignite endpoints which allows you to interact with https://apacheignite.readme.io/docs/id-generator[Ignite Atomic Sequences and ID Generators]. diff --git a/components/camel-ignite/src/main/docs/ignite-messaging-component.adoc b/components/camel-ignite/src/main/docs/ignite-messaging-component.adoc index c6c6f4a5d6272..155ebdaf3ae9d 100644 --- a/components/camel-ignite/src/main/docs/ignite-messaging-component.adoc +++ b/components/camel-ignite/src/main/docs/ignite-messaging-component.adoc @@ -1,11 +1,15 @@ [[ignite-messaging-component]] = Ignite Messaging Component +:docTitle: Ignite Messaging +:artifactId: camel-ignite +:description: The Ignite Messaging endpoint is one of camel-ignite endpoints which allows you to send and consume messages from an Ignite topic. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Ignite Messaging endpoint is one of camel-ignite endpoints which allows you to send and consume messages from an https://apacheignite.readme.io/docs/messaging[Ignite topic]. diff --git a/components/camel-ignite/src/main/docs/ignite-queue-component.adoc b/components/camel-ignite/src/main/docs/ignite-queue-component.adoc index 54bf4accf8b7a..350fe8c29ff41 100644 --- a/components/camel-ignite/src/main/docs/ignite-queue-component.adoc +++ b/components/camel-ignite/src/main/docs/ignite-queue-component.adoc @@ -1,11 +1,15 @@ [[ignite-queue-component]] = Ignite Queues Component +:docTitle: Ignite Queues +:artifactId: camel-ignite +:description: The Ignite Queue endpoint is one of camel-ignite endpoints which allows you to interact with Ignite Queue data structures. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Ignite Queue endpoint is one of camel-ignite endpoints which allows you to interact with https://apacheignite.readme.io/docs/queue-and-set[Ignite Queue data structures]. diff --git a/components/camel-ignite/src/main/docs/ignite-set-component.adoc b/components/camel-ignite/src/main/docs/ignite-set-component.adoc index 0b5009a6def6a..727d60ad59834 100644 --- a/components/camel-ignite/src/main/docs/ignite-set-component.adoc +++ b/components/camel-ignite/src/main/docs/ignite-set-component.adoc @@ -1,11 +1,15 @@ [[ignite-set-component]] = Ignite Sets Component +:docTitle: Ignite Sets +:artifactId: camel-ignite +:description: The Ignite Sets endpoint is one of camel-ignite endpoints which allows you to interact with Ignite Set data structures. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Ignite Sets endpoint is one of camel-ignite endpoints which allows you to interact with https://apacheignite.readme.io/docs/queue-and-set[Ignite Set data structures]. diff --git a/components/camel-ignite/src/main/docs/ignite.adoc b/components/camel-ignite/src/main/docs/ignite-summary.adoc similarity index 95% rename from components/camel-ignite/src/main/docs/ignite.adoc rename to components/camel-ignite/src/main/docs/ignite-summary.adoc index f24ea9ffd583a..e4cbb9ce38190 100644 --- a/components/camel-ignite/src/main/docs/ignite.adoc +++ b/components/camel-ignite/src/main/docs/ignite-summary.adoc @@ -1,6 +1,9 @@ = Ignite endpoints Component +//attributes written by hand, not generated +:docTitle: Ignite +:since: 2.17 -*Since Camel 2.17* +*Since Camel {since}* https://ignite.apache.org/[Apache Ignite] In-Memory Data Fabric is a high-performance, integrated and distributed in-memory platform for computing and transacting on large-scale data sets in real-time, orders of magnitude faster than possible with traditional disk-based or flash technologies. It is designed to deliver uncompromised performance for a wide set of in-memory computing use cases from high performance computing, to the industry most advanced data grid, highly available service grid, and streaming. See all https://ignite.apache.org/features.html[features]. @@ -27,10 +30,7 @@ To use this component, add the following dependency to your pom.xml: ---- -[IMPORTANT,title=Running in OSGi] -=== -If running in an OSGi container, please don't miss the <> section below. -=== +IMPORTANT: If running in an OSGi container, please consult the <> section below. diff --git a/components/camel-infinispan/src/main/docs/infinispan-component.adoc b/components/camel-infinispan/src/main/docs/infinispan-component.adoc index 053f5bb368e8e..00127a0c52765 100644 --- a/components/camel-infinispan/src/main/docs/infinispan-component.adoc +++ b/components/camel-infinispan/src/main/docs/infinispan-component.adoc @@ -1,11 +1,15 @@ [[infinispan-component]] = Infinispan Component +:docTitle: Infinispan +:artifactId: camel-infinispan +:description: For reading/writing from/to Infinispan distributed key/value store and data grid. +:since: 2.13 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.13* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component allows you to interact with http://infinispan.org/[Infinispan] distributed data grid / cache. diff --git a/components/camel-influxdb/src/main/docs/influxdb-component.adoc b/components/camel-influxdb/src/main/docs/influxdb-component.adoc index 4757d03fda2b3..25a8b24a82d05 100644 --- a/components/camel-influxdb/src/main/docs/influxdb-component.adoc +++ b/components/camel-influxdb/src/main/docs/influxdb-component.adoc @@ -1,11 +1,15 @@ [[influxdb-component]] = InfluxDB Component +:docTitle: InfluxDB +:artifactId: camel-influxdb +:description: The influxdb component allows you to interact with InfluxDB, a time series database. +:since: 2.18 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* This component allows you to interact with InfluxDB https://influxdata.com/time-series-platform/influxdb/ a time series database. The native body type for this component is diff --git a/components/camel-iota/src/main/docs/iota-component.adoc b/components/camel-iota/src/main/docs/iota-component.adoc index f230df9addfd8..0620fd08e78c6 100644 --- a/components/camel-iota/src/main/docs/iota-component.adoc +++ b/components/camel-iota/src/main/docs/iota-component.adoc @@ -1,11 +1,15 @@ [[iota-component]] = IOTA Component +:docTitle: IOTA +:artifactId: camel-iota +:description: Component for integrate IOTA DLT +:since: 2.23 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* According to IOTA Official site: "IOTA is the first open-source distributed ledger that is being built to power the future of the Internet of Things with feeless microtransactions and data integrity for machines." diff --git a/components/camel-ipfs/src/main/docs/ipfs-component.adoc b/components/camel-ipfs/src/main/docs/ipfs-component.adoc index f64815bdb8fd8..4a9630ab6d2d0 100644 --- a/components/camel-ipfs/src/main/docs/ipfs-component.adoc +++ b/components/camel-ipfs/src/main/docs/ipfs-component.adoc @@ -1,11 +1,15 @@ [[ipfs-component]] = IPFS Component +:docTitle: IPFS +:artifactId: camel-ipfs +:description: The camel-ipfs component provides access to the Interplanetary File System (IPFS). +:since: 2.23 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The IPFS component provides access to the Interplanetary File System https://ipfs.io/[(IPFS)]. diff --git a/components/camel-irc/src/main/docs/irc-component.adoc b/components/camel-irc/src/main/docs/irc-component.adoc index a7933bec4f166..715e14693dd67 100644 --- a/components/camel-irc/src/main/docs/irc-component.adoc +++ b/components/camel-irc/src/main/docs/irc-component.adoc @@ -1,11 +1,15 @@ [[irc-component]] = IRC Component +:docTitle: IRC +:artifactId: camel-irc +:description: The irc component implements an IRC (Internet Relay Chat) transport. +:since: 1.1 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The IRC component implements an http://en.wikipedia.org/wiki/Internet_Relay_Chat[IRC] (Internet Relay diff --git a/components/camel-ironmq/src/main/docs/ironmq-component.adoc b/components/camel-ironmq/src/main/docs/ironmq-component.adoc index 6f9ccaeff1bd7..f0d2120f01414 100644 --- a/components/camel-ironmq/src/main/docs/ironmq-component.adoc +++ b/components/camel-ironmq/src/main/docs/ironmq-component.adoc @@ -1,11 +1,15 @@ [[ironmq-component]] = IronMQ Component +:docTitle: IronMQ +:artifactId: camel-ironmq +:description: The ironmq provides integration with IronMQ an elastic and durable hosted message queue as a service. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The IronMQ component provides integration with http://www.iron.io/products/mq[IronMQ] an elastic and durable hosted message queue as a service. diff --git a/components/camel-jackson/src/main/docs/json-jackson-dataformat.adoc b/components/camel-jackson/src/main/docs/json-jackson-dataformat.adoc index f0917e54c196d..ce4cb291c5544 100644 --- a/components/camel-jackson/src/main/docs/json-jackson-dataformat.adoc +++ b/components/camel-jackson/src/main/docs/json-jackson-dataformat.adoc @@ -1,7 +1,12 @@ [[json-jackson-dataformat]] = JSon Jackson DataFormat +:docTitle: JSon Jackson +:artifactId: camel-jackson +:description: JSon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload. +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* Jackson is a Data Format which uses the https://github.com/FasterXML/jackson-core[Jackson Library] diff --git a/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc b/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc index dd5a5e116d776..41fcaf474dee6 100644 --- a/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc +++ b/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc @@ -1,7 +1,12 @@ [[jacksonxml-dataformat]] = JacksonXML DataFormat +:docTitle: JacksonXML +:artifactId: camel-jacksonxml +:description: JacksonXML data format is used for unmarshal a XML payload to POJO or to marshal POJO back to XML payload. +:since: 2.16 +:supportLevel: Stable -*Since Camel 2.16* +*Since Camel {since}* Jackson XML is a Data Format which uses the http://wiki.fasterxml.com/JacksonHome/[Jackson library] with the diff --git a/components/camel-jasypt/src/main/docs/jasypt.adoc b/components/camel-jasypt/src/main/docs/jasypt.adoc index 45409fc1beb4b..1e6d6384d2967 100644 --- a/components/camel-jasypt/src/main/docs/jasypt.adoc +++ b/components/camel-jasypt/src/main/docs/jasypt.adoc @@ -1,10 +1,16 @@ -= Jasypt component +[[jasypt-component]] += Jasypt Component +:docTitle: Jasypt +:artifactId: camel-jasypt +:description: Security using Jasypt +:since: 2.5 +:supportLevel: Stable -*Since Camel 2.5* +*Since Camel {since}* http://www.jasypt.org/[Jasypt] is a simplified encryption library which makes encryption and decryption easy. Camel integrates with Jasypt to -allow sensitive information in xref:properties-component.adoc[Properties] files to +allow sensitive information in xref:ROOT:properties-component.adoc[Properties] files to be encrypted. By dropping *`camel-jasypt`* on the classpath those encrypted values will automatically be decrypted on-the-fly by Camel. This ensures that human eyes can't easily spot sensitive information @@ -97,7 +103,7 @@ Decrypted text: tiger --------------------- The idea is then to use those encrypted values in your -xref:properties-component.adoc[Properties] files. Notice how the password value is +xref:ROOT:properties-component.adoc[Properties] files. Notice how the password value is encrypted and the value has the tokens surrounding `ENC(value here)` [TIP] @@ -156,7 +162,7 @@ The `password` option is then a matter of defining as follows: In Java DSL you need to configure Jasypt as a `JasyptPropertiesParser` instance and set it on the -xref:properties-component.adoc[Properties] component as show below: +xref:ROOT:properties-component.adoc[Properties] component as show below: The properties file `myproperties.properties` then contain the encrypted value, such as shown below. Notice how the password value is encrypted @@ -165,7 +171,7 @@ and the value has the tokens surrounding `ENC(value here)` == Example with Spring XML In Spring XML you need to configure the `JasyptPropertiesParser` which -is shown below. Then the Camel xref:properties-component.adoc[Properties] +is shown below. Then the Camel xref:ROOT:properties-component.adoc[Properties] component is told to use `jasypt` as the properties parser, which means Jasypt has its chance to decrypt values looked up in the properties. @@ -186,7 +192,7 @@ the properties. ----------------------------------------------------------------------------------------------------------- -The xref:properties-component.adoc[Properties] component can also be inlined +The xref:ROOT:properties-component.adoc[Properties] component can also be inlined inside the `` tag which is shown below. Notice how we use the `propertiesParserRef` attribute to refer to Jasypt. @@ -216,7 +222,7 @@ Jasypt. In Blueprint XML you need to configure the `JasyptPropertiesParser` which is shown below. Then the -Camel xref:properties-component.adoc[Properties] component is told to +Camel xref:ROOT:properties-component.adoc[Properties] component is told to use `jasypt` as the properties parser, which means Jasypt has its chance to decrypt values looked up in the properties. @@ -256,7 +262,7 @@ up in the properties. ---------------------------------------------------------------------------------------------------------------- -The xref:properties-component.adoc[Properties] component can also be inlined +The xref:ROOT:properties-component.adoc[Properties] component can also be inlined inside the `` tag which is shown below. Notice how we use the `propertiesParserRef` attribute to refer to Jasypt. @@ -287,4 +293,3 @@ to Jasypt. ---------------------------------------------------------------------------------------------------------------- - diff --git a/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc b/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc index 8674a82f9c9f8..4ce2eb3a39e05 100644 --- a/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc +++ b/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc @@ -1,7 +1,12 @@ [[jaxb-dataformat]] = JAXB DataFormat +:docTitle: JAXB +:artifactId: camel-jaxb +:description: JAXB data format uses the JAXB2 XML marshalling standard to unmarshal an XML payload into Java objects or to marshal Java objects into an XML payload. +:since: 1.0 +:supportLevel: Stable -*Since Camel 1.0* +*Since Camel {since}* JAXB is a Data Format which uses the JAXB2 XML marshalling standard which is included in Java 6 to unmarshal an XML diff --git a/components/camel-jbpm/src/main/docs/jbpm-component.adoc b/components/camel-jbpm/src/main/docs/jbpm-component.adoc index f90094a104894..945690d84833e 100644 --- a/components/camel-jbpm/src/main/docs/jbpm-component.adoc +++ b/components/camel-jbpm/src/main/docs/jbpm-component.adoc @@ -1,11 +1,15 @@ [[jbpm-component]] = JBPM Component +:docTitle: JBPM +:artifactId: camel-jbpm +:description: The jbpm component provides integration with jBPM (Business Process Management). +:since: 2.6 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.6* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The JBPM component provides integration with Business Process Management http://www.jbpm.org/[jBPM]. It uses diff --git a/components/camel-jcache/src/main/docs/jcache-component.adoc b/components/camel-jcache/src/main/docs/jcache-component.adoc index 3d8b32b2daac0..9dfff9d7a0287 100644 --- a/components/camel-jcache/src/main/docs/jcache-component.adoc +++ b/components/camel-jcache/src/main/docs/jcache-component.adoc @@ -1,11 +1,15 @@ [[jcache-component]] = JCache Component +:docTitle: JCache +:artifactId: camel-jcache +:description: The jcache component enables you to perform caching operations using JSR107/JCache as cache implementation. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The JCache component enables you to perform caching operations using JSR107/JCache as cache implementation. diff --git a/components/camel-jclouds/src/main/docs/jclouds-component.adoc b/components/camel-jclouds/src/main/docs/jclouds-component.adoc index 17f8ea8db3534..69fb350232d17 100644 --- a/components/camel-jclouds/src/main/docs/jclouds-component.adoc +++ b/components/camel-jclouds/src/main/docs/jclouds-component.adoc @@ -1,11 +1,15 @@ [[jclouds-component]] = JClouds Component +:docTitle: JClouds +:artifactId: camel-jclouds +:description: For interacting with cloud compute & blobstore service via jclouds. +:since: 2.9 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.9* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component allows interaction with cloud provider key-value engines (blobstores) and compute services. The component uses diff --git a/components/camel-jcr/src/main/docs/jcr-component.adoc b/components/camel-jcr/src/main/docs/jcr-component.adoc index 73edeb21ca46d..3d13b0b0f1631 100644 --- a/components/camel-jcr/src/main/docs/jcr-component.adoc +++ b/components/camel-jcr/src/main/docs/jcr-component.adoc @@ -1,11 +1,15 @@ [[jcr-component]] = JCR Component +:docTitle: JCR +:artifactId: camel-jcr +:description: The jcr component allows you to add/read nodes to/from a JCR compliant content repository. +:since: 1.3 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.3* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The JCR component allows you to add/read nodes to/from a JCR compliant content repository (for example, diff --git a/components/camel-jdbc/src/main/docs/jdbc-component.adoc b/components/camel-jdbc/src/main/docs/jdbc-component.adoc index 5e60af26c1460..adb408d77f515 100644 --- a/components/camel-jdbc/src/main/docs/jdbc-component.adoc +++ b/components/camel-jdbc/src/main/docs/jdbc-component.adoc @@ -1,11 +1,15 @@ [[jdbc-component]] = JDBC Component +:docTitle: JDBC +:artifactId: camel-jdbc +:description: The jdbc component enables you to access databases through JDBC, where SQL queries are sent in the message body. +:since: 1.2 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 1.2* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The JDBC component enables you to access databases through JDBC, where SQL queries (SELECT) and operations (INSERT, UPDATE, etc) are sent in diff --git a/components/camel-jetty/src/main/docs/jetty-component.adoc b/components/camel-jetty/src/main/docs/jetty-component.adoc index 701788fa0923a..88e98a555ad97 100644 --- a/components/camel-jetty/src/main/docs/jetty-component.adoc +++ b/components/camel-jetty/src/main/docs/jetty-component.adoc @@ -1,11 +1,15 @@ [[jetty-component]] = Jetty Component +:docTitle: Jetty +:artifactId: camel-jetty +:description: To use Jetty as a HTTP server as consumer for Camel routes. +:since: 1.2 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 1.2* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Jetty component provides HTTP-based endpoints for consuming and producing HTTP requests. That is, the Jetty component diff --git a/components/camel-jgroups-raft/src/main/docs/jgroups-raft-component.adoc b/components/camel-jgroups-raft/src/main/docs/jgroups-raft-component.adoc index 7946eebda2f3c..65c54df22af99 100644 --- a/components/camel-jgroups-raft/src/main/docs/jgroups-raft-component.adoc +++ b/components/camel-jgroups-raft/src/main/docs/jgroups-raft-component.adoc @@ -1,11 +1,15 @@ [[jgroups-raft-component]] = JGroups raft Component +:docTitle: JGroups raft +:artifactId: camel-jgroups-raft +:description: The jgroups component provides exchange of messages between Camel and JGroups clusters. +:since: 2.24 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.24* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* http://belaban.github.io/jgroups-raft/[JGroups-raft] is a https://raftconsensus.github.io/[Raft] implementation in http://www.jgroups.org/[JGroups]. The *jgroups-raft:* component provides interoperability between camel and a JGroups-raft clusters. diff --git a/components/camel-jgroups/src/main/docs/jgroups-component.adoc b/components/camel-jgroups/src/main/docs/jgroups-component.adoc index 494c8768c0717..424d072b75eb7 100644 --- a/components/camel-jgroups/src/main/docs/jgroups-component.adoc +++ b/components/camel-jgroups/src/main/docs/jgroups-component.adoc @@ -1,11 +1,15 @@ [[jgroups-component]] = JGroups Component +:docTitle: JGroups +:artifactId: camel-jgroups +:description: The jgroups component provides exchange of messages between Camel and JGroups clusters. +:since: 2.13 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.13* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* http://www.jgroups.org[JGroups] is a toolkit for reliable multicast communication. The *jgroups:* component provides exchange of messages diff --git a/components/camel-jing/src/main/docs/jing-component.adoc b/components/camel-jing/src/main/docs/jing-component.adoc index 66a0fc8bb7117..3f3612a4a8b1f 100644 --- a/components/camel-jing/src/main/docs/jing-component.adoc +++ b/components/camel-jing/src/main/docs/jing-component.adoc @@ -1,11 +1,15 @@ [[jing-component]] = Jing Component +:docTitle: Jing +:artifactId: camel-jing +:description: Validates the payload of a message using RelaxNG Syntax using Jing library. +:since: 1.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Jing component uses the http://www.thaiopensource.com/relaxng/jing.html[Jing Library] to perform diff --git a/components/camel-jira/src/main/docs/jira-component.adoc b/components/camel-jira/src/main/docs/jira-component.adoc index 2ad515b26ce86..1387c6550b1d1 100644 --- a/components/camel-jira/src/main/docs/jira-component.adoc +++ b/components/camel-jira/src/main/docs/jira-component.adoc @@ -1,11 +1,15 @@ [[jira-component]] = Jira Component +:docTitle: Jira +:artifactId: camel-jira +:description: The jira component interacts with the JIRA issue tracker. +:since: 3.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The JIRA component interacts with the JIRA API by encapsulating Atlassian's https://bitbucket.org/atlassian/jira-rest-java-client/src/master/[REST diff --git a/components/camel-jms/src/main/docs/jms-component.adoc b/components/camel-jms/src/main/docs/jms-component.adoc index 82f1cae07c1ca..29727b9e03cbe 100644 --- a/components/camel-jms/src/main/docs/jms-component.adoc +++ b/components/camel-jms/src/main/docs/jms-component.adoc @@ -1,11 +1,15 @@ [[jms-component]] = JMS Component +:docTitle: JMS +:artifactId: camel-jms +:description: The jms component allows messages to be sent to (or consumed from) a JMS Queue or Topic. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component allows messages to be sent to (or consumed from) a http://java.sun.com/products/jms/[JMS] Queue or Topic. It uses Spring's diff --git a/components/camel-jmx/src/main/docs/jmx-component.adoc b/components/camel-jmx/src/main/docs/jmx-component.adoc index eacaf4d80d304..03596695d9d62 100644 --- a/components/camel-jmx/src/main/docs/jmx-component.adoc +++ b/components/camel-jmx/src/main/docs/jmx-component.adoc @@ -1,11 +1,15 @@ [[jmx-component]] = JMX Component +:docTitle: JMX +:artifactId: camel-jmx +:description: The jmx component allows to receive JMX notifications. +:since: 2.6 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.6* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* Apache Camel has extensive support for JMX to allow you to monitor and control the Camel managed objects with a JMX client. diff --git a/components/camel-johnzon/src/main/docs/json-johnzon-dataformat.adoc b/components/camel-johnzon/src/main/docs/json-johnzon-dataformat.adoc index 9be0ed9fe03f8..16919732f8529 100644 --- a/components/camel-johnzon/src/main/docs/json-johnzon-dataformat.adoc +++ b/components/camel-johnzon/src/main/docs/json-johnzon-dataformat.adoc @@ -1,7 +1,12 @@ [[json-johnzon-dataformat]] = JSon Johnzon DataFormat +:docTitle: JSon Johnzon +:artifactId: camel-johnzon +:description: JSon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload. +:since: 2.18 +:supportLevel: Stable -*Since Camel 2.18* +*Since Camel {since}* Johnzon is a Data Format which uses the http://johnzon.apache.org/[Johnzon Library] diff --git a/components/camel-jolt/src/main/docs/jolt-component.adoc b/components/camel-jolt/src/main/docs/jolt-component.adoc index 6b15574ad9bda..028e4c5adbd09 100644 --- a/components/camel-jolt/src/main/docs/jolt-component.adoc +++ b/components/camel-jolt/src/main/docs/jolt-component.adoc @@ -1,11 +1,15 @@ [[jolt-component]] = JOLT Component +:docTitle: JOLT +:artifactId: camel-jolt +:description: The jolt component allows you to process a JSON messages using an JOLT specification (such as JSON-JSON transformation). +:since: 2.16 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Jolt component allows you to process a JSON messages using an https://github.com/bazaarvoice/jolt[JOLT] specification. This can be diff --git a/components/camel-jooq/src/main/docs/jooq-component.adoc b/components/camel-jooq/src/main/docs/jooq-component.adoc index 486cdc91fb4a4..a0da184f72a18 100644 --- a/components/camel-jooq/src/main/docs/jooq-component.adoc +++ b/components/camel-jooq/src/main/docs/jooq-component.adoc @@ -1,11 +1,15 @@ [[jooq-component]] = JOOQ Component +:docTitle: JOOQ +:artifactId: camel-jooq +:description: The jooq component enables you to store and retrieve entities from databases using JOOQ +:since: 3.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The JOOQ component enables you to store and retrieve Java objects from persistent storage using JOOQ library. diff --git a/components/camel-jpa/src/main/docs/jpa-component.adoc b/components/camel-jpa/src/main/docs/jpa-component.adoc index ef1086f22f0d3..4df6b8e9ded00 100644 --- a/components/camel-jpa/src/main/docs/jpa-component.adoc +++ b/components/camel-jpa/src/main/docs/jpa-component.adoc @@ -1,11 +1,15 @@ [[jpa-component]] = JPA Component +:docTitle: JPA +:artifactId: camel-jpa +:description: The jpa component enables you to store and retrieve Java objects from databases using JPA. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The JPA component enables you to store and retrieve Java objects from persistent storage using EJB 3's Java Persistence Architecture (JPA), diff --git a/components/camel-jsch/src/main/docs/scp-component.adoc b/components/camel-jsch/src/main/docs/scp-component.adoc index 59bf273a94798..8ac5b3408c4f0 100644 --- a/components/camel-jsch/src/main/docs/scp-component.adoc +++ b/components/camel-jsch/src/main/docs/scp-component.adoc @@ -1,11 +1,15 @@ [[scp-component]] = SCP Component +:docTitle: SCP +:artifactId: camel-jsch +:description: To copy files using the secure copy protocol (SCP). +:since: 2.10 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Camel-Jsch component supports the http://en.wikipedia.org/wiki/Secure_copy[SCP protocol] using the Client diff --git a/components/camel-jslt/src/main/docs/jslt-component.adoc b/components/camel-jslt/src/main/docs/jslt-component.adoc index d11e5bfb76b9d..0bd13bbea4ed3 100644 --- a/components/camel-jslt/src/main/docs/jslt-component.adoc +++ b/components/camel-jslt/src/main/docs/jslt-component.adoc @@ -1,11 +1,15 @@ [[jslt-component]] = JSLT Component +:docTitle: JSLT +:artifactId: camel-jslt +:description: The jslt component allows you to process a JSON messages using an JSLT transformations. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Jslt component allows you to process a JSON messages using an https://github.com/schibsted/jslt[JSLT] expression. This can be diff --git a/components/camel-json-validator/src/main/docs/json-validator-component.adoc b/components/camel-json-validator/src/main/docs/json-validator-component.adoc index 43de707d85b7a..f1b9fcd3d4209 100644 --- a/components/camel-json-validator/src/main/docs/json-validator-component.adoc +++ b/components/camel-json-validator/src/main/docs/json-validator-component.adoc @@ -1,11 +1,15 @@ [[json-validator-component]] = JSON Schema Validator Component +:docTitle: JSON Schema Validator +:artifactId: camel-json-validator +:description: Validates the payload of a message using NetworkNT JSON Schema library. +:since: 2.20 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The JSON Schema Validator component performs bean validation of the message body against JSON Schemas v4 draft using the NetworkNT JSON Schema library diff --git a/components/camel-jsonapi/src/main/docs/jsonApi-dataformat.adoc b/components/camel-jsonapi/src/main/docs/jsonApi-dataformat.adoc index 56d2e453abc75..d2ab5bc927f34 100644 --- a/components/camel-jsonapi/src/main/docs/jsonApi-dataformat.adoc +++ b/components/camel-jsonapi/src/main/docs/jsonApi-dataformat.adoc @@ -1,7 +1,12 @@ [[jsonApi-dataformat]] = JSonApi DataFormat +:docTitle: JSonApi +:artifactId: camel-jsonapi +:description: JSonApi data format is used for marshal and unmarshal Json API object. +:since: 3.0 +:supportLevel: Stable -*Since Camel 3.0* +*Since Camel {since}* // dataformat options: START The JSonApi dataformat supports 3 options, which are listed below. diff --git a/components/camel-jsonpath/src/main/docs/jsonpath-language.adoc b/components/camel-jsonpath/src/main/docs/jsonpath-language.adoc index 6d631c70ea59c..d2981adaeb590 100644 --- a/components/camel-jsonpath/src/main/docs/jsonpath-language.adoc +++ b/components/camel-jsonpath/src/main/docs/jsonpath-language.adoc @@ -1,7 +1,12 @@ [[jsonpath-language]] = JsonPath Language +:docTitle: JsonPath +:artifactId: camel-jsonpath +:description: To use JsonPath in Camel expressions or predicates. +:since: 2.13 +:supportLevel: Stable -*Since Camel 2.13* +*Since Camel {since}* Camel supports https://code.google.com/p/json-path/[JSonPath] to allow using Expression or Predicate diff --git a/components/camel-jt400/src/main/docs/jt400-component.adoc b/components/camel-jt400/src/main/docs/jt400-component.adoc index e36db9cb6e9ac..89f6ceea48788 100644 --- a/components/camel-jt400/src/main/docs/jt400-component.adoc +++ b/components/camel-jt400/src/main/docs/jt400-component.adoc @@ -1,11 +1,15 @@ [[jt400-component]] = JT400 Component +:docTitle: JT400 +:artifactId: camel-jt400 +:description: The jt400 component allows you to exchanges messages with an AS/400 system using data queues or program call. +:since: 1.5 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.5* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The JT400 component allows you to exchanges messages with an AS/400 system using data queues. diff --git a/components/camel-kafka/src/main/docs/kafka-component.adoc b/components/camel-kafka/src/main/docs/kafka-component.adoc index 6ba41aac464bc..b0d0d9bfef82d 100644 --- a/components/camel-kafka/src/main/docs/kafka-component.adoc +++ b/components/camel-kafka/src/main/docs/kafka-component.adoc @@ -1,11 +1,15 @@ [[kafka-component]] = Kafka Component +:docTitle: Kafka +:artifactId: camel-kafka +:description: The kafka component allows messages to be sent to (or consumed from) Apache Kafka brokers. +:since: 2.13 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.13* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Kafka component is used for communicating with http://kafka.apache.org/[Apache Kafka] message broker. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-config-maps-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-config-maps-component.adoc index e961ce055c861..f60fb1488cc85 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-config-maps-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-config-maps-component.adoc @@ -1,13 +1,17 @@ [[kubernetes-config-maps-component]] = Kubernetes ConfigMap Component +:docTitle: Kubernetes ConfigMap +:artifactId: camel-kubernetes +:description: The Kubernetes Configmaps component provides a producer to execute kubernetes configmap operations. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* -The Kubernetes ConfigMap component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes ConfigMap component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes ConfigMap operations and a consumer to consume events related to Config maps. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc index e7fe7803dd13d..a9c2784210491 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc @@ -1,13 +1,17 @@ [[kubernetes-deployments-component]] = Kubernetes Deployments Component +:docTitle: Kubernetes Deployments +:artifactId: camel-kubernetes +:description: The Kubernetes Nodes component provides a producer to execute kubernetes node operations and a consumer to consume node events. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -The Kubernetes Deployments component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Deployments component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes secret operations. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-hpa-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-hpa-component.adoc index 776a04c2f7ef0..5035867d67dd7 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-hpa-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-hpa-component.adoc @@ -1,13 +1,17 @@ [[kubernetes-hpa-component]] = Kubernetes HPA Component +:docTitle: Kubernetes HPA +:artifactId: camel-kubernetes +:description: The Kubernetes HPA component provides a producer to execute kubernetes hpa operations and a consumer to consume HPA events. +:since: 2.23 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -The Kubernetes HPA component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes HPA component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes hpa operations and a consumer to consume kubernetes hpa events. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-job-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-job-component.adoc index 12042e4710f5d..25fdfe6d0a7e0 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-job-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-job-component.adoc @@ -1,13 +1,17 @@ [[kubernetes-job-component]] = Kubernetes Job Component +:docTitle: Kubernetes Job +:artifactId: camel-kubernetes +:description: The Kubernetes Jobs component provides a producer to execute kubernetes job operations +:since: 2.23 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -The Kubernetes Job component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Job component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes job operations. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-namespaces-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-namespaces-component.adoc index 4b813a254b329..e112555dda459 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-namespaces-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-namespaces-component.adoc @@ -1,13 +1,17 @@ [[kubernetes-namespaces-component]] = Kubernetes Namespaces Component +:docTitle: Kubernetes Namespaces +:artifactId: camel-kubernetes +:description: The Kubernetes Namespaces component provides a producer to execute kubernetes namespace operations and a consumer to consume namespace events. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -The Kubernetes Namespaces component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Namespaces component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes namespace operations and a consumer to consume kubernetes namespace events. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-nodes-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-nodes-component.adoc index 45d1e9be3da56..4360a491f27cb 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-nodes-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-nodes-component.adoc @@ -1,13 +1,17 @@ [[kubernetes-nodes-component]] = Kubernetes Nodes Component +:docTitle: Kubernetes Nodes +:artifactId: camel-kubernetes +:description: The Kubernetes Nodes component provides a producer to execute kubernetes node operations and a consumer to consume node events. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -The Kubernetes Nodes component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Nodes component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes node operations and a consumer to consume kubernetes node events. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-claims-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-claims-component.adoc index 47544e69badfb..8302242e7403a 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-claims-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-claims-component.adoc @@ -1,13 +1,17 @@ [[kubernetes-persistent-volumes-claims-component]] = Kubernetes Persistent Volume Claim Component +:docTitle: Kubernetes Persistent Volume Claim +:artifactId: camel-kubernetes +:description: The Kubernetes Persistent Volumes Claims component provides a producer to execute kubernetes persistent volume claim operations. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* -The Kubernetes Persistent Volume Claim component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Persistent Volume Claim component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes persistent volume claim operations. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-component.adoc index 2cf0d675a6a5f..c03b8f33d833e 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-component.adoc @@ -1,13 +1,17 @@ [[kubernetes-persistent-volumes-component]] = Kubernetes Persistent Volume Component +:docTitle: Kubernetes Persistent Volume +:artifactId: camel-kubernetes +:description: The Kubernetes Persistent Volumes component provides a producer to execute kubernetes persistent volume operations. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* -The Kubernetes Persistent Volume component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Persistent Volume component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes persistent volume operations. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-pods-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-pods-component.adoc index 62234946f3630..9d17d94390732 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-pods-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-pods-component.adoc @@ -1,13 +1,17 @@ [[kubernetes-pods-component]] = Kubernetes Pods Component +:docTitle: Kubernetes Pods +:artifactId: camel-kubernetes +:description: The Kubernetes Pods component provides a producer to execute kubernetes pod operations and a consumer to consume pod events. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -The Kubernetes Pods component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Pods component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes pod operations. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-replication-controllers-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-replication-controllers-component.adoc index 363237b2e143a..33de02b2ef0e2 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-replication-controllers-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-replication-controllers-component.adoc @@ -1,13 +1,17 @@ [[kubernetes-replication-controllers-component]] = Kubernetes Replication Controller Component +:docTitle: Kubernetes Replication Controller +:artifactId: camel-kubernetes +:description: The Kubernetes Replication Controllers component provides a producer to execute kubernetes replication controller operations and a consumer to consume replication controller events. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -The Kubernetes Replication Controller component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Replication Controller component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes replication controller operations and a consumer to consume kubernetes replication controller events. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-resources-quota-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-resources-quota-component.adoc index 59c491f836843..619c6ae8abcad 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-resources-quota-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-resources-quota-component.adoc @@ -1,13 +1,17 @@ [[kubernetes-resources-quota-component]] = Kubernetes Resources Quota Component +:docTitle: Kubernetes Resources Quota +:artifactId: camel-kubernetes +:description: The Kubernetes Resources Quota component provides a producer to execute kubernetes resources quota operations. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* -The Kubernetes Resources Quota component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Resources Quota component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes resource quota operations. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-secrets-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-secrets-component.adoc index 766c58c92f8d1..18cb23a59a309 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-secrets-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-secrets-component.adoc @@ -1,13 +1,17 @@ [[kubernetes-secrets-component]] = Kubernetes Secrets Component +:docTitle: Kubernetes Secrets +:artifactId: camel-kubernetes +:description: The Kubernetes Secrets component provides a producer to execute kubernetes secret operations. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* -The Kubernetes Secrets component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Secrets component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes secret operations. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-service-accounts-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-service-accounts-component.adoc index b2600fad84b16..f854b3bebea23 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-service-accounts-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-service-accounts-component.adoc @@ -1,13 +1,17 @@ [[kubernetes-service-accounts-component]] = Kubernetes Service Account Component +:docTitle: Kubernetes Service Account +:artifactId: camel-kubernetes +:description: The Kubernetes Service Accounts component provides a producer to execute service account operations. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* -The Kubernetes Service Account component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Service Account component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes Service Account operations. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-services-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-services-component.adoc index 04610197f8c37..867f89e344f60 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-services-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-services-component.adoc @@ -1,13 +1,17 @@ [[kubernetes-services-component]] = Kubernetes Services Component +:docTitle: Kubernetes Services +:artifactId: camel-kubernetes +:description: The Kubernetes Services component provides a producer to execute service operations and a consumer to consume service events. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -The Kubernetes Services component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Services component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes service operations and a consumer to consume kubernetes service events. diff --git a/docs/components/modules/ROOT/pages/kubernetes.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-summary.adoc similarity index 98% rename from docs/components/modules/ROOT/pages/kubernetes.adoc rename to components/camel-kubernetes/src/main/docs/kubernetes-summary.adoc index 74e57107c1ee6..3cc02d4be0dd4 100644 --- a/docs/components/modules/ROOT/pages/kubernetes.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-summary.adoc @@ -1,7 +1,9 @@ = Kubernetes Components -:page-source: components/camel-kubernetes/src/main/docs/kubernetes.adoc +//attributes written by hand, not generated +:docTitle: Kubernetes +:since: 2.17 -*Since Camel 2.17* +*Since Camel {since}* The Kubernetes components integrate your application with Kubernetes standalone or on top of Openshift. diff --git a/components/camel-kubernetes/src/main/docs/openshift-build-configs-component.adoc b/components/camel-kubernetes/src/main/docs/openshift-build-configs-component.adoc index e3fe242379740..9507fc465f2fe 100644 --- a/components/camel-kubernetes/src/main/docs/openshift-build-configs-component.adoc +++ b/components/camel-kubernetes/src/main/docs/openshift-build-configs-component.adoc @@ -1,13 +1,17 @@ [[openshift-build-configs-component]] = Openshift Build Config Component +:docTitle: Openshift Build Config +:artifactId: camel-kubernetes +:description: The Kubernetes Build Config component provides a producer to execute kubernetes build config operations. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* -The OpenShift Build Config component is one of xref:kubernetes.adoc[Kubernetes Components] which +The OpenShift Build Config component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes build config operations. diff --git a/components/camel-kubernetes/src/main/docs/openshift-builds-component.adoc b/components/camel-kubernetes/src/main/docs/openshift-builds-component.adoc index d399d572a79a4..8ac9bb33716cb 100644 --- a/components/camel-kubernetes/src/main/docs/openshift-builds-component.adoc +++ b/components/camel-kubernetes/src/main/docs/openshift-builds-component.adoc @@ -1,13 +1,17 @@ [[openshift-builds-component]] = Openshift Builds Component +:docTitle: Openshift Builds +:artifactId: camel-kubernetes +:description: The Openshift Builds component provides a producer to execute openshift build operations. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* -The Kubernetes Builds component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Builds component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes build operations. diff --git a/components/camel-kudu/src/main/docs/kudu-component.adoc b/components/camel-kudu/src/main/docs/kudu-component.adoc index ff5148732bec7..24c147c6399bd 100644 --- a/components/camel-kudu/src/main/docs/kudu-component.adoc +++ b/components/camel-kudu/src/main/docs/kudu-component.adoc @@ -1,11 +1,15 @@ [[kudu-component]] = Kudu Component +:docTitle: Kudu +:artifactId: camel-kudu +:description: Represents a Kudu endpoint. A kudu endpoint allows you to interact with Apache Kudu, a free and open source column-oriented data store of the Apache Hadoop ecosystem. +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* *Since Camel 3.0* diff --git a/components/camel-language/src/main/docs/language-component.adoc b/components/camel-language/src/main/docs/language-component.adoc index 9d3140a3db984..7e29f9abd7fc9 100644 --- a/components/camel-language/src/main/docs/language-component.adoc +++ b/components/camel-language/src/main/docs/language-component.adoc @@ -1,11 +1,16 @@ [[language-component]] = Language Component +:docTitle: Language +:artifactId: camel-language +:description: The language component allows you to send a message to an endpoint which executes a script by any of the supported Languages in Camel. +:since: 2.5 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 2.5* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Language component allows you to send Exchange to an endpoint which executes a script by any of the supported diff --git a/components/camel-ldap/src/main/docs/ldap-component.adoc b/components/camel-ldap/src/main/docs/ldap-component.adoc index 93031587affcc..88e95db8e2638 100644 --- a/components/camel-ldap/src/main/docs/ldap-component.adoc +++ b/components/camel-ldap/src/main/docs/ldap-component.adoc @@ -1,11 +1,15 @@ [[ldap-component]] = LDAP Component +:docTitle: LDAP +:artifactId: camel-ldap +:description: The ldap component allows you to perform searches in LDAP servers using filters as the message payload. +:since: 1.5 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 1.5* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The LDAP component allows you to perform searches in LDAP servers using filters as the message payload. + diff --git a/components/camel-ldif/src/main/docs/ldif-component.adoc b/components/camel-ldif/src/main/docs/ldif-component.adoc index b0fb2f1b9e4bc..377c18ba898a9 100644 --- a/components/camel-ldif/src/main/docs/ldif-component.adoc +++ b/components/camel-ldif/src/main/docs/ldif-component.adoc @@ -1,11 +1,15 @@ [[ldif-component]] = LDIF Component +:docTitle: LDIF +:artifactId: camel-ldif +:description: The ldif component allows you to do updates on an LDAP server from a LDIF body content. +:since: 2.20 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The LDIF component allows you to do updates on an LDAP server from a LDIF body content. diff --git a/components/camel-leveldb/src/main/docs/leveldb.adoc b/components/camel-leveldb/src/main/docs/leveldb.adoc index c5fa8adb435e0..b92bf7c9f31a8 100644 --- a/components/camel-leveldb/src/main/docs/leveldb.adoc +++ b/components/camel-leveldb/src/main/docs/leveldb.adoc @@ -1,7 +1,12 @@ -[[LevelDB-LevelDB]] -= LevelDB +[[leveldb-component]] += LevelDB Component +:docTitle: LevelDB +:artifactId: camel-leveldb +:description: Using LevelDB as persistent EIP store +:since: 2.10 +:supportLevel: Stable -*Since Camel 2.10* +*Since Camel {since}* https://code.google.com/p/leveldb/[Leveldb] is a very lightweight and embedable key value database. It allows together with Camel to provide @@ -148,4 +153,3 @@ the download page for the latest versions). x.y.z ---------------------------------------- - diff --git a/components/camel-log/src/main/docs/log-component.adoc b/components/camel-log/src/main/docs/log-component.adoc index a11dce29e62c2..1d3b1a9bf4ff8 100644 --- a/components/camel-log/src/main/docs/log-component.adoc +++ b/components/camel-log/src/main/docs/log-component.adoc @@ -1,11 +1,16 @@ [[log-component]] = Log Component +:docTitle: Log +:artifactId: camel-log +:description: The log component logs message exchanges to the underlying logging mechanism. +:since: 1.1 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Log component logs message exchanges to the underlying logging mechanism. diff --git a/components/camel-lra/src/main/docs/lra.adoc b/components/camel-lra/src/main/docs/lra.adoc index 21723a9335aa7..7f1d2239e85aa 100644 --- a/components/camel-lra/src/main/docs/lra.adoc +++ b/components/camel-lra/src/main/docs/lra.adoc @@ -1,6 +1,12 @@ +[[lra-component]] = LRA Component +:docTitle: LRA +:artifactId: camel-lra +:description: Camel saga binding for Long-Running-Action framework +:since: 2.21 +:supportLevel: Stable -*Since Camel 2.21.0* +*Since Camel {since}* The LRA module provides bindings of the Saga EIP with any https://github.com/eclipse/microprofile-sandbox/tree/master/proposals/0009-LRA[Microprofile compatible LRA Coordinator (sandbox)]. diff --git a/components/camel-lucene/src/main/docs/lucene-component.adoc b/components/camel-lucene/src/main/docs/lucene-component.adoc index a386871bb1951..8ef52a6e4c7e1 100644 --- a/components/camel-lucene/src/main/docs/lucene-component.adoc +++ b/components/camel-lucene/src/main/docs/lucene-component.adoc @@ -1,11 +1,15 @@ [[lucene-component]] = Lucene Component +:docTitle: Lucene +:artifactId: camel-lucene +:description: To insert or query from Apache Lucene databases. +:since: 2.2 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.2* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Lucene component is based on the Apache Lucene project. Apache Lucene is a powerful high-performance, full-featured text search engine diff --git a/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc b/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc index 40af538e7a5cb..117b08978f17f 100644 --- a/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc +++ b/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc @@ -1,11 +1,15 @@ [[lumberjack-component]] = Lumberjack Component +:docTitle: Lumberjack +:artifactId: camel-lumberjack +:description: The lumberjack retrieves logs sent over the network using the Lumberjack protocol. +:since: 2.18 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Lumberjack component retrieves logs sent over the network using the Lumberjack protocol, from https://www.elastic.co/fr/products/beats/filebeat[Filebeat] for instance. diff --git a/components/camel-lzf/src/main/docs/lzf-dataformat.adoc b/components/camel-lzf/src/main/docs/lzf-dataformat.adoc index 1e4b6485e4862..946d60df72d6b 100644 --- a/components/camel-lzf/src/main/docs/lzf-dataformat.adoc +++ b/components/camel-lzf/src/main/docs/lzf-dataformat.adoc @@ -1,7 +1,12 @@ [[lzf-dataformat]] = LZF Deflate Compression DataFormat +:docTitle: LZF Deflate Compression +:artifactId: camel-lzf +:description: The LZF data format is a message compression and de-compression format (uses the LZF deflate algorithm). +:since: 2.17 +:supportLevel: Stable -*Since Camel 2.17* +*Since Camel {since}* The LZF xref:manual::data-format.adoc[Data Format] is a message compression diff --git a/components/camel-mail/src/main/docs/mail-component.adoc b/components/camel-mail/src/main/docs/mail-component.adoc index 51049c24d1099..db52fde3a1035 100644 --- a/components/camel-mail/src/main/docs/mail-component.adoc +++ b/components/camel-mail/src/main/docs/mail-component.adoc @@ -1,11 +1,15 @@ [[mail-component]] = Mail Component +:docTitle: Mail +:artifactId: camel-mail +:description: To send or receive emails using imap/pop3 or smtp protocols. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Mail component provides access to Email via Spring's Mail support and the underlying JavaMail system. diff --git a/components/camel-mail/src/main/docs/mime-multipart-dataformat.adoc b/components/camel-mail/src/main/docs/mime-multipart-dataformat.adoc index 11a6f01d931bb..1210216764099 100644 --- a/components/camel-mail/src/main/docs/mime-multipart-dataformat.adoc +++ b/components/camel-mail/src/main/docs/mime-multipart-dataformat.adoc @@ -1,7 +1,12 @@ [[mime-multipart-dataformat]] = MIME Multipart DataFormat +:docTitle: MIME Multipart +:artifactId: camel-mail +:description: The MIME Multipart data format is used for marshalling Camel messages with attachments into MIME-Multipart message, and vise-versa. +:since: 2.17 +:supportLevel: Stable -*Since Camel 2.17* +*Since Camel {since}* This data format that can convert a Camel message with attachments into a Camel message having a MIME-Multipart message as message body (and no diff --git a/components/camel-master/src/main/docs/master-component.adoc b/components/camel-master/src/main/docs/master-component.adoc index ce6f7f0c7b21d..bb702dcbc6aeb 100644 --- a/components/camel-master/src/main/docs/master-component.adoc +++ b/components/camel-master/src/main/docs/master-component.adoc @@ -1,11 +1,15 @@ [[master-component]] = Master Component +:docTitle: Master +:artifactId: camel-master +:description: Represents an endpoint which only becomes active when the CamelClusterView has the leadership. +:since: 2.20 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Camel-Master endpoint provides a way to ensure only a single consumer in a cluster consumes from a given endpoint; with automatic failover if that JVM dies. diff --git a/components/camel-metrics/src/main/docs/metrics-component.adoc b/components/camel-metrics/src/main/docs/metrics-component.adoc index 15c01b45a091f..50ddbe4e91b37 100644 --- a/components/camel-metrics/src/main/docs/metrics-component.adoc +++ b/components/camel-metrics/src/main/docs/metrics-component.adoc @@ -1,11 +1,15 @@ [[metrics-component]] = Metrics Component +:docTitle: Metrics +:artifactId: camel-metrics +:description: To collect various metrics directly from Camel routes using the DropWizard metrics library. +:since: 2.14 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Metrics component allows to collect various metrics directly from Camel routes. Supported metric types diff --git a/components/camel-micrometer/src/main/docs/micrometer-component.adoc b/components/camel-micrometer/src/main/docs/micrometer-component.adoc index d1fe0df28e443..2f7c3f24e43fc 100644 --- a/components/camel-micrometer/src/main/docs/micrometer-component.adoc +++ b/components/camel-micrometer/src/main/docs/micrometer-component.adoc @@ -1,11 +1,15 @@ [[micrometer-component]] = Micrometer Component +:docTitle: Micrometer +:artifactId: camel-micrometer +:description: To collect various metrics directly from Camel routes using the Micrometer library. +:since: 2.22 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.22* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Micrometer component allows to collect various metrics directly from Camel routes. Supported metric types diff --git a/components/camel-microprofile-config/src/main/docs/microprofile-config.adoc b/components/camel-microprofile-config/src/main/docs/microprofile-config.adoc index 37013d317362b..4935796a6b583 100644 --- a/components/camel-microprofile-config/src/main/docs/microprofile-config.adoc +++ b/components/camel-microprofile-config/src/main/docs/microprofile-config.adoc @@ -1,7 +1,12 @@ -[[MicroProfileConfig]] -= MicroProfile Config +[[microprofile-config-component]] += Microprofile Config Component +:docTitle: Microprofile Config +:artifactId: camel-microprofile-config +:description: Bridging Eclipse MicroProfile Config with Camel properties +:since: 3.0 +:supportLevel: Stable -*Since Camel 3.0* +*Since Camel {since}* The microprofile-config component is used for bridging the Eclipse MicroProfile Config with Camels properties component. This allows to use configuration management from Eclipse MicroProfile with Camel. diff --git a/components/camel-microprofile-fault-tolerance/src/main/docs/microprofile-fault-tolerance.adoc b/components/camel-microprofile-fault-tolerance/src/main/docs/microprofile-fault-tolerance.adoc index da9d07cb85855..f48af0aa25d62 100644 --- a/components/camel-microprofile-fault-tolerance/src/main/docs/microprofile-fault-tolerance.adoc +++ b/components/camel-microprofile-fault-tolerance/src/main/docs/microprofile-fault-tolerance.adoc @@ -1,6 +1,12 @@ +[[microprofile-fault-tolerance-component]] = Microprofile Fault Tolerance Component +:docTitle: Microprofile Fault Tolerance +:artifactId: camel-microprofile-fault-tolerance +:description: Circuit Breaker EIP using Microprofile Fault Tolerance +:since: 3.3 +:supportLevel: Preview -*Since Camel 3.3* +*Since Camel {since}* This component supports the Circuit Breaker EIP with the Microprofile Fault Tolerance library. @@ -18,4 +24,3 @@ for this component: ---- - diff --git a/components/camel-microprofile-health/src/main/docs/microprofile-health.adoc b/components/camel-microprofile-health/src/main/docs/microprofile-health.adoc index 57d4a3ac26acf..2b4c27d149e34 100644 --- a/components/camel-microprofile-health/src/main/docs/microprofile-health.adoc +++ b/components/camel-microprofile-health/src/main/docs/microprofile-health.adoc @@ -1,7 +1,12 @@ -[[MicroProfileHealth-MicroProfileHealthComponent]] -= MicroProfile Health - -*Since Camel 3.0* +[[microprofile-health-component]] += Microprofile Health Component +:docTitle: Microprofile Health +:artifactId: camel-microprofile-health +:description: Bridging Eclipse MicroProfile Health with Camel health checks +:since: 3.0 +:supportLevel: Stable + +*Since Camel {since}* The microprofile-health component is used for bridging https://microprofile.io/project/eclipse/microprofile-health[Eclipse MicroProfile Health] checks with Camel's own Health Check API. diff --git a/components/camel-microprofile-metrics/src/main/docs/microprofile-metrics-component.adoc b/components/camel-microprofile-metrics/src/main/docs/microprofile-metrics-component.adoc index 17cd42ff3f22a..ba1007a4d9323 100644 --- a/components/camel-microprofile-metrics/src/main/docs/microprofile-metrics-component.adoc +++ b/components/camel-microprofile-metrics/src/main/docs/microprofile-metrics-component.adoc @@ -1,11 +1,15 @@ [[microprofile-metrics-component]] = MicroProfile Metrics Component +:docTitle: MicroProfile Metrics +:artifactId: camel-microprofile-metrics +:description: Camel metrics exposed with Eclipse MicroProfile Metrics +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The MircoProfile Metrics component provides the capability to expose metrics from Camel routes. diff --git a/components/camel-milo/src/main/docs/milo-client-component.adoc b/components/camel-milo/src/main/docs/milo-client-component.adoc index fc16e178d9b63..d5496eb72abc4 100644 --- a/components/camel-milo/src/main/docs/milo-client-component.adoc +++ b/components/camel-milo/src/main/docs/milo-client-component.adoc @@ -1,11 +1,15 @@ [[milo-client-component]] = OPC UA Client Component +:docTitle: OPC UA Client +:artifactId: camel-milo +:description: Connect to OPC UA servers using the binary protocol for acquiring telemetry data +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Milo Client component provides access to OPC UA servers using the http://eclipse.org/milo[Eclipse Miloâ„¢] implementation. diff --git a/components/camel-milo/src/main/docs/milo-server-component.adoc b/components/camel-milo/src/main/docs/milo-server-component.adoc index dd2bd6b531d1f..c662e442767eb 100644 --- a/components/camel-milo/src/main/docs/milo-server-component.adoc +++ b/components/camel-milo/src/main/docs/milo-server-component.adoc @@ -1,11 +1,15 @@ [[milo-server-component]] = OPC UA Server Component +:docTitle: OPC UA Server +:artifactId: camel-milo +:description: Make telemetry data available as an OPC UA server +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Milo Server component provides an OPC UA server using the http://eclipse.org/milo[Eclipse Miloâ„¢] implementation. diff --git a/components/camel-mina/src/main/docs/mina-component.adoc b/components/camel-mina/src/main/docs/mina-component.adoc index 3783ca8d217db..6748edf08f450 100644 --- a/components/camel-mina/src/main/docs/mina-component.adoc +++ b/components/camel-mina/src/main/docs/mina-component.adoc @@ -1,11 +1,15 @@ [[mina-component]] = Mina Component +:docTitle: Mina +:artifactId: camel-mina +:description: Socket level networking using TCP or UDP with the Apache Mina 2.x library. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Mina component is a transport for working with http://mina.apache.org/[Apache MINA 2.x] diff --git a/components/camel-mllp/src/main/docs/mllp-component.adoc b/components/camel-mllp/src/main/docs/mllp-component.adoc index 0c018f13778c7..df41c55091d13 100644 --- a/components/camel-mllp/src/main/docs/mllp-component.adoc +++ b/components/camel-mllp/src/main/docs/mllp-component.adoc @@ -1,11 +1,15 @@ [[mllp-component]] = MLLP Component +:docTitle: MLLP +:artifactId: camel-mllp +:description: Provides functionality required by Healthcare providers to communicate with other systems using the MLLP protocol. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The MLLP component is specifically designed to handle the nuances of the MLLP protocol and provide the functionality required by Healthcare diff --git a/components/camel-mock/src/main/docs/mock-component.adoc b/components/camel-mock/src/main/docs/mock-component.adoc index e7e26f273ec59..f121cbeb19485 100644 --- a/components/camel-mock/src/main/docs/mock-component.adoc +++ b/components/camel-mock/src/main/docs/mock-component.adoc @@ -1,11 +1,16 @@ [[mock-component]] = Mock Component +:docTitle: Mock +:artifactId: camel-mock +:description: The mock component is used for testing routes and mediation rules using mocks. +:since: 1.0 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* Testing of distributed and asynchronous processing is notoriously difficult. The xref:mock-component.adoc[Mock], xref:mock-component.adoc[Test] @@ -37,7 +42,7 @@ Expression. [NOTE] ==== -There is also the xref:test.adoc[Test endpoint] which is a +There is also the xref:others:test.adoc[Test endpoint] which is a Mock endpoint, but which uses a second endpoint to provide the list of expected message bodies and automatically sets up the Mock endpoint assertions. In other words, it's a Mock endpoint that automatically sets diff --git a/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc b/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc index 7aef8cf8b8771..dfcf131fcc98b 100644 --- a/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc +++ b/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc @@ -1,11 +1,15 @@ [[mongodb-gridfs-component]] = MongoDB GridFS Component +:docTitle: MongoDB GridFS +:artifactId: camel-mongodb-gridfs +:description: Component for working with MongoDB GridFS. +:since: 2.18 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Maven users will need to add the following dependency to their `pom.xml` for this component: diff --git a/components/camel-mongodb/src/main/docs/mongodb-component.adoc b/components/camel-mongodb/src/main/docs/mongodb-component.adoc index 19d70c75fdeb0..904733237c105 100644 --- a/components/camel-mongodb/src/main/docs/mongodb-component.adoc +++ b/components/camel-mongodb/src/main/docs/mongodb-component.adoc @@ -1,11 +1,15 @@ [[mongodb-component]] = MongoDB Component +:docTitle: MongoDB +:artifactId: camel-mongodb +:description: Component for working with documents stored in MongoDB database. +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* [NOTE] ==== diff --git a/components/camel-msv/src/main/docs/msv-component.adoc b/components/camel-msv/src/main/docs/msv-component.adoc index ceba083abcc1e..aa418a269259e 100644 --- a/components/camel-msv/src/main/docs/msv-component.adoc +++ b/components/camel-msv/src/main/docs/msv-component.adoc @@ -1,11 +1,15 @@ [[msv-component]] = MSV Component +:docTitle: MSV +:artifactId: camel-msv +:description: Validates the payload of a message using the MSV Library. +:since: 1.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The MSV component performs XML validation of the message body using the https://msv.dev.java.net/[MSV Library] and any of the supported XML diff --git a/components/camel-mustache/src/main/docs/mustache-component.adoc b/components/camel-mustache/src/main/docs/mustache-component.adoc index 295e5eb0c89ba..8957224db3367 100644 --- a/components/camel-mustache/src/main/docs/mustache-component.adoc +++ b/components/camel-mustache/src/main/docs/mustache-component.adoc @@ -1,11 +1,15 @@ [[mustache-component]] = Mustache Component +:docTitle: Mustache +:artifactId: camel-mustache +:description: Transforms the message using a Mustache template. +:since: 2.12 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Mustache component allows for processing a message using a http://mustache.github.io/[Mustache] template. This can be ideal when diff --git a/components/camel-mvel/src/main/docs/mvel-component.adoc b/components/camel-mvel/src/main/docs/mvel-component.adoc index 52149a4f92dec..264280f680516 100644 --- a/components/camel-mvel/src/main/docs/mvel-component.adoc +++ b/components/camel-mvel/src/main/docs/mvel-component.adoc @@ -1,11 +1,15 @@ [[mvel-component]] = MVEL Component +:docTitle: MVEL +:artifactId: camel-mvel +:description: Transforms the message using a MVEL template. +:since: 2.12 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The MVEL component allows you to process a message using an http://mvel.documentnode.com/[MVEL] template. This can be ideal when using diff --git a/components/camel-mvel/src/main/docs/mvel-language.adoc b/components/camel-mvel/src/main/docs/mvel-language.adoc index 1c22201319cbc..fd90dbbe203c4 100644 --- a/components/camel-mvel/src/main/docs/mvel-language.adoc +++ b/components/camel-mvel/src/main/docs/mvel-language.adoc @@ -1,7 +1,12 @@ [[mvel-language]] = MVEL Language +:docTitle: MVEL +:artifactId: camel-mvel +:description: To use MVEL scripts in Camel expressions or predicates. +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* Camel allows Mvel to be used as an Expression or Predicate the DSL or diff --git a/components/camel-mybatis/src/main/docs/mybatis-bean-component.adoc b/components/camel-mybatis/src/main/docs/mybatis-bean-component.adoc index 366b50c9e2d44..e8e061b6db901 100644 --- a/components/camel-mybatis/src/main/docs/mybatis-bean-component.adoc +++ b/components/camel-mybatis/src/main/docs/mybatis-bean-component.adoc @@ -1,11 +1,15 @@ [[mybatis-bean-component]] = MyBatis Bean Component +:docTitle: MyBatis Bean +:artifactId: camel-mybatis +:description: Performs a query, insert, update or delete in a relational database using MyBatis. +:since: 2.22 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.22* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The MyBatis Bean component allows you to query, insert, update and delete data in a relational database using http://mybatis.org/[MyBatis] bean annotations. diff --git a/components/camel-mybatis/src/main/docs/mybatis-component.adoc b/components/camel-mybatis/src/main/docs/mybatis-component.adoc index 5e57fe28cf43b..25d35f1f8911c 100644 --- a/components/camel-mybatis/src/main/docs/mybatis-component.adoc +++ b/components/camel-mybatis/src/main/docs/mybatis-component.adoc @@ -1,11 +1,15 @@ [[mybatis-component]] = MyBatis Component +:docTitle: MyBatis +:artifactId: camel-mybatis +:description: Performs a query, poll, insert, update or delete in a relational database using MyBatis. +:since: 2.7 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The MyBatis component allows you to query, poll, insert, update and delete data in a relational database using http://mybatis.org/[MyBatis]. diff --git a/components/camel-nagios/src/main/docs/nagios-component.adoc b/components/camel-nagios/src/main/docs/nagios-component.adoc index 27bfbcad36da4..bd0c0b5d21a2f 100644 --- a/components/camel-nagios/src/main/docs/nagios-component.adoc +++ b/components/camel-nagios/src/main/docs/nagios-component.adoc @@ -1,11 +1,15 @@ [[nagios-component]] = Nagios Component +:docTitle: Nagios +:artifactId: camel-nagios +:description: To send passive checks to Nagios using JSendNSCA. +:since: 2.3 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.3* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The xref:nagios-component.adoc[Nagios] component allows you to send passive checks to http://nagios.org[Nagios]. diff --git a/components/camel-nats/src/main/docs/nats-component.adoc b/components/camel-nats/src/main/docs/nats-component.adoc index 2421961361776..f374e706b0154 100644 --- a/components/camel-nats/src/main/docs/nats-component.adoc +++ b/components/camel-nats/src/main/docs/nats-component.adoc @@ -1,11 +1,15 @@ [[nats-component]] = Nats Component +:docTitle: Nats +:artifactId: camel-nats +:description: The nats component allows you produce and consume messages from NATS. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* http://nats.io/[NATS] is a fast and reliable messaging platform. diff --git a/components/camel-netty-http/src/main/docs/netty-http-component.adoc b/components/camel-netty-http/src/main/docs/netty-http-component.adoc index 92bb5e95b5610..de3970469c317 100644 --- a/components/camel-netty-http/src/main/docs/netty-http-component.adoc +++ b/components/camel-netty-http/src/main/docs/netty-http-component.adoc @@ -1,11 +1,15 @@ [[netty-http-component]] = Netty HTTP Component +:docTitle: Netty HTTP +:artifactId: camel-netty-http +:description: Netty HTTP server and client using the Netty 4.x library. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Netty HTTP component is an extension to xref:netty-component.adoc[Netty] component to facilitiate HTTP transport with xref:netty-component.adoc[Netty]. diff --git a/components/camel-netty/src/main/docs/netty-component.adoc b/components/camel-netty/src/main/docs/netty-component.adoc index 17b63f2d1e908..639a00f9ea6db 100644 --- a/components/camel-netty/src/main/docs/netty-component.adoc +++ b/components/camel-netty/src/main/docs/netty-component.adoc @@ -1,11 +1,15 @@ [[netty-component]] = Netty Component +:docTitle: Netty +:artifactId: camel-netty +:description: Socket level networking using TCP or UDP with the Netty 4.x library. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Netty component in Camel is a socket communication component, based on the http://netty.io/[Netty] project version 4. + diff --git a/components/camel-nitrite/src/main/docs/nitrite-component.adoc b/components/camel-nitrite/src/main/docs/nitrite-component.adoc index 89ba58e19caac..ae0fd33fdf2f9 100644 --- a/components/camel-nitrite/src/main/docs/nitrite-component.adoc +++ b/components/camel-nitrite/src/main/docs/nitrite-component.adoc @@ -1,11 +1,15 @@ [[nitrite-component]] = Nitrite Component +:docTitle: Nitrite +:artifactId: camel-nitrite +:description: Used for integrating Camel with Nitrite databases. +:since: 3.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Nitrite component is used to access https://github.com/dizitart/nitrite-database[Nitrite NoSQL database] diff --git a/components/camel-nsq/src/main/docs/nsq-component.adoc b/components/camel-nsq/src/main/docs/nsq-component.adoc index 7e9e18631f682..e322a062f55e9 100644 --- a/components/camel-nsq/src/main/docs/nsq-component.adoc +++ b/components/camel-nsq/src/main/docs/nsq-component.adoc @@ -1,11 +1,15 @@ [[nsq-component]] = NSQ Component +:docTitle: NSQ +:artifactId: camel-nsq +:description: Represents a nsq endpoint. +:since: 2.23 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* http://nsq.io/[NSQ] is a realtime distributed messaging platform. diff --git a/components/camel-ognl/src/main/docs/ognl-language.adoc b/components/camel-ognl/src/main/docs/ognl-language.adoc index 14067a168f5ee..22446544ffcf5 100644 --- a/components/camel-ognl/src/main/docs/ognl-language.adoc +++ b/components/camel-ognl/src/main/docs/ognl-language.adoc @@ -1,7 +1,12 @@ [[ognl-language]] = OGNL Language +:docTitle: OGNL +:artifactId: camel-ognl +:description: To use OGNL scripts in Camel expressions or predicates. +:since: 1.1 +:supportLevel: Stable -*Since Camel 1.1* +*Since Camel {since}* Camel allows http://commons.apache.org/proper/commons-ognl/[OGNL] to be used as an Expression or diff --git a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc index 10bc97e99b049..1bc3d1f491e4c 100644 --- a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc +++ b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc @@ -1,11 +1,15 @@ [[olingo2-component]] = Olingo2 Component +:docTitle: Olingo2 +:artifactId: camel-olingo2 +:description: Communicates with OData 2.0 services using Apache Olingo. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Olingo2 component utilizes http://olingo.apache.org/[Apache Olingo] version 2.0 APIs to interact with OData 2.0 compliant services. @@ -329,4 +333,3 @@ from("olingo2://read/Manufacturers?queryParams=#paramsBean&timeUnit=SECONDS&dela --------------------------------------------------------------------------------------------------------- include::camel-spring-boot::page$olingo2-starter.adoc[] - diff --git a/components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc b/components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc index 7e9abe7aa7a34..78aeb92adaeb7 100644 --- a/components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc +++ b/components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc @@ -1,11 +1,15 @@ [[olingo4-component]] = Olingo4 Component +:docTitle: Olingo4 +:artifactId: camel-olingo4 +:description: Communicates with OData 4.0 services using Apache Olingo OData API. +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Olingo4 component utilizes http://olingo.apache.org/[Apache Olingo] version 4.0 APIs to interact with OData 4.0 compliant service. @@ -307,4 +311,3 @@ from("direct:...") ------------------------------------------------------------ include::camel-spring-boot::page$olingo4-starter.adoc[] - diff --git a/components/camel-openapi-java/src/main/docs/openapi-java.adoc b/components/camel-openapi-java/src/main/docs/openapi-java.adoc index f46748275f891..ee1b6202b16d4 100644 --- a/components/camel-openapi-java/src/main/docs/openapi-java.adoc +++ b/components/camel-openapi-java/src/main/docs/openapi-java.adoc @@ -1,6 +1,12 @@ -= OpenApi Java Component - -*Available as of Camel 3.1.0* +[[openapi-java-component]] += Openapi Java Component +:docTitle: Openapi Java +:artifactId: camel-openapi-java +:description: Rest-dsl support for using openapi doc +:since: 3.1 +:supportLevel: Stable + +*Since Camel {since}* The Rest DSL can be integrated with the `camel-openapi-java` module which is used for exposing the REST diff --git a/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc b/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc index 737d500b46cf2..74a9e46853b8c 100644 --- a/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc @@ -1,11 +1,15 @@ [[openstack-cinder-component]] = OpenStack Cinder Component +:docTitle: OpenStack Cinder +:artifactId: camel-openstack +:description: The openstack-cinder component allows messages to be sent to an OpenStack block storage services. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Openstack Cinder component allows messages to be sent to an OpenStack block storage services. diff --git a/components/camel-openstack/src/main/docs/openstack-glance-component.adoc b/components/camel-openstack/src/main/docs/openstack-glance-component.adoc index 57b1553744131..bcdd82b4e1d18 100644 --- a/components/camel-openstack/src/main/docs/openstack-glance-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-glance-component.adoc @@ -1,11 +1,15 @@ [[openstack-glance-component]] = OpenStack Glance Component +:docTitle: OpenStack Glance +:artifactId: camel-openstack +:description: The openstack-glance component allows messages to be sent to an OpenStack image services. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Openstack Glance component allows messages to be sent to an OpenStack image services. diff --git a/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc b/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc index 3d0f9ee7457ca..8726218db1688 100644 --- a/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc @@ -1,11 +1,15 @@ [[openstack-keystone-component]] = OpenStack Keystone Component +:docTitle: OpenStack Keystone +:artifactId: camel-openstack +:description: The openstack-keystone component allows messages to be sent to an OpenStack identity services. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Openstack Keystone component allows messages to be sent to an OpenStack identity services. diff --git a/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc b/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc index da872029e921b..13b1a41424bef 100644 --- a/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc @@ -1,11 +1,15 @@ [[openstack-neutron-component]] = OpenStack Neutron Component +:docTitle: OpenStack Neutron +:artifactId: camel-openstack +:description: The openstack-neutron component allows messages to be sent to an OpenStack network services. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Openstack Neutron component allows messages to be sent to an OpenStack network services. diff --git a/components/camel-openstack/src/main/docs/openstack-nova-component.adoc b/components/camel-openstack/src/main/docs/openstack-nova-component.adoc index f298e9fceba00..62a9359561619 100644 --- a/components/camel-openstack/src/main/docs/openstack-nova-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-nova-component.adoc @@ -1,11 +1,15 @@ [[openstack-nova-component]] = OpenStack Nova Component +:docTitle: OpenStack Nova +:artifactId: camel-openstack +:description: The openstack-nova component allows messages to be sent to an OpenStack compute services. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Openstack Nova component allows messages to be sent to an OpenStack compute services. diff --git a/components/camel-openstack/src/main/docs/openstack.adoc b/components/camel-openstack/src/main/docs/openstack-summary.adoc similarity index 94% rename from components/camel-openstack/src/main/docs/openstack.adoc rename to components/camel-openstack/src/main/docs/openstack-summary.adoc index 0bb35c6e98d8d..e2d3f56d8bd02 100644 --- a/components/camel-openstack/src/main/docs/openstack.adoc +++ b/components/camel-openstack/src/main/docs/openstack-summary.adoc @@ -1,7 +1,10 @@ [[Openstack-OpenstackComponent]] = Openstack Component +//attributes written by hand, not generated +:docTitle: Openstack +:since: 2.19 -*Since Camel 2.19* +*Since Camel {since}* The Openstack component is a component for managing your https://www.openstack.org//[OpenStack] applications. diff --git a/components/camel-openstack/src/main/docs/openstack-swift-component.adoc b/components/camel-openstack/src/main/docs/openstack-swift-component.adoc index 8e85f540d32d8..34758f2148a03 100644 --- a/components/camel-openstack/src/main/docs/openstack-swift-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-swift-component.adoc @@ -1,11 +1,15 @@ [[openstack-swift-component]] = OpenStack Swift Component +:docTitle: OpenStack Swift +:artifactId: camel-openstack +:description: The openstack-swift component allows messages to be sent to an OpenStack object storage services. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Openstack Swift component allows messages to be sent to an OpenStack object storage services. diff --git a/components/camel-opentracing/src/main/docs/opentracing.adoc b/components/camel-opentracing/src/main/docs/opentracing.adoc index 03f8cb6376073..760ba099ddc0b 100644 --- a/components/camel-opentracing/src/main/docs/opentracing.adoc +++ b/components/camel-opentracing/src/main/docs/opentracing.adoc @@ -1,7 +1,12 @@ -[[OpenTracing-OpenTracingComponent]] +[[opentracing-component]] = OpenTracing Component +:docTitle: OpenTracing +:artifactId: camel-opentracing +:description: Distributed tracing using OpenTracing +:since: 2.19 +:supportLevel: Stable -*Since Camel 2.19* +*Since Camel {since}* The OpenTracing component is used for tracing and timing incoming and outgoing Camel messages using http://opentracing.io/[OpenTracing]. diff --git a/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc b/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc index 90ac521645ee3..fb84ac3942126 100644 --- a/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc +++ b/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc @@ -1,11 +1,15 @@ [[optaplanner-component]] = OptaPlanner Component +:docTitle: OptaPlanner +:artifactId: camel-optaplanner +:description: Solves the planning problem contained in a message with OptaPlanner. +:since: 2.13 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.13* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Optaplanner component solves the planning problem contained in a message with http://www.optaplanner.org/[OptaPlanner]. + diff --git a/components/camel-paho/src/main/docs/paho-component.adoc b/components/camel-paho/src/main/docs/paho-component.adoc index e96ac8203817c..e946b93d95f1a 100644 --- a/components/camel-paho/src/main/docs/paho-component.adoc +++ b/components/camel-paho/src/main/docs/paho-component.adoc @@ -1,11 +1,15 @@ [[paho-component]] = Paho Component +:docTitle: Paho +:artifactId: camel-paho +:description: Component for communicating with MQTT message brokers using Eclipse Paho MQTT Client. +:since: 2.16 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Paho component provides connector for the MQTT messaging protocol using the https://eclipse.org/paho/[Eclipse Paho] library. Paho is one of the diff --git a/components/camel-pdf/src/main/docs/pdf-component.adoc b/components/camel-pdf/src/main/docs/pdf-component.adoc index ab0ca3c98ce8a..d8ef7376012ad 100644 --- a/components/camel-pdf/src/main/docs/pdf-component.adoc +++ b/components/camel-pdf/src/main/docs/pdf-component.adoc @@ -1,11 +1,15 @@ [[pdf-component]] = PDF Component +:docTitle: PDF +:artifactId: camel-pdf +:description: The pdf components provides the ability to create, modify or extract content from PDF documents. +:since: 2.16 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The PDF components provides the ability to create, modify or extract content from PDF documents. This component uses diff --git a/components/camel-pg-replication-slot/src/main/docs/pg-replication-slot-component.adoc b/components/camel-pg-replication-slot/src/main/docs/pg-replication-slot-component.adoc index c897b8536ff9f..c10589e520c84 100644 --- a/components/camel-pg-replication-slot/src/main/docs/pg-replication-slot-component.adoc +++ b/components/camel-pg-replication-slot/src/main/docs/pg-replication-slot-component.adoc @@ -1,11 +1,15 @@ [[pg-replication-slot-component]] = PostgresSQL Replication Slot Component +:docTitle: PostgresSQL Replication Slot +:artifactId: camel-pg-replication-slot +:description: Consumer endpoint to receive from PostgreSQL Replication Slot. +:since: 3.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* This is a component for Apache Camel which allows for consuming from PostgreSQL replication slots. The component works with PostgreSQL 10 or later. diff --git a/components/camel-pgevent/src/main/docs/pgevent-component.adoc b/components/camel-pgevent/src/main/docs/pgevent-component.adoc index 968cd7fe7655a..4bd1fca1cf893 100644 --- a/components/camel-pgevent/src/main/docs/pgevent-component.adoc +++ b/components/camel-pgevent/src/main/docs/pgevent-component.adoc @@ -1,11 +1,15 @@ [[pgevent-component]] = PostgresSQL Event Component +:docTitle: PostgresSQL Event +:artifactId: camel-pgevent +:description: The pgevent component allows for producing/consuming PostgreSQL events related to the listen/notify commands. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This is a component for Apache Camel which allows for Producing/Consuming PostgreSQL events related to the LISTEN/NOTIFY diff --git a/components/camel-platform-http-vertx/src/main/docs/platform-http-vertx.adoc b/components/camel-platform-http-vertx/src/main/docs/platform-http-vertx.adoc index 26a5648fd31d5..eb33c4d27c864 100644 --- a/components/camel-platform-http-vertx/src/main/docs/platform-http-vertx.adoc +++ b/components/camel-platform-http-vertx/src/main/docs/platform-http-vertx.adoc @@ -1,6 +1,12 @@ -= PlatformHttp VertX +[[platform-http-vertx-component]] += Platform Http Vertx Component +:docTitle: Platform Http Vertx +:artifactId: camel-platform-http-vertx +:description: Implementation of the Platform HTTP Engine based on Vert.x Web +:since: 3.2 +:supportLevel: Stable -*Since Camel 3.2* +*Since Camel {since}* The camel-platform-http-vertx is a Vert.x based implementation of the `PlatformHttp` SPI. @@ -42,4 +48,4 @@ context.addRoutes(new RouteBuilder() { }); context.start(); ----- \ No newline at end of file +---- diff --git a/components/camel-platform-http/src/main/docs/platform-http-component.adoc b/components/camel-platform-http/src/main/docs/platform-http-component.adoc index 8f7e43d25118d..7082263a0d834 100644 --- a/components/camel-platform-http/src/main/docs/platform-http-component.adoc +++ b/components/camel-platform-http/src/main/docs/platform-http-component.adoc @@ -1,11 +1,15 @@ [[platform-http-component]] = Platform HTTP Component +:docTitle: Platform HTTP +:artifactId: camel-platform-http +:description: HTTP service leveraging existing runtime platform HTTP server +:since: 3.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* *Since Camel 3.0* diff --git a/components/camel-printer/src/main/docs/lpr-component.adoc b/components/camel-printer/src/main/docs/lpr-component.adoc index 28d8f93559518..0b2bd08010df6 100644 --- a/components/camel-printer/src/main/docs/lpr-component.adoc +++ b/components/camel-printer/src/main/docs/lpr-component.adoc @@ -1,11 +1,15 @@ [[lpr-component]] = Printer Component +:docTitle: Printer +:artifactId: camel-printer +:description: The printer component is used for sending messages to printers as print jobs. +:since: 2.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Printer component provides a way to direct payloads on a route to a printer. Obviously the payload has to be a formatted piece of payload diff --git a/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc b/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc index a02bd248a3638..ad889b0d950ae 100644 --- a/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc +++ b/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc @@ -1,7 +1,12 @@ [[protobuf-dataformat]] = Protobuf DataFormat -[[Protobuf-Protobuf-ProtocolBuffers]] -*Since Camel 2.2.0* +:docTitle: Protobuf +:artifactId: camel-protobuf +:description: The Protobuf data format is used for serializing between Java objects and the Google Protobuf protocol. +:since: 2.2 +:supportLevel: Stable + +*Since Camel {since}* Protobuf - Protocol Buffers --------------------------- diff --git a/components/camel-pubnub/src/main/docs/pubnub-component.adoc b/components/camel-pubnub/src/main/docs/pubnub-component.adoc index 7cd44741d9c0e..c65099872755e 100644 --- a/components/camel-pubnub/src/main/docs/pubnub-component.adoc +++ b/components/camel-pubnub/src/main/docs/pubnub-component.adoc @@ -1,11 +1,15 @@ [[pubnub-component]] = PubNub Component +:docTitle: PubNub +:artifactId: camel-pubnub +:description: To send and receive messages to PubNub data stream network for connected devices. +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Camel PubNub component can be used to communicate with the https://www.pubnub.com/[PubNub] data stream network for connected devices. This component uses pubnub https://github.com/pubnub/java[java library]. diff --git a/components/camel-pulsar/src/main/docs/pulsar-component.adoc b/components/camel-pulsar/src/main/docs/pulsar-component.adoc index 8f78530519ac7..0b601fbf14094 100644 --- a/components/camel-pulsar/src/main/docs/pulsar-component.adoc +++ b/components/camel-pulsar/src/main/docs/pulsar-component.adoc @@ -1,11 +1,15 @@ [[pulsar-component]] = Pulsar Component +:docTitle: Pulsar +:artifactId: camel-pulsar +:description: Camel Apache Pulsar Component +:since: 2.24 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.24* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Maven users will need to add the following dependency to their `pom.xml` for this component. diff --git a/components/camel-quartz/src/main/docs/quartz-component.adoc b/components/camel-quartz/src/main/docs/quartz-component.adoc index 94da0fbeba599..ea96fb489cd25 100644 --- a/components/camel-quartz/src/main/docs/quartz-component.adoc +++ b/components/camel-quartz/src/main/docs/quartz-component.adoc @@ -1,11 +1,15 @@ [[quartz-component]] = Quartz Component +:docTitle: Quartz +:artifactId: camel-quartz +:description: Provides a scheduled delivery of messages using the Quartz 2.x scheduler. +:since: 2.12 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Quartz component provides a scheduled delivery of messages using the http://www.quartz-scheduler.org/[Quartz Scheduler 2.x]. + diff --git a/components/camel-quickfix/src/main/docs/quickfix-component.adoc b/components/camel-quickfix/src/main/docs/quickfix-component.adoc index 8ff1a7011ff4b..f6d3258b7eb67 100644 --- a/components/camel-quickfix/src/main/docs/quickfix-component.adoc +++ b/components/camel-quickfix/src/main/docs/quickfix-component.adoc @@ -1,11 +1,15 @@ [[quickfix-component]] = QuickFix Component +:docTitle: QuickFix +:artifactId: camel-quickfix +:description: The quickfix component allows to send Financial Interchange (FIX) messages to the QuickFix engine. +:since: 2.1 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.1* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Quickfix component adapts the http://www.quickfixj.org/[QuickFIX/J] FIX engine for using in Camel . diff --git a/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc b/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc index 5deb41408fa42..ea1f0f87e4367 100644 --- a/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc +++ b/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc @@ -1,11 +1,15 @@ [[rabbitmq-component]] = RabbitMQ Component +:docTitle: RabbitMQ +:artifactId: camel-rabbitmq +:description: The rabbitmq component allows you produce and consume messages from RabbitMQ instances. +:since: 2.12 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The RabbitMQ component allows you produce and consume messages from http://www.rabbitmq.com/[RabbitMQ] instances. Using the RabbitMQ AMQP diff --git a/components/camel-reactive-executor-vertx/src/main/docs/reactive-executor-vertx.adoc b/components/camel-reactive-executor-vertx/src/main/docs/reactive-executor-vertx.adoc index deafd3581a18d..d76c301ff51c5 100644 --- a/components/camel-reactive-executor-vertx/src/main/docs/reactive-executor-vertx.adoc +++ b/components/camel-reactive-executor-vertx/src/main/docs/reactive-executor-vertx.adoc @@ -1,6 +1,12 @@ -= ReactiveExecutor VertX - -*Since Camel 3.0* +[[reactive-executor-vertx-component]] += Reactive Executor Vert.x Component +:docTitle: Reactive Executor Vert.x +:artifactId: camel-reactive-executor-vertx +:description: Reactive Executor for camel-core using Vert.x +:since: 3.0 +:supportLevel: Experimental + +*Since Camel {since}* The camel-reactive-executor-vertx is a VertX based implementation of the `ReactiveExecutor` SPI. diff --git a/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc b/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc index eb337b63faebd..5f0f1801c3be9 100644 --- a/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc +++ b/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc @@ -1,11 +1,15 @@ [[reactive-streams-component]] = Reactive Streams Component +:docTitle: Reactive Streams +:artifactId: camel-reactive-streams +:description: Reactive Camel using reactive streams +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Reactive Streams component allows you to exchange messages with reactive stream processing libraries compatible with the diff --git a/components/camel-reactor/src/main/docs/reactor.adoc b/components/camel-reactor/src/main/docs/reactor.adoc index d450ff22a82a7..24f208bd9c2ce 100644 --- a/components/camel-reactor/src/main/docs/reactor.adoc +++ b/components/camel-reactor/src/main/docs/reactor.adoc @@ -1,6 +1,12 @@ +[[reactor-component]] = Reactor Component +:docTitle: Reactor +:artifactId: camel-reactor +:description: Reactor based back-end for Camel's reactive streams component +:since: 2.20 +:supportLevel: Stable -*Since Camel 2.20* +*Since Camel {since}* Maven users will need to add the following dependency to their `pom.xml` for this component: diff --git a/components/camel-ref/src/main/docs/ref-component.adoc b/components/camel-ref/src/main/docs/ref-component.adoc index 9a5b4bb56d6a1..f1b88ccbe48bb 100644 --- a/components/camel-ref/src/main/docs/ref-component.adoc +++ b/components/camel-ref/src/main/docs/ref-component.adoc @@ -1,11 +1,16 @@ [[ref-component]] = Ref Component +:docTitle: Ref +:artifactId: camel-ref +:description: The ref component is used for lookup of existing endpoints bound in the Registry. +:since: 1.2 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 1.2* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Ref component is used for lookup of existing endpoints bound in the Registry. diff --git a/components/camel-resilience4j/src/main/docs/resilience4j.adoc b/components/camel-resilience4j/src/main/docs/resilience4j.adoc index 84256063f64e8..e78c2d572f134 100644 --- a/components/camel-resilience4j/src/main/docs/resilience4j.adoc +++ b/components/camel-resilience4j/src/main/docs/resilience4j.adoc @@ -1,6 +1,12 @@ +[[resilience4j-component]] = Resilience4j Component +:docTitle: Resilience4j +:artifactId: camel-resilience4j +:description: Circuit Breaker EIP using Resilience4j +:since: 3.0 +:supportLevel: Stable -*Since Camel 3.0* +*Since Camel {since}* This component supports the Circuit Breaker EIP with the Resilience4j library. @@ -18,4 +24,3 @@ for this component: ---- - diff --git a/components/camel-rest-openapi/src/main/docs/rest-openapi-component.adoc b/components/camel-rest-openapi/src/main/docs/rest-openapi-component.adoc index 1215428d02596..9bbff556ba8bd 100644 --- a/components/camel-rest-openapi/src/main/docs/rest-openapi-component.adoc +++ b/components/camel-rest-openapi/src/main/docs/rest-openapi-component.adoc @@ -1,14 +1,16 @@ [[rest-openapi-component]] = REST OpenApi Component -= REST OpenApi Component -*Since Camel 3.1* +:docTitle: REST OpenApi +:artifactId: camel-rest-openapi +:description: An awesome REST endpoint backed by OpenApi specifications. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The REST OpenApi* configures rest producers from https://www.openapis.org/[OpenApi] (Open API) specification document and diff --git a/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc b/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc index 1f881236a6cfb..ceb480c287367 100644 --- a/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc +++ b/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc @@ -1,11 +1,15 @@ [[rest-swagger-component]] = REST Swagger Component +:docTitle: REST Swagger +:artifactId: camel-rest-swagger +:description: An awesome REST endpoint backed by Swagger specifications. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The REST Swagger* configures rest producers from http://swagger.io/[Swagger] (Open API) specification document and diff --git a/components/camel-rest/src/main/docs/rest-api-component.adoc b/components/camel-rest/src/main/docs/rest-api-component.adoc index 3cb63bf90f12e..557fb654914de 100644 --- a/components/camel-rest/src/main/docs/rest-api-component.adoc +++ b/components/camel-rest/src/main/docs/rest-api-component.adoc @@ -1,11 +1,16 @@ [[rest-api-component]] = REST API Component +:docTitle: REST API +:artifactId: camel-rest +:description: The rest-api component is used for providing Swagger API of the REST services which has been defined using the rest-dsl in Camel. +:since: 2.16 +:supportLevel: Stable +:component-header: Only consumer is supported +:core: -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The REST API component is used for providing Swagger API of the REST services which has been defined using the rest-dsl in Camel. diff --git a/components/camel-rest/src/main/docs/rest-component.adoc b/components/camel-rest/src/main/docs/rest-component.adoc index cf51bad428927..683bc2306a06a 100644 --- a/components/camel-rest/src/main/docs/rest-component.adoc +++ b/components/camel-rest/src/main/docs/rest-component.adoc @@ -1,11 +1,16 @@ [[rest-component]] = REST Component +:docTitle: REST +:artifactId: camel-rest +:description: The rest component is used for either hosting REST services (consumer) or calling external REST services (producer). +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The REST component allows to define REST endpoints (consumer) using the Rest DSL and plugin to other Camel components as the diff --git a/components/camel-ribbon/src/main/docs/ribbon.adoc b/components/camel-ribbon/src/main/docs/ribbon.adoc index 7eea6ec974c5c..a8ecc3a6b2047 100644 --- a/components/camel-ribbon/src/main/docs/ribbon.adoc +++ b/components/camel-ribbon/src/main/docs/ribbon.adoc @@ -1,6 +1,12 @@ +[[ribbon-component]] = Ribbon Component +:docTitle: Ribbon +:artifactId: camel-ribbon +:description: Using Netflix Ribbon for client side load balancing +:since: 2.18 +:supportLevel: Stable -*Since Camel 2.18* +*Since Camel {since}* The Ribbon component provides use of Netflix Ribbon for client side load balancing. @@ -73,4 +79,3 @@ from("direct:start") ---- - diff --git a/components/camel-robotframework/src/main/docs/robotframework-component.adoc b/components/camel-robotframework/src/main/docs/robotframework-component.adoc index a93d77d21bda1..219fcd1c6e0e9 100644 --- a/components/camel-robotframework/src/main/docs/robotframework-component.adoc +++ b/components/camel-robotframework/src/main/docs/robotframework-component.adoc @@ -1,11 +1,15 @@ [[robotframework-component]] = Robot Framework Component +:docTitle: Robot Framework +:artifactId: camel-robotframework +:description: Represents a RobotFramework endpoint. +:since: 3.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The *robotframework:* component allows for processing camel exchanges diff --git a/components/camel-rss/src/main/docs/rss-component.adoc b/components/camel-rss/src/main/docs/rss-component.adoc index a53d762957111..a8f99505d73de 100644 --- a/components/camel-rss/src/main/docs/rss-component.adoc +++ b/components/camel-rss/src/main/docs/rss-component.adoc @@ -1,11 +1,15 @@ [[rss-component]] = RSS Component +:docTitle: RSS +:artifactId: camel-rss +:description: The rss component is used for consuming RSS feeds. +:since: 2.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The RSS component is used for polling RSS feeds. Camel will default poll the feed every 60th seconds. diff --git a/components/camel-rss/src/main/docs/rss-dataformat.adoc b/components/camel-rss/src/main/docs/rss-dataformat.adoc index de7adff198c75..ea2b46d54bf2d 100644 --- a/components/camel-rss/src/main/docs/rss-dataformat.adoc +++ b/components/camel-rss/src/main/docs/rss-dataformat.adoc @@ -1,7 +1,12 @@ [[rss-dataformat]] = RSS DataFormat +:docTitle: RSS +:artifactId: camel-rss +:description: RSS data format is used for working with RSS sync feed Java Objects and transforming to XML and vice-versa. +:since: 2.1 +:supportLevel: Stable -*Since Camel 2.1* +*Since Camel {since}* The RSS component ships with an RSS dataformat that can be used to convert between String (as XML) and ROME RSS model objects. diff --git a/components/camel-rxjava/src/main/docs/rxjava.adoc b/components/camel-rxjava/src/main/docs/rxjava.adoc index 083dde4e81922..70f7f76432c95 100644 --- a/components/camel-rxjava/src/main/docs/rxjava.adoc +++ b/components/camel-rxjava/src/main/docs/rxjava.adoc @@ -1,6 +1,12 @@ +[[rxjava-component]] = RxJava Component +:docTitle: RxJava +:artifactId: camel-rxjava +:description: RxJava based back-end for Camel's reactive streams component +:since: 2.22 +:supportLevel: Stable -*Since Camel 2.22* +*Since Camel {since}* RxJava based back-end for Camel's reactive streams component. diff --git a/components/camel-saga/src/main/docs/saga-component.adoc b/components/camel-saga/src/main/docs/saga-component.adoc index d1789402769f5..83faf3f226e42 100644 --- a/components/camel-saga/src/main/docs/saga-component.adoc +++ b/components/camel-saga/src/main/docs/saga-component.adoc @@ -1,11 +1,16 @@ [[saga-component]] = Saga Component +:docTitle: Saga +:artifactId: camel-saga +:description: The saga component provides access to advanced options for managing the flow in the Saga EIP. +:since: 2.21 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 2.21* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Saga component provides a bridge to execute custom actions within a route using the Saga EIP. diff --git a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc index 80432d6a27ac4..94eb5345ba7b9 100644 --- a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc +++ b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc @@ -1,11 +1,15 @@ [[salesforce-component]] = Salesforce Component +:docTitle: Salesforce +:artifactId: camel-salesforce +:description: The salesforce component is used for integrating Camel with the massive Salesforce API. +:since: 2.12 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component supports producer and consumer endpoints to communicate with Salesforce using Java DTOs. + @@ -817,4 +821,3 @@ with the following path and query parameters: // endpoint options: END include::camel-spring-boot::page$salesforce-starter.adoc[] - diff --git a/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc b/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc index db6c66c1c5743..5f6cf3d34bab8 100644 --- a/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc +++ b/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc @@ -1,11 +1,15 @@ [[sap-netweaver-component]] = SAP NetWeaver Component +:docTitle: SAP NetWeaver +:artifactId: camel-sap-netweaver +:description: The sap-netweaver component integrates with the SAP NetWeaver Gateway using HTTP transports. +:since: 2.12 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The SAP Netweaver integrates with the http://scn.sap.com/community/developer-center/netweaver-gateway[SAP diff --git a/components/camel-saxon/src/main/docs/xquery-component.adoc b/components/camel-saxon/src/main/docs/xquery-component.adoc index aa97e80e870b1..8a3b49303306b 100644 --- a/components/camel-saxon/src/main/docs/xquery-component.adoc +++ b/components/camel-saxon/src/main/docs/xquery-component.adoc @@ -1,11 +1,15 @@ [[xquery-component]] = XQuery Component +:docTitle: XQuery +:artifactId: camel-saxon +:description: Transforms the message using a XQuery template using Saxon. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Camel supports http://www.w3.org/TR/xquery/[XQuery] to allow an Expression or Predicate to be diff --git a/components/camel-saxon/src/main/docs/xquery-language.adoc b/components/camel-saxon/src/main/docs/xquery-language.adoc index c833a98bf52d9..b96c5398b79ad 100644 --- a/components/camel-saxon/src/main/docs/xquery-language.adoc +++ b/components/camel-saxon/src/main/docs/xquery-language.adoc @@ -1,7 +1,12 @@ [[xquery-language]] = XQuery Language +:docTitle: XQuery +:artifactId: camel-saxon +:description: To use XQuery (XML) in Camel expressions or predicates. +:since: 1.0 +:supportLevel: Stable -*Since Camel 1.0* +*Since Camel {since}* Camel supports http://www.w3.org/TR/xquery/[XQuery] to allow an Expression or Predicate to be diff --git a/components/camel-scheduler/src/main/docs/scheduler-component.adoc b/components/camel-scheduler/src/main/docs/scheduler-component.adoc index 81f8fa036406f..16c65dbd5d3cf 100644 --- a/components/camel-scheduler/src/main/docs/scheduler-component.adoc +++ b/components/camel-scheduler/src/main/docs/scheduler-component.adoc @@ -1,11 +1,16 @@ [[scheduler-component]] = Scheduler Component +:docTitle: Scheduler +:artifactId: camel-scheduler +:description: The scheduler component is used for generating message exchanges when a scheduler fires. +:since: 2.15 +:supportLevel: Stable +:component-header: Only consumer is supported +:core: -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Scheduler component is used to generate message exchanges when a scheduler fires. This component is similar to the diff --git a/components/camel-schematron/src/main/docs/schematron-component.adoc b/components/camel-schematron/src/main/docs/schematron-component.adoc index 8c11a6ea074ba..05e61d5534274 100644 --- a/components/camel-schematron/src/main/docs/schematron-component.adoc +++ b/components/camel-schematron/src/main/docs/schematron-component.adoc @@ -1,11 +1,15 @@ [[schematron-component]] = Schematron Component +:docTitle: Schematron +:artifactId: camel-schematron +:description: Validates the payload of a message using the Schematron Library. +:since: 2.15 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* http://www.schematron.com/index.html[Schematron] is an XML-based language for validating XML instance documents. It is used to make diff --git a/components/camel-seda/src/main/docs/seda-component.adoc b/components/camel-seda/src/main/docs/seda-component.adoc index 5b063cb83ee94..3f77ec8df7148 100644 --- a/components/camel-seda/src/main/docs/seda-component.adoc +++ b/components/camel-seda/src/main/docs/seda-component.adoc @@ -1,11 +1,16 @@ [[seda-component]] = SEDA Component +:docTitle: SEDA +:artifactId: camel-seda +:description: The seda component provides asynchronous call to another endpoint from any CamelContext in the same JVM. +:since: 1.1 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The SEDA component provides asynchronous https://en.wikipedia.org/wiki/Staged_event-driven_architecture[SEDA] behavior, so that diff --git a/components/camel-service/src/main/docs/service-component.adoc b/components/camel-service/src/main/docs/service-component.adoc index bbbb36aaf7f5d..f60a4a7485000 100644 --- a/components/camel-service/src/main/docs/service-component.adoc +++ b/components/camel-service/src/main/docs/service-component.adoc @@ -1,11 +1,15 @@ [[service-component]] = Service Component +:docTitle: Service +:artifactId: camel-service +:description: Represents an endpoint which is registered to a Service Registry such as Consul, Etcd. +:since: 2.22 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.22* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* == Using the service endpoint diff --git a/components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc b/components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc index e94a0572215c1..02df4b3155ddc 100644 --- a/components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc +++ b/components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc @@ -1,11 +1,15 @@ [[servicenow-component]] = ServiceNow Component +:docTitle: ServiceNow +:artifactId: camel-servicenow +:description: The servicenow component is used to integrate Camel with ServiceNow cloud services. +:since: 2.18 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The ServiceNow component provides access to ServiceNow platform through their REST API. @@ -357,4 +361,3 @@ FluentProducerTemplate.on(context) ------------------------------------------------------------------------------------------------------------------- include::camel-spring-boot::page$servicenow-starter.adoc[] - diff --git a/components/camel-servlet/src/main/docs/servlet-component.adoc b/components/camel-servlet/src/main/docs/servlet-component.adoc index 3283f34f1e8e2..7301ddeb6c90f 100644 --- a/components/camel-servlet/src/main/docs/servlet-component.adoc +++ b/components/camel-servlet/src/main/docs/servlet-component.adoc @@ -1,11 +1,15 @@ [[servlet-component]] = Servlet Component +:docTitle: Servlet +:artifactId: camel-servlet +:description: To use a HTTP Servlet as entry for Camel routes when running in a servlet container. +:since: 2.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Servlet component provides HTTP based endpoints for consuming HTTP requests that arrive at diff --git a/components/camel-shiro/src/main/docs/shiro.adoc b/components/camel-shiro/src/main/docs/shiro.adoc index b8b6e4711b721..46e4099ab1f76 100644 --- a/components/camel-shiro/src/main/docs/shiro.adoc +++ b/components/camel-shiro/src/main/docs/shiro.adoc @@ -1,7 +1,12 @@ -[[ShiroSecurity-ShiroSecurityComponent]] -= Shiro Security Component +[[shiro-component]] += Shiro Component +:docTitle: Shiro +:artifactId: camel-shiro +:description: Security using Shiro +:since: 2.5 +:supportLevel: Stable -*Since Camel 2.5* +*Since Camel {since}* The Shiro Security component in Camel is a security focused component, based on the Apache Shiro security project. @@ -131,7 +136,7 @@ of the roles in the list are applicable. these or pass in your own Cipher implementation |`base64` |`false` |`boolean` |To use base64 encoding for the security token header, -which allows transferring the header over xref:jms-component.adoc[JMS] etc. This +which allows transferring the header over xref:ROOT:jms-component.adoc[JMS] etc. This option must also be set on `ShiroSecurityTokenInjector` as well. |`allPermissionsRequired` |`false` |`boolean` |The default is that authorization is granted if any of the diff --git a/components/camel-sip/src/main/docs/sip-component.adoc b/components/camel-sip/src/main/docs/sip-component.adoc index 32e07252aa983..51a285af1a8ac 100644 --- a/components/camel-sip/src/main/docs/sip-component.adoc +++ b/components/camel-sip/src/main/docs/sip-component.adoc @@ -1,11 +1,15 @@ [[sip-component]] = SIP Component +:docTitle: SIP +:artifactId: camel-sip +:description: To send and receive messages using the SIP protocol (used in telco and mobile). +:since: 2.5 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.5* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The SIP component in Camel is a communication component, based on the Jain SIP implementation (available under the JCP license). diff --git a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc index ec2542377dffd..3d8ccebfd1e96 100644 --- a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc +++ b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc @@ -1,11 +1,15 @@ [[sjms-batch-component]] = Simple JMS Batch Component +:docTitle: Simple JMS Batch +:artifactId: camel-sjms +:description: The sjms-batch component is a specialized for highly performant, transactional batch consumption from a JMS queue. +:since: 2.16 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* SJMS Batch is a specialized component for highly performant, transactional batch consumption from a JMS queue. It can be thought of diff --git a/components/camel-sjms/src/main/docs/sjms-component.adoc b/components/camel-sjms/src/main/docs/sjms-component.adoc index d09be19bdc75f..4bef25d6e262e 100644 --- a/components/camel-sjms/src/main/docs/sjms-component.adoc +++ b/components/camel-sjms/src/main/docs/sjms-component.adoc @@ -1,11 +1,15 @@ [[sjms-component]] = Simple JMS Component +:docTitle: Simple JMS +:artifactId: camel-sjms +:description: The sjms component (simple jms) allows messages to be sent to (or consumed from) a JMS Queue or Topic (uses JMS 1.x API). +:since: 2.11 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.11* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Simple JMS Component, or SJMS, is a JMS client for use with Camel that uses well known best practices when it comes to JMS client creation diff --git a/components/camel-sjms2/src/main/docs/sjms2-component.adoc b/components/camel-sjms2/src/main/docs/sjms2-component.adoc index a7d15a97dfb7f..d1af381ea9e88 100644 --- a/components/camel-sjms2/src/main/docs/sjms2-component.adoc +++ b/components/camel-sjms2/src/main/docs/sjms2-component.adoc @@ -1,11 +1,15 @@ [[sjms2-component]] = Simple JMS2 Component +:docTitle: Simple JMS2 +:artifactId: camel-sjms2 +:description: The sjms2 component (simple jms) allows messages to be sent to (or consumed from) a JMS Queue or Topic (uses JMS 2.x API). +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Simple JMS 2.0 Component, or SJMS2, is a JMS client for use with Camel that uses well known best practices when it comes to JMS client creation diff --git a/components/camel-slack/src/main/docs/slack-component.adoc b/components/camel-slack/src/main/docs/slack-component.adoc index 44bb526262eb9..0e85897641654 100644 --- a/components/camel-slack/src/main/docs/slack-component.adoc +++ b/components/camel-slack/src/main/docs/slack-component.adoc @@ -1,11 +1,15 @@ [[slack-component]] = Slack Component +:docTitle: Slack +:artifactId: camel-slack +:description: The slack component allows you to send messages to Slack. +:since: 2.16 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Slack component allows you to connect to an instance of http://www.slack.com/[Slack] and delivers a message contained in the diff --git a/components/camel-smpp/src/main/docs/smpp-component.adoc b/components/camel-smpp/src/main/docs/smpp-component.adoc index c478dbd0a3f08..c7964a2d8f1cf 100644 --- a/components/camel-smpp/src/main/docs/smpp-component.adoc +++ b/components/camel-smpp/src/main/docs/smpp-component.adoc @@ -1,11 +1,15 @@ [[smpp-component]] = SMPP Component +:docTitle: SMPP +:artifactId: camel-smpp +:description: To send and receive SMS using a SMSC (Short Message Service Center). +:since: 2.2 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.2* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component provides access to an SMSC (Short Message Service Center) over the http://smsforum.net/SMPP_v3_4_Issue1_2.zip[SMPP] protocol to diff --git a/components/camel-snakeyaml/src/main/docs/yaml-snakeyaml-dataformat.adoc b/components/camel-snakeyaml/src/main/docs/yaml-snakeyaml-dataformat.adoc index 362dab82eee3c..bf02e88980ebd 100644 --- a/components/camel-snakeyaml/src/main/docs/yaml-snakeyaml-dataformat.adoc +++ b/components/camel-snakeyaml/src/main/docs/yaml-snakeyaml-dataformat.adoc @@ -1,7 +1,12 @@ [[yaml-snakeyaml-dataformat]] = YAML SnakeYAML DataFormat +:docTitle: YAML SnakeYAML +:artifactId: camel-snakeyaml +:description: YAML is a data format to marshal and unmarshal Java objects to and from YAML. +:since: 2.17 +:supportLevel: Stable -*Since Camel 2.17* +*Since Camel {since}* YAML is a Data Format to marshal and unmarshal Java objects to and from http://www.yaml.org/[YAML]. diff --git a/components/camel-snmp/src/main/docs/snmp-component.adoc b/components/camel-snmp/src/main/docs/snmp-component.adoc index 8ad27460a99d5..e42a9c81fead8 100644 --- a/components/camel-snmp/src/main/docs/snmp-component.adoc +++ b/components/camel-snmp/src/main/docs/snmp-component.adoc @@ -1,11 +1,15 @@ [[snmp-component]] = SNMP Component +:docTitle: SNMP +:artifactId: camel-snmp +:description: The snmp component gives you the ability to poll SNMP capable devices or receiving traps. +:since: 2.1 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.1* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The SNMP component gives you the ability to poll SNMP capable devices or receiving traps diff --git a/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc b/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc index b90168cc9ccdf..38c31fe2b7640 100644 --- a/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc +++ b/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc @@ -1,7 +1,12 @@ [[soapjaxb-dataformat]] = SOAP DataFormat +:docTitle: SOAP +:artifactId: camel-soap +:description: SOAP is a data format which uses JAXB2 and JAX-WS annotations to marshal and unmarshal SOAP payloads. +:since: 2.3 +:supportLevel: Stable -*Since Camel 2.3* +*Since Camel {since}* SOAP is a Data Format which uses JAXB2 and JAX-WS annotations to marshal and unmarshal SOAP payloads. It provides the diff --git a/components/camel-solr/src/main/docs/solr-component.adoc b/components/camel-solr/src/main/docs/solr-component.adoc index eba8ed8fd1998..6a6f41678996c 100644 --- a/components/camel-solr/src/main/docs/solr-component.adoc +++ b/components/camel-solr/src/main/docs/solr-component.adoc @@ -1,11 +1,15 @@ [[solr-component]] = Solr Component +:docTitle: Solr +:artifactId: camel-solr +:description: The solr component allows you to interface with an Apache Lucene Solr server. +:since: 2.9 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.9* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Solr component allows you to interface with an http://lucene.apache.org/solr/[Apache Lucene Solr] server (based on diff --git a/components/camel-soroush/src/main/docs/soroush-component.adoc b/components/camel-soroush/src/main/docs/soroush-component.adoc index 1f4a357705b23..8cb239902e287 100644 --- a/components/camel-soroush/src/main/docs/soroush-component.adoc +++ b/components/camel-soroush/src/main/docs/soroush-component.adoc @@ -1,11 +1,15 @@ [[soroush-component]] = Soroush Component +:docTitle: Soroush +:artifactId: camel-soroush +:description: To integrate with the Soroush chat bot. +:since: 3.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Soroush component provides access to the https://soroush-app.ir/developer.html[Soroush Bot API]. It allows a Camel-based application to send and receive messages by acting as a Bot, i.e. participating in direct conversation with normal users and send and receive message and files diff --git a/components/camel-spark/src/main/docs/spark-component.adoc b/components/camel-spark/src/main/docs/spark-component.adoc index a740c8f5aed30..3b29cac48c932 100644 --- a/components/camel-spark/src/main/docs/spark-component.adoc +++ b/components/camel-spark/src/main/docs/spark-component.adoc @@ -1,11 +1,15 @@ [[spark-component]] = Spark Component +:docTitle: Spark +:artifactId: camel-spark +:description: The spark component can be used to send RDD or DataFrame jobs to Apache Spark cluster. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* *Since Camel 2.17* diff --git a/components/camel-splunk/src/main/docs/splunk-component.adoc b/components/camel-splunk/src/main/docs/splunk-component.adoc index affb8a36d93be..23f6ad7768b03 100644 --- a/components/camel-splunk/src/main/docs/splunk-component.adoc +++ b/components/camel-splunk/src/main/docs/splunk-component.adoc @@ -1,11 +1,15 @@ [[splunk-component]] = Splunk Component +:docTitle: Splunk +:artifactId: camel-splunk +:description: The splunk component allows to publish or search for events in Splunk. +:since: 2.13 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.13* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Splunk component provides access to http://docs.splunk.com/Documentation/Splunk/latest[Splunk] using the diff --git a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc index e1c26da36bfee..8e19aa927e83d 100644 --- a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc +++ b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc @@ -1,11 +1,15 @@ [[spring-batch-component]] = Spring Batch Component +:docTitle: Spring Batch +:artifactId: camel-spring-batch +:description: The spring-batch component allows to send messages to Spring Batch for further processing. +:since: 2.10 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Spring Batch component and support classes provide integration bridge between Camel and http://www.springsource.org/spring-batch[Spring diff --git a/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc b/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc index 584caa467378d..8fb932204aecc 100644 --- a/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc +++ b/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc @@ -1,11 +1,15 @@ [[spring-integration-component]] = Spring Integration Component +:docTitle: Spring Integration +:artifactId: camel-spring-integration +:description: Bridges Camel with Spring Integration. +:since: 1.4 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.4* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Spring Integration component provides a bridge for Camel components to talk to diff --git a/components/camel-spring-javaconfig/src/main/docs/spring-javaconfig.adoc b/components/camel-spring-javaconfig/src/main/docs/spring-javaconfig.adoc index 04ae0b152dfdd..bb0f38ba355bb 100644 --- a/components/camel-spring-javaconfig/src/main/docs/spring-javaconfig.adoc +++ b/components/camel-spring-javaconfig/src/main/docs/spring-javaconfig.adoc @@ -1,5 +1,12 @@ -[[SpringJavaConfig-SpringJavaConfig]] -= Spring Java Config +[[spring-javaconfig-component]] += Spring Java Configuration Component +:docTitle: Spring Java Configuration +:artifactId: camel-spring-javaconfig +:description: Using Camel with Spring Java Configuration +:since: 2.0 +:supportLevel: Stable + +*Since Camel {since}* Spring started life using XML Config to wire beans together. However some folks don't like using XML and would rather use diff --git a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc index c8695ad2772ae..d8f266f52590c 100644 --- a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc +++ b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc @@ -1,11 +1,15 @@ [[spring-ldap-component]] = Spring LDAP Component +:docTitle: Spring LDAP +:artifactId: camel-spring-ldap +:description: The spring-ldap component allows you to perform searches in LDAP servers using filters as the message payload. +:since: 2.11 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.11* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Spring LDAP component provides a Camel wrapper for http://www.springsource.org/ldap[Spring LDAP]. diff --git a/components/camel-spring-main/src/main/docs/spring-main.adoc b/components/camel-spring-main/src/main/docs/spring-main.adoc index 58c43c8c5fe17..0531fd0ff96be 100644 --- a/components/camel-spring-main/src/main/docs/spring-main.adoc +++ b/components/camel-spring-main/src/main/docs/spring-main.adoc @@ -1,4 +1,11 @@ -[[SpringMain-SpringMain]] -= Spring Main +[[spring-main-component]] += Spring Main Component +:docTitle: Spring Main +:artifactId: camel-spring-main +:description: Camel Spring Main support +:since: 3.2 +:supportLevel: Stable + +*Since Camel {since}* This module is used for running Spring standalone via a main class extended from `camel-main`. diff --git a/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc b/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc index 8f258c7e6d9cc..685363824df41 100644 --- a/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc +++ b/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc @@ -1,11 +1,15 @@ [[spring-redis-component]] = Spring Redis Component +:docTitle: Spring Redis +:artifactId: camel-spring-redis +:description: The spring-redis component allows sending and receiving messages from Redis. +:since: 2.11 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.11* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component allows sending and receiving messages from https://redis.io/[Redis]. Redis is advanced key-value store where diff --git a/components/camel-spring-security/src/main/docs/spring-security.adoc b/components/camel-spring-security/src/main/docs/spring-security.adoc index 63330d43ad41b..a3886f94859e7 100644 --- a/components/camel-spring-security/src/main/docs/spring-security.adoc +++ b/components/camel-spring-security/src/main/docs/spring-security.adoc @@ -1,7 +1,12 @@ -[[SpringSecurity-SpringSecurity]] -= Spring Security +[[spring-security-component]] += Spring Security Component +:docTitle: Spring Security +:artifactId: camel-spring-security +:description: Security using Spring Security +:since: 2.3 +:supportLevel: Stable -*Since Camel 2.3* +*Since Camel {since}* The Camel Spring Security component provides role-based authorization for Camel routes. It leverages the authentication and user services @@ -84,7 +89,7 @@ authorization is not specified by this component. You can write your own processors or components which get authentication information from the exchange depending on your needs. For example, you might create a processor that gets credentials from an HTTP request header originating -in the xref:jetty-component.adoc[Jetty] component. No matter how the credentials +in the xref:ROOT:jetty-component.adoc[Jetty] component. No matter how the credentials are collected, they need to be placed in the In message or the `SecurityContextHolder` so the Camel xref:spring-security.adoc[Spring Security] component can access them: @@ -143,7 +148,7 @@ implementation of the `org.apache.camel.component.spring.security.AuthenticationAdapter` to your `` bean. This can be useful if you are working with components that do not use Spring Security but do provide a -`Subject`. At this time, only the xref:cxf-component.adoc[CXF] component populates +`Subject`. At this time, only the xref:ROOT:cxf-component.adoc[CXF] component populates the `Exchange.AUTHENTICATION` header. [[SpringSecurity-Handlingauthenticationandauthorizationerrors]] @@ -197,4 +202,3 @@ for this component: This dependency will also pull in `org.springframework.security:spring-security-core:3.0.3.RELEASE` and `org.springframework.security:spring-security-config:3.0.3.RELEASE`. - diff --git a/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc b/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc index 6897adfbdb740..038fd10e23036 100644 --- a/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc +++ b/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc @@ -1,11 +1,15 @@ [[spring-ws-component]] = Spring WebService Component +:docTitle: Spring WebService +:artifactId: camel-spring-ws +:description: The spring-ws component is used for SOAP WebServices using Spring WebServices. +:since: 2.6 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.6* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Spring WS component allows you to integrate with http://static.springsource.org/spring-ws/sites/1.5/[Spring Web diff --git a/components/camel-spring/src/main/docs/spel-language.adoc b/components/camel-spring/src/main/docs/spel-language.adoc index f797dcfcb08f6..8ab74c572b24f 100644 --- a/components/camel-spring/src/main/docs/spel-language.adoc +++ b/components/camel-spring/src/main/docs/spel-language.adoc @@ -1,7 +1,12 @@ [[spel-language]] = SpEL Language +:docTitle: SpEL +:artifactId: camel-spring +:description: To use Spring Expression Language (SpEL) in Camel expressions or predicates. +:since: 2.7 +:supportLevel: Stable -*Since Camel 2.7* +*Since Camel {since}* Camel allows https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#expressions[Spring Expression Language (SpEL)] diff --git a/components/camel-spring/src/main/docs/spring-event-component.adoc b/components/camel-spring/src/main/docs/spring-event-component.adoc index 9e1a80bc6fd3b..f3d5939c28d24 100644 --- a/components/camel-spring/src/main/docs/spring-event-component.adoc +++ b/components/camel-spring/src/main/docs/spring-event-component.adoc @@ -1,11 +1,15 @@ [[spring-event-component]] = Spring Event Component +:docTitle: Spring Event +:artifactId: camel-spring +:description: The spring-event component allows to listen for Spring Application Events. +:since: 1.4 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.4* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Spring Event component provides access to the Spring `ApplicationEvent` objects. This allows you to publish diff --git a/components/camel-spring/src/main/docs/spring.adoc b/components/camel-spring/src/main/docs/spring-summary.adoc similarity index 99% rename from components/camel-spring/src/main/docs/spring.adoc rename to components/camel-spring/src/main/docs/spring-summary.adoc index 4f7463a1504db..5618cc109484a 100644 --- a/components/camel-spring/src/main/docs/spring.adoc +++ b/components/camel-spring/src/main/docs/spring-summary.adoc @@ -1,5 +1,7 @@ [[SpringSupport-SpringSupport]] = Spring Support +//attributes written by hand, not generated +:docTitle: Spring Apache Camel is designed to work nicely with the Spring Framework in a number of ways. @@ -21,7 +23,7 @@ Type Converter support for Spring Resources etc framework to simplify your unit and integration testing using xref:{eip-vc}:eips:enterprise-integration-patterns.adoc[Enterprise Integration Patterns] and Camel's powerful xref:mock-component.adoc[Mock] and -xref:test.adoc[Test] endpoints +xref:others:test.adoc[Test] endpoints == Using Spring to configure the CamelContext diff --git a/components/camel-sql/src/main/docs/sql-component.adoc b/components/camel-sql/src/main/docs/sql-component.adoc index 9aac649825d22..6804e11b5ece3 100644 --- a/components/camel-sql/src/main/docs/sql-component.adoc +++ b/components/camel-sql/src/main/docs/sql-component.adoc @@ -1,11 +1,15 @@ [[sql-component]] = SQL Component +:docTitle: SQL +:artifactId: camel-sql +:description: The sql component allows you to work with databases using JDBC SQL queries. +:since: 1.4 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.4* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The SQL component allows you to work with databases using JDBC queries. The difference between this component and xref:jdbc-component.adoc[JDBC] diff --git a/components/camel-sql/src/main/docs/sql-stored-component.adoc b/components/camel-sql/src/main/docs/sql-stored-component.adoc index 725b4133d997b..37bcfdc3aa00b 100644 --- a/components/camel-sql/src/main/docs/sql-stored-component.adoc +++ b/components/camel-sql/src/main/docs/sql-stored-component.adoc @@ -1,11 +1,15 @@ [[sql-stored-component]] = SQL Stored Procedure Component +:docTitle: SQL Stored Procedure +:artifactId: camel-sql +:description: The sql component allows you to work with databases using JDBC Stored Procedure queries. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The SQL Stored component allows you to work with databases using JDBC Stored Procedure queries. This component is an extension to diff --git a/components/camel-ssh/src/main/docs/ssh-component.adoc b/components/camel-ssh/src/main/docs/ssh-component.adoc index bbb2444c1ca70..c4319c8a8f1a8 100644 --- a/components/camel-ssh/src/main/docs/ssh-component.adoc +++ b/components/camel-ssh/src/main/docs/ssh-component.adoc @@ -1,11 +1,15 @@ [[ssh-component]] = SSH Component +:docTitle: SSH +:artifactId: camel-ssh +:description: The ssh component enables access to SSH servers such that you can send an SSH command, and process the response. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The SSH component enables access to SSH servers such that you can send an SSH command, and process the response. diff --git a/components/camel-stax/src/main/docs/stax-component.adoc b/components/camel-stax/src/main/docs/stax-component.adoc index 8e19eca61580a..73e08fdd66142 100644 --- a/components/camel-stax/src/main/docs/stax-component.adoc +++ b/components/camel-stax/src/main/docs/stax-component.adoc @@ -1,11 +1,15 @@ [[stax-component]] = StAX Component +:docTitle: StAX +:artifactId: camel-stax +:description: The stax component allows messages to be process through a SAX ContentHandler. +:since: 2.9 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.9* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The StAX component allows messages to be process through a SAX http://download.oracle.com/javase/6/docs/api/org/xml/sax/ContentHandler.html[ContentHandler]. + diff --git a/components/camel-stomp/src/main/docs/stomp-component.adoc b/components/camel-stomp/src/main/docs/stomp-component.adoc index 97bb039233189..f0371ab7531b8 100644 --- a/components/camel-stomp/src/main/docs/stomp-component.adoc +++ b/components/camel-stomp/src/main/docs/stomp-component.adoc @@ -1,11 +1,15 @@ [[stomp-component]] = Stomp Component +:docTitle: Stomp +:artifactId: camel-stomp +:description: The stomp component is used for communicating with Stomp compliant message brokers. +:since: 2.12 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Stomp component is used for communicating with http://stomp.github.io/[Stomp] compliant message brokers, like diff --git a/components/camel-stream/src/main/docs/stream-component.adoc b/components/camel-stream/src/main/docs/stream-component.adoc index 57f892dac934c..0e646e8e386f5 100644 --- a/components/camel-stream/src/main/docs/stream-component.adoc +++ b/components/camel-stream/src/main/docs/stream-component.adoc @@ -1,11 +1,15 @@ [[stream-component]] = Stream Component +:docTitle: Stream +:artifactId: camel-stream +:description: The stream: component provides access to the system-in, system-out and system-err streams as well as allowing streaming of file. +:since: 1.3 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.3* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Stream component provides access to the `System.in`, `System.out` and `System.err` streams as well as allowing streaming of file. diff --git a/components/camel-stringtemplate/src/main/docs/string-template-component.adoc b/components/camel-stringtemplate/src/main/docs/string-template-component.adoc index bea373339b630..f48e2b9390758 100644 --- a/components/camel-stringtemplate/src/main/docs/string-template-component.adoc +++ b/components/camel-stringtemplate/src/main/docs/string-template-component.adoc @@ -1,11 +1,15 @@ [[string-template-component]] = String Template Component +:docTitle: String Template +:artifactId: camel-stringtemplate +:description: Transforms the message using a String template. +:since: 1.2 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 1.2* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The String Template component allows you to process a message using a http://www.stringtemplate.org/[String Template]. This can be ideal when diff --git a/components/camel-stub/src/main/docs/stub-component.adoc b/components/camel-stub/src/main/docs/stub-component.adoc index e4e3b908e0afd..8708ee91c83c9 100644 --- a/components/camel-stub/src/main/docs/stub-component.adoc +++ b/components/camel-stub/src/main/docs/stub-component.adoc @@ -1,11 +1,16 @@ [[stub-component]] = Stub Component +:docTitle: Stub +:artifactId: camel-stub +:description: The stub component provides a simple way to stub out any physical endpoints while in development or testing. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Stub component provides a simple way to stub out any physical endpoints while in development or testing, allowing you for example to diff --git a/components/camel-swagger-java/src/main/docs/swagger-java.adoc b/components/camel-swagger-java/src/main/docs/swagger-java.adoc index 953aef3917505..6197bfcc2d810 100644 --- a/components/camel-swagger-java/src/main/docs/swagger-java.adoc +++ b/components/camel-swagger-java/src/main/docs/swagger-java.adoc @@ -1,6 +1,12 @@ +[[swagger-java-component]] = Swagger Java Component +:docTitle: Swagger Java +:artifactId: camel-swagger-java +:description: Rest-dsl support for using swagger api-doc +:since: 2.16 +:supportLevel: Stable -*Since Camel 2.16* +*Since Camel {since}* The Rest DSL can be integrated with the `camel-swagger-java` module which is used for exposing the REST diff --git a/components/camel-syslog/src/main/docs/syslog-dataformat.adoc b/components/camel-syslog/src/main/docs/syslog-dataformat.adoc index c73beb63ad013..6a87faf0ec8ea 100644 --- a/components/camel-syslog/src/main/docs/syslog-dataformat.adoc +++ b/components/camel-syslog/src/main/docs/syslog-dataformat.adoc @@ -1,7 +1,12 @@ [[syslog-dataformat]] = Syslog DataFormat +:docTitle: Syslog +:artifactId: camel-syslog +:description: The Syslog dataformat is used for working with RFC3164 and RFC5424 messages (logging and monitoring). +:since: 2.6 +:supportLevel: Stable -*Since Camel 2.6* +*Since Camel {since}* The Syslog dataformat is used for working with http://www.ietf.org/rfc/rfc3164.txt[RFC3164] and RFC5424 messages. diff --git a/components/camel-tagsoup/src/main/docs/tidyMarkup-dataformat.adoc b/components/camel-tagsoup/src/main/docs/tidyMarkup-dataformat.adoc index d726059545f13..7eb2486f1ea8c 100644 --- a/components/camel-tagsoup/src/main/docs/tidyMarkup-dataformat.adoc +++ b/components/camel-tagsoup/src/main/docs/tidyMarkup-dataformat.adoc @@ -1,7 +1,12 @@ [[tidyMarkup-dataformat]] = TidyMarkup DataFormat +:docTitle: TidyMarkup +:artifactId: camel-tagsoup +:description: TidyMarkup data format is used for parsing HTML and return it as pretty well-formed HTML. +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* TidyMarkup is a Data Format that uses the http://www.ccil.org/~cowan/XML/tagsoup/[TagSoup] to tidy up HTML. It can diff --git a/components/camel-tarfile/src/main/docs/tarfile-dataformat.adoc b/components/camel-tarfile/src/main/docs/tarfile-dataformat.adoc index d70ba792146a0..d85ab37191096 100644 --- a/components/camel-tarfile/src/main/docs/tarfile-dataformat.adoc +++ b/components/camel-tarfile/src/main/docs/tarfile-dataformat.adoc @@ -1,7 +1,12 @@ [[tarfile-dataformat]] = Tar File DataFormat +:docTitle: Tar File +:artifactId: camel-tarfile +:description: The Tar File data format is a message compression and de-compression format of tar files. +:since: 2.16 +:supportLevel: Stable -*Since Camel 2.16* +*Since Camel {since}* The Tar File Data Format is a message compression and de-compression format. Messages can be marshalled (compressed) to diff --git a/components/camel-telegram/src/main/docs/telegram-component.adoc b/components/camel-telegram/src/main/docs/telegram-component.adoc index 774ad35d6ad03..28a0d55dd9a16 100644 --- a/components/camel-telegram/src/main/docs/telegram-component.adoc +++ b/components/camel-telegram/src/main/docs/telegram-component.adoc @@ -1,11 +1,15 @@ [[telegram-component]] = Telegram Component +:docTitle: Telegram +:artifactId: camel-telegram +:description: The telegram component provides access to the Telegram Bot API. +:since: 2.18 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Telegram component provides access to the https://core.telegram.org/bots/api[Telegram Bot API]. It allows a Camel-based application to send and receive messages by acting as a Bot, participating in diff --git a/components/camel-test-cdi/src/main/docs/test-cdi.adoc b/components/camel-test-cdi/src/main/docs/test-cdi.adoc index 3eaf320bd2f93..aa8dc372b6bfc 100644 --- a/components/camel-test-cdi/src/main/docs/test-cdi.adoc +++ b/components/camel-test-cdi/src/main/docs/test-cdi.adoc @@ -1,5 +1,12 @@ -[[CDITesting-CDITesting]] -= CDI Testing +[[test-cdi-component]] += Test CDI Component +:docTitle: Test CDI +:artifactId: camel-test-cdi +:description: Camel unit testing with CDI +:since: 2.17 +:supportLevel: Stable + +*Since Camel {since}* http://camel.apache.org/testing.html[Testing] is a crucial part of any development or integration work. In case you're using the Camel CDI @@ -278,7 +285,7 @@ Using ShrinkWarp Descriptors, you have a complete control over the configuration and kind of Camel CDI applications you want to test. For example, to test a Camel CDI application that uses the Camel REST DSL configured with the -xref:servlet-component.adoc[Servlet component], you need to create a Web archive, +xref:ROOT:servlet-component.adoc[Servlet component], you need to create a Web archive, e.g.: [source,java] @@ -632,7 +639,7 @@ Camel context bean provided by the Camel CDI component. can _advice_ an existing route before its being tested. It allows to add http://camel.apache.org/intercept.html[Intercept] or _weave_ routes for testing purpose, for example using -the xref:mock-component.adoc[Mock] component. +the xref:ROOT:mock-component.adoc[Mock] component. It is recommended to only advice routes which are not started already. To meet that requirement, you can use the `CamelContextStartingEvent` @@ -726,4 +733,3 @@ public class CamelCdiTest { }; } ---- - diff --git a/components/camel-test-junit5/src/main/docs/test-junit5.adoc b/components/camel-test-junit5/src/main/docs/test-junit5.adoc index f8bd98195a9e2..3c98c47e8dcc0 100644 --- a/components/camel-test-junit5/src/main/docs/test-junit5.adoc +++ b/components/camel-test-junit5/src/main/docs/test-junit5.adoc @@ -1,5 +1,12 @@ -[[Test]] -= Test Module +[[test-junit5-component]] += Test JUnit5 Component +:docTitle: Test JUnit5 +:artifactId: camel-test-junit5 +:description: Camel unit testing with JUnit 5 +:since: 3.0 +:supportLevel: Stable + +*Since Camel {since}* The `camel-test-junit5` module is used for unit testing Camel. diff --git a/components/camel-test-spring-junit5/src/main/docs/test-spring-junit5.adoc b/components/camel-test-spring-junit5/src/main/docs/test-spring-junit5.adoc index 31b233f07111a..dbc73312fe830 100644 --- a/components/camel-test-spring-junit5/src/main/docs/test-spring-junit5.adoc +++ b/components/camel-test-spring-junit5/src/main/docs/test-spring-junit5.adoc @@ -1,6 +1,12 @@ -= Camel Test Spring JUnit 5 +[[test-spring-junit5-component]] += Test Spring JUnit5 Component +:docTitle: Test Spring JUnit5 +:artifactId: camel-test-spring-junit5 +:description: Camel unit testing with Spring and JUnit 5 +:since: 3.0 +:supportLevel: Stable -*Available since 3.0* +*Since Camel {since}* The `camel-test-spring-junit5` module makes it possible to test Camel Spring based applications with JUnit 5. @@ -34,7 +40,7 @@ public class SimpleMockTest extends CamelSpringTestSupport { } ---- -This approach provides feature parity with `org.apache.camel.test.junit5.CamelTestSupport` from xref:components::test-junit5.adoc[camel-test-junit5] but does not support Spring annotations on the test class such as `@Autowired`, `@DirtiesContext`, and `@ContextConfiguration`. +This approach provides feature parity with `org.apache.camel.test.junit5.CamelTestSupport` from xref:test-junit5.adoc[camel-test-junit5] but does not support Spring annotations on the test class such as `@Autowired`, `@DirtiesContext`, and `@ContextConfiguration`. Instead of instantiating the `CamelContext` and routes programmatically, this class relies on a Spring context to wire the needed components together. If your test extends this class, you must provide the Spring context by implementing the following method. [source,java] @@ -134,7 +140,7 @@ Tips: It's possible to run JUnit 4 & JUnit 5 based Camel Spring tests side by si `camel-test-spring-junit5` and `junit-vintage-engine`. This configuration allows to migrate a Camel Spring test at once. === Typical migration steps linked to JUnit 5 support in Camel Test Spring -* Migration steps linked to xref:components::test-junit5.adoc[JUnit 5 support in Camel Test itself] should have been applied first +* Migration steps linked to xref:test-junit5.adoc[JUnit 5 support in Camel Test itself] should have been applied first * Imports of `org.apache.camel.test.spring.\*` should be replaced with `org.apache.camel.test.spring.junit5.*` * Usage of `@RunWith(CamelSpringRunner.class)` should be replaced with `@CamelSpringTest` * Usage of `@BootstrapWith(CamelTestContextBootstrapper.class)` should be replaced with `@CamelSpringTest` diff --git a/components/camel-test-spring/src/main/docs/test-spring.adoc b/components/camel-test-spring/src/main/docs/test-spring.adoc index dbc80854ef708..c59f38226e57b 100644 --- a/components/camel-test-spring/src/main/docs/test-spring.adoc +++ b/components/camel-test-spring/src/main/docs/test-spring.adoc @@ -1,6 +1,12 @@ -= Test Spring +[[test-spring-component]] += Test Spring Component +:docTitle: Test Spring +:artifactId: camel-test-spring +:description: Camel unit testing with Spring +:since: 2.10 +:supportLevel: Stable -*Available since 2.10* +*Since Camel {since}* Allows to test Camel with Spring applications such as Spring XML files or Spring-Boot. @@ -11,7 +17,7 @@ This documentation is old and needs to be updated xref:manual::testing.adoc[Testing] is a crucial part of any development or integration work. The Spring Framework offers a number of features that makes it easy to test while using Spring for Inversion of Control which works with JUnit 3.x and JUnit 4.x. -We can use Spring for IoC and the Camel xref:components::mock-component.adoc[Mock] and xref:components::test.adoc[Test] endpoints to create sophisticated integration/unit tests that are easy to run and debug inside your IDE. There are three supported approaches for testing with Spring in Camel. +We can use Spring for IoC and the Camel xref:ROOT:mock-component.adoc[Mock] and xref:test.adoc[Test] endpoints to create sophisticated integration/unit tests that are easy to run and debug inside your IDE. There are three supported approaches for testing with Spring in Camel. [width="100%",cols="1,1,4,1",options="header",] |======================================================================= |Name |Testing Frameworks Supported |Description |Required Camel Test Dependencies @@ -25,7 +31,7 @@ Provided by: * `org.apache.camel.test.CamelSpringTestSupport` * `org.apache.camel.test.junit4.CamelSpringTestSupport` -These base classes provide feature parity with the simple `CamelTestSupport` classes from xref:components::test.adoc[Camel Test] but do not support Spring annotations on the test class such as `@Autowired`, `@DirtiesContext`, and `@ContextConfiguration`. +These base classes provide feature parity with the simple `CamelTestSupport` classes from xref:test.adoc[Camel Test] but do not support Spring annotations on the test class such as `@Autowired`, `@DirtiesContext`, and `@ContextConfiguration`. a| * JUnit 3.x (deprecated) - camel-test-spring @@ -408,5 +414,3 @@ public class Foo { } } ---- - - diff --git a/components/camel-test/src/main/docs/test.adoc b/components/camel-test/src/main/docs/test.adoc index dc8752f5b0d1a..1432d71d04b58 100644 --- a/components/camel-test/src/main/docs/test.adoc +++ b/components/camel-test/src/main/docs/test.adoc @@ -1,5 +1,12 @@ -[[Test]] -= Test Module +[[test-component]] += Test Component +:docTitle: Test +:artifactId: camel-test +:description: Camel unit testing +:since: 2.9 +:supportLevel: Stable + +*Since Camel {since}* The `camel-test` module is used for unit testing Camel. @@ -44,4 +51,3 @@ public class SimpleMockTest extends CamelTestSupport { } ---- - diff --git a/components/camel-testcontainers-junit5/src/main/docs/testcontainers-junit5.adoc b/components/camel-testcontainers-junit5/src/main/docs/testcontainers-junit5.adoc index 3c8e3db3a74af..7633e418407af 100644 --- a/components/camel-testcontainers-junit5/src/main/docs/testcontainers-junit5.adoc +++ b/components/camel-testcontainers-junit5/src/main/docs/testcontainers-junit5.adoc @@ -1,6 +1,12 @@ -= Testcontainers +[[testcontainers-junit5-component]] += Testcontainers JUnit5 Component +:docTitle: Testcontainers JUnit5 +:artifactId: camel-testcontainers-junit5 +:description: Camel support for testcontainers with JUnit 5 +:since: 3.0 +:supportLevel: Stable -*Available since 3.0.0* +*Since Camel {since}* Testing camel components is sometime complex because the 3rd party system a component interacts with does not provide testing facilities and/or is only available as a native application. To reduce this complexity, *Camel Testcontainers JUnit 5* extends standard camel test support providing a way to create and interact with containerized applications. @@ -132,5 +138,5 @@ Tips: It's possible to run JUnit4 & JUnit5 based camel tests side by side includ `camel-testcontainers-junit5` and `junit-vintage-engine`. This configuration allows to migrate a camel test at once. === Typical migration steps linked to JUnit 5 support in Camel Testcontainers -* Migration steps linked to xref:components::test-junit5.adoc[JUnit 5 support in Camel Test itself] should have been applied first +* Migration steps linked to xref:test-junit5.adoc[JUnit 5 support in Camel Test itself] should have been applied first * Imports of `org.apache.camel.test.testcontainers.\*` should be replaced with `org.apache.camel.test.testcontainers.junit5.*` diff --git a/components/camel-testcontainers-spring-junit5/src/main/docs/testcontainers-spring-junit5.adoc b/components/camel-testcontainers-spring-junit5/src/main/docs/testcontainers-spring-junit5.adoc index 32b9b28d6818c..ed88cdfb06109 100644 --- a/components/camel-testcontainers-spring-junit5/src/main/docs/testcontainers-spring-junit5.adoc +++ b/components/camel-testcontainers-spring-junit5/src/main/docs/testcontainers-spring-junit5.adoc @@ -1,6 +1,12 @@ -= Testcontainers Spring +[[testcontainers-spring-junit5-component]] += Testcontainers Spring Junit5 Component +:docTitle: Testcontainers Spring Junit5 +:artifactId: camel-testcontainers-spring-junit5 +:description: Camel unit testing with Spring, testcontainers and JUnit 5 +:since: 3.0 +:supportLevel: Stable -*Available since 3.0.0* +*Since Camel {since}* Testing camel components is sometime complex because the 3th party system a component interacts with does not provide testing facilities and/or is only available as a native application. To reduce this complexity, *Camel Testcontainers Spring JUnit 5* extends camel spring test support providing a way to create and interact with containerized applications. @@ -24,5 +30,5 @@ Tips: It's possible to run JUnit4 & JUnit5 based camel tests side by side includ `camel-testcontainers-spring-junit5` and `junit-vintage-engine`. This configuration allows to migrate a camel test at once. === Typical migration steps linked to JUnit 5 support in Camel Testcontainers Spring -* Migration steps linked to xref:components::testcontainers-junit5.adoc[JUnit 5 support in Camel Testcontainers itself] should have been applied first +* Migration steps linked to xref:testcontainers-junit5.adoc[JUnit 5 support in Camel Testcontainers itself] should have been applied first * Imports of `org.apache.camel.test.testcontainers.spring.\*` should be replaced with `org.apache.camel.test.testcontainers.spring.junit5.*` diff --git a/components/camel-testcontainers-spring/src/main/docs/testcontainers-spring.adoc b/components/camel-testcontainers-spring/src/main/docs/testcontainers-spring.adoc index 96b3347e5284d..ea19556ed348c 100644 --- a/components/camel-testcontainers-spring/src/main/docs/testcontainers-spring.adoc +++ b/components/camel-testcontainers-spring/src/main/docs/testcontainers-spring.adoc @@ -1,9 +1,14 @@ -= Testcontainers Spring +[[testcontainers-spring-component]] += Testcontainers Spring Component +:docTitle: Testcontainers Spring +:artifactId: camel-testcontainers-spring +:description: Camel unit testing with Spring and testcontainers +:since: 2.22 +:supportLevel: Stable -*Available since 2.22.0* +*Since Camel {since}* Testing camel components is sometime complex because the 3th party system a component interacts with does not provide testing facilities and/or is only available as a native application. To reduce this complexity, *Camel Testcontainers Spring* extends camel spring test support providing a way to create and interact with containerized applications. This module is an extension to the camel-testcontainers component to add support for Spring. Therefore see the documentation for testcontainers for more details. - diff --git a/components/camel-testcontainers/src/main/docs/testcontainers.adoc b/components/camel-testcontainers/src/main/docs/testcontainers.adoc index 019dfc6778089..eb17f9873a9ac 100644 --- a/components/camel-testcontainers/src/main/docs/testcontainers.adoc +++ b/components/camel-testcontainers/src/main/docs/testcontainers.adoc @@ -1,6 +1,12 @@ -= Testcontainers - -*Available since 2.22.0* +[[testcontainers-component]] += Testcontainers Component +:docTitle: Testcontainers +:artifactId: camel-testcontainers +:description: Camel support for testcontainers +:since: 2.22 +:supportLevel: Stable + +*Since Camel {since}* Testing camel components is sometime complex because the 3th party system a component interacts with does not provide testing facilities and/or is only available as a native application. To reduce this complexity, *Camel Testcontainers* extends standard camel test support providing a way to create and interact with containerized applications. diff --git a/components/camel-thrift/src/main/docs/thrift-component.adoc b/components/camel-thrift/src/main/docs/thrift-component.adoc index 7ee9a20be924e..0c5f6ec62c117 100644 --- a/components/camel-thrift/src/main/docs/thrift-component.adoc +++ b/components/camel-thrift/src/main/docs/thrift-component.adoc @@ -1,11 +1,15 @@ [[thrift-component]] = Thrift Component +:docTitle: Thrift +:artifactId: camel-thrift +:description: The Thrift component allows to call and expose remote procedures (RPC) with Apache Thrift data format and serialization mechanism +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Thrift component allows you to call or expose Remote Procedure Call (RPC) services using https://thrift.apache.org/[Apache Thrift] binary communication protocol and serialization mechanism. diff --git a/components/camel-thrift/src/main/docs/thrift-dataformat.adoc b/components/camel-thrift/src/main/docs/thrift-dataformat.adoc index 82b70154519ee..4a0a38e9c8c4b 100644 --- a/components/camel-thrift/src/main/docs/thrift-dataformat.adoc +++ b/components/camel-thrift/src/main/docs/thrift-dataformat.adoc @@ -1,7 +1,12 @@ [[thrift-dataformat]] = Thrift DataFormat +:docTitle: Thrift +:artifactId: camel-thrift +:description: The Thrift data format is used for serialization and deserialization of messages using Apache Thrift binary dataformat. +:since: 2.20 +:supportLevel: Stable -*Since Camel 2.20* +*Since Camel {since}* Camel provides a Data Format to serialize between diff --git a/components/camel-tika/src/main/docs/tika-component.adoc b/components/camel-tika/src/main/docs/tika-component.adoc index 3419089022578..ce178e864189e 100644 --- a/components/camel-tika/src/main/docs/tika-component.adoc +++ b/components/camel-tika/src/main/docs/tika-component.adoc @@ -1,11 +1,15 @@ [[tika-component]] = Tika Component +:docTitle: Tika +:artifactId: camel-tika +:description: This component integrates with Apache Tika to extract content and metadata from thousands of file types. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The *Tika*: components provides the ability to detect and parse documents with Apache Tika. This component uses diff --git a/components/camel-timer/src/main/docs/timer-component.adoc b/components/camel-timer/src/main/docs/timer-component.adoc index 6be3a5e2a1ccc..18fce0ea31aef 100644 --- a/components/camel-timer/src/main/docs/timer-component.adoc +++ b/components/camel-timer/src/main/docs/timer-component.adoc @@ -1,11 +1,16 @@ [[timer-component]] = Timer Component +:docTitle: Timer +:artifactId: camel-timer +:description: The timer component is used for generating message exchanges when a timer fires. +:since: 1.0 +:supportLevel: Stable +:component-header: Only consumer is supported +:core: -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Timer component is used to generate message exchanges when a timer fires You can only consume events from this endpoint. diff --git a/components/camel-twilio/src/main/docs/twilio-component.adoc b/components/camel-twilio/src/main/docs/twilio-component.adoc index d08f75b3fe7d7..fa9fecbee6900 100644 --- a/components/camel-twilio/src/main/docs/twilio-component.adoc +++ b/components/camel-twilio/src/main/docs/twilio-component.adoc @@ -1,11 +1,15 @@ [[twilio-component]] = Twilio Component +:docTitle: Twilio +:artifactId: camel-twilio +:description: The Twilio component allows you to interact with the Twilio REST APIs using Twilio Java SDK. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Twilio component provides access to Version 2010-04-01 of Twilio REST APIs accessible using https://github.com/twilio/twilio-java[Twilio Java SDK]. diff --git a/components/camel-twitter/src/main/docs/twitter-directmessage-component.adoc b/components/camel-twitter/src/main/docs/twitter-directmessage-component.adoc index 9b639f1108890..926972127f9fc 100644 --- a/components/camel-twitter/src/main/docs/twitter-directmessage-component.adoc +++ b/components/camel-twitter/src/main/docs/twitter-directmessage-component.adoc @@ -1,11 +1,15 @@ [[twitter-directmessage-component]] = Twitter Direct Message Component +:docTitle: Twitter Direct Message +:artifactId: camel-twitter +:description: The Twitter Direct Message Component consumes/produces user's direct messages. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Twitter Direct Message Component consumes/produces a user's direct messages. diff --git a/components/camel-twitter/src/main/docs/twitter-search-component.adoc b/components/camel-twitter/src/main/docs/twitter-search-component.adoc index 669d85f2a83a2..fdbd0ef5644b2 100644 --- a/components/camel-twitter/src/main/docs/twitter-search-component.adoc +++ b/components/camel-twitter/src/main/docs/twitter-search-component.adoc @@ -1,11 +1,15 @@ [[twitter-search-component]] = Twitter Search Component +:docTitle: Twitter Search +:artifactId: camel-twitter +:description: The Twitter Search component consumes search results. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Twitter Search component consumes search results. diff --git a/components/camel-twitter/src/main/docs/twitter-timeline-component.adoc b/components/camel-twitter/src/main/docs/twitter-timeline-component.adoc index 0a740ff4bb41f..b4473ffb41e84 100644 --- a/components/camel-twitter/src/main/docs/twitter-timeline-component.adoc +++ b/components/camel-twitter/src/main/docs/twitter-timeline-component.adoc @@ -1,11 +1,15 @@ [[twitter-timeline-component]] = Twitter Timeline Component +:docTitle: Twitter Timeline +:artifactId: camel-twitter +:description: The Twitter Timeline component consumes twitter timeline or update the status of specific user. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Twitter Timeline component consumes twitter timeline or update the status of specific user. diff --git a/components/camel-undertow/src/main/docs/undertow-component.adoc b/components/camel-undertow/src/main/docs/undertow-component.adoc index 7762baa4fe0d6..99c2c8d3b406e 100644 --- a/components/camel-undertow/src/main/docs/undertow-component.adoc +++ b/components/camel-undertow/src/main/docs/undertow-component.adoc @@ -1,11 +1,15 @@ [[undertow-component]] = Undertow Component +:docTitle: Undertow +:artifactId: camel-undertow +:description: The undertow component provides HTTP and WebSocket based endpoints for consuming and producing HTTP/WebSocket requests. +:since: 2.16 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Undertow component provides HTTP and WebSocket based endpoints for consuming and producing HTTP/WebSocket requests. diff --git a/components/camel-univocity-parsers/src/main/docs/univocity-csv-dataformat.adoc b/components/camel-univocity-parsers/src/main/docs/univocity-csv-dataformat.adoc index fc567c8fec67e..854a39c405bcd 100644 --- a/components/camel-univocity-parsers/src/main/docs/univocity-csv-dataformat.adoc +++ b/components/camel-univocity-parsers/src/main/docs/univocity-csv-dataformat.adoc @@ -1,7 +1,12 @@ [[univocity-csv-dataformat]] = uniVocity CSV DataFormat +:docTitle: uniVocity CSV +:artifactId: camel-univocity-parsers +:description: The uniVocity CSV data format is used for working with CSV (Comma Separated Values) flat payloads. +:since: 2.15 +:supportLevel: Stable -*Since Camel 2.15* +*Since Camel {since}* This xref:manual::data-format.adoc[Data Format] uses http://www.univocity.com/pages/about-parsers[uniVocity-parsers] diff --git a/components/camel-univocity-parsers/src/main/docs/univocity-fixed-dataformat.adoc b/components/camel-univocity-parsers/src/main/docs/univocity-fixed-dataformat.adoc index 1d48db0851cd8..f5afdcbe518e0 100644 --- a/components/camel-univocity-parsers/src/main/docs/univocity-fixed-dataformat.adoc +++ b/components/camel-univocity-parsers/src/main/docs/univocity-fixed-dataformat.adoc @@ -1,7 +1,12 @@ [[univocity-fixed-dataformat]] = uniVocity Fixed Length DataFormat +:docTitle: uniVocity Fixed Length +:artifactId: camel-univocity-parsers +:description: The uniVocity Fixed Length data format is used for working with fixed length flat payloads. +:since: 2.15 +:supportLevel: Stable -*Since Camel 2.15* +*Since Camel {since}* This xref:manual::data-format.adoc[Data Format] uses http://www.univocity.com/pages/about-parsers[uniVocity-parsers] diff --git a/components/camel-univocity-parsers/src/main/docs/univocity-tsv-dataformat.adoc b/components/camel-univocity-parsers/src/main/docs/univocity-tsv-dataformat.adoc index b084aa6c8426b..1ef06bfab19ac 100644 --- a/components/camel-univocity-parsers/src/main/docs/univocity-tsv-dataformat.adoc +++ b/components/camel-univocity-parsers/src/main/docs/univocity-tsv-dataformat.adoc @@ -1,7 +1,12 @@ [[univocity-tsv-dataformat]] = uniVocity TSV DataFormat +:docTitle: uniVocity TSV +:artifactId: camel-univocity-parsers +:description: The uniVocity TSV data format is used for working with TSV (Tabular Separated Values) flat payloads. +:since: 2.15 +:supportLevel: Stable -*Since Camel 2.15* +*Since Camel {since}* This xref:manual::data-format.adoc[Data Format] uses http://www.univocity.com/pages/about-parsers[uniVocity-parsers] diff --git a/components/camel-validator/src/main/docs/validator-component.adoc b/components/camel-validator/src/main/docs/validator-component.adoc index c2461f42091b7..083a2f71f911a 100644 --- a/components/camel-validator/src/main/docs/validator-component.adoc +++ b/components/camel-validator/src/main/docs/validator-component.adoc @@ -1,11 +1,16 @@ [[validator-component]] = Validator Component +:docTitle: Validator +:artifactId: camel-validator +:description: Validates the payload of a message using XML Schema and JAXP Validation. +:since: 1.1 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Validation component performs XML validation of the message body using the JAXP Validation API and based on any of the supported XML diff --git a/components/camel-velocity/src/main/docs/velocity-component.adoc b/components/camel-velocity/src/main/docs/velocity-component.adoc index 7126cfac0d4fd..5f9076c58eaa9 100644 --- a/components/camel-velocity/src/main/docs/velocity-component.adoc +++ b/components/camel-velocity/src/main/docs/velocity-component.adoc @@ -1,11 +1,15 @@ [[velocity-component]] = Velocity Component +:docTitle: Velocity +:artifactId: camel-velocity +:description: Transforms the message using a Velocity template. +:since: 1.2 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 1.2* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Velocity component allows you to process a message using an http://velocity.apache.org/[Apache Velocity] template. This can be ideal diff --git a/components/camel-vertx/src/main/docs/vertx-component.adoc b/components/camel-vertx/src/main/docs/vertx-component.adoc index 34304a4fee941..e580ed717e4d0 100644 --- a/components/camel-vertx/src/main/docs/vertx-component.adoc +++ b/components/camel-vertx/src/main/docs/vertx-component.adoc @@ -1,11 +1,15 @@ [[vertx-component]] = Vert.x Component +:docTitle: Vert.x +:artifactId: camel-vertx +:description: The vertx component is used for sending and receive messages from a vertx event bus. +:since: 2.12 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Vert.x component is for working with the http://vertx.io/[Vertx] https://vertx.io/docs/vertx-core/java/#event_bus[EventBus]. diff --git a/components/camel-vm/src/main/docs/vm-component.adoc b/components/camel-vm/src/main/docs/vm-component.adoc index 957c8f62782b4..4b25b0e95bdfe 100644 --- a/components/camel-vm/src/main/docs/vm-component.adoc +++ b/components/camel-vm/src/main/docs/vm-component.adoc @@ -1,11 +1,16 @@ [[vm-component]] = VM Component +:docTitle: VM +:artifactId: camel-vm +:description: The vm component provides asynchronous call to another endpoint from the same CamelContext. +:since: 1.1 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The VM component provides asynchronous https://en.wikipedia.org/wiki/Staged_event-driven_architecture[SEDA] behavior, exchanging diff --git a/components/camel-weather/src/main/docs/weather-component.adoc b/components/camel-weather/src/main/docs/weather-component.adoc index 3624e28b395d1..7abf5753c2335 100644 --- a/components/camel-weather/src/main/docs/weather-component.adoc +++ b/components/camel-weather/src/main/docs/weather-component.adoc @@ -1,11 +1,15 @@ [[weather-component]] = Weather Component +:docTitle: Weather +:artifactId: camel-weather +:description: Polls the weather information from Open Weather Map. +:since: 2.12 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Weather component is used for polling weather information from http://openweathermap.org[Open Weather Map] - a site that provides free diff --git a/components/camel-web3j/src/main/docs/web3j-component.adoc b/components/camel-web3j/src/main/docs/web3j-component.adoc index 063e9ae3a4fe8..81a41e9c5810c 100644 --- a/components/camel-web3j/src/main/docs/web3j-component.adoc +++ b/components/camel-web3j/src/main/docs/web3j-component.adoc @@ -1,11 +1,15 @@ [[web3j-component]] = Web3j Ethereum Blockchain Component +:docTitle: Web3j Ethereum Blockchain +:artifactId: camel-web3j +:description: The web3j component uses the Web3j client API and allows you to add/read nodes to/from a web3j compliant content repositories. +:since: 2.22 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.22* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Ethereum blockchain component uses the https://github.com/web3j/web3j[web3j] client diff --git a/components/camel-webhook/src/main/docs/webhook-component.adoc b/components/camel-webhook/src/main/docs/webhook-component.adoc index 6f3c6e12ab423..7c6fda1a0e395 100644 --- a/components/camel-webhook/src/main/docs/webhook-component.adoc +++ b/components/camel-webhook/src/main/docs/webhook-component.adoc @@ -1,11 +1,15 @@ [[webhook-component]] = Webhook Component +:docTitle: Webhook +:artifactId: camel-webhook +:description: The webhook component allows other Camel components that can receive push notifications to expose webhook endpoints and automatically register them with their own webhook provider. +:since: 3.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Webhook meta component allows other Camel components to configure webhooks on a remote webhook provider and diff --git a/components/camel-websocket-jsr356/src/main/docs/websocket-jsr356-component.adoc b/components/camel-websocket-jsr356/src/main/docs/websocket-jsr356-component.adoc index 72dba4aec0a7a..10f206d9f5e86 100644 --- a/components/camel-websocket-jsr356/src/main/docs/websocket-jsr356-component.adoc +++ b/components/camel-websocket-jsr356/src/main/docs/websocket-jsr356-component.adoc @@ -1,11 +1,15 @@ [[websocket-jsr356-component]] = Javax Websocket Component +:docTitle: Javax Websocket +:artifactId: camel-websocket-jsr356 +:description: Camel WebSocket using JSR356 (javax) +:since: 2.23 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The JSR356 component provides websocket endpoints for communicating with clients using diff --git a/components/camel-websocket/src/main/docs/websocket-component.adoc b/components/camel-websocket/src/main/docs/websocket-component.adoc index f8d80b135910d..b4f90a32071d1 100644 --- a/components/camel-websocket/src/main/docs/websocket-component.adoc +++ b/components/camel-websocket/src/main/docs/websocket-component.adoc @@ -1,11 +1,15 @@ [[websocket-component]] = Jetty Websocket Component +:docTitle: Jetty Websocket +:artifactId: camel-websocket +:description: The websocket component provides websocket endpoints with Jetty for communicating with clients using websocket. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The WebSocket component provides websocket endpoints for communicating with clients using diff --git a/components/camel-weka/src/main/docs/weka-component.adoc b/components/camel-weka/src/main/docs/weka-component.adoc index 78ab431a6885e..580013d61b560 100644 --- a/components/camel-weka/src/main/docs/weka-component.adoc +++ b/components/camel-weka/src/main/docs/weka-component.adoc @@ -1,11 +1,15 @@ [[weka-component]] = Weka Component +:docTitle: Weka +:artifactId: camel-weka +:description: The camel-weka component provides Data Mining functionality through Weka. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Weka component provides access to the https://www.cs.waikato.ac.nz/ml/weka[(Weka Data Mining)] toolset. diff --git a/components/camel-wordpress/src/main/docs/wordpress-component.adoc b/components/camel-wordpress/src/main/docs/wordpress-component.adoc index c52f1a88b4858..b59f1bb39af3a 100644 --- a/components/camel-wordpress/src/main/docs/wordpress-component.adoc +++ b/components/camel-wordpress/src/main/docs/wordpress-component.adoc @@ -1,11 +1,15 @@ [[wordpress-component]] = Wordpress Component +:docTitle: Wordpress +:artifactId: camel-wordpress +:description: Integrates Camel with Wordpress. +:since: 2.21 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.21* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Camel component for https://developer.wordpress.org/rest-api/reference/[Wordpress API]. diff --git a/components/camel-workday/src/main/docs/workday-component.adoc b/components/camel-workday/src/main/docs/workday-component.adoc index 28fb290c7f8d3..bf6514e22aad2 100644 --- a/components/camel-workday/src/main/docs/workday-component.adoc +++ b/components/camel-workday/src/main/docs/workday-component.adoc @@ -1,11 +1,15 @@ [[workday-component]] = Workday Component +:docTitle: Workday +:artifactId: camel-workday +:description: Represents a Workday endpoint. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The *Workday*: components provides the ability to detect and parse documents with Workday. diff --git a/components/camel-xchange/src/main/docs/xchange-component.adoc b/components/camel-xchange/src/main/docs/xchange-component.adoc index 2bc37986e859a..b2e4e1b1750d7 100644 --- a/components/camel-xchange/src/main/docs/xchange-component.adoc +++ b/components/camel-xchange/src/main/docs/xchange-component.adoc @@ -1,11 +1,15 @@ [[xchange-component]] = XChange Component +:docTitle: XChange +:artifactId: camel-xchange +:description: The camel-xchange component provide access to many bitcoin and altcoin exchanges for trading and accessing market data. +:since: 2.21 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.21* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The XChange component uses the https://knowm.org/open-source/xchange/[XChange] Java library to provide access to 60+ Bitcoin and Altcoin exchanges. It comes with a consistent interface for trading and accessing market data. diff --git a/components/camel-xj/src/main/docs/xj-component.adoc b/components/camel-xj/src/main/docs/xj-component.adoc index 8667d3440f9b7..c337c055f7def 100644 --- a/components/camel-xj/src/main/docs/xj-component.adoc +++ b/components/camel-xj/src/main/docs/xj-component.adoc @@ -1,11 +1,15 @@ [[xj-component]] = XJ Component +:docTitle: XJ +:artifactId: camel-xj +:description: Transforms json/xml message back and forth using a XSLT. +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The XJ component allows you to convert XML and JSON documents directly forth and back without the need of intermediate java objects. You can even specify an XSLT stylesheet to convert directly to the target diff --git a/components/camel-xmlsecurity/src/main/docs/secureXML-dataformat.adoc b/components/camel-xmlsecurity/src/main/docs/secureXML-dataformat.adoc index 9bc7f2657d6f6..33ebd46e1daa0 100644 --- a/components/camel-xmlsecurity/src/main/docs/secureXML-dataformat.adoc +++ b/components/camel-xmlsecurity/src/main/docs/secureXML-dataformat.adoc @@ -1,7 +1,12 @@ [[secureXML-dataformat]] = XML Security DataFormat +:docTitle: XML Security +:artifactId: camel-xmlsecurity +:description: The XML Security data format facilitates encryption and decryption of XML payloads. +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* The XMLSecurity Data Format facilitates encryption and decryption of XML payloads at the Document, Element, and Element Content levels (including diff --git a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-sign-component.adoc b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-sign-component.adoc index 0dd5f1a899c0c..289cc0e2b8499 100644 --- a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-sign-component.adoc +++ b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-sign-component.adoc @@ -1,15 +1,17 @@ [[xmlsecurity-sign-component]] = XML Security Sign Component -*Since Camel 2.12* -*Since Camel 2.12* +:docTitle: XML Security Sign +:artifactId: camel-xmlsecurity +:description: Used to sign exchanges using the XML signature specification. +:since: 2.12 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* With this Apache Camel component, you can generate and validate XML signatures as described in the W3C standard diff --git a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-verify-component.adoc b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-verify-component.adoc index 50de7e23d7653..8e874a256f312 100644 --- a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-verify-component.adoc +++ b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-verify-component.adoc @@ -1,15 +1,17 @@ [[xmlsecurity-verify-component]] = XML Security Verify Component -*Since Camel 2.12* -*Since Camel 2.12* +:docTitle: XML Security Verify +:artifactId: camel-xmlsecurity +:description: Used to verify exchanges using the XML signature specification. +:since: 2.12 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* With this Apache Camel component, you can generate and validate XML signatures as described in the W3C standard diff --git a/components/camel-xmpp/src/main/docs/xmpp-component.adoc b/components/camel-xmpp/src/main/docs/xmpp-component.adoc index efbcde431a9e6..ad1a1ffdbff0d 100644 --- a/components/camel-xmpp/src/main/docs/xmpp-component.adoc +++ b/components/camel-xmpp/src/main/docs/xmpp-component.adoc @@ -1,11 +1,15 @@ [[xmpp-component]] = XMPP Component +:docTitle: XMPP +:artifactId: camel-xmpp +:description: To send and receive messages from a XMPP (chat) server. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The XMPP component implements an XMPP (Jabber) transport. diff --git a/components/camel-xpath/src/main/docs/xpath-language.adoc b/components/camel-xpath/src/main/docs/xpath-language.adoc index 81f0404a9ec82..d945a7b14e7ab 100644 --- a/components/camel-xpath/src/main/docs/xpath-language.adoc +++ b/components/camel-xpath/src/main/docs/xpath-language.adoc @@ -1,7 +1,12 @@ [[xpath-language]] = XPath Language +:docTitle: XPath +:artifactId: camel-xpath +:description: To use XPath (XML) in Camel expressions or predicates. +:since: 1.1 +:supportLevel: Stable -*Since Camel 1.1* +*Since Camel {since}* Camel supports http://www.w3.org/TR/xpath[XPath] to allow an Expression or Predicate to be diff --git a/components/camel-xslt-saxon/src/main/docs/xslt-saxon-component.adoc b/components/camel-xslt-saxon/src/main/docs/xslt-saxon-component.adoc index baba559576ca8..d369800ecadc3 100644 --- a/components/camel-xslt-saxon/src/main/docs/xslt-saxon-component.adoc +++ b/components/camel-xslt-saxon/src/main/docs/xslt-saxon-component.adoc @@ -1,11 +1,16 @@ [[xslt-saxon-component]] = XSLT Saxon Component +:docTitle: XSLT Saxon +:artifactId: camel-xslt-saxon +:description: Transforms the message using a XSLT template using Saxon. +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The XSLT Saxon component allows you to process a message using an http://www.w3.org/TR/xslt[XSLT] template using Saxon. This can be ideal when using diff --git a/components/camel-xslt/src/main/docs/xslt-component.adoc b/components/camel-xslt/src/main/docs/xslt-component.adoc index 8cf23141c9e5d..944b01f1793a9 100644 --- a/components/camel-xslt/src/main/docs/xslt-component.adoc +++ b/components/camel-xslt/src/main/docs/xslt-component.adoc @@ -1,11 +1,16 @@ [[xslt-component]] = XSLT Component +:docTitle: XSLT +:artifactId: camel-xslt +:description: Transforms the message using a XSLT template. +:since: 1.3 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 1.3* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The XSLT component allows you to process a message using an http://www.w3.org/TR/xslt[XSLT] template. This can be ideal when using diff --git a/components/camel-xstream/src/main/docs/json-xstream-dataformat.adoc b/components/camel-xstream/src/main/docs/json-xstream-dataformat.adoc index a49b4ceee037e..8c610c1abe85c 100644 --- a/components/camel-xstream/src/main/docs/json-xstream-dataformat.adoc +++ b/components/camel-xstream/src/main/docs/json-xstream-dataformat.adoc @@ -1,7 +1,12 @@ [[json-xstream-dataformat]] = JSon XStream DataFormat +:docTitle: JSon XStream +:artifactId: camel-xstream +:description: JSon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload. +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* XStream is a Data Format which uses the http://xstream.codehaus.org/[XStream library] to marshal and unmarshal diff --git a/components/camel-xstream/src/main/docs/xstream-dataformat.adoc b/components/camel-xstream/src/main/docs/xstream-dataformat.adoc index 8cd63ac47a601..4a230f6b2f137 100644 --- a/components/camel-xstream/src/main/docs/xstream-dataformat.adoc +++ b/components/camel-xstream/src/main/docs/xstream-dataformat.adoc @@ -1,7 +1,12 @@ [[xstream-dataformat]] = XStream DataFormat +:docTitle: XStream +:artifactId: camel-xstream +:description: XStream data format is used for unmarshal a XML payload to POJO or to marshal POJO back to XML payload. +:since: 1.3 +:supportLevel: Stable -*Since Camel 1.3* +*Since Camel {since}* XStream is a Data Format which uses the http://x-stream.github.io/[XStream library] to marshal and unmarshal diff --git a/components/camel-yammer/src/main/docs/yammer-component.adoc b/components/camel-yammer/src/main/docs/yammer-component.adoc index 6a46c92b3f487..dd590d57f4d2e 100644 --- a/components/camel-yammer/src/main/docs/yammer-component.adoc +++ b/components/camel-yammer/src/main/docs/yammer-component.adoc @@ -1,11 +1,15 @@ [[yammer-component]] = Yammer Component +:docTitle: Yammer +:artifactId: camel-yammer +:description: The yammer component allows you to interact with the Yammer enterprise social network. +:since: 2.12 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Yammer component allows you to interact with the https://www.yammer.com[Yammer] enterprise social network. diff --git a/components/camel-zendesk/src/main/docs/zendesk-component.adoc b/components/camel-zendesk/src/main/docs/zendesk-component.adoc index ed41be091ac2c..402670b624f47 100644 --- a/components/camel-zendesk/src/main/docs/zendesk-component.adoc +++ b/components/camel-zendesk/src/main/docs/zendesk-component.adoc @@ -1,11 +1,15 @@ [[zendesk-component]] = Zendesk Component +:docTitle: Zendesk +:artifactId: camel-zendesk +:description: Allows producing messages to manage Zendesk ticket, user, organization, etc. +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Zendesk component provides access to all of the zendesk.com APIs accessible using https://github.com/cloudbees/zendesk-java-client[zendesk-java-client]. It diff --git a/components/camel-zip-deflater/src/main/docs/gzipdeflater-dataformat.adoc b/components/camel-zip-deflater/src/main/docs/gzipdeflater-dataformat.adoc index 23fe6e96113db..812fb39a59cc2 100644 --- a/components/camel-zip-deflater/src/main/docs/gzipdeflater-dataformat.adoc +++ b/components/camel-zip-deflater/src/main/docs/gzipdeflater-dataformat.adoc @@ -1,7 +1,12 @@ [[gzipdeflater-dataformat]] = GZip Deflater DataFormat +:docTitle: GZip Deflater +:artifactId: camel-zip-deflater +:description: The GZip data format is a message compression and de-compression format (which works with the popular gzip/gunzip tools). +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* The GZip Deflater Data Format is a message compression and de-compression format. It uses the same deflate algorithm that is used diff --git a/components/camel-zip-deflater/src/main/docs/zipdeflater-dataformat.adoc b/components/camel-zip-deflater/src/main/docs/zipdeflater-dataformat.adoc index 9cd1143329f8f..1305e84555b6b 100644 --- a/components/camel-zip-deflater/src/main/docs/zipdeflater-dataformat.adoc +++ b/components/camel-zip-deflater/src/main/docs/zipdeflater-dataformat.adoc @@ -1,7 +1,12 @@ [[zipdeflater-dataformat]] = Zip Deflate Compression DataFormat +:docTitle: Zip Deflate Compression +:artifactId: camel-zip-deflater +:description: Zip Deflate Compression data format is a message compression and de-compression format (not zip files). +:since: 2.12 +:supportLevel: Stable -*Since Camel 2.12* +*Since Camel {since}* The Zip Deflater Data Format is a message compression and diff --git a/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc b/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc index e80e2cde96759..100d3447bcc8b 100644 --- a/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc +++ b/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc @@ -1,7 +1,12 @@ [[zipfile-dataformat]] = Zip File DataFormat +:docTitle: Zip File +:artifactId: camel-zipfile +:description: The Zip File data format is a message compression and de-compression format of zip files. +:since: 2.11 +:supportLevel: Stable -*Since Camel 2.11* +*Since Camel {since}* The Zip File Data Format is a message compression and de-compression format. Messages can be marshalled (compressed) to diff --git a/components/camel-zipkin/src/main/docs/zipkin.adoc b/components/camel-zipkin/src/main/docs/zipkin.adoc index d43015a36807a..2949c992eca9d 100644 --- a/components/camel-zipkin/src/main/docs/zipkin.adoc +++ b/components/camel-zipkin/src/main/docs/zipkin.adoc @@ -1,7 +1,12 @@ -[[Zipkin-ZipkinComponent]] +[[zipkin-component]] = Zipkin Component +:docTitle: Zipkin +:artifactId: camel-zipkin +:description: Distributed message tracing using Zipkin +:since: 2.18 +:supportLevel: Stable -*Since Camel 2.18* +*Since Camel {since}* The Camel Zipkin component is used for tracing and timing incoming and outgoing Camel messages using http://zipkin.io/[zipkin]. diff --git a/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc b/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc index c94243c99bbd9..400d8448c0350 100644 --- a/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc +++ b/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc @@ -1,11 +1,15 @@ [[zookeeper-master-component]] = ZooKeeper Master Component +:docTitle: ZooKeeper Master +:artifactId: camel-zookeeper-master +:description: Represents an endpoint which only becomes active when it obtains the master lock +:since: 2.19 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The **zookeeper-master:** endpoint provides a way to ensure only a single consumer in a cluster consumes from a given endpoint; with automatic failover if that JVM dies. diff --git a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc index f75d9a7053dc7..91a8931cd41ed 100644 --- a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc +++ b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc @@ -1,11 +1,15 @@ [[zookeeper-component]] = ZooKeeper Component +:docTitle: ZooKeeper +:artifactId: camel-zookeeper +:description: The zookeeper component allows interaction with a ZooKeeper cluster. +:since: 2.9 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.9* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The ZooKeeper component allows interaction with a http://hadoop.apache.org/zookeeper/[ZooKeeper] cluster and exposes the diff --git a/components/fix-eip-xrefs.sh b/components/fix-eip-xrefs.sh new file mode 100755 index 0000000000000..bd139fda59da6 --- /dev/null +++ b/components/fix-eip-xrefs.sh @@ -0,0 +1,24 @@ +#!/bin/sh + +#version: latest component: components file: undefined path modules/languages/pages/bean-language.adoc lineno: undefined message: Unresolved page ID manual::message +#sed -i -e 's/xref:manual::message/xref:{eip-vc}:eips:manual::message/g' `find . -name "bean-language.adoc"` +#version: latest component: components file: undefined path modules/languages/pages/bean-language.adoc lineno: undefined message: Unresolved page ID manual::message +#sed -i -e 's/xref:manual::message/xref:{eip-vc}:eips:manual::message/g' modules/languages/pages/bean-language.adoc"` +#version: latest component: components file: undefined path modules/ROOT/pages/beanstalk-component.adoc"` lineno: undefined message: Unresolved page ID manual::polling-consumer +sed -i -e 's/xref:manual::polling-consumer/xref:{eip-vc}:eips:manual::polling-consumer/g' `find . -name "beanstalk-component.adoc"` +#version: latest component: components file: undefined path modules/ROOT/pages/dataset-component.adoc"` lineno: undefined message: Unresolved page ID manual::enterprise-integration-patterns +sed -i -e 's/xref:manual::enterprise-integration-patterns/xref:{eip-vc}:eips:manual::enterprise-integration-patterns/g' `find . -name "dataset-component.adoc"` +#version: latest component: components file: undefined path modules/ROOT/pages/dataset-test-component.adoc"` lineno: undefined message: Unresolved page ID manual::enterprise-integration-patterns +sed -i -e 's/xref:manual::enterprise-integration-patterns/xref:{eip-vc}:eips:manual::enterprise-integration-patterns/g' `find . -name "dataset-test-component.adoc"` +#version: latest component: components file: undefined path modules/ROOT/pages/facebook-component.adoc"` lineno: undefined message: Unresolved page ID manual::polling-consumer +sed -i -e 's/xref:manual::polling-consumer/xref:{eip-vc}:eips:manual::polling-consumer/g' `find . -name "facebook-component.adoc"` +#version: latest component: components file: undefined path modules/ROOT/pages/jms-component.adoc"` lineno: undefined message: Unresolved page ID manual::dead-letter-channel +sed -i -e 's/xref:manual::dead-letter-channel/xref:{eip-vc}:eips:manual::dead-letter-channel/g' `find . -name "jms-component.adoc"` +#version: latest component: components file: undefined path modules/ROOT/pages/mock-component.adoc"` lineno: undefined message: Unresolved page ID manual::enterprise-integration-patterns +sed -i -e 's/xref:manual::enterprise-integration-patterns/xref:{eip-vc}:eips:manual::enterprise-integration-patterns/g' `find . -name "mock-component.adoc"` +#version: latest component: components file: undefined path modules/ROOT/pages/quartz-component.adoc"` lineno: undefined message: Unresolved page ID manual::polling-consumer +sed -i -e 's/xref:manual::polling-consumer/xref:{eip-vc}:eips:manual::polling-consumer/g' `find . -name "quartz-component.adoc"` +#version: latest component: components file: undefined path modules/ROOT/pages/spring-event-component.adoc"` lineno: undefined message: Unresolved page ID manual::enterprise-integration-patterns +sed -i -e 's/xref:manual::enterprise-integration-patterns/xref:{eip-vc}:eips:manual::enterprise-integration-patterns/g' `find . -name "spring-event-component.adoc"` +#version: latest component: components file: undefined path modules/ROOT/pages/spring.adoc"` lineno: undefined message: Unresolved page ID manual::enterprise-integration-patterns +sed -i -e 's/xref:manual::enterprise-integration-patterns/xref:{eip-vc}:eips:manual::enterprise-integration-patterns/g' `find . -name "spring.adoc"` diff --git a/core/camel-base/src/main/docs/properties-component.adoc b/core/camel-base/src/main/docs/properties-component.adoc index 3305467fcf5d7..f3f04880f33fe 100644 --- a/core/camel-base/src/main/docs/properties-component.adoc +++ b/core/camel-base/src/main/docs/properties-component.adoc @@ -1,7 +1,13 @@ [[properties-component]] = Properties Component - -*Since Camel 2.3* +//Written by hand, not generated. +:docTitle: Properties +:artifactId: camel-base +:description: The properties component is used for property placeholders in your Camel application, such as endpoint URIs. +:since: 2.3 +:supportLevel: Stable + +*Since Camel {since}* The properties component is used for property placeholders in your Camel application, such as endpoint URIs. It is *not* a regular Camel component with producer and consumer for routing messages. However for historical diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/aggregate-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/aggregate-eip.adoc index 58ba2bed9ee65..fcb5e02e144dc 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/aggregate-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/aggregate-eip.adoc @@ -1,5 +1,8 @@ [[aggregate-eip]] = Aggregate EIP +:description: Aggregates many messages into a single message +:since: +:supportLevel: Stable The http://www.enterpriseintegrationpatterns.com/Aggregator.html[Aggregator] @@ -192,7 +195,7 @@ consumer etc) The aggregator provides a pluggable repository which you can implement your own `org.apache.camel.spi.AggregationRepository`. + If you need persistent repository then you can use either Camel -xref:components::leveldb.adoc[LevelDB], or xref:components::sql-component.adoc[SQL Component] components. +xref:components:others:leveldb.adoc[LevelDB], or xref:components::sql-component.adoc[SQL Component] components. == Using TimeoutAwareAggregationStrategy diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/batch-config-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/batch-config-eip.adoc index 118850c90a3a2..b732a2b3ccf93 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/batch-config-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/batch-config-eip.adoc @@ -1,5 +1,8 @@ [[batch-config-eip]] = Batch-config EIP +:description: Configures batch-processing resequence eip. +:since: +:supportLevel: Stable Batch-processing resequence EIP diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/bean-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/bean-eip.adoc index 3e226b1bdc72a..03597c8718628 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/bean-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/bean-eip.adoc @@ -1,5 +1,8 @@ [[bean-eip]] = Bean EIP +:description: Calls a java bean +:since: +:supportLevel: Stable The Bean EIP binds beans to Camel message exchanges. @@ -93,4 +96,3 @@ 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 of the various xref:latest@manual:ROOT:bean-integration.adoc[Bean Integration] mechanisms in Camel. - diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/choice-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/choice-eip.adoc index 676df5412d9a2..e436842deae09 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/choice-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/choice-eip.adoc @@ -1,5 +1,8 @@ [[choice-eip]] = Choice EIP +:description: Routes messages based on a series of predicates +:since: +:supportLevel: Stable The http://www.enterpriseintegrationpatterns.com/ContentBasedRouter.html[Content diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/circuitBreaker-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/circuitBreaker-eip.adoc index 72ea62a513f13..3472b1d2088ac 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/circuitBreaker-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/circuitBreaker-eip.adoc @@ -1,5 +1,8 @@ [[circuitBreaker-eip]] = Circuit Breaker EIP +:description: null +:since: +:supportLevel: Stable The Circuit Breaker pattern is inspired by the real-world electrical circuit breaker, which is used to detect excessive current draw and fail fast to protect electrical equipment. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/claimCheck-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/claimCheck-eip.adoc index 4f0d7298b79d1..78307385b892b 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/claimCheck-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/claimCheck-eip.adoc @@ -1,5 +1,8 @@ [[claimCheck-eip]] = Claim Check EIP +:description: The Claim Check EIP allows you to replace message content with a claim check (a unique key), which can be used to retrieve the message content at a later time. +:since: +:supportLevel: Stable The http://www.enterpriseintegrationpatterns.com/patterns/messaging/StoreInLibrary.html[Claim Check] from the xref:enterprise-integration-patterns.adoc[EIP patterns] allows you to replace message content with a claim check (a unique key), which can be used to retrieve the message content at a later time. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/convertBodyTo-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/convertBodyTo-eip.adoc index 9ffee9b04cb3c..9a33fb325a3b6 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/convertBodyTo-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/convertBodyTo-eip.adoc @@ -1,5 +1,8 @@ [[convertBodyTo-eip]] = Convert Body To EIP +:description: Converts the message body to another type +:since: +:supportLevel: Stable The ConvertBodyTo EIP allows you to transform your body to a different type. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/customLoadBalancer-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/customLoadBalancer-eip.adoc index a7e7d18a32825..6611d8d0c1b93 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/customLoadBalancer-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/customLoadBalancer-eip.adoc @@ -1,5 +1,8 @@ [[customLoadBalancer-eip]] = Custom Load Balancer EIP +:description: Custom load balancer +:since: +:supportLevel: Stable This EIP allows you to use your own Load Balancer implementation diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/delay-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/delay-eip.adoc index 8b0f273f8baa9..a11d77cc28f1a 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/delay-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/delay-eip.adoc @@ -1,6 +1,9 @@ [[delay-eip]] = Delay EIP -The Delayer Pattern allows you to delay the delivery of messages to some destination. +// The Delayer Pattern allows you to delay the delivery of messages to some destination. +:description: Delays processing for a specified length of time +:since: +:supportLevel: Stable == Options @@ -169,4 +172,3 @@ public class SomeBean { } } ---- - diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/dynamicRouter-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/dynamicRouter-eip.adoc index a24520b177cc6..8f61ac7e1898d 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/dynamicRouter-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/dynamicRouter-eip.adoc @@ -1,5 +1,8 @@ [[dynamicRouter-eip]] = Dynamic Router EIP +:description: Routes messages based on dynamic rules +:since: +:supportLevel: Stable The http://www.enterpriseintegrationpatterns.com/DynamicRouter.html[Dynamic Router] from the xref:enterprise-integration-patterns.adoc[EIP patterns] allows you to route messages while avoiding the dependency of the router on all possible destinations while maintaining its efficiency. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/enrich-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/enrich-eip.adoc index 979e469a13e9c..8d87e6cc80553 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/enrich-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/enrich-eip.adoc @@ -1,5 +1,8 @@ [[enrich-eip]] = Enrich EIP +:description: Enriches a message with data from a secondary resource +:since: +:supportLevel: Stable Camel supports the Content Enricher from the EIP patterns using a Message Translator, an arbitrary Processor in the routing logic, or using the enrich DSL element to enrich the message. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/failover-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/failover-eip.adoc index 2abcd9febdac6..4045637430cfc 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/failover-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/failover-eip.adoc @@ -1,5 +1,8 @@ [[failover-eip]] = Failover EIP +:description: Failover load balancer The failover load balancer is capable of trying the next processor in case an Exchange failed with an exception during processing. You can constrain the failover to activate only when one exception of a list you specify occurs. If you do not specify a list any exception will cause fail over to occur. This balancer uses the same strategy for matching exceptions as the Exception Clause does for the onException. +:since: +:supportLevel: Stable Failover Load Balancer, with this policy in case of failures the exchange will be tried on the next endpoint. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/faultToleranceConfiguration-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/faultToleranceConfiguration-eip.adoc index f02d211fcb7a3..2082395dcfeb9 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/faultToleranceConfiguration-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/faultToleranceConfiguration-eip.adoc @@ -1,5 +1,8 @@ [[faultToleranceConfiguration-eip]] = Fault Tolerance Configuration EIP +:description: MicroProfile Fault Tolerance Circuit Breaker EIP configuration +:since: +:supportLevel: Stable // eip options: START diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/filter-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/filter-eip.adoc index 9e37116c2d526..e30a8a2d9a388 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/filter-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/filter-eip.adoc @@ -1,5 +1,8 @@ [[filter-eip]] = Filter EIP +:description: Filter out messages based using a predicate +:since: +:supportLevel: Stable The http://www.enterpriseintegrationpatterns.com/Filter.html[Message Filter] from the xref:enterprise-integration-patterns.adoc[EIP patterns] diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/from-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/from-eip.adoc index 2faf74034f3d5..cf7e3cf1672fe 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/from-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/from-eip.adoc @@ -1,6 +1,9 @@ [[from-eip]] = From EIP -Starting point for a Camel route that starts a route with a given endpoint. The endpoint can be from one of the many Camel https://github.com/apache/camel/tree/master/components[Components]. The component creates Camel exchanges from their respective sources and puts them into the route. +// Starting point for a Camel route that starts a route with a given endpoint. The endpoint can be from one of the many Camel https://github.com/apache/camel/tree/master/components[Components]. The component creates Camel exchanges from their respective sources and puts them into the route. +:description: Act as a message source as input to a route +:since: +:supportLevel: Stable == Options diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/hystrix-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/hystrix-eip.adoc index 0c9d6f01997f4..72e0fad519037 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/hystrix-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/hystrix-eip.adoc @@ -113,7 +113,7 @@ You can find an example with the source code: https://github.com/apache/camel-sp == Using Hystrix with Spring Boot -See the xref:components::hystrix.adoc[Hystrix Component]. +See the xref:components:others:hystrix.adoc[Hystrix Component]. == Camel's Error Handler and Circuit Breaker EIP diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/hystrixConfiguration-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/hystrixConfiguration-eip.adoc index ba32bdd05fb8a..c995d350c56ed 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/hystrixConfiguration-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/hystrixConfiguration-eip.adoc @@ -1,5 +1,8 @@ [[hystrixConfiguration-eip]] = Hystrix Configuration EIP +:description: Hystrix Circuit Breaker EIP configuration +:since: +:supportLevel: Stable // eip options: START diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/idempotentConsumer-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/idempotentConsumer-eip.adoc index 061b487784f9e..9e59c1e508a43 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/idempotentConsumer-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/idempotentConsumer-eip.adoc @@ -1,5 +1,8 @@ [[idempotentConsumer-eip]] = Idempotent Consumer EIP +:description: Filters out duplicate messages +:since: +:supportLevel: Stable The http://www.enterpriseintegrationpatterns.com/IdempotentReceiver.html[Idempotent @@ -18,7 +21,7 @@ Camel provides the following Idempotent Consumer implementations: * MemoryIdempotentRepository * xref:components::file-component.adoc[FileIdempotentRepository] -* xref:components::hazelcast.adoc[HazelcastIdempotentRepository] +* xref:components::hazelcast-summary.adoc[HazelcastIdempotentRepository] * xref:components::sql-component.adoc[JdbcMessageIdRepository] * xref:components::jpa-component.adoc[JpaMessageIdRepository] * xref:components::infinispan-component.adoc[InfinispanIdempotentRepository] diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/inOnly-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/inOnly-eip.adoc index 3b8296cd2a15f..8191ac28b4f54 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/inOnly-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/inOnly-eip.adoc @@ -1,5 +1,8 @@ [[inOnly-eip]] = In Only EIP +:description: Marks the exchange pattern for the route to one way +:since: +:supportLevel: Stable The *inOnly:* EIP define an InOnly ExchangePattern. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/inOut-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/inOut-eip.adoc index c6ce5a8e79e77..c3cd8dad24f78 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/inOut-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/inOut-eip.adoc @@ -1,5 +1,8 @@ [[inOut-eip]] = In Out EIP +:description: Marks the exchange pattern for the route to request/reply +:since: +:supportLevel: Stable The *inOut:* EIP define an InOut ExchangePattern. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/loadBalance-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/loadBalance-eip.adoc index dc6634fdf548b..c941ab81ace79 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/loadBalance-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/loadBalance-eip.adoc @@ -1,5 +1,8 @@ [[loadBalance-eip]] = Load Balance EIP +:description: Balances message processing among a number of nodes +:since: +:supportLevel: Stable The Load Balancer Pattern allows you to delegate to one of a number of endpoints using a variety of different load balancing policies. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/log-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/log-eip.adoc index 4534f6aadb8c9..a64ef7bad486e 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/log-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/log-eip.adoc @@ -1,5 +1,8 @@ [[log-eip]] = Log EIP +:description: Logs the defined message to the logger +:since: +:supportLevel: Stable How can I log the processing of a xref:message.adoc[Message]? diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/loop-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/loop-eip.adoc index 088b8ff8f4661..0452f693d8b58 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/loop-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/loop-eip.adoc @@ -1,5 +1,8 @@ [[loop-eip]] = Loop EIP +:description: Processes a message multiple times +:since: +:supportLevel: Stable The Loop allows for processing a message a number of times, possibly in a different way for each iteration. Useful mostly during testing. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/multicast-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/multicast-eip.adoc index 8329d281f6967..1207c963488a4 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/multicast-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/multicast-eip.adoc @@ -1,5 +1,8 @@ [[multicast-eip]] = Multicast EIP +:description: Routes the same message to multiple paths either sequentially or in parallel. +:since: +:supportLevel: Stable The Multicast EIP allows to route the same message to a number of endpoints and process them in a different way. The main difference between the diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/onFallback-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/onFallback-eip.adoc index bc083e47a6d05..aed61a1063ce5 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/onFallback-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/onFallback-eip.adoc @@ -1,5 +1,8 @@ [[onFallback-eip]] = On Fallback EIP +:description: Route to be executed when Hystrix EIP executes fallback +:since: +:supportLevel: Stable If you are using *onFallback* then that is intended to be local processing only where you can do a message transformation or call a bean or something as the fallback. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/otherwise-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/otherwise-eip.adoc index 60328f52432d8..17406bb0147d5 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/otherwise-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/otherwise-eip.adoc @@ -1,5 +1,8 @@ [[otherwise-eip]] = Otherwise EIP +:description: Route to be executed when all other choices evaluate to false +:since: +:supportLevel: Stable The Otherwise EIP is related to http://www.enterpriseintegrationpatterns.com/ContentBasedRouter.html[Content Based Router] from the xref:enterprise-integration-patterns.adoc[EIP diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/pipeline-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/pipeline-eip.adoc index 888626768656c..f99473aa2aced 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/pipeline-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/pipeline-eip.adoc @@ -1,5 +1,8 @@ [[pipeline-eip]] = Pipeline EIP +:description: Routes the message to a sequence of processors. +:since: +:supportLevel: Stable Camel supports the http://www.enterpriseintegrationpatterns.com/PipesAndFilters.html[Pipes and Filters] from the xref:enterprise-integration-patterns.adoc[EIP patterns] in various ways. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/pollEnrich-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/pollEnrich-eip.adoc index 21d5238c23dd4..2902610878780 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/pollEnrich-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/pollEnrich-eip.adoc @@ -1,5 +1,8 @@ [[pollEnrich-eip]] = Poll Enrich EIP +:description: Enriches messages with data polled from a secondary resource +:since: +:supportLevel: Stable Camel comes with flavor `pollEnrich` as a choice of content enricher in the DSL. The other one is `enrich` diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/process-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/process-eip.adoc index 8339cdd2a358c..3a6d13f75cca9 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/process-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/process-eip.adoc @@ -1,5 +1,8 @@ [[process-eip]] = Process EIP +:description: Calls a Camel processor +:since: +:supportLevel: Stable 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] @@ -97,4 +100,3 @@ deriving from http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/impl/DefaultComponent.html[DefaultComponent] which returns instances of ProcessorEndpoint. For more details see xref:latest@manual:ROOT:writing-components.adoc[Writing Components] - diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/random-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/random-eip.adoc index d315c2b0e4eaa..8cdf7d55ef183 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/random-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/random-eip.adoc @@ -1,5 +1,8 @@ [[random-eip]] = Random EIP +:description: Random load balancer The random load balancer selects a random endpoint for each exchange. +:since: +:supportLevel: Stable // eip options: START diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/recipientList-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/recipientList-eip.adoc index 0c9112041583c..cc4ee6f3ec46c 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/recipientList-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/recipientList-eip.adoc @@ -1,6 +1,9 @@ [[recipientList-eip]] = Recipient List EIP -The http://www.enterpriseintegrationpatterns.com/RecipientList.html[Recipient List] from the EIP patterns allows you to route messages to a number of dynamically specified recipients. +// The http://www.enterpriseintegrationpatterns.com/RecipientList.html[Recipient List] from the EIP patterns allows you to route messages to a number of dynamically specified recipients. +:description: Routes messages to a number of dynamically specified recipients (dynamic to) +:since: +:supportLevel: Stable image::eip/RecipientList.gif[image] diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/removeHeader-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/removeHeader-eip.adoc index e7be974e67f79..b7a3d54ca6da9 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/removeHeader-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/removeHeader-eip.adoc @@ -1,6 +1,9 @@ [[removeHeader-eip]] = Remove Header EIP -The Remove Header EIP allows you to remove an header from your exchange. +// The Remove Header EIP allows you to remove an header from your exchange. +:description: Removes a named header from the message +:since: +:supportLevel: Stable == Options diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/removeHeaders-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/removeHeaders-eip.adoc index 9a3f05e54acc5..61eb4e0fb9ba5 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/removeHeaders-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/removeHeaders-eip.adoc @@ -1,6 +1,9 @@ [[removeHeaders-eip]] = Remove Headers EIP -The Remove Headers EIP allows you to remove headers from your exchange. +// The Remove Headers EIP allows you to remove headers from your exchange. +:description: Removes message headers whose name matches a specified pattern +:since: +:supportLevel: Stable == Options diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/removeProperties-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/removeProperties-eip.adoc index f4b0b92a9baca..504bf0b2a9cc2 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/removeProperties-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/removeProperties-eip.adoc @@ -1,5 +1,8 @@ [[removeProperties-eip]] = Remove Properties EIP +:description: Removes message exchange properties whose name matches a specified pattern +:since: +:supportLevel: Stable The RemoveProperties EIP allows you to remove Properties from you exchange. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/removeProperty-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/removeProperty-eip.adoc index b7ffa6491c9e8..cd967640bc736 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/removeProperty-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/removeProperty-eip.adoc @@ -1,5 +1,8 @@ [[removeProperty-eip]] = Remove Property EIP +:description: Removes a named property from the message exchange +:since: +:supportLevel: Stable The RemoveProperty EIP allows you to remove a Property from your exchange. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/resequence-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/resequence-eip.adoc index 0c0a8877a8d02..3be84327eb101 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/resequence-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/resequence-eip.adoc @@ -1,5 +1,8 @@ [[resequence-eip]] = Resequence EIP +:description: Resequences (re-order) messages based on an expression +:since: +:supportLevel: Stable The http://www.enterpriseintegrationpatterns.com/Resequencer.html[Resequencer] from the https://camel.apache.org/enterprise-integration-patterns.html[EIP patterns] allows you to reorganise messages based on some comparator. + By default in Camel we use an Expression to create the comparator; so that you can compare by a message header or the body or a piece of a message etc. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/resilience4j-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/resilience4j-eip.adoc index cec79f1651c30..514c55473f04d 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/resilience4j-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/resilience4j-eip.adoc @@ -113,7 +113,7 @@ You can find an example with the source code: https://github.com/apache/camel-sp == Using Resilience4j with Spring Boot -See the xref:components::resilience4j.adoc[Resilience4j Component]. +See the xref:components:others:resilience4j.adoc[Resilience4j Component]. == Camel's Error Handler and Circuit Breaker EIP diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/resilience4jConfiguration-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/resilience4jConfiguration-eip.adoc index 397fd628f0793..156eaad8636c0 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/resilience4jConfiguration-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/resilience4jConfiguration-eip.adoc @@ -1,5 +1,8 @@ [[resilience4jConfiguration-eip]] = Resilience4j Configuration EIP +:description: Resilience4j Circuit Breaker EIP configuration +:since: +:supportLevel: Stable // eip options: START diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/rollback-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/rollback-eip.adoc index ea7fd440cb15f..f361b59147248 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/rollback-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/rollback-eip.adoc @@ -1,6 +1,9 @@ [[rollback-eip]] = Rollback EIP -Rollback might be needed if there is a transaction or transactional pieces in your design. +// Rollback might be needed if there is a transaction or transactional pieces in your design. +:description: Forces a rollback by stopping routing the message +:since: +:supportLevel: Stable Camel recommends supporting the http://www.enterpriseintegrationpatterns.com/TransactionalClient.html[Transactional @@ -238,4 +241,3 @@ how we have configured the `onException` in the 2nd route to indicate in case of any exceptions we should handle it and just rollback this transaction. This is done using the `markRollbackOnlyLast` which tells Camel to only do it for the current transaction and not globally. - diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/roundRobin-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/roundRobin-eip.adoc index a3c82de745967..ce52b3e37ada3 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/roundRobin-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/roundRobin-eip.adoc @@ -1,5 +1,8 @@ [[roundRobin-eip]] = Round Robin EIP +:description: Round robin load balancer The round robin load balancer will use the next endpoint for each message. This load balancer is not meant to work with failover, for that you should use the dedicated failover load balancer. +:since: +:supportLevel: Stable Round Robin Load Balancer. With this Load Balancing policy, a random endpoint is selected for each exchange. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/routingSlip-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/routingSlip-eip.adoc index 808380bd53a0b..2f241c85f84a8 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/routingSlip-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/routingSlip-eip.adoc @@ -1,6 +1,9 @@ [[routingSlip-eip]] = Routing Slip EIP -The Routing Slip from the https://camel.apache.org/enterprise-integration-patterns.html[EIP patterns] allows you to route a message consecutively through a series of processing steps where the sequence of steps is not known at design time and can vary for each message. +// The Routing Slip from the https://camel.apache.org/enterprise-integration-patterns.html[EIP patterns] allows you to route a message consecutively through a series of processing steps where the sequence of steps is not known at design time and can vary for each message. +:description: Routes a message through a series of steps that are pre-determined (the slip) +:since: +:supportLevel: Stable image::eip/RoutingTableSimple.gif[image] diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/saga-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/saga-eip.adoc index e217b8d3b239e..b82da35d79338 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/saga-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/saga-eip.adoc @@ -1,5 +1,8 @@ [[saga-eip]] = Saga EIP +:description: Enables sagas on the route +:since: +:supportLevel: Stable The Saga EIP provides a way to define a series of related actions in a Camel route that should be either completed successfully (*all of them*) or not-executed/compensated. Sagas implementations are able to coordinate *distributed services communicating using any transport* towards a globally *consistent outcome*. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/sample-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/sample-eip.adoc index 6b6bbec1a68da..bd756ea5e309e 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/sample-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/sample-eip.adoc @@ -1,5 +1,8 @@ [[sample-eip]] = Sample EIP +:description: Extract a sample of the messages passing through a route +:since: +:supportLevel: Stable A sampling throttler allows you to extract a sample of the exchanges from the traffic through a route. + It is configured with a sampling period during which only a single exchange is allowed to pass through. All other exchanges will be stopped. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/script-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/script-eip.adoc index a336093e47b0f..a65452c2de7b5 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/script-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/script-eip.adoc @@ -1,5 +1,8 @@ [[script-eip]] = Script EIP +:description: Executes a script from a language which does not change the message body. +:since: +:supportLevel: Stable Is used to execute a script which does not change the message (by default). This is useful when you need to invoke some logic that are not in Java code such as JavaScript, diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/serviceCall-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/serviceCall-eip.adoc index b38db156edf23..82bda04ac3401 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/serviceCall-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/serviceCall-eip.adoc @@ -1,5 +1,8 @@ [[serviceCall-eip]] = Service Call EIP +:description: To call remote services +:since: +:supportLevel: Stable The Service Call EIP allows to call remote services in a distributed system. The service to call is looked up in a service registry of some sorts such as Kubernetes, Consul, Etcd, Zookeeper, DNS. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/setBody-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/setBody-eip.adoc index 39aa16b8a74a9..873d2a29a60c0 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/setBody-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/setBody-eip.adoc @@ -1,5 +1,8 @@ [[setBody-eip]] = Set Body EIP +:description: Sets the contents of the message body +:since: +:supportLevel: Stable The SetBody EIP allows you to set the body of your exchange. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/setHeader-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/setHeader-eip.adoc index 9c5e86c95fa4a..f57995472eb66 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/setHeader-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/setHeader-eip.adoc @@ -1,5 +1,8 @@ [[setHeader-eip]] = Set Header EIP +:description: Sets the value of a message header +:since: +:supportLevel: Stable The SetHeader EIP allows you to set and header on your exchange. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/setProperty-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/setProperty-eip.adoc index b10e6ec48247e..14a23d3ee3261 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/setProperty-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/setProperty-eip.adoc @@ -1,5 +1,8 @@ [[setProperty-eip]] = Set Property EIP +:description: Sets a named property on the message exchange +:since: +:supportLevel: Stable The SetProperty EIP allows you to set a property on your exchange. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/sort-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/sort-eip.adoc index 9537d1e5f5d8f..cd3861d6ff1b6 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/sort-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/sort-eip.adoc @@ -1,5 +1,8 @@ [[sort-eip]] = Sort EIP +:description: Sorts the contents of the message +:since: +:supportLevel: Stable Sort can be used to sort a message. Imagine you consume text files and before processing each file you want to be sure the content is sorted. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/split-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/split-eip.adoc index 784510be2e5b8..27909206afc02 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/split-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/split-eip.adoc @@ -1,5 +1,8 @@ [[split-eip]] = Split EIP +:description: Splits a single message into many sub-messages. +:since: +:supportLevel: Stable The http://www.enterpriseintegrationpatterns.com/patterns/messaging/Sequencer.html[Splitter] from the xref:enterprise-integration-patterns.adoc[EIP patterns] allows you split a message into a number of pieces and process them individually. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/step-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/step-eip.adoc index d95fa003589ef..6a8fabbe9aab3 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/step-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/step-eip.adoc @@ -1,5 +1,8 @@ [[step-eip]] = Step EIP +:description: Routes the message to a sequence of processors which is grouped together as one logical name +:since: +:supportLevel: Stable Camel supports the http://www.enterpriseintegrationpatterns.com/PipesAndFilters.html[Pipes and Filters] from the xref:enterprise-integration-patterns.adoc[EIP patterns] in various ways. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/sticky-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/sticky-eip.adoc index 5e1910ca06f8f..f6b069da0c4e5 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/sticky-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/sticky-eip.adoc @@ -1,5 +1,8 @@ [[sticky-eip]] = Sticky EIP +:description: Sticky load balancer Sticky load balancing using an Expression to calculate a correlation key to perform the sticky load balancing; rather like jsessionid in the web or JMSXGroupID in JMS. +:since: +:supportLevel: Stable Sticky Load Balancer. Sticky load balancing uses an Expression to calculate a correlation key to perform the sticky load balancing. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/stop-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/stop-eip.adoc index 7dbb6d7ca01dd..0afa6e0d41804 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/stop-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/stop-eip.adoc @@ -1,6 +1,9 @@ [[stop-eip]] = Stop EIP -The Stop EIP stops the processing of the current message +// The Stop EIP stops the processing of the current message +:description: Stops the processing of the current message +:since: +:supportLevel: Stable == Options diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/stream-config-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/stream-config-eip.adoc index eefa867b465c2..77ec024534ad1 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/stream-config-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/stream-config-eip.adoc @@ -1,5 +1,8 @@ [[stream-config-eip]] = Stream-config EIP +:description: Configures stream-processing resequence eip. +:since: +:supportLevel: Stable Stream-processing resequence EIP diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/threads-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/threads-eip.adoc index b415dcf419d9d..0a84a8440b58b 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/threads-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/threads-eip.adoc @@ -1,6 +1,9 @@ [[threads-eip]] = Threads EIP -The Threads Pattern allows you to introduce a thread pool into a route. +// The Threads Pattern allows you to introduce a thread pool into a route. +:description: Specifies that all steps after this node are processed asynchronously +:since: +:supportLevel: Stable == Options diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/throttle-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/throttle-eip.adoc index 6d1a6b124072d..8687582538460 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/throttle-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/throttle-eip.adoc @@ -1,5 +1,8 @@ [[throttle-eip]] = Throttle EIP +:description: Controls the rate at which messages are passed to the next node in the route +:since: +:supportLevel: Stable The Throttler Pattern allows you to ensure that a specific endpoint does not get overloaded, or that we don't exceed an agreed SLA with some external service. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/to-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/to-eip.adoc index fb1c22caf7268..b32b74bb48d56 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/to-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/to-eip.adoc @@ -1,5 +1,8 @@ [[to-eip]] = To EIP +:description: Sends the message to a static endpoint +:since: +:supportLevel: Stable See message related documentation diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/toD-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/toD-eip.adoc index 890e2d8545f49..ba2c6cd10f9a7 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/toD-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/toD-eip.adoc @@ -1,5 +1,8 @@ [[toD-eip]] = To D EIP +:description: Sends the message to a dynamic endpoint You can specify multiple languages in the uri separated by the plus sign, such as mock:language:xpath:/order/uri where mock: would be a prefix to a xpath expression. For more dynamic behavior use Recipient List or Dynamic Router EIP instead. +:since: +:supportLevel: Stable There is a new `.toD` / `` that allows to send a message to a dynamic computed xref:latest@manual:ROOT:endpoint.adoc[Endpoint] using one or @@ -216,5 +219,3 @@ during startup if `toD` was optimised, or if there was a failure loading the opt ---- Detected SendDynamicAware component: http optimising toD: http:myloginserver:8080/login?userid=${header.userName} ---- - - diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/topic-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/topic-eip.adoc index 1bedcb40c5118..e71fe88cf3d2c 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/topic-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/topic-eip.adoc @@ -1,5 +1,8 @@ [[topic-eip]] = Topic EIP +:description: Topic load balancer The topic load balancer sends to all destinations (rather like JMS Topics) +:since: +:supportLevel: Stable Topic Load Balancer, with this policy you'll get a Topic behavior by sending to all destinations. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/transform-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/transform-eip.adoc index 687d16c05780a..2d14c23b8cf2f 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/transform-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/transform-eip.adoc @@ -1,5 +1,8 @@ [[transform-eip]] = Transform EIP +:description: Transforms the message body based on an expression +:since: +:supportLevel: Stable See below for details diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/unmarshal-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/unmarshal-eip.adoc index 9d7570f01bbf7..c9f15be3f276d 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/unmarshal-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/unmarshal-eip.adoc @@ -28,7 +28,7 @@ from("activemq:My.Queue"). to("mqseries:Another.Queue"); ---- -The above uses a named DataFormat of _jaxb_ which is configured with a number of Java package names. You can if you prefer use a named reference to a data format which can then be defined in your xref:latest@manual:ROOT:registry.adoc[Registry] such as via your xref:components::spring.adoc[Spring] XML file. +The above uses a named DataFormat of _jaxb_ which is configured with a number of Java package names. You can if you prefer use a named reference to a data format which can then be defined in your xref:latest@manual:ROOT:registry.adoc[Registry] such as via your xref:components::spring-summary.adoc[Spring] XML file. You can also use the DSL itself to define the data format as you use it. For example the following uses Java serialization to unmarshal a binary diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/validate-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/validate-eip.adoc index 7e907763966fe..0a1c1607a5aa6 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/validate-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/validate-eip.adoc @@ -1,5 +1,8 @@ [[validate-eip]] = Validate EIP +:description: Validates a message based on an expression +:since: +:supportLevel: Stable Validate uses an expression or predicates to validate the contents of a message. It is useful for ensuring that messages are valid before attempting to process them. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/weighted-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/weighted-eip.adoc index f3cf2763aa98e..ac1e490241d6e 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/weighted-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/weighted-eip.adoc @@ -1,5 +1,8 @@ [[weighted-eip]] = Weighted EIP +:description: Weighted load balancer The weighted load balancing policy allows you to specify a processing load distribution ratio for each server with respect to others. In addition to the weight, endpoint selection is then further refined using random distribution based on weight. +:since: +:supportLevel: Stable Weighted Load Balancer, with this policy in case of failures the exchange will be tried on the next endpoint. diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/when-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/when-eip.adoc index f41157a59093c..5d6fde7dfc241 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/when-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/when-eip.adoc @@ -1,5 +1,8 @@ [[when-eip]] = When EIP +:description: Triggers a route when an expression evaluates to true +:since: +:supportLevel: Stable The When EIP is related to http://www.enterpriseintegrationpatterns.com/ContentBasedRouter.html[Content Based Router] from the xref:enterprise-integration-patterns.adoc[EIP diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/wireTap-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/wireTap-eip.adoc index 73aaaff02b2fb..fe9cf423b18a9 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/wireTap-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/wireTap-eip.adoc @@ -1,5 +1,8 @@ [[wireTap-eip]] = Wire Tap EIP +:description: Routes a copy of a message (or creates a new message) to a secondary destination while continue routing the original message. +:since: +:supportLevel: Stable http://www.enterpriseintegrationpatterns.com/WireTap.html[Wire Tap] (from the xref:enterprise-integration-patterns.adoc[EIP patterns]) diff --git a/core/camel-core-languages/src/main/docs/modules/languages/pages/constant-language.adoc b/core/camel-core-languages/src/main/docs/modules/languages/pages/constant-language.adoc index 9230d084aaab2..f5792b10b1fc3 100644 --- a/core/camel-core-languages/src/main/docs/modules/languages/pages/constant-language.adoc +++ b/core/camel-core-languages/src/main/docs/modules/languages/pages/constant-language.adoc @@ -1,7 +1,12 @@ [[constant-language]] = Constant Language +:docTitle: Constant +:artifactId: camel-core-languages +:description: To use a constant value in Camel expressions or predicates. Important: this is a fixed constant value that is only set once during starting up the route, do not use this if you want dynamic values during routing. +:since: 1.5 +:supportLevel: Stable -*Since Camel 1.5* +*Since Camel {since}* The Constant Expression Language is really just a way to specify constant strings as a type of expression. diff --git a/core/camel-core-languages/src/main/docs/modules/languages/pages/exchangeProperty-language.adoc b/core/camel-core-languages/src/main/docs/modules/languages/pages/exchangeProperty-language.adoc index b85370b4b07b6..461b010c1a3a1 100644 --- a/core/camel-core-languages/src/main/docs/modules/languages/pages/exchangeProperty-language.adoc +++ b/core/camel-core-languages/src/main/docs/modules/languages/pages/exchangeProperty-language.adoc @@ -1,7 +1,12 @@ [[exchangeProperty-language]] = ExchangeProperty Language +:docTitle: ExchangeProperty +:artifactId: camel-core-languages +:description: To use a Camel Exchange property in expressions or predicates. +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* The ExchangeProperty Expression Language allows you to extract values of named exchange properties. @@ -57,4 +62,4 @@ from("direct:a").recipientList().exchangeProperty("myProperty"); == Dependencies -The ExchangeProperty language is part of *camel-core*. \ No newline at end of file +The ExchangeProperty language is part of *camel-core*. diff --git a/core/camel-core-languages/src/main/docs/modules/languages/pages/file-language.adoc b/core/camel-core-languages/src/main/docs/modules/languages/pages/file-language.adoc index 0e6506902a3c7..e7ba049d4ab68 100644 --- a/core/camel-core-languages/src/main/docs/modules/languages/pages/file-language.adoc +++ b/core/camel-core-languages/src/main/docs/modules/languages/pages/file-language.adoc @@ -1,7 +1,12 @@ [[file-language]] = File Language +:docTitle: File +:artifactId: camel-core-languages +:description: For expressions and predicates using the file/simple language. +:since: 1.1 +:supportLevel: Stable -*Since Camel 1.1* +*Since Camel {since}* The file language is merged with xref:simple-language.adoc[Simple] language which means you can use all the file diff --git a/core/camel-core-languages/src/main/docs/modules/languages/pages/header-language.adoc b/core/camel-core-languages/src/main/docs/modules/languages/pages/header-language.adoc index c8566c73d1d92..2cd071c9404fc 100644 --- a/core/camel-core-languages/src/main/docs/modules/languages/pages/header-language.adoc +++ b/core/camel-core-languages/src/main/docs/modules/languages/pages/header-language.adoc @@ -1,7 +1,12 @@ [[header-language]] = Header Language +:docTitle: Header +:artifactId: camel-core-languages +:description: To use a Camel Message header in expressions or predicates. +:since: 1.5 +:supportLevel: Stable -*Since Camel 1.5* +*Since Camel {since}* The Header Expression Language allows you to extract values of named headers. @@ -41,4 +46,4 @@ from("direct:a").recipientList().header("myHeader"); == Dependencies -The Header language is part of *camel-core*. \ No newline at end of file +The Header language is part of *camel-core*. diff --git a/core/camel-core-languages/src/main/docs/modules/languages/pages/ref-language.adoc b/core/camel-core-languages/src/main/docs/modules/languages/pages/ref-language.adoc index b3a0c6a770f4a..3f8b83c131b81 100644 --- a/core/camel-core-languages/src/main/docs/modules/languages/pages/ref-language.adoc +++ b/core/camel-core-languages/src/main/docs/modules/languages/pages/ref-language.adoc @@ -1,7 +1,12 @@ [[ref-language]] = Ref Language +:docTitle: Ref +:artifactId: camel-core-languages +:description: Reference to an existing Camel expression or predicate, which is looked up from the Camel registry. +:since: 2.8 +:supportLevel: Stable -*Since Camel 2.8* +*Since Camel {since}* The Ref Expression Language is really just a way to lookup a custom Expression or Predicate from the Registry. @@ -54,4 +59,4 @@ from("seda:a").split().ref("myExpression").to("seda:b"); == Dependencies -The Ref language is part of *camel-core*. \ No newline at end of file +The Ref language is part of *camel-core*. diff --git a/core/camel-core-languages/src/main/docs/modules/languages/pages/simple-language.adoc b/core/camel-core-languages/src/main/docs/modules/languages/pages/simple-language.adoc index db6c480591e55..5d912c1180a7c 100644 --- a/core/camel-core-languages/src/main/docs/modules/languages/pages/simple-language.adoc +++ b/core/camel-core-languages/src/main/docs/modules/languages/pages/simple-language.adoc @@ -1,7 +1,12 @@ [[simple-language]] = Simple Language +:docTitle: Simple +:artifactId: camel-core-languages +:description: To use Camels built-in Simple language in Camel expressions or predicates. +:since: 1.1 +:supportLevel: Stable -*Since Camel 1.1* +*Since Camel {since}* The Simple Expression Language was a really simple language when it was created, but has since grown more powerful. It is primarily intended for @@ -885,4 +890,3 @@ You can set a spring bean into an exchange property as shown below: ... ---- - diff --git a/core/camel-core-languages/src/main/docs/modules/languages/pages/tokenize-language.adoc b/core/camel-core-languages/src/main/docs/modules/languages/pages/tokenize-language.adoc index 74ae6d6293a66..81cf82447bb8a 100644 --- a/core/camel-core-languages/src/main/docs/modules/languages/pages/tokenize-language.adoc +++ b/core/camel-core-languages/src/main/docs/modules/languages/pages/tokenize-language.adoc @@ -1,7 +1,12 @@ [[tokenize-language]] = Tokenize Language +:docTitle: Tokenize +:artifactId: camel-core-languages +:description: To use Camel message body or header with a tokenizer in Camel expressions or predicates. +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* The tokenizer language is a built-in language in camel-core, which is most often used only with the Splitter EIP to split diff --git a/core/camel-xml-jaxp/src/main/docs/modules/languages/pages/xtokenize-language.adoc b/core/camel-xml-jaxp/src/main/docs/modules/languages/pages/xtokenize-language.adoc index f910c87630525..1ea406f4778f5 100644 --- a/core/camel-xml-jaxp/src/main/docs/modules/languages/pages/xtokenize-language.adoc +++ b/core/camel-xml-jaxp/src/main/docs/modules/languages/pages/xtokenize-language.adoc @@ -1,7 +1,12 @@ [[xtokenize-language]] = XML Tokenize Language +:docTitle: XML Tokenize +:artifactId: camel-xml-jaxp +:description: To use Camel message body or header with a XML tokenizer in Camel expressions or predicates. +:since: 2.14 +:supportLevel: Stable -*Since Camel 2.14* +*Since Camel {since}* The xml tokenizer language is a built-in language in camel-core, which is a truly XML-aware tokenizer that can be used with the Splitter as the @@ -28,4 +33,4 @@ The XML Tokenize language supports 4 options, which are listed below. | group | | Integer | To group N parts together | trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks |=== -// language options: END \ No newline at end of file +// language options: END diff --git a/docs/component-others-nav.adoc.template b/docs/component-others-nav.adoc.template new file mode 100644 index 0000000000000..eb2bb995fac54 --- /dev/null +++ b/docs/component-others-nav.adoc.template @@ -0,0 +1,5 @@ + + +* xref:others:index.adoc[Miscellaneous Components] + + diff --git a/docs/components/antora.yml b/docs/components/antora.yml index e775abf4d73e7..fbebc129e2595 100644 --- a/docs/components/antora.yml +++ b/docs/components/antora.yml @@ -22,4 +22,9 @@ nav: - modules/ROOT/nav.adoc - modules/dataformats/nav.adoc - modules/languages/nav.adoc + - modules/others/nav.adoc - modules/eips/nav.adoc +asciidoc: + attributes: + index-table-format: width="100%",cols="4,3,3,3,6",options="header" +# | Data Format | Artifact | Support Level | Since | Description diff --git a/docs/components/modules/ROOT/nav.adoc b/docs/components/modules/ROOT/nav.adoc index f4f17f2a1411b..6ef7aab052be4 100644 --- a/docs/components/modules/ROOT/nav.adoc +++ b/docs/components/modules/ROOT/nav.adoc @@ -2,375 +2,341 @@ // make edits in docs/*nav.adoc.template files instead * xref:ROOT:index.adoc[Components] -** xref:activemq-component.adoc[ActiveMQ Component] -** xref:ahc-component.adoc[AHC Component] -** xref:ahc-ws-component.adoc[AHC Websocket Component] -** xref:amqp-component.adoc[AMQP Component] -** xref:apns-component.adoc[APNS Component] -** xref:as2-component.adoc[AS2 Component] -** xref:asterisk-component.adoc[Asterisk Component] -** xref:atmos-component.adoc[Atmos Component] -** xref:atmosphere-websocket-component.adoc[Atmosphere Websocket Component] -** xref:atom-component.adoc[Atom Component] -** xref:atomix-map-component.adoc[Atomix Map Component] -** xref:atomix-messaging-component.adoc[Atomix Messaging Component] -** xref:atomix-multimap-component.adoc[Atomix MultiMap Component] -** xref:atomix-queue-component.adoc[Atomix Queue Component] -** xref:atomix-set-component.adoc[Atomix Set Component] -** xref:atomix-value-component.adoc[Atomix Value Component] -** xref:attachments.adoc[Attachments Component] -** xref:avro-component.adoc[Avro Component] -** xref:aws2-cw-component.adoc[AWS 2 CloudWatch Component] -** xref:aws2-ddb-component.adoc[AWS 2 DynamoDB Component] -** xref:aws2-ddbstream-component.adoc[AWS 2 DynamoDB Streams Component] -** xref:aws2-ec2-component.adoc[AWS 2 EC2 Component] -** xref:aws2-ecs-component.adoc[AWS 2 ECS Component] -** xref:aws2-eks-component.adoc[AWS 2 EKS Component] -** xref:aws2-iam-component.adoc[AWS 2 IAM Component] -** xref:aws2-kinesis-component.adoc[AWS 2 Kinesis Component] -** xref:aws2-kinesis-firehose-component.adoc[AWS 2 Kinesis Firehose Component] -** xref:aws2-kms-component.adoc[AWS 2 KMS Component] -** xref:aws2-mq-component.adoc[AWS 2 MQ Component] -** xref:aws2-msk-component.adoc[AWS 2 MSK Component] -** xref:aws2-ses-component.adoc[AWS 2 Simple Email Service Component] -** xref:aws2-sns-component.adoc[AWS 2 Simple Notification System Component] -** xref:aws2-sqs-component.adoc[AWS 2 Simple Queue Service Component] -** xref:aws2-translate-component.adoc[AWS 2 Translate Component] -** xref:aws-cw-component.adoc[AWS CloudWatch Component] -** xref:aws-ddb-component.adoc[AWS DynamoDB Component] -** xref:aws-ddbstream-component.adoc[AWS DynamoDB Streams Component] -** xref:aws-ec2-component.adoc[AWS EC2 Component] -** xref:aws-ecs-component.adoc[AWS ECS Component] -** xref:aws-eks-component.adoc[AWS EKS Component] -** xref:aws-iam-component.adoc[AWS IAM Component] -** xref:aws-kinesis-component.adoc[AWS Kinesis Component] -** xref:aws-kinesis-firehose-component.adoc[AWS Kinesis Firehose Component] -** xref:aws-kms-component.adoc[AWS KMS Component] -** xref:aws-lambda-component.adoc[AWS Lambda Component] -** xref:aws2-lambda-component.adoc[AWS Lambda Component] -** xref:aws-mq-component.adoc[AWS MQ Component] -** xref:aws-msk-component.adoc[AWS MSK Component] -** xref:aws-s3-component.adoc[AWS S3 Storage Service Component] -** xref:aws-ses-component.adoc[AWS Simple Email Service Component] -** xref:aws-sns-component.adoc[AWS Simple Notification System Component] -** xref:aws-sqs-component.adoc[AWS Simple Queue Service Component] -** xref:aws-swf-component.adoc[AWS Simple Workflow Component] -** xref:aws-sdb-component.adoc[AWS SimpleDB Component] -** xref:aws-translate-component.adoc[AWS Translate Component] -** xref:aws-xray.adoc[AWS XRay Component] -** xref:aws2-s3-component.adoc[AWS2 S3 Storage Service Component] -** xref:azure-blob-component.adoc[Azure Storage Blob Service Component] -** xref:azure-storage-blob-component.adoc[Azure Storage Blob Service Component] -** xref:azure-queue-component.adoc[Azure Storage Queue Service Component] -** xref:bean-component.adoc[Bean Component] -** xref:bean-validator-component.adoc[Bean Validator Component] -** xref:beanstalk-component.adoc[Beanstalk Component] -** xref:bonita-component.adoc[Bonita Component] -** xref:box-component.adoc[Box Component] -** xref:braintree-component.adoc[Braintree Component] -** xref:browse-component.adoc[Browse Component] -** xref:caffeine-cache-component.adoc[Caffeine Cache Component] -** xref:caffeine-loadcache-component.adoc[Caffeine LoadCache Component] -** xref:cdi.adoc[Camel CDI] -** xref:azure.adoc[Camel Components for Windows Azure Services] -** xref:test-spring-junit5.adoc[Camel Test Spring JUnit 5] -** xref:cql-component.adoc[Cassandra CQL Component] -** xref:test-cdi.adoc[CDI Testing] -** xref:chatscript-component.adoc[ChatScript Component] -** xref:chunk-component.adoc[Chunk Component] -** xref:class-component.adoc[Class Component] -** xref:cm-sms-component.adoc[CM SMS Gateway Component] -** xref:cmis-component.adoc[CMIS Component] -** xref:coap-component.adoc[CoAP Component] -** xref:cometd-component.adoc[CometD Component] -** xref:consul-component.adoc[Consul Component] -** xref:controlbus-component.adoc[Control Bus Component] -** xref:corda-component.adoc[Corda Component] -** xref:couchbase-component.adoc[Couchbase Component] -** xref:couchdb-component.adoc[CouchDB Component] -** xref:cron-component.adoc[Cron Component] -** xref:crypto-component.adoc[Crypto (JCE) Component] -** xref:crypto-cms-component.adoc[Crypto CMS Component (deprecated)] -** xref:cxf-component.adoc[CXF Component] -** xref:cxf-transport.adoc[CXF Transport Component] -** xref:cxfrs-component.adoc[CXF-RS Component] -** xref:dataformat-component.adoc[Data Format Component] -** xref:dataset-component.adoc[Dataset Component] -** xref:dataset-test-component.adoc[DataSet Test Component] -** xref:debezium-mongodb-component.adoc[Debezium MongoDB Connector Component] -** xref:debezium-mysql-component.adoc[Debezium MySQL Connector Component] -** xref:debezium-postgres-component.adoc[Debezium PostgresSQL Connector Component] -** xref:debezium-sqlserver-component.adoc[Debezium SQL Server Connector Component] -** xref:djl-component.adoc[Deep Java Library Component] -** xref:digitalocean-component.adoc[DigitalOcean Component] -** xref:direct-component.adoc[Direct Component] -** xref:direct-vm-component.adoc[Direct VM Component] -** xref:disruptor-component.adoc[Disruptor Component] -** xref:dns-component.adoc[DNS Component] -** xref:docker-component.adoc[Docker Component] -** xref:dozer-component.adoc[Dozer Component] -** xref:drill-component.adoc[Drill Component] -** xref:dropbox-component.adoc[Dropbox Component] -** xref:ehcache-component.adoc[Ehcache Component] -** xref:elasticsearch-rest-component.adoc[Elastichsearch Rest Component] -** xref:elsql-component.adoc[ElSQL Component] -** xref:etcd-keys-component.adoc[Etcd Keys Component] -** xref:etcd-stats-component.adoc[Etcd Stats Component] -** xref:etcd-watch-component.adoc[Etcd Watch Component] -** xref:exec-component.adoc[Exec Component] -** xref:facebook-component.adoc[Facebook Component] -** xref:fhir-component.adoc[FHIR Component] -** xref:file-component.adoc[File Component] -** xref:file-watch-component.adoc[File Watch Component] -** xref:flatpack-component.adoc[Flatpack Component] -** xref:flink-component.adoc[Flink Component] -** xref:fop-component.adoc[FOP Component] -** xref:freemarker-component.adoc[Freemarker Component] -** xref:ftp-component.adoc[FTP Component] -** xref:ftps-component.adoc[FTPS Component] -** xref:ganglia-component.adoc[Ganglia Component] -** xref:geocoder-component.adoc[Geocoder Component] -** xref:git-component.adoc[Git Component] -** xref:github-component.adoc[GitHub Component] -** xref:google-bigquery-component.adoc[Google BigQuery Component] -** xref:google-bigquery-sql-component.adoc[Google BigQuery Standard SQL Component] -** xref:google-calendar-component.adoc[Google Calendar Component] -** xref:google-calendar-stream-component.adoc[Google Calendar Stream Component] -** xref:google-drive-component.adoc[Google Drive Component] -** xref:google-mail-component.adoc[Google Mail Component] -** xref:google-mail-stream-component.adoc[Google Mail Stream Component] -** xref:google-pubsub-component.adoc[Google Pubsub Component] -** xref:google-sheets-component.adoc[Google Sheets Component] -** xref:google-sheets-stream-component.adoc[Google Sheets Stream Component] -** xref:gora-component.adoc[Gora Component] -** xref:grape-component.adoc[Grape Component] -** xref:graphql-component.adoc[GraphQL Component] -** xref:grpc-component.adoc[gRPC Component] -** xref:guava-eventbus-component.adoc[Guava EventBus Component] -** xref:hazelcast-atomicvalue-component.adoc[Hazelcast Atomic Number Component] -** xref:hazelcast.adoc[Hazelcast Component] -** xref:hazelcast-instance-component.adoc[Hazelcast Instance Component] -** xref:hazelcast-list-component.adoc[Hazelcast List Component] -** xref:hazelcast-map-component.adoc[Hazelcast Map Component] -** xref:hazelcast-multimap-component.adoc[Hazelcast Multimap Component] -** xref:hazelcast-queue-component.adoc[Hazelcast Queue Component] -** xref:hazelcast-replicatedmap-component.adoc[Hazelcast Replicated Map Component] -** xref:hazelcast-ringbuffer-component.adoc[Hazelcast Ringbuffer Component] -** xref:hazelcast-seda-component.adoc[Hazelcast SEDA Component] -** xref:hazelcast-set-component.adoc[Hazelcast Set Component] -** xref:hazelcast-topic-component.adoc[Hazelcast Topic Component] -** xref:hbase-component.adoc[HBase Component] -** xref:hdfs-component.adoc[HDFS Component] -** xref:hipchat-component.adoc[Hipchat Component] -** xref:http-component.adoc[HTTP Component] -** xref:hystrix.adoc[Hystrix Component] -** xref:iec60870-client-component.adoc[IEC 60870 Client Component] -** xref:iec60870-server-component.adoc[IEC 60870 Server Component] -** xref:ignite-cache-component.adoc[Ignite Cache Component] -** xref:ignite-compute-component.adoc[Ignite Compute Component] -** xref:ignite.adoc[Ignite endpoints Component] -** xref:ignite-events-component.adoc[Ignite Events Component] -** xref:ignite-idgen-component.adoc[Ignite ID Generator Component] -** xref:ignite-messaging-component.adoc[Ignite Messaging Component] -** xref:ignite-queue-component.adoc[Ignite Queues Component] -** xref:ignite-set-component.adoc[Ignite Sets Component] -** xref:infinispan-component.adoc[Infinispan Component] -** xref:influxdb-component.adoc[InfluxDB Component] -** xref:iota-component.adoc[IOTA Component] -** xref:ipfs-component.adoc[IPFS Component] -** xref:irc-component.adoc[IRC Component] -** xref:ironmq-component.adoc[IronMQ Component] -** xref:jasypt.adoc[Jasypt component] -** xref:websocket-jsr356-component.adoc[Javax Websocket Component] -** xref:jbpm-component.adoc[JBPM Component] -** xref:jcache-component.adoc[JCache Component] -** xref:jclouds-component.adoc[JClouds Component] -** xref:jcr-component.adoc[JCR Component] -** xref:jdbc-component.adoc[JDBC Component] -** xref:jetty-component.adoc[Jetty Component] -** xref:websocket-component.adoc[Jetty Websocket Component] -** xref:jgroups-component.adoc[JGroups Component] -** xref:jgroups-raft-component.adoc[JGroups raft Component] -** xref:jing-component.adoc[Jing Component] -** xref:jira-component.adoc[Jira Component] -** xref:jms-component.adoc[JMS Component] -** xref:jmx-component.adoc[JMX Component] -** xref:jolt-component.adoc[JOLT Component] -** xref:jooq-component.adoc[JOOQ Component] -** xref:jpa-component.adoc[JPA Component] -** xref:jslt-component.adoc[JSLT Component] -** xref:json-validator-component.adoc[JSON Schema Validator Component] -** xref:jt400-component.adoc[JT400 Component] -** xref:kafka-component.adoc[Kafka Component] -** xref:kubernetes.adoc[Kubernetes Components] -** xref:kubernetes-config-maps-component.adoc[Kubernetes ConfigMap Component] -** xref:kubernetes-deployments-component.adoc[Kubernetes Deployments Component] -** xref:kubernetes-hpa-component.adoc[Kubernetes HPA Component] -** xref:kubernetes-job-component.adoc[Kubernetes Job Component] -** xref:kubernetes-namespaces-component.adoc[Kubernetes Namespaces Component] -** xref:kubernetes-nodes-component.adoc[Kubernetes Nodes Component] -** xref:kubernetes-persistent-volumes-claims-component.adoc[Kubernetes Persistent Volume Claim Component] -** xref:kubernetes-persistent-volumes-component.adoc[Kubernetes Persistent Volume Component] -** xref:kubernetes-pods-component.adoc[Kubernetes Pods Component] -** xref:kubernetes-replication-controllers-component.adoc[Kubernetes Replication Controller Component] -** xref:kubernetes-resources-quota-component.adoc[Kubernetes Resources Quota Component] -** xref:kubernetes-secrets-component.adoc[Kubernetes Secrets Component] -** xref:kubernetes-service-accounts-component.adoc[Kubernetes Service Account Component] -** xref:kubernetes-services-component.adoc[Kubernetes Services Component] -** xref:kudu-component.adoc[Kudu Component] -** xref:language-component.adoc[Language Component] -** xref:ldap-component.adoc[LDAP Component] -** xref:ldif-component.adoc[LDIF Component] -** xref:leveldb.adoc[LevelDB] -** xref:log-component.adoc[Log Component] -** xref:lra.adoc[LRA Component] -** xref:lucene-component.adoc[Lucene Component] -** xref:lumberjack-component.adoc[Lumberjack Component] -** xref:mail-component.adoc[Mail Component] -** xref:master-component.adoc[Master Component] -** xref:metrics-component.adoc[Metrics Component] -** xref:micrometer-component.adoc[Micrometer Component] -** xref:microprofile-config.adoc[MicroProfile Config] -** xref:microprofile-fault-tolerance.adoc[Microprofile Fault Tolerance Component] -** xref:microprofile-health.adoc[MicroProfile Health] -** xref:microprofile-metrics-component.adoc[MicroProfile Metrics Component] -** xref:mina-component.adoc[Mina Component] -** xref:mllp-component.adoc[MLLP Component] -** xref:mock-component.adoc[Mock Component] -** xref:mongodb-component.adoc[MongoDB Component] -** xref:mongodb-gridfs-component.adoc[MongoDB GridFS Component] -** xref:msv-component.adoc[MSV Component] -** xref:mustache-component.adoc[Mustache Component] -** xref:mvel-component.adoc[MVEL Component] -** xref:mybatis-bean-component.adoc[MyBatis Bean Component] -** xref:mybatis-component.adoc[MyBatis Component] -** xref:nagios-component.adoc[Nagios Component] -** xref:nats-component.adoc[Nats Component] -** xref:netty-component.adoc[Netty Component] -** xref:netty-http-component.adoc[Netty HTTP Component] -** xref:nitrite-component.adoc[Nitrite Component] -** xref:nsq-component.adoc[NSQ Component] -** xref:olingo2-component.adoc[Olingo2 Component] -** xref:olingo4-component.adoc[Olingo4 Component] -** xref:milo-client-component.adoc[OPC UA Client Component] -** xref:milo-server-component.adoc[OPC UA Server Component] -** xref:openapi-java.adoc[OpenApi Java Component] -** xref:openshift-build-configs-component.adoc[Openshift Build Config Component] -** xref:openshift-builds-component.adoc[Openshift Builds Component] -** xref:openstack-cinder-component.adoc[OpenStack Cinder Component] -** xref:openstack.adoc[Openstack Component] -** xref:openstack-glance-component.adoc[OpenStack Glance Component] -** xref:openstack-keystone-component.adoc[OpenStack Keystone Component] -** xref:openstack-neutron-component.adoc[OpenStack Neutron Component] -** xref:openstack-nova-component.adoc[OpenStack Nova Component] -** xref:openstack-swift-component.adoc[OpenStack Swift Component] -** xref:opentracing.adoc[OpenTracing Component] -** xref:optaplanner-component.adoc[OptaPlanner Component] -** xref:paho-component.adoc[Paho Component] -** xref:pdf-component.adoc[PDF Component] -** xref:platform-http-component.adoc[Platform HTTP Component] -** xref:platform-http-vertx.adoc[PlatformHttp VertX] -** xref:pgevent-component.adoc[PostgresSQL Event Component] -** xref:pg-replication-slot-component.adoc[PostgresSQL Replication Slot Component] -** xref:lpr-component.adoc[Printer Component] -** xref:properties-component.adoc[Properties Component] -** xref:pubnub-component.adoc[PubNub Component] -** xref:pulsar-component.adoc[Pulsar Component] -** xref:quartz-component.adoc[Quartz Component] -** xref:quickfix-component.adoc[QuickFix Component] -** xref:rabbitmq-component.adoc[RabbitMQ Component] -** xref:reactive-streams-component.adoc[Reactive Streams Component] -** xref:reactive-executor-vertx.adoc[ReactiveExecutor VertX] -** xref:reactor.adoc[Reactor Component] -** xref:ref-component.adoc[Ref Component] -** xref:resilience4j.adoc[Resilience4j Component] -** xref:rest-api-component.adoc[REST API Component] -** xref:rest-component.adoc[REST Component] -** xref:rest-openapi-component.adoc[REST OpenApi Component] -** xref:rest-swagger-component.adoc[REST Swagger Component] -** xref:ribbon.adoc[Ribbon Component] -** xref:robotframework-component.adoc[Robot Framework Component] -** xref:rss-component.adoc[RSS Component] -** xref:rxjava.adoc[RxJava Component] -** xref:saga-component.adoc[Saga Component] -** xref:salesforce-component.adoc[Salesforce Component] -** xref:sap-netweaver-component.adoc[SAP NetWeaver Component] -** xref:scheduler-component.adoc[Scheduler Component] -** xref:schematron-component.adoc[Schematron Component] -** xref:scp-component.adoc[SCP Component] -** xref:seda-component.adoc[SEDA Component] -** xref:service-component.adoc[Service Component] -** xref:servicenow-component.adoc[ServiceNow Component] -** xref:servlet-component.adoc[Servlet Component] -** xref:sftp-component.adoc[SFTP Component] -** xref:shiro.adoc[Shiro Security Component] -** xref:sjms-batch-component.adoc[Simple JMS Batch Component] -** xref:sjms-component.adoc[Simple JMS Component] -** xref:sjms2-component.adoc[Simple JMS2 Component] -** xref:sip-component.adoc[SIP Component] -** xref:slack-component.adoc[Slack Component] -** xref:smpp-component.adoc[SMPP Component] -** xref:snmp-component.adoc[SNMP Component] -** xref:solr-component.adoc[Solr Component] -** xref:soroush-component.adoc[Soroush Component] -** xref:spark-component.adoc[Spark Component] -** xref:splunk-component.adoc[Splunk Component] -** xref:spring-batch-component.adoc[Spring Batch Component] -** xref:spring-event-component.adoc[Spring Event Component] -** xref:spring-integration-component.adoc[Spring Integration Component] -** xref:spring-javaconfig.adoc[Spring Java Config] -** xref:spring-ldap-component.adoc[Spring LDAP Component] -** xref:spring-main.adoc[Spring Main] -** xref:spring-redis-component.adoc[Spring Redis Component] -** xref:spring-security.adoc[Spring Security] -** xref:spring.adoc[Spring Support] -** xref:spring-ws-component.adoc[Spring WebService Component] -** xref:sql-component.adoc[SQL Component] -** xref:sql-stored-component.adoc[SQL Stored Procedure Component] -** xref:ssh-component.adoc[SSH Component] -** xref:stax-component.adoc[StAX Component] -** xref:stomp-component.adoc[Stomp Component] -** xref:stream-component.adoc[Stream Component] -** xref:string-template-component.adoc[String Template Component] -** xref:stub-component.adoc[Stub Component] -** xref:swagger-java.adoc[Swagger Java Component] -** xref:telegram-component.adoc[Telegram Component] -** xref:test-junit5.adoc[Test Module] -** xref:test.adoc[Test Module] -** xref:test-spring.adoc[Test Spring] -** xref:testcontainers-junit5.adoc[Testcontainers] -** xref:testcontainers.adoc[Testcontainers] -** xref:testcontainers-spring-junit5.adoc[Testcontainers Spring] -** xref:testcontainers-spring.adoc[Testcontainers Spring] -** xref:thrift-component.adoc[Thrift Component] -** xref:tika-component.adoc[Tika Component] -** xref:timer-component.adoc[Timer Component] -** xref:twilio-component.adoc[Twilio Component] -** xref:twitter-directmessage-component.adoc[Twitter Direct Message Component] -** xref:twitter-search-component.adoc[Twitter Search Component] -** xref:twitter-timeline-component.adoc[Twitter Timeline Component] -** xref:undertow-component.adoc[Undertow Component] +** xref:activemq-component.adoc[ActiveMQ] +** xref:ahc-component.adoc[AHC] +** xref:ahc-ws-component.adoc[AHC Websocket] +** xref:amqp-component.adoc[AMQP] +** xref:apns-component.adoc[APNS] +** xref:as2-component.adoc[AS2] +** xref:asterisk-component.adoc[Asterisk] +** xref:atmos-component.adoc[Atmos] +** xref:atmosphere-websocket-component.adoc[Atmosphere Websocket] +** xref:atom-component.adoc[Atom] +** xref:atomix-map-component.adoc[Atomix Map] +** xref:atomix-messaging-component.adoc[Atomix Messaging] +** xref:atomix-multimap-component.adoc[Atomix MultiMap] +** xref:atomix-queue-component.adoc[Atomix Queue] +** xref:atomix-set-component.adoc[Atomix Set] +** xref:atomix-value-component.adoc[Atomix Value] +** xref:avro-component.adoc[Avro] +** xref:aws2-cw-component.adoc[AWS 2 CloudWatch] +** xref:aws2-ddb-component.adoc[AWS 2 DynamoDB] +** xref:aws2-ddbstream-component.adoc[AWS 2 DynamoDB Streams] +** xref:aws2-ec2-component.adoc[AWS 2 EC2] +** xref:aws2-ecs-component.adoc[AWS 2 ECS] +** xref:aws2-eks-component.adoc[AWS 2 EKS] +** xref:aws2-iam-component.adoc[AWS 2 IAM] +** xref:aws2-kinesis-component.adoc[AWS 2 Kinesis] +** xref:aws2-kinesis-firehose-component.adoc[AWS 2 Kinesis Firehose] +** xref:aws2-kms-component.adoc[AWS 2 KMS] +** xref:aws2-mq-component.adoc[AWS 2 MQ] +** xref:aws2-msk-component.adoc[AWS 2 MSK] +** xref:aws2-ses-component.adoc[AWS 2 Simple Email Service] +** xref:aws2-sns-component.adoc[AWS 2 Simple Notification System] +** xref:aws2-sqs-component.adoc[AWS 2 Simple Queue Service] +** xref:aws2-translate-component.adoc[AWS 2 Translate] +** xref:aws-cw-component.adoc[AWS CloudWatch] +** xref:aws-ddb-component.adoc[AWS DynamoDB] +** xref:aws-ddbstream-component.adoc[AWS DynamoDB Streams] +** xref:aws-ec2-component.adoc[AWS EC2] +** xref:aws-ecs-component.adoc[AWS ECS] +** xref:aws-eks-component.adoc[AWS EKS] +** xref:aws-iam-component.adoc[AWS IAM] +** xref:aws-kinesis-component.adoc[AWS Kinesis] +** xref:aws-kinesis-firehose-component.adoc[AWS Kinesis Firehose] +** xref:aws-kms-component.adoc[AWS KMS] +** xref:aws-lambda-component.adoc[AWS Lambda] +** xref:aws2-lambda-component.adoc[AWS Lambda] +** xref:aws-mq-component.adoc[AWS MQ] +** xref:aws-msk-component.adoc[AWS MSK] +** xref:aws-s3-component.adoc[AWS S3 Storage Service] +** xref:aws-ses-component.adoc[AWS Simple Email Service] +** xref:aws-sns-component.adoc[AWS Simple Notification System] +** xref:aws-sqs-component.adoc[AWS Simple Queue Service] +** xref:aws-swf-component.adoc[AWS Simple Workflow] +** xref:aws-sdb-component.adoc[AWS SimpleDB] +** xref:aws-translate-component.adoc[AWS Translate] +** xref:aws2-s3-component.adoc[AWS2 S3 Storage Service] +** xref:azure-summary.adoc[Azure] +** xref:azure-storage-blob-component.adoc[Azure Storage Blob Service] +** xref:azure-blob-component.adoc[Azure Storage Blob Service] +** xref:azure-queue-component.adoc[Azure Storage Queue Service] +** xref:bean-component.adoc[Bean] +** xref:bean-validator-component.adoc[Bean Validator] +** xref:beanstalk-component.adoc[Beanstalk] +** xref:bonita-component.adoc[Bonita] +** xref:box-component.adoc[Box] +** xref:braintree-component.adoc[Braintree] +** xref:browse-component.adoc[Browse] +** xref:caffeine-cache-component.adoc[Caffeine Cache] +** xref:caffeine-loadcache-component.adoc[Caffeine LoadCache] +** xref:cql-component.adoc[Cassandra CQL] +** xref:chatscript-component.adoc[ChatScript] +** xref:chunk-component.adoc[Chunk] +** xref:class-component.adoc[Class] +** xref:cm-sms-component.adoc[CM SMS Gateway] +** xref:cmis-component.adoc[CMIS] +** xref:coap-component.adoc[CoAP] +** xref:cometd-component.adoc[CometD] +** xref:consul-component.adoc[Consul] +** xref:controlbus-component.adoc[Control Bus] +** xref:corda-component.adoc[Corda] +** xref:couchbase-component.adoc[Couchbase] +** xref:couchdb-component.adoc[CouchDB] +** xref:cron-component.adoc[Cron] +** xref:crypto-component.adoc[Crypto (JCE)] +** xref:crypto-cms-component.adoc[Crypto CMS] +** xref:cxf-component.adoc[CXF] +** xref:cxfrs-component.adoc[CXF-RS] +** xref:dataformat-component.adoc[Data Format] +** xref:dataset-component.adoc[Dataset] +** xref:dataset-test-component.adoc[DataSet Test] +** xref:debezium-mongodb-component.adoc[Debezium MongoDB Connector] +** xref:debezium-mysql-component.adoc[Debezium MySQL Connector] +** xref:debezium-postgres-component.adoc[Debezium PostgresSQL Connector] +** xref:debezium-sqlserver-component.adoc[Debezium SQL Server Connector] +** xref:djl-component.adoc[Deep Java Library] +** xref:digitalocean-component.adoc[DigitalOcean] +** xref:direct-component.adoc[Direct] +** xref:direct-vm-component.adoc[Direct VM] +** xref:disruptor-component.adoc[Disruptor] +** xref:dns-component.adoc[DNS] +** xref:docker-component.adoc[Docker] +** xref:dozer-component.adoc[Dozer] +** xref:drill-component.adoc[Drill] +** xref:dropbox-component.adoc[Dropbox] +** xref:ehcache-component.adoc[Ehcache] +** xref:elasticsearch-rest-component.adoc[Elastichsearch Rest] +** xref:elsql-component.adoc[ElSQL] +** xref:etcd-keys-component.adoc[Etcd Keys] +** xref:etcd-stats-component.adoc[Etcd Stats] +** xref:etcd-watch-component.adoc[Etcd Watch] +** xref:exec-component.adoc[Exec] +** xref:facebook-component.adoc[Facebook] +** xref:fhir-component.adoc[FHIR] +** xref:file-component.adoc[File] +** xref:file-watch-component.adoc[File Watch] +** xref:flatpack-component.adoc[Flatpack] +** xref:flink-component.adoc[Flink] +** xref:fop-component.adoc[FOP] +** xref:freemarker-component.adoc[Freemarker] +** xref:ftp-component.adoc[FTP] +** xref:ftps-component.adoc[FTPS] +** xref:ganglia-component.adoc[Ganglia] +** xref:geocoder-component.adoc[Geocoder] +** xref:git-component.adoc[Git] +** xref:github-component.adoc[GitHub] +** xref:google-bigquery-component.adoc[Google BigQuery] +** xref:google-bigquery-sql-component.adoc[Google BigQuery Standard SQL] +** xref:google-calendar-component.adoc[Google Calendar] +** xref:google-calendar-stream-component.adoc[Google Calendar Stream] +** xref:google-drive-component.adoc[Google Drive] +** xref:google-mail-component.adoc[Google Mail] +** xref:google-mail-stream-component.adoc[Google Mail Stream] +** xref:google-pubsub-component.adoc[Google Pubsub] +** xref:google-sheets-component.adoc[Google Sheets] +** xref:google-sheets-stream-component.adoc[Google Sheets Stream] +** xref:gora-component.adoc[Gora] +** xref:grape-component.adoc[Grape] +** xref:graphql-component.adoc[GraphQL] +** xref:grpc-component.adoc[gRPC] +** xref:guava-eventbus-component.adoc[Guava EventBus] +** xref:hazelcast-summary.adoc[Hazelcast] +** xref:hazelcast-atomicvalue-component.adoc[Hazelcast Atomic Number] +** xref:hazelcast-instance-component.adoc[Hazelcast Instance] +** xref:hazelcast-list-component.adoc[Hazelcast List] +** xref:hazelcast-map-component.adoc[Hazelcast Map] +** xref:hazelcast-multimap-component.adoc[Hazelcast Multimap] +** xref:hazelcast-queue-component.adoc[Hazelcast Queue] +** xref:hazelcast-replicatedmap-component.adoc[Hazelcast Replicated Map] +** xref:hazelcast-ringbuffer-component.adoc[Hazelcast Ringbuffer] +** xref:hazelcast-seda-component.adoc[Hazelcast SEDA] +** xref:hazelcast-set-component.adoc[Hazelcast Set] +** xref:hazelcast-topic-component.adoc[Hazelcast Topic] +** xref:hbase-component.adoc[HBase] +** xref:hdfs-component.adoc[HDFS] +** xref:hipchat-component.adoc[Hipchat] +** xref:http-component.adoc[HTTP] +** xref:iec60870-client-component.adoc[IEC 60870 Client] +** xref:iec60870-server-component.adoc[IEC 60870 Server] +** xref:ignite-summary.adoc[Ignite] +** xref:ignite-cache-component.adoc[Ignite Cache] +** xref:ignite-compute-component.adoc[Ignite Compute] +** xref:ignite-events-component.adoc[Ignite Events] +** xref:ignite-idgen-component.adoc[Ignite ID Generator] +** xref:ignite-messaging-component.adoc[Ignite Messaging] +** xref:ignite-queue-component.adoc[Ignite Queues] +** xref:ignite-set-component.adoc[Ignite Sets] +** xref:infinispan-component.adoc[Infinispan] +** xref:influxdb-component.adoc[InfluxDB] +** xref:iota-component.adoc[IOTA] +** xref:ipfs-component.adoc[IPFS] +** xref:irc-component.adoc[IRC] +** xref:ironmq-component.adoc[IronMQ] +** xref:websocket-jsr356-component.adoc[Javax Websocket] +** xref:jbpm-component.adoc[JBPM] +** xref:jcache-component.adoc[JCache] +** xref:jclouds-component.adoc[JClouds] +** xref:jcr-component.adoc[JCR] +** xref:jdbc-component.adoc[JDBC] +** xref:jetty-component.adoc[Jetty] +** xref:websocket-component.adoc[Jetty Websocket] +** xref:jgroups-component.adoc[JGroups] +** xref:jgroups-raft-component.adoc[JGroups raft] +** xref:jing-component.adoc[Jing] +** xref:jira-component.adoc[Jira] +** xref:jms-component.adoc[JMS] +** xref:jmx-component.adoc[JMX] +** xref:jolt-component.adoc[JOLT] +** xref:jooq-component.adoc[JOOQ] +** xref:jpa-component.adoc[JPA] +** xref:jslt-component.adoc[JSLT] +** xref:json-validator-component.adoc[JSON Schema Validator] +** xref:jt400-component.adoc[JT400] +** xref:kafka-component.adoc[Kafka] +** xref:kubernetes-summary.adoc[Kubernetes] +** xref:kubernetes-config-maps-component.adoc[Kubernetes ConfigMap] +** xref:kubernetes-deployments-component.adoc[Kubernetes Deployments] +** xref:kubernetes-hpa-component.adoc[Kubernetes HPA] +** xref:kubernetes-job-component.adoc[Kubernetes Job] +** xref:kubernetes-namespaces-component.adoc[Kubernetes Namespaces] +** xref:kubernetes-nodes-component.adoc[Kubernetes Nodes] +** xref:kubernetes-persistent-volumes-component.adoc[Kubernetes Persistent Volume] +** xref:kubernetes-persistent-volumes-claims-component.adoc[Kubernetes Persistent Volume Claim] +** xref:kubernetes-pods-component.adoc[Kubernetes Pods] +** xref:kubernetes-replication-controllers-component.adoc[Kubernetes Replication Controller] +** xref:kubernetes-resources-quota-component.adoc[Kubernetes Resources Quota] +** xref:kubernetes-secrets-component.adoc[Kubernetes Secrets] +** xref:kubernetes-service-accounts-component.adoc[Kubernetes Service Account] +** xref:kubernetes-services-component.adoc[Kubernetes Services] +** xref:kudu-component.adoc[Kudu] +** xref:language-component.adoc[Language] +** xref:ldap-component.adoc[LDAP] +** xref:ldif-component.adoc[LDIF] +** xref:log-component.adoc[Log] +** xref:lucene-component.adoc[Lucene] +** xref:lumberjack-component.adoc[Lumberjack] +** xref:mail-component.adoc[Mail] +** xref:master-component.adoc[Master] +** xref:metrics-component.adoc[Metrics] +** xref:micrometer-component.adoc[Micrometer] +** xref:microprofile-metrics-component.adoc[MicroProfile Metrics] +** xref:mina-component.adoc[Mina] +** xref:mllp-component.adoc[MLLP] +** xref:mock-component.adoc[Mock] +** xref:mongodb-component.adoc[MongoDB] +** xref:mongodb-gridfs-component.adoc[MongoDB GridFS] +** xref:msv-component.adoc[MSV] +** xref:mustache-component.adoc[Mustache] +** xref:mvel-component.adoc[MVEL] +** xref:mybatis-component.adoc[MyBatis] +** xref:mybatis-bean-component.adoc[MyBatis Bean] +** xref:nagios-component.adoc[Nagios] +** xref:nats-component.adoc[Nats] +** xref:netty-component.adoc[Netty] +** xref:netty-http-component.adoc[Netty HTTP] +** xref:nitrite-component.adoc[Nitrite] +** xref:nsq-component.adoc[NSQ] +** xref:olingo2-component.adoc[Olingo2] +** xref:olingo4-component.adoc[Olingo4] +** xref:milo-client-component.adoc[OPC UA Client] +** xref:milo-server-component.adoc[OPC UA Server] +** xref:openshift-build-configs-component.adoc[Openshift Build Config] +** xref:openshift-builds-component.adoc[Openshift Builds] +** xref:openstack-summary.adoc[Openstack] +** xref:openstack-cinder-component.adoc[OpenStack Cinder] +** xref:openstack-glance-component.adoc[OpenStack Glance] +** xref:openstack-keystone-component.adoc[OpenStack Keystone] +** xref:openstack-neutron-component.adoc[OpenStack Neutron] +** xref:openstack-nova-component.adoc[OpenStack Nova] +** xref:openstack-swift-component.adoc[OpenStack Swift] +** xref:optaplanner-component.adoc[OptaPlanner] +** xref:paho-component.adoc[Paho] +** xref:pdf-component.adoc[PDF] +** xref:platform-http-component.adoc[Platform HTTP] +** xref:pgevent-component.adoc[PostgresSQL Event] +** xref:pg-replication-slot-component.adoc[PostgresSQL Replication Slot] +** xref:lpr-component.adoc[Printer] +** xref:properties-component.adoc[Properties] +** xref:pubnub-component.adoc[PubNub] +** xref:pulsar-component.adoc[Pulsar] +** xref:quartz-component.adoc[Quartz] +** xref:quickfix-component.adoc[QuickFix] +** xref:rabbitmq-component.adoc[RabbitMQ] +** xref:reactive-streams-component.adoc[Reactive Streams] +** xref:ref-component.adoc[Ref] +** xref:rest-component.adoc[REST] +** xref:rest-api-component.adoc[REST API] +** xref:rest-openapi-component.adoc[REST OpenApi] +** xref:rest-swagger-component.adoc[REST Swagger] +** xref:robotframework-component.adoc[Robot Framework] +** xref:rss-component.adoc[RSS] +** xref:saga-component.adoc[Saga] +** xref:salesforce-component.adoc[Salesforce] +** xref:sap-netweaver-component.adoc[SAP NetWeaver] +** xref:scheduler-component.adoc[Scheduler] +** xref:schematron-component.adoc[Schematron] +** xref:scp-component.adoc[SCP] +** xref:seda-component.adoc[SEDA] +** xref:service-component.adoc[Service] +** xref:servicenow-component.adoc[ServiceNow] +** xref:servlet-component.adoc[Servlet] +** xref:sftp-component.adoc[SFTP] +** xref:sjms-component.adoc[Simple JMS] +** xref:sjms-batch-component.adoc[Simple JMS Batch] +** xref:sjms2-component.adoc[Simple JMS2] +** xref:sip-component.adoc[SIP] +** xref:slack-component.adoc[Slack] +** xref:smpp-component.adoc[SMPP] +** xref:snmp-component.adoc[SNMP] +** xref:solr-component.adoc[Solr] +** xref:soroush-component.adoc[Soroush] +** xref:spark-component.adoc[Spark] +** xref:splunk-component.adoc[Splunk] +** xref:spring-summary.adoc[Spring] +** xref:spring-batch-component.adoc[Spring Batch] +** xref:spring-event-component.adoc[Spring Event] +** xref:spring-integration-component.adoc[Spring Integration] +** xref:spring-ldap-component.adoc[Spring LDAP] +** xref:spring-redis-component.adoc[Spring Redis] +** xref:spring-ws-component.adoc[Spring WebService] +** xref:sql-component.adoc[SQL] +** xref:sql-stored-component.adoc[SQL Stored Procedure] +** xref:ssh-component.adoc[SSH] +** xref:stax-component.adoc[StAX] +** xref:stomp-component.adoc[Stomp] +** xref:stream-component.adoc[Stream] +** xref:string-template-component.adoc[String Template] +** xref:stub-component.adoc[Stub] +** xref:telegram-component.adoc[Telegram] +** xref:thrift-component.adoc[Thrift] +** xref:tika-component.adoc[Tika] +** xref:timer-component.adoc[Timer] +** xref:twilio-component.adoc[Twilio] +** xref:twitter-directmessage-component.adoc[Twitter Direct Message] +** xref:twitter-search-component.adoc[Twitter Search] +** xref:twitter-timeline-component.adoc[Twitter Timeline] +** xref:undertow-component.adoc[Undertow] ** xref:elytron-component.adoc[Undertow Elytron Security Provider] -** xref:validator-component.adoc[Validator Component] -** xref:velocity-component.adoc[Velocity Component] -** xref:vertx-component.adoc[Vert.x Component] -** xref:vm-component.adoc[VM Component] -** xref:weather-component.adoc[Weather Component] -** xref:web3j-component.adoc[Web3j Ethereum Blockchain Component] -** xref:webhook-component.adoc[Webhook Component] -** xref:weka-component.adoc[Weka Component] -** xref:wordpress-component.adoc[Wordpress Component] -** xref:workday-component.adoc[Workday Component] -** xref:xchange-component.adoc[XChange Component] -** xref:xj-component.adoc[XJ Component] -** xref:xmlsecurity-sign-component.adoc[XML Security Sign Component] -** xref:xmlsecurity-verify-component.adoc[XML Security Verify Component] -** xref:xmpp-component.adoc[XMPP Component] -** xref:xquery-component.adoc[XQuery Component] -** xref:xslt-component.adoc[XSLT Component] -** xref:xslt-saxon-component.adoc[XSLT Saxon Component] -** xref:yammer-component.adoc[Yammer Component] -** xref:zendesk-component.adoc[Zendesk Component] -** xref:zipkin.adoc[Zipkin Component] -** xref:zookeeper-component.adoc[ZooKeeper Component] -** xref:zookeeper-master-component.adoc[ZooKeeper Master Component] +** xref:validator-component.adoc[Validator] +** xref:velocity-component.adoc[Velocity] +** xref:vertx-component.adoc[Vert.x] +** xref:vm-component.adoc[VM] +** xref:weather-component.adoc[Weather] +** xref:web3j-component.adoc[Web3j Ethereum Blockchain] +** xref:webhook-component.adoc[Webhook] +** xref:weka-component.adoc[Weka] +** xref:wordpress-component.adoc[Wordpress] +** xref:workday-component.adoc[Workday] +** xref:xchange-component.adoc[XChange] +** xref:xj-component.adoc[XJ] +** xref:xmlsecurity-sign-component.adoc[XML Security Sign] +** xref:xmlsecurity-verify-component.adoc[XML Security Verify] +** xref:xmpp-component.adoc[XMPP] +** xref:xquery-component.adoc[XQuery] +** xref:xslt-component.adoc[XSLT] +** xref:xslt-saxon-component.adoc[XSLT Saxon] +** xref:yammer-component.adoc[Yammer] +** xref:zendesk-component.adoc[Zendesk] +** xref:zookeeper-component.adoc[ZooKeeper] +** xref:zookeeper-master-component.adoc[ZooKeeper Master] diff --git a/docs/components/modules/ROOT/pages/activemq-component.adoc b/docs/components/modules/ROOT/pages/activemq-component.adoc index e4ab6decb8854..d668ec476575a 100644 --- a/docs/components/modules/ROOT/pages/activemq-component.adoc +++ b/docs/components/modules/ROOT/pages/activemq-component.adoc @@ -1,12 +1,16 @@ [[activemq-component]] = ActiveMQ Component :page-source: components/camel-activemq/src/main/docs/activemq-component.adoc +:docTitle: ActiveMQ +:artifactId: camel-activemq +:description: The activemq component allows messages to be sent to (or consumed from) Apache ActiveMQ. This component extends the Camel JMS component. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The ActiveMQ component is an extension to the JMS component and has been pre-configured for using Apache ActiveMQ 5.x (not Artemis). Users of Apache ActiveMQ Artemis should use the JMS component. diff --git a/docs/components/modules/ROOT/pages/ahc-component.adoc b/docs/components/modules/ROOT/pages/ahc-component.adoc index 955ff6b1587f8..418c6bd91937b 100644 --- a/docs/components/modules/ROOT/pages/ahc-component.adoc +++ b/docs/components/modules/ROOT/pages/ahc-component.adoc @@ -1,12 +1,16 @@ [[ahc-component]] = AHC Component :page-source: components/camel-ahc/src/main/docs/ahc-component.adoc +:docTitle: AHC +:artifactId: camel-ahc +:description: To call external HTTP services using Async Http Client. +:since: 2.8 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.8* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The AHC component provides HTTP based endpoints for consuming external HTTP resources (as a client to call external diff --git a/docs/components/modules/ROOT/pages/ahc-ws-component.adoc b/docs/components/modules/ROOT/pages/ahc-ws-component.adoc index f2f43ae7c54e4..268015697e31f 100644 --- a/docs/components/modules/ROOT/pages/ahc-ws-component.adoc +++ b/docs/components/modules/ROOT/pages/ahc-ws-component.adoc @@ -1,12 +1,16 @@ [[ahc-ws-component]] = AHC Websocket Component :page-source: components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc +:docTitle: AHC Websocket +:artifactId: camel-ahc-ws +:description: To exchange data with external Websocket servers using Async Http Client. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The AHC-WS component provides Websocket based endpoints for a client communicating with diff --git a/docs/components/modules/ROOT/pages/amqp-component.adoc b/docs/components/modules/ROOT/pages/amqp-component.adoc index 66839fb36c8be..2ee5ae88dc864 100644 --- a/docs/components/modules/ROOT/pages/amqp-component.adoc +++ b/docs/components/modules/ROOT/pages/amqp-component.adoc @@ -1,12 +1,16 @@ [[amqp-component]] = AMQP Component :page-source: components/camel-amqp/src/main/docs/amqp-component.adoc +:docTitle: AMQP +:artifactId: camel-amqp +:description: Messaging with AMQP protocol using Apache QPid Client. +:since: 1.2 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.2* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The AMQP component supports the http://www.amqp.org/[AMQP 1.0 protocol] diff --git a/docs/components/modules/ROOT/pages/apns-component.adoc b/docs/components/modules/ROOT/pages/apns-component.adoc index 17ff3a489df3c..48956c0cc2192 100644 --- a/docs/components/modules/ROOT/pages/apns-component.adoc +++ b/docs/components/modules/ROOT/pages/apns-component.adoc @@ -1,12 +1,16 @@ [[apns-component]] = APNS Component :page-source: components/camel-apns/src/main/docs/apns-component.adoc +:docTitle: APNS +:artifactId: camel-apns +:description: For sending notifications to Apple iOS devices. +:since: 2.8 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.8* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The APNS component is used for sending notifications to iOS devices. The APNS components use https://github.com/notnoop/java-apns[javapns] diff --git a/docs/components/modules/ROOT/pages/as2-component.adoc b/docs/components/modules/ROOT/pages/as2-component.adoc index 22df865d2c693..1cd31b4dafb14 100644 --- a/docs/components/modules/ROOT/pages/as2-component.adoc +++ b/docs/components/modules/ROOT/pages/as2-component.adoc @@ -1,12 +1,16 @@ [[as2-component]] = AS2 Component :page-source: components/camel-as2/camel-as2-component/src/main/docs/as2-component.adoc +:docTitle: AS2 +:artifactId: camel-as2 +:description: Component used for transferring data secure and reliable over the internet using the AS2 protocol. +:since: 2.22 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.22* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The AS2 component provides transport of EDI messages using the HTTP transfer protocol as specified in https://tools.ietf.org/html/rfc4130[RFC4130]. @@ -260,4 +264,3 @@ URI Options for _server_ |=== include::camel-spring-boot::page$as2-starter.adoc[] - diff --git a/docs/components/modules/ROOT/pages/asterisk-component.adoc b/docs/components/modules/ROOT/pages/asterisk-component.adoc index 12fe33d1fd649..8d745374241b3 100644 --- a/docs/components/modules/ROOT/pages/asterisk-component.adoc +++ b/docs/components/modules/ROOT/pages/asterisk-component.adoc @@ -1,12 +1,16 @@ [[asterisk-component]] = Asterisk Component :page-source: components/camel-asterisk/src/main/docs/asterisk-component.adoc +:docTitle: Asterisk +:artifactId: camel-asterisk +:description: The asterisk component is used to interact with Asterisk PBX Server. +:since: 2.18 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Asterisk component allows you to work easily with an Asterisk PBX Server http://www.asterisk.org/ using https://asterisk-java.org/[asterisk-java] diff --git a/docs/components/modules/ROOT/pages/atmos-component.adoc b/docs/components/modules/ROOT/pages/atmos-component.adoc index 9d2a47664e2c7..e90fe369c19bd 100644 --- a/docs/components/modules/ROOT/pages/atmos-component.adoc +++ b/docs/components/modules/ROOT/pages/atmos-component.adoc @@ -1,12 +1,16 @@ [[atmos-component]] = Atmos Component :page-source: components/camel-atmos/src/main/docs/atmos-component.adoc +:docTitle: Atmos +:artifactId: camel-atmos +:description: The atmos component is used for integrating with EMC's Atomos Storage. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Camel-Atmos is an http://camel.apache.org/[Apache Camel] component that allows you to work with ViPR object data services using the diff --git a/docs/components/modules/ROOT/pages/atmosphere-websocket-component.adoc b/docs/components/modules/ROOT/pages/atmosphere-websocket-component.adoc index 35602544c1f7c..369b9731ddc03 100644 --- a/docs/components/modules/ROOT/pages/atmosphere-websocket-component.adoc +++ b/docs/components/modules/ROOT/pages/atmosphere-websocket-component.adoc @@ -1,12 +1,16 @@ [[atmosphere-websocket-component]] = Atmosphere Websocket Component :page-source: components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc +:docTitle: Atmosphere Websocket +:artifactId: camel-atmosphere-websocket +:description: To exchange data with external Websocket clients using Atmosphere. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Atmosphere-Websocket component provides Websocket based endpoints for a servlet communicating with diff --git a/docs/components/modules/ROOT/pages/atom-component.adoc b/docs/components/modules/ROOT/pages/atom-component.adoc index 741437580adce..b9399cda9fa91 100644 --- a/docs/components/modules/ROOT/pages/atom-component.adoc +++ b/docs/components/modules/ROOT/pages/atom-component.adoc @@ -1,12 +1,16 @@ [[atom-component]] = Atom Component :page-source: components/camel-atom/src/main/docs/atom-component.adoc +:docTitle: Atom +:artifactId: camel-atom +:description: The atom component is used for consuming Atom RSS feeds. +:since: 1.2 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 1.2* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Atom component is used for polling Atom feeds. diff --git a/docs/components/modules/ROOT/pages/atomix-map-component.adoc b/docs/components/modules/ROOT/pages/atomix-map-component.adoc index 2e83d10256c58..52d266f21b518 100644 --- a/docs/components/modules/ROOT/pages/atomix-map-component.adoc +++ b/docs/components/modules/ROOT/pages/atomix-map-component.adoc @@ -1,12 +1,16 @@ [[atomix-map-component]] = Atomix Map Component :page-source: components/camel-atomix/src/main/docs/atomix-map-component.adoc +:docTitle: Atomix Map +:artifactId: camel-atomix +:description: The atomix-map component is used to access Atomix's distributed map. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The camel Atomix-Map component allows you to work with http://atomix.io[Atomix's] https://atomix.io/docs/latest/user-manual/primitives/DistributedMap/[Distributed Map] collection. diff --git a/docs/components/modules/ROOT/pages/atomix-messaging-component.adoc b/docs/components/modules/ROOT/pages/atomix-messaging-component.adoc index 60cd427ffeecc..5915219f7af7a 100644 --- a/docs/components/modules/ROOT/pages/atomix-messaging-component.adoc +++ b/docs/components/modules/ROOT/pages/atomix-messaging-component.adoc @@ -1,12 +1,16 @@ [[atomix-messaging-component]] = Atomix Messaging Component :page-source: components/camel-atomix/src/main/docs/atomix-messaging-component.adoc +:docTitle: Atomix Messaging +:artifactId: camel-atomix +:description: The atomix-messaging component is used to access Atomix's group messaging. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The camel Atomix-Messaging component allows you to work with http://atomix.io[Atomix's] https://atomix.io/docs/latest/user-manual/cluster-communication/direct-messaging[Group Messaging]. diff --git a/docs/components/modules/ROOT/pages/atomix-multimap-component.adoc b/docs/components/modules/ROOT/pages/atomix-multimap-component.adoc index 71d6aa31ee551..7097e73f384eb 100644 --- a/docs/components/modules/ROOT/pages/atomix-multimap-component.adoc +++ b/docs/components/modules/ROOT/pages/atomix-multimap-component.adoc @@ -1,12 +1,16 @@ [[atomix-multimap-component]] = Atomix MultiMap Component :page-source: components/camel-atomix/src/main/docs/atomix-multimap-component.adoc +:docTitle: Atomix MultiMap +:artifactId: camel-atomix +:description: The atomix-multimap component is used to access Atomix's distributed multi map. +:since: 2.20 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The camel Atomix-Multimap component allows you to work with http://atomix.io[Atomix's] https://atomix.io/docs/latest/user-manual/primitives/DistributedMultimap/[Distributed MultiMap] collection. diff --git a/docs/components/modules/ROOT/pages/atomix-queue-component.adoc b/docs/components/modules/ROOT/pages/atomix-queue-component.adoc index c1ca618e60129..159bd0c698078 100644 --- a/docs/components/modules/ROOT/pages/atomix-queue-component.adoc +++ b/docs/components/modules/ROOT/pages/atomix-queue-component.adoc @@ -1,12 +1,16 @@ [[atomix-queue-component]] = Atomix Queue Component :page-source: components/camel-atomix/src/main/docs/atomix-queue-component.adoc +:docTitle: Atomix Queue +:artifactId: camel-atomix +:description: The atomix-queue component is used to access Atomix's distributed queue. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The camel Atomix-Queue component allows you to work with http://atomix.io[Atomix's] https://atomix.io/docs/latest/user-manual/primitives/DistributedQueue/[Distributed Queue] collection. diff --git a/docs/components/modules/ROOT/pages/atomix-set-component.adoc b/docs/components/modules/ROOT/pages/atomix-set-component.adoc index 696f43dd676cc..c9812f3d12b58 100644 --- a/docs/components/modules/ROOT/pages/atomix-set-component.adoc +++ b/docs/components/modules/ROOT/pages/atomix-set-component.adoc @@ -1,12 +1,16 @@ [[atomix-set-component]] = Atomix Set Component :page-source: components/camel-atomix/src/main/docs/atomix-set-component.adoc +:docTitle: Atomix Set +:artifactId: camel-atomix +:description: The atomix-set component is used to access Atomix's distributed set. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The camel Atomix-Set component allows you to work with http://atomix.io[Atomix's] https://atomix.io/docs/latest/user-manual/primitives/DistributedSet/[Distributed Set] collection. diff --git a/docs/components/modules/ROOT/pages/atomix-value-component.adoc b/docs/components/modules/ROOT/pages/atomix-value-component.adoc index 8445fc352aa30..e4f500058b774 100644 --- a/docs/components/modules/ROOT/pages/atomix-value-component.adoc +++ b/docs/components/modules/ROOT/pages/atomix-value-component.adoc @@ -1,12 +1,16 @@ [[atomix-value-component]] = Atomix Value Component :page-source: components/camel-atomix/src/main/docs/atomix-value-component.adoc +:docTitle: Atomix Value +:artifactId: camel-atomix +:description: The atomix-value component is used to access Atomix's distributed value. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The camel Atomix-Value component allows you to work with http://atomix.io[Atomix's] https://atomix.io/docs/latest/user-manual/primitives/DistributedValue/[Distributed Value]. diff --git a/docs/components/modules/ROOT/pages/avro-component.adoc b/docs/components/modules/ROOT/pages/avro-component.adoc index bc6b46482e247..90012833cd99d 100644 --- a/docs/components/modules/ROOT/pages/avro-component.adoc +++ b/docs/components/modules/ROOT/pages/avro-component.adoc @@ -1,12 +1,16 @@ [[avro-component]] = Avro Component :page-source: components/camel-avro-rpc/src/main/docs/avro-component.adoc +:docTitle: Avro +:artifactId: camel-avro-rpc +:description: Working with Apache Avro for data serialization. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component provides a support for Apache Avro's rpc, by providing producers and consumers endpoint for using avro over netty or @@ -271,4 +275,4 @@ is used and `getProcessor` will receive Value class directly in body, while `putProcessor` will receive an array of size 2 with String key and Value value filled as array contents. -include::camel-spring-boot::page$avro-starter.adoc[] \ No newline at end of file +include::camel-spring-boot::page$avro-starter.adoc[] diff --git a/docs/components/modules/ROOT/pages/aws-cw-component.adoc b/docs/components/modules/ROOT/pages/aws-cw-component.adoc index 1c30832ee93f0..df76101d1164b 100644 --- a/docs/components/modules/ROOT/pages/aws-cw-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-cw-component.adoc @@ -1,12 +1,16 @@ [[aws-cw-component]] = AWS CloudWatch Component :page-source: components/camel-aws-cw/src/main/docs/aws-cw-component.adoc +:docTitle: AWS CloudWatch +:artifactId: camel-aws-cw +:description: The aws-cw component is used for sending metrics to an Amazon CloudWatch. +:since: 2.11 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.11* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The CW component allows messages to be sent to an https://aws.amazon.com/cloudwatch/[Amazon CloudWatch] metrics. The diff --git a/docs/components/modules/ROOT/pages/aws-ddb-component.adoc b/docs/components/modules/ROOT/pages/aws-ddb-component.adoc index 095157ff7ea68..e5b58756e5ba9 100644 --- a/docs/components/modules/ROOT/pages/aws-ddb-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-ddb-component.adoc @@ -1,12 +1,16 @@ [[aws-ddb-component]] = AWS DynamoDB Component :page-source: components/camel-aws-ddb/src/main/docs/aws-ddb-component.adoc +:docTitle: AWS DynamoDB +:artifactId: camel-aws-ddb +:description: The aws-ddb component is used for storing and retrieving data from Amazon's DynamoDB service. +:since: 2.10 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The DynamoDB component supports storing and retrieving data from/to https://aws.amazon.com/dynamodb[Amazon's DynamoDB] service. diff --git a/docs/components/modules/ROOT/pages/aws-ddbstream-component.adoc b/docs/components/modules/ROOT/pages/aws-ddbstream-component.adoc index 7a18b8fd8b3d9..1c01860ffb86d 100644 --- a/docs/components/modules/ROOT/pages/aws-ddbstream-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-ddbstream-component.adoc @@ -1,12 +1,16 @@ [[aws-ddbstream-component]] = AWS DynamoDB Streams Component :page-source: components/camel-aws-ddb/src/main/docs/aws-ddbstream-component.adoc +:docTitle: AWS DynamoDB Streams +:artifactId: camel-aws-ddb +:description: The aws-ddbstream component is used for working with Amazon DynamoDB Streams. +:since: 2.17 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The DynamoDB Stream component supports receiving messages from Amazon DynamoDB Stream service. diff --git a/docs/components/modules/ROOT/pages/aws-ec2-component.adoc b/docs/components/modules/ROOT/pages/aws-ec2-component.adoc index 8613659f5952b..13786558d4118 100644 --- a/docs/components/modules/ROOT/pages/aws-ec2-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-ec2-component.adoc @@ -1,12 +1,16 @@ [[aws-ec2-component]] = AWS EC2 Component :page-source: components/camel-aws-ec2/src/main/docs/aws-ec2-component.adoc +:docTitle: AWS EC2 +:artifactId: camel-aws-ec2 +:description: The aws-ec2 is used for managing Amazon EC2 instances. +:since: 2.16 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The EC2 component supports the ability to create, run, start, stop and terminate https://aws.amazon.com/ec2/[AWS EC2] instances. diff --git a/docs/components/modules/ROOT/pages/aws-ecs-component.adoc b/docs/components/modules/ROOT/pages/aws-ecs-component.adoc index 379e616c76bdd..a72ff680da9cf 100644 --- a/docs/components/modules/ROOT/pages/aws-ecs-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-ecs-component.adoc @@ -1,12 +1,16 @@ [[aws-ecs-component]] = AWS ECS Component :page-source: components/camel-aws-ecs/src/main/docs/aws-ecs-component.adoc +:docTitle: AWS ECS +:artifactId: camel-aws-ecs +:description: The aws-ecs is used for managing Amazon ECS +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The ECS component supports create, delete, describe and list https://aws.amazon.com/ecs/[AWS ECS] clusters instances. diff --git a/docs/components/modules/ROOT/pages/aws-eks-component.adoc b/docs/components/modules/ROOT/pages/aws-eks-component.adoc index 3a02585832fd1..797a4f4a522eb 100644 --- a/docs/components/modules/ROOT/pages/aws-eks-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-eks-component.adoc @@ -1,12 +1,16 @@ [[aws-eks-component]] = AWS EKS Component :page-source: components/camel-aws-eks/src/main/docs/aws-eks-component.adoc +:docTitle: AWS EKS +:artifactId: camel-aws-eks +:description: The aws-eks is used for managing Amazon EKS +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The EKS component supports create, delete, describe and list https://aws.amazon.com/eks/[AWS EKS] clusters instances. diff --git a/docs/components/modules/ROOT/pages/aws-iam-component.adoc b/docs/components/modules/ROOT/pages/aws-iam-component.adoc index 154d0f9da9516..3138d21070b6e 100644 --- a/docs/components/modules/ROOT/pages/aws-iam-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-iam-component.adoc @@ -1,12 +1,16 @@ [[aws-iam-component]] = AWS IAM Component :page-source: components/camel-aws-iam/src/main/docs/aws-iam-component.adoc +:docTitle: AWS IAM +:artifactId: camel-aws-iam +:description: The aws-iam is used for managing Amazon IAM +:since: 2.23 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The KMS component supports create, run, start, stop and terminate https://aws.amazon.com/iam/[AWS IAM] instances. diff --git a/docs/components/modules/ROOT/pages/aws-kinesis-component.adoc b/docs/components/modules/ROOT/pages/aws-kinesis-component.adoc index 54a84b6c2189d..d606f5ec726d6 100644 --- a/docs/components/modules/ROOT/pages/aws-kinesis-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-kinesis-component.adoc @@ -1,12 +1,16 @@ [[aws-kinesis-component]] = AWS Kinesis Component :page-source: components/camel-aws-kinesis/src/main/docs/aws-kinesis-component.adoc +:docTitle: AWS Kinesis +:artifactId: camel-aws-kinesis +:description: The aws-kinesis component is for consuming and producing records from Amazon Kinesis Streams. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Kinesis component supports receiving messages from and sending messages to Amazon Kinesis service. diff --git a/docs/components/modules/ROOT/pages/aws-kinesis-firehose-component.adoc b/docs/components/modules/ROOT/pages/aws-kinesis-firehose-component.adoc index 46068d83d62bb..ca96a18999010 100644 --- a/docs/components/modules/ROOT/pages/aws-kinesis-firehose-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-kinesis-firehose-component.adoc @@ -1,12 +1,16 @@ [[aws-kinesis-firehose-component]] = AWS Kinesis Firehose Component :page-source: components/camel-aws-kinesis/src/main/docs/aws-kinesis-firehose-component.adoc +:docTitle: AWS Kinesis Firehose +:artifactId: camel-aws-kinesis +:description: The aws-kinesis-firehose component is used for producing Amazon's Kinesis Firehose streams. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Kinesis Firehose component supports sending messages to Amazon Kinesis Firehose service. diff --git a/docs/components/modules/ROOT/pages/aws-kms-component.adoc b/docs/components/modules/ROOT/pages/aws-kms-component.adoc index 844218afd02e2..81ac45ba44a87 100644 --- a/docs/components/modules/ROOT/pages/aws-kms-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-kms-component.adoc @@ -1,12 +1,16 @@ [[aws-kms-component]] = AWS KMS Component :page-source: components/camel-aws-kms/src/main/docs/aws-kms-component.adoc +:docTitle: AWS KMS +:artifactId: camel-aws-kms +:description: The aws-kms is used for managing Amazon KMS +:since: 2.21 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.21* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The KMS component supports the ability to work with keys stored in https://aws.amazon.com/kms/[AWS KMS] instances. diff --git a/docs/components/modules/ROOT/pages/aws-lambda-component.adoc b/docs/components/modules/ROOT/pages/aws-lambda-component.adoc index 29eadf39c83e6..11b9e74a288af 100644 --- a/docs/components/modules/ROOT/pages/aws-lambda-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-lambda-component.adoc @@ -1,12 +1,16 @@ [[aws-lambda-component]] = AWS Lambda Component :page-source: components/camel-aws-lambda/src/main/docs/aws-lambda-component.adoc +:docTitle: AWS Lambda +:artifactId: camel-aws-lambda +:description: The aws-lambda is used for managing and invoking functions from Amazon Lambda. +:since: 2.20 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Lambda component supports create, get, list, delete and invoke https://aws.amazon.com/lambda/[AWS Lambda] functions. diff --git a/docs/components/modules/ROOT/pages/aws-mq-component.adoc b/docs/components/modules/ROOT/pages/aws-mq-component.adoc index 2164e0d950a09..d707a60c390cd 100644 --- a/docs/components/modules/ROOT/pages/aws-mq-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-mq-component.adoc @@ -1,12 +1,16 @@ [[aws-mq-component]] = AWS MQ Component :page-source: components/camel-aws-mq/src/main/docs/aws-mq-component.adoc +:docTitle: AWS MQ +:artifactId: camel-aws-mq +:description: The aws-mq is used for managing Amazon MQ instances. +:since: 2.21 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.21* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The MQ component supports create, run, start, stop and terminate https://aws.amazon.com/amazon-mq/[AWS MQ] instances. diff --git a/docs/components/modules/ROOT/pages/aws-msk-component.adoc b/docs/components/modules/ROOT/pages/aws-msk-component.adoc index 209ab316f03ae..7526483824bc8 100644 --- a/docs/components/modules/ROOT/pages/aws-msk-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-msk-component.adoc @@ -1,12 +1,16 @@ [[aws-msk-component]] = AWS MSK Component :page-source: components/camel-aws-msk/src/main/docs/aws-msk-component.adoc +:docTitle: AWS MSK +:artifactId: camel-aws-msk +:description: The aws-msk is used for managing Amazon MSK +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The AWS MSK component supports create, run, start, stop and terminate https://aws.amazon.com/msk/[AWS MSK] instances. diff --git a/docs/components/modules/ROOT/pages/aws-s3-component.adoc b/docs/components/modules/ROOT/pages/aws-s3-component.adoc index 2d4a58173a228..006e697cdc6f9 100644 --- a/docs/components/modules/ROOT/pages/aws-s3-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-s3-component.adoc @@ -1,12 +1,16 @@ [[aws-s3-component]] = AWS S3 Storage Service Component :page-source: components/camel-aws-s3/src/main/docs/aws-s3-component.adoc +:docTitle: AWS S3 Storage Service +:artifactId: camel-aws-s3 +:description: The aws-s3 component is used for storing and retrieving object from Amazon S3 Storage Service. +:since: 2.8 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.8* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The S3 component supports storing and retrieving objects from/to https://aws.amazon.com/s3[Amazon's S3] service. diff --git a/docs/components/modules/ROOT/pages/aws-sdb-component.adoc b/docs/components/modules/ROOT/pages/aws-sdb-component.adoc index 81c01aeb4f52e..59aa5fa614316 100644 --- a/docs/components/modules/ROOT/pages/aws-sdb-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-sdb-component.adoc @@ -1,12 +1,16 @@ [[aws-sdb-component]] = AWS SimpleDB Component :page-source: components/camel-aws-sdb/src/main/docs/aws-sdb-component.adoc +:docTitle: AWS SimpleDB +:artifactId: camel-aws-sdb +:description: The aws-sdb component is for storing and retrieving data from/to Amazon's SDB service. +:since: 2.9 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.9* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The sdb component supports storing and retrieving data from/to https://aws.amazon.com/sdb[Amazon's SDB] service. diff --git a/docs/components/modules/ROOT/pages/aws-ses-component.adoc b/docs/components/modules/ROOT/pages/aws-ses-component.adoc index a6a2eb8c0096b..d6377da2c4aa5 100644 --- a/docs/components/modules/ROOT/pages/aws-ses-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-ses-component.adoc @@ -1,12 +1,16 @@ [[aws-ses-component]] = AWS Simple Email Service Component :page-source: components/camel-aws-ses/src/main/docs/aws-ses-component.adoc +:docTitle: AWS Simple Email Service +:artifactId: camel-aws-ses +:description: The aws-ses component is used for sending emails with Amazon's SES service. +:since: 2.9 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.9* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The ses component supports sending emails with https://aws.amazon.com/ses[Amazon's SES] service. diff --git a/docs/components/modules/ROOT/pages/aws-sns-component.adoc b/docs/components/modules/ROOT/pages/aws-sns-component.adoc index a47427d6259ae..dbe8e116b9fd0 100644 --- a/docs/components/modules/ROOT/pages/aws-sns-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-sns-component.adoc @@ -1,12 +1,16 @@ [[aws-sns-component]] = AWS Simple Notification System Component :page-source: components/camel-aws-sns/src/main/docs/aws-sns-component.adoc +:docTitle: AWS Simple Notification System +:artifactId: camel-aws-sns +:description: The aws-sns component is used for sending messages to an Amazon Simple Notification Topic. +:since: 2.8 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.8* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The SNS component allows messages to be sent to an https://aws.amazon.com/sns[Amazon Simple Notification] Topic. The diff --git a/docs/components/modules/ROOT/pages/aws-sqs-component.adoc b/docs/components/modules/ROOT/pages/aws-sqs-component.adoc index 15310912245c8..03d11c5f2a509 100644 --- a/docs/components/modules/ROOT/pages/aws-sqs-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-sqs-component.adoc @@ -1,12 +1,16 @@ [[aws-sqs-component]] = AWS Simple Queue Service Component :page-source: components/camel-aws-sqs/src/main/docs/aws-sqs-component.adoc +:docTitle: AWS Simple Queue Service +:artifactId: camel-aws-sqs +:description: The aws-sqs component is used for sending and receiving messages to Amazon's SQS service. +:since: 2.6 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.6* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The sqs component supports sending and receiving messages to https://aws.amazon.com/sqs[Amazon's SQS] service. diff --git a/docs/components/modules/ROOT/pages/aws-swf-component.adoc b/docs/components/modules/ROOT/pages/aws-swf-component.adoc index 07563d15df49e..1784aac4a4eb3 100644 --- a/docs/components/modules/ROOT/pages/aws-swf-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-swf-component.adoc @@ -1,12 +1,16 @@ [[aws-swf-component]] = AWS Simple Workflow Component :page-source: components/camel-aws-swf/src/main/docs/aws-swf-component.adoc +:docTitle: AWS Simple Workflow +:artifactId: camel-aws-swf +:description: The aws-swf component is used for managing workflows from Amazon Simple Workflow. +:since: 2.13 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.13* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Simple Workflow component supports managing workflows from https://aws.amazon.com/swf/[Amazon's Simple Workflow] service. diff --git a/docs/components/modules/ROOT/pages/aws-translate-component.adoc b/docs/components/modules/ROOT/pages/aws-translate-component.adoc index f2d964cf45103..cd192345aa2be 100644 --- a/docs/components/modules/ROOT/pages/aws-translate-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-translate-component.adoc @@ -1,12 +1,16 @@ [[aws-translate-component]] = AWS Translate Component :page-source: components/camel-aws-translate/src/main/docs/aws-translate-component.adoc +:docTitle: AWS Translate +:artifactId: camel-aws-translate +:description: The aws-translate component is used for managing Amazon Translate +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Translate component supports translate a text in multiple languages. https://aws.amazon.com/translate/[AWS Translate] clusters instances. diff --git a/docs/components/modules/ROOT/pages/aws2-cw-component.adoc b/docs/components/modules/ROOT/pages/aws2-cw-component.adoc index e604f5675f0b9..0e2069dd3fbb9 100644 --- a/docs/components/modules/ROOT/pages/aws2-cw-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-cw-component.adoc @@ -1,12 +1,16 @@ [[aws2-cw-component]] = AWS 2 CloudWatch Component :page-source: components/camel-aws2-cw/src/main/docs/aws2-cw-component.adoc +:docTitle: AWS 2 CloudWatch +:artifactId: camel-aws2-cw +:description: The aws2-cw component is used for sending metrics to an Amazon CloudWatch. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The CW component allows messages to be sent to an https://aws.amazon.com/cloudwatch/[Amazon CloudWatch] metrics. The diff --git a/docs/components/modules/ROOT/pages/aws2-ddb-component.adoc b/docs/components/modules/ROOT/pages/aws2-ddb-component.adoc index d4ccc0947e906..37d5634b52c18 100644 --- a/docs/components/modules/ROOT/pages/aws2-ddb-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-ddb-component.adoc @@ -1,12 +1,16 @@ [[aws2-ddb-component]] = AWS 2 DynamoDB Component :page-source: components/camel-aws2-ddb/src/main/docs/aws2-ddb-component.adoc +:docTitle: AWS 2 DynamoDB +:artifactId: camel-aws2-ddb +:description: The aws2-ddb component is used for storing and retrieving data from Amazon's DynamoDB service. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The DynamoDB component supports storing and retrieving data from/to https://aws.amazon.com/dynamodb[Amazon's DynamoDB] service. diff --git a/docs/components/modules/ROOT/pages/aws2-ddbstream-component.adoc b/docs/components/modules/ROOT/pages/aws2-ddbstream-component.adoc index 3ae90ab710c56..989992bc2bd50 100644 --- a/docs/components/modules/ROOT/pages/aws2-ddbstream-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-ddbstream-component.adoc @@ -1,12 +1,16 @@ [[aws2-ddbstream-component]] = AWS 2 DynamoDB Streams Component :page-source: components/camel-aws2-ddb/src/main/docs/aws2-ddbstream-component.adoc +:docTitle: AWS 2 DynamoDB Streams +:artifactId: camel-aws2-ddb +:description: The aws2-ddbstream component is used for working with Amazon DynamoDB Streams. +:since: 3.1 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The DynamoDB Stream component supports receiving messages from Amazon DynamoDB Stream service. diff --git a/docs/components/modules/ROOT/pages/aws2-ec2-component.adoc b/docs/components/modules/ROOT/pages/aws2-ec2-component.adoc index a269c94c77ea3..26d86aa8ca20d 100644 --- a/docs/components/modules/ROOT/pages/aws2-ec2-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-ec2-component.adoc @@ -1,12 +1,16 @@ [[aws2-ec2-component]] = AWS 2 EC2 Component :page-source: components/camel-aws2-ec2/src/main/docs/aws2-ec2-component.adoc +:docTitle: AWS 2 EC2 +:artifactId: camel-aws2-ec2 +:description: The aws2-ec2 is used for managing Amazon EC2 instances. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The EC2 component supports the ability to create, run, start, stop and terminate https://aws.amazon.com/ec2/[AWS EC2] instances. diff --git a/docs/components/modules/ROOT/pages/aws2-ecs-component.adoc b/docs/components/modules/ROOT/pages/aws2-ecs-component.adoc index b9ce232910af1..14b7f08dd9e51 100644 --- a/docs/components/modules/ROOT/pages/aws2-ecs-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-ecs-component.adoc @@ -1,15 +1,19 @@ [[aws2-ecs-component]] = AWS 2 ECS Component :page-source: components/camel-aws2-ecs/src/main/docs/aws2-ecs-component.adoc +:docTitle: AWS 2 ECS +:artifactId: camel-aws2-ecs +:description: The aws2-ecs is used for managing Amazon ECS +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* *Since Camel 3.1* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The ECS component supports create, delete, describe and list https://aws.amazon.com/ecs/[AWS ECS] clusters instances. diff --git a/docs/components/modules/ROOT/pages/aws2-eks-component.adoc b/docs/components/modules/ROOT/pages/aws2-eks-component.adoc index cdbf096782171..7e50d6bbf3775 100644 --- a/docs/components/modules/ROOT/pages/aws2-eks-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-eks-component.adoc @@ -1,15 +1,19 @@ [[aws2-eks-component]] = AWS 2 EKS Component :page-source: components/camel-aws2-eks/src/main/docs/aws2-eks-component.adoc +:docTitle: AWS 2 EKS +:artifactId: camel-aws2-eks +:description: The aws2-eks is used for managing Amazon EKS +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* *Since Camel 3.1* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The EKS component supports create, delete, describe and list https://aws.amazon.com/eks/[AWS EKS] clusters instances. diff --git a/docs/components/modules/ROOT/pages/aws2-iam-component.adoc b/docs/components/modules/ROOT/pages/aws2-iam-component.adoc index 08c8a308ed0b1..c4be66ff4a7a5 100644 --- a/docs/components/modules/ROOT/pages/aws2-iam-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-iam-component.adoc @@ -1,15 +1,19 @@ [[aws2-iam-component]] = AWS 2 IAM Component :page-source: components/camel-aws2-iam/src/main/docs/aws2-iam-component.adoc +:docTitle: AWS 2 IAM +:artifactId: camel-aws2-iam +:description: The aws2-iam is used for managing Amazon IAM +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* *Since Camel 3.1* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The KMS component supports create, run, start, stop and terminate https://aws.amazon.com/iam/[AWS IAM] instances. diff --git a/docs/components/modules/ROOT/pages/aws2-kinesis-component.adoc b/docs/components/modules/ROOT/pages/aws2-kinesis-component.adoc index 638e3fd8cdc64..3ca631d1d327a 100644 --- a/docs/components/modules/ROOT/pages/aws2-kinesis-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-kinesis-component.adoc @@ -1,12 +1,16 @@ [[aws2-kinesis-component]] = AWS 2 Kinesis Component :page-source: components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-component.adoc +:docTitle: AWS 2 Kinesis +:artifactId: camel-aws2-kinesis +:description: The aws2-kinesis component is for consuming and producing records from Amazon Kinesis Streams. +:since: 3.2 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.2* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Kinesis component supports receiving messages from and sending messages to Amazon Kinesis service. diff --git a/docs/components/modules/ROOT/pages/aws2-kinesis-firehose-component.adoc b/docs/components/modules/ROOT/pages/aws2-kinesis-firehose-component.adoc index 10f8f389bcd58..503838ccda0af 100644 --- a/docs/components/modules/ROOT/pages/aws2-kinesis-firehose-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-kinesis-firehose-component.adoc @@ -1,12 +1,16 @@ [[aws2-kinesis-firehose-component]] = AWS 2 Kinesis Firehose Component :page-source: components/camel-aws2-kinesis/src/main/docs/aws2-kinesis-firehose-component.adoc +:docTitle: AWS 2 Kinesis Firehose +:artifactId: camel-aws2-kinesis +:description: The aws2-kinesis-firehose component is used for producing Amazon's Kinesis Firehose streams. +:since: 3.2 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.2* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Kinesis Firehose component supports sending messages to Amazon Kinesis Firehose service. diff --git a/docs/components/modules/ROOT/pages/aws2-kms-component.adoc b/docs/components/modules/ROOT/pages/aws2-kms-component.adoc index 7531a17a2f755..6b4bf88c25000 100644 --- a/docs/components/modules/ROOT/pages/aws2-kms-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-kms-component.adoc @@ -1,15 +1,19 @@ [[aws2-kms-component]] = AWS 2 KMS Component :page-source: components/camel-aws2-kms/src/main/docs/aws2-kms-component.adoc +:docTitle: AWS 2 KMS +:artifactId: camel-aws2-kms +:description: The aws2-kms is used for managing Amazon KMS +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* *Since Camel 3.1* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The KMS component supports the ability to work with keys stored in https://aws.amazon.com/kms/[AWS KMS] instances. diff --git a/docs/components/modules/ROOT/pages/aws2-lambda-component.adoc b/docs/components/modules/ROOT/pages/aws2-lambda-component.adoc index 8de6345ad33a5..05373100e5b27 100644 --- a/docs/components/modules/ROOT/pages/aws2-lambda-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-lambda-component.adoc @@ -1,12 +1,16 @@ [[aws2-lambda-component]] = AWS Lambda Component :page-source: components/camel-aws2-lambda/src/main/docs/aws2-lambda-component.adoc +:docTitle: AWS Lambda +:artifactId: camel-aws2-lambda +:description: The aws2-lambda is used for managing and invoking functions from Amazon Lambda. +:since: 3.2 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.2* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Lambda component supports create, get, list, delete and invoke https://aws.amazon.com/lambda/[AWS Lambda] functions. diff --git a/docs/components/modules/ROOT/pages/aws2-mq-component.adoc b/docs/components/modules/ROOT/pages/aws2-mq-component.adoc index 4febc4910f451..bc002ab298b48 100644 --- a/docs/components/modules/ROOT/pages/aws2-mq-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-mq-component.adoc @@ -1,12 +1,16 @@ [[aws2-mq-component]] = AWS 2 MQ Component :page-source: components/camel-aws2-mq/src/main/docs/aws2-mq-component.adoc +:docTitle: AWS 2 MQ +:artifactId: camel-aws2-mq +:description: The aws2-mq is used for managing Amazon MQ instances. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The MQ component supports create, run, start, stop and terminate https://aws.amazon.com/amazon-mq/[AWS MQ] instances. diff --git a/docs/components/modules/ROOT/pages/aws2-msk-component.adoc b/docs/components/modules/ROOT/pages/aws2-msk-component.adoc index 6e05ee79afc25..4fbccfd062d0f 100644 --- a/docs/components/modules/ROOT/pages/aws2-msk-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-msk-component.adoc @@ -1,15 +1,19 @@ [[aws2-msk-component]] = AWS 2 MSK Component :page-source: components/camel-aws2-msk/src/main/docs/aws2-msk-component.adoc +:docTitle: AWS 2 MSK +:artifactId: camel-aws2-msk +:description: The aws2-msk is used for managing Amazon MSK +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* *Since Camel 3.1* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The AWS MSK component supports create, run, start, stop and terminate https://aws.amazon.com/msk/[AWS MSK] instances. diff --git a/docs/components/modules/ROOT/pages/aws2-s3-component.adoc b/docs/components/modules/ROOT/pages/aws2-s3-component.adoc index fc862f656841b..6483102aa4ed5 100644 --- a/docs/components/modules/ROOT/pages/aws2-s3-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-s3-component.adoc @@ -1,15 +1,19 @@ [[aws2-s3-component]] = AWS2 S3 Storage Service Component :page-source: components/camel-aws2-s3/src/main/docs/aws2-s3-component.adoc +:docTitle: AWS2 S3 Storage Service +:artifactId: camel-aws2-s3 +:description: The aws2-s3 component is used for storing and retrieving object from Amazon S3 Storage Service. +:since: 3.2 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.2* +*Since Camel {since}* *Since Camel 3.2* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The S3 component supports storing and retrieving objects from/to https://aws.amazon.com/s3[Amazon's S3] service. diff --git a/docs/components/modules/ROOT/pages/aws2-ses-component.adoc b/docs/components/modules/ROOT/pages/aws2-ses-component.adoc index 3fc3ebfa9005d..a671b9388b43c 100644 --- a/docs/components/modules/ROOT/pages/aws2-ses-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-ses-component.adoc @@ -1,12 +1,16 @@ [[aws2-ses-component]] = AWS 2 Simple Email Service Component :page-source: components/camel-aws2-ses/src/main/docs/aws2-ses-component.adoc +:docTitle: AWS 2 Simple Email Service +:artifactId: camel-aws2-ses +:description: The aws2-ses component is used for sending emails with Amazon's SES service. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The ses component supports sending emails with https://aws.amazon.com/ses[Amazon's SES] service. diff --git a/docs/components/modules/ROOT/pages/aws2-sns-component.adoc b/docs/components/modules/ROOT/pages/aws2-sns-component.adoc index 86e162fa3f13b..713b796456269 100644 --- a/docs/components/modules/ROOT/pages/aws2-sns-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-sns-component.adoc @@ -1,15 +1,19 @@ [[aws2-sns-component]] = AWS 2 Simple Notification System Component :page-source: components/camel-aws2-sns/src/main/docs/aws2-sns-component.adoc +:docTitle: AWS 2 Simple Notification System +:artifactId: camel-aws2-sns +:description: The aws2-sns component is used for sending messages to an Amazon Simple Notification Topic. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* *Since Camel 3.1* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The SNS component allows messages to be sent to an https://aws.amazon.com/sns[Amazon Simple Notification] Topic. The diff --git a/docs/components/modules/ROOT/pages/aws2-sqs-component.adoc b/docs/components/modules/ROOT/pages/aws2-sqs-component.adoc index 031d6dda9133a..c241d52441160 100644 --- a/docs/components/modules/ROOT/pages/aws2-sqs-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-sqs-component.adoc @@ -1,12 +1,16 @@ [[aws2-sqs-component]] = AWS 2 Simple Queue Service Component :page-source: components/camel-aws2-sqs/src/main/docs/aws2-sqs-component.adoc +:docTitle: AWS 2 Simple Queue Service +:artifactId: camel-aws2-sqs +:description: The aws2-sqs component is used for sending and receiving messages to Amazon's SQS service. +:since: 3.1 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The sqs component supports sending and receiving messages to https://aws.amazon.com/sqs[Amazon's SQS] service. diff --git a/docs/components/modules/ROOT/pages/aws2-translate-component.adoc b/docs/components/modules/ROOT/pages/aws2-translate-component.adoc index 00ac26eb952ba..f75ac835883ba 100644 --- a/docs/components/modules/ROOT/pages/aws2-translate-component.adoc +++ b/docs/components/modules/ROOT/pages/aws2-translate-component.adoc @@ -1,13 +1,17 @@ [[aws2-translate-component]] = AWS 2 Translate Component :page-source: components/camel-aws2-translate/src/main/docs/aws2-translate-component.adoc +:docTitle: AWS 2 Translate +:artifactId: camel-aws2-translate +:description: The aws2-translate component is used for managing Amazon Translate +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Translate component supports translate a text in multiple languages. https://aws.amazon.com/translate/[AWS Translate] clusters instances. diff --git a/docs/components/modules/ROOT/pages/azure-blob-component.adoc b/docs/components/modules/ROOT/pages/azure-blob-component.adoc index 8d49d15e2b4b8..44df02aafba0e 100644 --- a/docs/components/modules/ROOT/pages/azure-blob-component.adoc +++ b/docs/components/modules/ROOT/pages/azure-blob-component.adoc @@ -1,12 +1,16 @@ [[azure-blob-component]] = Azure Storage Blob Service Component :page-source: components/camel-azure/src/main/docs/azure-blob-component.adoc +:docTitle: Azure Storage Blob Service +:artifactId: camel-azure +:description: The azure-blob component is used for storing and retrieving blobs from Azure Storage Blob Service. +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Azure Blob component supports storing and retrieving the blobs to/from https://azure.microsoft.com/services/storage/blobs/[Azure Storage Blob] service. diff --git a/docs/components/modules/ROOT/pages/azure-queue-component.adoc b/docs/components/modules/ROOT/pages/azure-queue-component.adoc index 498161dc63447..11848d1daa235 100644 --- a/docs/components/modules/ROOT/pages/azure-queue-component.adoc +++ b/docs/components/modules/ROOT/pages/azure-queue-component.adoc @@ -1,12 +1,16 @@ [[azure-queue-component]] = Azure Storage Queue Service Component :page-source: components/camel-azure/src/main/docs/azure-queue-component.adoc +:docTitle: Azure Storage Queue Service +:artifactId: camel-azure +:description: The azure-queue component is used for storing and retrieving messages from Azure Storage Queue Service. +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Azure Queue component supports storing and retrieving the messages to/from https://azure.microsoft.com/services/storage/queues/[Azure Storage Queue] service. diff --git a/docs/components/modules/ROOT/pages/azure-storage-blob-component.adoc b/docs/components/modules/ROOT/pages/azure-storage-blob-component.adoc index 26a5fae7d00ee..7cd400bb0fa5d 100644 --- a/docs/components/modules/ROOT/pages/azure-storage-blob-component.adoc +++ b/docs/components/modules/ROOT/pages/azure-storage-blob-component.adoc @@ -1,12 +1,16 @@ [[azure-storage-blob-component]] = Azure Storage Blob Service Component :page-source: components/camel-azure-storage-blob/src/main/docs/azure-storage-blob-component.adoc +:docTitle: Azure Storage Blob Service +:artifactId: camel-azure-storage-blob +:description: The azure-storage-blob component is used for storing and retrieving blobs from Azure Storage Blob Service using SDK v12. +:since: 3.3 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.3* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Azure Storage Blob component is used for storing and retrieving blobs from https://azure.microsoft.com/services/storage/blobs/[Azure Storage Blob] Service using *Azure APIs v12*. However in case of versions above v12, we will see if this component can adopt these changes depending on how much breaking changes can result. diff --git a/docs/components/modules/ROOT/pages/azure.adoc b/docs/components/modules/ROOT/pages/azure-summary.adoc similarity index 87% rename from docs/components/modules/ROOT/pages/azure.adoc rename to docs/components/modules/ROOT/pages/azure-summary.adoc index 843bbbdf9b328..5893d69007ef8 100644 --- a/docs/components/modules/ROOT/pages/azure.adoc +++ b/docs/components/modules/ROOT/pages/azure-summary.adoc @@ -1,6 +1,8 @@ [[Azure-CamelComponentsforWindowsAzureServices]] = Camel Components for Windows Azure Services -:page-source: components/camel-azure/src/main/docs/azure.adoc +:page-source: components/camel-azure/src/main/docs/azure-summary.adoc +//attributes written by hand, not generated +:docTitle: Azure The Camel Components for https://azure.microsoft.com/[Windows Azure Services] provide connectivity to Azure services from Camel. diff --git a/docs/components/modules/ROOT/pages/bean-component.adoc b/docs/components/modules/ROOT/pages/bean-component.adoc index 1cf2476e52f8a..96423d3728000 100644 --- a/docs/components/modules/ROOT/pages/bean-component.adoc +++ b/docs/components/modules/ROOT/pages/bean-component.adoc @@ -1,12 +1,17 @@ [[bean-component]] = Bean Component :page-source: components/camel-bean/src/main/docs/bean-component.adoc +:docTitle: Bean +:artifactId: camel-bean +:description: The bean component is for invoking Java beans from Camel. +:since: 1.0 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Bean component binds beans to Camel message exchanges. diff --git a/docs/components/modules/ROOT/pages/bean-validator-component.adoc b/docs/components/modules/ROOT/pages/bean-validator-component.adoc index ce73b259b4c71..d22920672f9f8 100644 --- a/docs/components/modules/ROOT/pages/bean-validator-component.adoc +++ b/docs/components/modules/ROOT/pages/bean-validator-component.adoc @@ -1,12 +1,16 @@ [[bean-validator-component]] = Bean Validator Component :page-source: components/camel-bean-validator/src/main/docs/bean-validator-component.adoc +:docTitle: Bean Validator +:artifactId: camel-bean-validator +:description: The Validator component performs bean validation of the message body using the Java Bean Validation API. +:since: 2.3 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.3* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Validator component performs bean validation of the message body using the Java Bean Validation API diff --git a/docs/components/modules/ROOT/pages/beanstalk-component.adoc b/docs/components/modules/ROOT/pages/beanstalk-component.adoc index 0f3ac2138acfd..f5eb9c168dcc2 100644 --- a/docs/components/modules/ROOT/pages/beanstalk-component.adoc +++ b/docs/components/modules/ROOT/pages/beanstalk-component.adoc @@ -1,12 +1,16 @@ [[beanstalk-component]] = Beanstalk Component :page-source: components/camel-beanstalk/src/main/docs/beanstalk-component.adoc +:docTitle: Beanstalk +:artifactId: camel-beanstalk +:description: The beanstalk component is used for job retrieval and post-processing of Beanstalk jobs. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Camel Beanstalk project provides a Camel component for job retrieval and post-processing of Beanstalk jobs. diff --git a/docs/components/modules/ROOT/pages/bonita-component.adoc b/docs/components/modules/ROOT/pages/bonita-component.adoc index b28d51b18a278..541a2a84b255a 100644 --- a/docs/components/modules/ROOT/pages/bonita-component.adoc +++ b/docs/components/modules/ROOT/pages/bonita-component.adoc @@ -1,12 +1,16 @@ [[bonita-component]] = Bonita Component :page-source: components/camel-bonita/src/main/docs/bonita-component.adoc +:docTitle: Bonita +:artifactId: camel-bonita +:description: Used for communicating with a remote Bonita BPM process engine. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* Used for communicating with a remote Bonita BPM process engine. diff --git a/docs/components/modules/ROOT/pages/box-component.adoc b/docs/components/modules/ROOT/pages/box-component.adoc index b5b83ecd17125..097a4078a952a 100644 --- a/docs/components/modules/ROOT/pages/box-component.adoc +++ b/docs/components/modules/ROOT/pages/box-component.adoc @@ -1,12 +1,16 @@ [[box-component]] = Box Component :page-source: components/camel-box/camel-box-component/src/main/docs/box-component.adoc +:docTitle: Box +:artifactId: camel-box +:description: For uploading downloading and managing files folders groups collaborations etc on box DOT com. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Box component provides access to all of the Box.com APIs accessible using https://github.com/box/box-java-sdk/[https://github.com/box/box-java-sdk]. It @@ -812,4 +816,3 @@ from("direct:foo") ---- include::camel-spring-boot::page$box-starter.adoc[] - diff --git a/docs/components/modules/ROOT/pages/braintree-component.adoc b/docs/components/modules/ROOT/pages/braintree-component.adoc index a1736f90cb830..ca39d0fd83288 100644 --- a/docs/components/modules/ROOT/pages/braintree-component.adoc +++ b/docs/components/modules/ROOT/pages/braintree-component.adoc @@ -1,12 +1,16 @@ [[braintree-component]] = Braintree Component :page-source: components/camel-braintree/src/main/docs/braintree-component.adoc +:docTitle: Braintree +:artifactId: camel-braintree +:description: The braintree component is used for integrating with the Braintree Payment System. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Braintree component provides access to https://www.braintreepayments.com/[Braintree Payments] trough through diff --git a/docs/components/modules/ROOT/pages/browse-component.adoc b/docs/components/modules/ROOT/pages/browse-component.adoc index 08964731bcc2a..b863a99399c65 100644 --- a/docs/components/modules/ROOT/pages/browse-component.adoc +++ b/docs/components/modules/ROOT/pages/browse-component.adoc @@ -1,12 +1,17 @@ [[browse-component]] = Browse Component :page-source: components/camel-browse/src/main/docs/browse-component.adoc +:docTitle: Browse +:artifactId: camel-browse +:description: The browse component is used for viewing the messages received on endpoints that supports BrowsableEndpoint. +:since: 1.3 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 1.3* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Browse component provides a simple BrowsableEndpoint which can be useful for diff --git a/docs/components/modules/ROOT/pages/caffeine-cache-component.adoc b/docs/components/modules/ROOT/pages/caffeine-cache-component.adoc index e7b5273093266..6f3f9a1d07985 100644 --- a/docs/components/modules/ROOT/pages/caffeine-cache-component.adoc +++ b/docs/components/modules/ROOT/pages/caffeine-cache-component.adoc @@ -1,12 +1,16 @@ [[caffeine-cache-component]] = Caffeine Cache Component :page-source: components/camel-caffeine/src/main/docs/caffeine-cache-component.adoc +:docTitle: Caffeine Cache +:artifactId: camel-caffeine +:description: The caffeine-cache component is used for integration with Caffeine Cache. +:since: 2.20 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Caffeine Cache component enables you to perform caching operations using the simple cache from Caffeine. diff --git a/docs/components/modules/ROOT/pages/caffeine-loadcache-component.adoc b/docs/components/modules/ROOT/pages/caffeine-loadcache-component.adoc index e1730046f9796..5ba28a5858c61 100644 --- a/docs/components/modules/ROOT/pages/caffeine-loadcache-component.adoc +++ b/docs/components/modules/ROOT/pages/caffeine-loadcache-component.adoc @@ -1,12 +1,16 @@ [[caffeine-loadcache-component]] = Caffeine LoadCache Component :page-source: components/camel-caffeine/src/main/docs/caffeine-loadcache-component.adoc +:docTitle: Caffeine LoadCache +:artifactId: camel-caffeine +:description: The caffeine-loadcache component is used for integration with Caffeine Load Cache. +:since: 2.20 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Caffeine Loadcache component enables you to perform caching operations using The Load cache from Caffeine. diff --git a/docs/components/modules/ROOT/pages/chatscript-component.adoc b/docs/components/modules/ROOT/pages/chatscript-component.adoc index efe7753a20bd2..ca725b7d779e8 100644 --- a/docs/components/modules/ROOT/pages/chatscript-component.adoc +++ b/docs/components/modules/ROOT/pages/chatscript-component.adoc @@ -1,12 +1,16 @@ [[chatscript-component]] = ChatScript Component :page-source: components/camel-chatscript/src/main/docs/chatscript-component.adoc +:docTitle: ChatScript +:artifactId: camel-chatscript +:description: Represents a ChatScript endpoint. +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The ChatScript component allows you to interact with ChatScript Server and have conversations. This component is stateless and relies on ChatScript to maintain chat history. diff --git a/docs/components/modules/ROOT/pages/chunk-component.adoc b/docs/components/modules/ROOT/pages/chunk-component.adoc index f6d584fcd22b2..8dcbebe752ed7 100644 --- a/docs/components/modules/ROOT/pages/chunk-component.adoc +++ b/docs/components/modules/ROOT/pages/chunk-component.adoc @@ -1,12 +1,16 @@ [[chunk-component]] = Chunk Component :page-source: components/camel-chunk/src/main/docs/chunk-component.adoc +:docTitle: Chunk +:artifactId: camel-chunk +:description: Transforms the message using a Chunk template. +:since: 2.15 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Chunk component allows for processing a message using a http://www.x5software.com/chunk/examples/ChunkExample?loc=en_US[Chunk] template. diff --git a/docs/components/modules/ROOT/pages/class-component.adoc b/docs/components/modules/ROOT/pages/class-component.adoc index daa7c3beb18fa..bb99a46023b9a 100644 --- a/docs/components/modules/ROOT/pages/class-component.adoc +++ b/docs/components/modules/ROOT/pages/class-component.adoc @@ -1,12 +1,17 @@ [[class-component]] = Class Component :page-source: components/camel-bean/src/main/docs/class-component.adoc +:docTitle: Class +:artifactId: camel-bean +:description: The Class component is for invoking Java classes (Java beans) from Camel. +:since: 2.4 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 2.4* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Class component binds beans to Camel message exchanges. It works in the same way as the xref:bean-component.adoc[Bean] component but instead of diff --git a/docs/components/modules/ROOT/pages/cm-sms-component.adoc b/docs/components/modules/ROOT/pages/cm-sms-component.adoc index 5cb17c55ac34d..539b81697a07f 100644 --- a/docs/components/modules/ROOT/pages/cm-sms-component.adoc +++ b/docs/components/modules/ROOT/pages/cm-sms-component.adoc @@ -1,12 +1,16 @@ [[cm-sms-component]] = CM SMS Gateway Component :page-source: components/camel-cm-sms/src/main/docs/cm-sms-component.adoc +:docTitle: CM SMS Gateway +:artifactId: camel-cm-sms +:description: The cm-sms component allows to integrate with CM SMS Gateway. +:since: 2.18 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* *Camel-Cm-Sms* is an http://camel.apache.org/[Apache Camel] component for the [CM SMS Gateway](https://www.cmtelecom.com). diff --git a/docs/components/modules/ROOT/pages/cmis-component.adoc b/docs/components/modules/ROOT/pages/cmis-component.adoc index ad856f35c963a..ba8309881db5e 100644 --- a/docs/components/modules/ROOT/pages/cmis-component.adoc +++ b/docs/components/modules/ROOT/pages/cmis-component.adoc @@ -1,12 +1,16 @@ [[cmis-component]] = CMIS Component :page-source: components/camel-cmis/src/main/docs/cmis-component.adoc +:docTitle: CMIS +:artifactId: camel-cmis +:description: The cmis component uses the Apache Chemistry client API and allows you to add/read nodes to/from a CMIS compliant content repositories. +:since: 2.11 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.11* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The cmis component uses the http://chemistry.apache.org/java/opencmis.html[Apache Chemistry] client diff --git a/docs/components/modules/ROOT/pages/coap-component.adoc b/docs/components/modules/ROOT/pages/coap-component.adoc index e18b5744444d4..15ce66c03612a 100644 --- a/docs/components/modules/ROOT/pages/coap-component.adoc +++ b/docs/components/modules/ROOT/pages/coap-component.adoc @@ -1,12 +1,16 @@ [[coap-component]] = CoAP Component :page-source: components/camel-coap/src/main/docs/coap-component.adoc +:docTitle: CoAP +:artifactId: camel-coap +:description: The coap component is used for sending and receiving messages from COAP capable devices. +:since: 2.16 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Camel-CoAP is an http://camel.apache.org/[Apache Camel] component that allows you to work with CoAP, a lightweight REST-type protocol for machine-to-machine operation. diff --git a/docs/components/modules/ROOT/pages/cometd-component.adoc b/docs/components/modules/ROOT/pages/cometd-component.adoc index d9cdbf57d0ae8..2765f5b0b7497 100644 --- a/docs/components/modules/ROOT/pages/cometd-component.adoc +++ b/docs/components/modules/ROOT/pages/cometd-component.adoc @@ -1,12 +1,16 @@ [[cometd-component]] = CometD Component :page-source: components/camel-cometd/src/main/docs/cometd-component.adoc +:docTitle: CometD +:artifactId: camel-cometd +:description: The cometd component is a transport for working with the Jetty implementation of the cometd/bayeux protocol. +:since: 2.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Cometd component is a transport for working with the http://www.mortbay.org/jetty[jetty] implementation of the diff --git a/docs/components/modules/ROOT/pages/consul-component.adoc b/docs/components/modules/ROOT/pages/consul-component.adoc index 959451e9a1569..d2acef3983544 100644 --- a/docs/components/modules/ROOT/pages/consul-component.adoc +++ b/docs/components/modules/ROOT/pages/consul-component.adoc @@ -1,12 +1,16 @@ [[consul-component]] = Consul Component :page-source: components/camel-consul/src/main/docs/consul-component.adoc +:docTitle: Consul +:artifactId: camel-consul +:description: The camel consul component allows you to work with Consul, a distributed, highly available, datacenter-aware, service discovery and configuration system. +:since: 2.18 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Consul**** component is a component for integrating your application with Consul. diff --git a/docs/components/modules/ROOT/pages/controlbus-component.adoc b/docs/components/modules/ROOT/pages/controlbus-component.adoc index ecdea04d728e5..7bfe85b69a628 100644 --- a/docs/components/modules/ROOT/pages/controlbus-component.adoc +++ b/docs/components/modules/ROOT/pages/controlbus-component.adoc @@ -1,12 +1,17 @@ [[controlbus-component]] = Control Bus Component :page-source: components/camel-controlbus/src/main/docs/controlbus-component.adoc +:docTitle: Control Bus +:artifactId: camel-controlbus +:description: The controlbus component provides easy management of Camel applications based on the Control Bus EIP pattern. +:since: 2.11 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 2.11* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The http://www.eaipatterns.com/ControlBus.html[Control Bus] from the EIP patterns allows for the diff --git a/docs/components/modules/ROOT/pages/corda-component.adoc b/docs/components/modules/ROOT/pages/corda-component.adoc index eda83d5c775fb..01b1ecc03f658 100644 --- a/docs/components/modules/ROOT/pages/corda-component.adoc +++ b/docs/components/modules/ROOT/pages/corda-component.adoc @@ -1,16 +1,18 @@ [[corda-component]] = Corda Component :page-source: components/camel-corda/src/main/docs/corda-component.adoc -*Since Camel 2.23* -*Since Camel 2.23* +:docTitle: Corda +:artifactId: camel-corda +:description: The corda component uses corda-rpc to interact with corda nodes. +:since: 2.23 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -*Since Camel 2.23* +*Since Camel {since}* Camel connector for R3's https://www.corda.net/[corda] blockchain platform using corda-rpc library. This component uses the corda rpc client. diff --git a/docs/components/modules/ROOT/pages/couchbase-component.adoc b/docs/components/modules/ROOT/pages/couchbase-component.adoc index d203861fe190e..319dd462614e0 100644 --- a/docs/components/modules/ROOT/pages/couchbase-component.adoc +++ b/docs/components/modules/ROOT/pages/couchbase-component.adoc @@ -1,12 +1,16 @@ [[couchbase-component]] = Couchbase Component :page-source: components/camel-couchbase/src/main/docs/couchbase-component.adoc +:docTitle: Couchbase +:artifactId: camel-couchbase +:description: Represents a Couchbase endpoint that can query Views with a Poll strategy and/or produce various type of operations. +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The *couchbase:* component allows you to treat https://www.couchbase.com/[CouchBase] instances as a producer or consumer diff --git a/docs/components/modules/ROOT/pages/couchdb-component.adoc b/docs/components/modules/ROOT/pages/couchdb-component.adoc index ff3c0b75e7ed2..37e26a7ab3b7f 100644 --- a/docs/components/modules/ROOT/pages/couchdb-component.adoc +++ b/docs/components/modules/ROOT/pages/couchdb-component.adoc @@ -1,12 +1,16 @@ [[couchdb-component]] = CouchDB Component :page-source: components/camel-couchdb/src/main/docs/couchdb-component.adoc +:docTitle: CouchDB +:artifactId: camel-couchdb +:description: The couchdb component is used for integrate with CouchDB databases. +:since: 2.11 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.11* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The *couchdb:* component allows you to treat http://couchdb.apache.org/[CouchDB] instances as a producer or consumer diff --git a/docs/components/modules/ROOT/pages/cql-component.adoc b/docs/components/modules/ROOT/pages/cql-component.adoc index d3a74225e7c5b..8a3e02cf0ca9e 100644 --- a/docs/components/modules/ROOT/pages/cql-component.adoc +++ b/docs/components/modules/ROOT/pages/cql-component.adoc @@ -1,12 +1,16 @@ [[cql-component]] = Cassandra CQL Component :page-source: components/camel-cassandraql/src/main/docs/cql-component.adoc +:docTitle: Cassandra CQL +:artifactId: camel-cassandraql +:description: The cql component aims at integrating Cassandra 2.0 using the CQL3 API (not the Thrift API). It's based on Cassandra Java Driver provided by DataStax. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* http://cassandra.apache.org[Apache Cassandra] is an open source NoSQL database designed to handle large amounts on commodity hardware. Like diff --git a/docs/components/modules/ROOT/pages/cron-component.adoc b/docs/components/modules/ROOT/pages/cron-component.adoc index 52c68628d0df2..03fda0b485f97 100644 --- a/docs/components/modules/ROOT/pages/cron-component.adoc +++ b/docs/components/modules/ROOT/pages/cron-component.adoc @@ -1,12 +1,16 @@ [[cron-component]] = Cron Component :page-source: components/camel-cron/src/main/docs/cron-component.adoc +:docTitle: Cron +:artifactId: camel-cron +:description: Camel Cron Component +:since: 3.1 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Cron component is a generic interface component that allows triggering events at specific time interval specified using the Unix cron syntax (e.g. `0/2 * * * * ?` to trigger an event every two seconds). diff --git a/docs/components/modules/ROOT/pages/crypto-cms-component.adoc b/docs/components/modules/ROOT/pages/crypto-cms-component.adoc index 0a65ffc388b4d..e4ebabb6fd338 100644 --- a/docs/components/modules/ROOT/pages/crypto-cms-component.adoc +++ b/docs/components/modules/ROOT/pages/crypto-cms-component.adoc @@ -1,15 +1,20 @@ [[crypto-cms-component]] = Crypto CMS Component (deprecated) :page-source: components/camel-crypto-cms/src/main/docs/crypto-cms-component.adoc +:docTitle: Crypto CMS +:artifactId: camel-crypto-cms +:description: The crypto cms component is used for encrypting data in CMS Enveloped Data format, decrypting CMS Enveloped Data, signing data in CMS Signed Data format, and verifying CMS Signed Data. +:since: 2.20 +:supportLevel: Stable-deprecated +:deprecated: *deprecated* +:component-header: Only producer is supported -*Since Camel 2.20* +*Since Camel {since}* *Since Camel 2.20* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* http://tools.ietf.org/html/rfc5652[Cryptographic Message Syntax (CMS)] is a well established standard for signing and encrypting messages. The Apache Crypto CMS component supports the following parts of this standard: * Content Type "Enveloped Data" with Key Transport (asymmetric key), diff --git a/docs/components/modules/ROOT/pages/crypto-component.adoc b/docs/components/modules/ROOT/pages/crypto-component.adoc index 1ae67c99a3bc5..d8f9385f873f0 100644 --- a/docs/components/modules/ROOT/pages/crypto-component.adoc +++ b/docs/components/modules/ROOT/pages/crypto-component.adoc @@ -1,12 +1,16 @@ [[crypto-component]] = Crypto (JCE) Component :page-source: components/camel-crypto/src/main/docs/crypto-component.adoc +:docTitle: Crypto (JCE) +:artifactId: camel-crypto +:description: The crypto component is used for signing and verifying exchanges using the Signature Service of the Java Cryptographic Extension (JCE). +:since: 2.3 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.3* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* With Camel cryptographic endpoints and Java's Cryptographic extension it is easy to create Digital Signatures for Exchanges. diff --git a/docs/components/modules/ROOT/pages/cxf-component.adoc b/docs/components/modules/ROOT/pages/cxf-component.adoc index 341fe2c7e990d..4272987fd5f9f 100644 --- a/docs/components/modules/ROOT/pages/cxf-component.adoc +++ b/docs/components/modules/ROOT/pages/cxf-component.adoc @@ -1,12 +1,16 @@ [[cxf-component]] = CXF Component :page-source: components/camel-cxf/src/main/docs/cxf-component.adoc +:docTitle: CXF +:artifactId: camel-cxf +:description: The cxf component is used for SOAP WebServices using Apache CXF. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* [TIP] ==== diff --git a/docs/components/modules/ROOT/pages/cxfrs-component.adoc b/docs/components/modules/ROOT/pages/cxfrs-component.adoc index 799d39cffc108..32e6636122188 100644 --- a/docs/components/modules/ROOT/pages/cxfrs-component.adoc +++ b/docs/components/modules/ROOT/pages/cxfrs-component.adoc @@ -1,12 +1,16 @@ [[cxfrs-component]] = CXF-RS Component :page-source: components/camel-cxf/src/main/docs/cxfrs-component.adoc +:docTitle: CXF-RS +:artifactId: camel-cxf +:description: The cxfrs component is used for JAX-RS REST services using Apache CXF. +:since: 2.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The CXFRS component provides integration with http://cxf.apache.org[Apache CXF] for connecting to JAX-RS 1.1 and 2.0 diff --git a/docs/components/modules/ROOT/pages/dataformat-component.adoc b/docs/components/modules/ROOT/pages/dataformat-component.adoc index 84cb570c21985..a21959f8ba617 100644 --- a/docs/components/modules/ROOT/pages/dataformat-component.adoc +++ b/docs/components/modules/ROOT/pages/dataformat-component.adoc @@ -1,12 +1,17 @@ [[dataformat-component]] = Data Format Component :page-source: components/camel-dataformat/src/main/docs/dataformat-component.adoc +:docTitle: Data Format +:artifactId: camel-dataformat +:description: The dataformat component is used for working with Data Formats as if it was a regular Component supporting Endpoints and URIs. +:since: 2.12 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Dataformat component allows to use xref:manual::data-format.adoc[Data Format] as a Camel Component. diff --git a/docs/components/modules/ROOT/pages/dataset-component.adoc b/docs/components/modules/ROOT/pages/dataset-component.adoc index ea1443a36e663..6739256b9055a 100644 --- a/docs/components/modules/ROOT/pages/dataset-component.adoc +++ b/docs/components/modules/ROOT/pages/dataset-component.adoc @@ -1,12 +1,17 @@ [[dataset-component]] = Dataset Component :page-source: components/camel-dataset/src/main/docs/dataset-component.adoc +:docTitle: Dataset +:artifactId: camel-dataset +:description: The dataset component provides a mechanism to easily perform load & soak testing of your system. +:since: 1.3 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 1.3* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Testing of distributed and asynchronous processing is notoriously difficult. The xref:mock-component.adoc[Mock], xref:mock-component.adoc[Test] diff --git a/docs/components/modules/ROOT/pages/dataset-test-component.adoc b/docs/components/modules/ROOT/pages/dataset-test-component.adoc index acc7ee00917b2..d055d471ce1fb 100644 --- a/docs/components/modules/ROOT/pages/dataset-test-component.adoc +++ b/docs/components/modules/ROOT/pages/dataset-test-component.adoc @@ -1,12 +1,17 @@ [[dataset-test-component]] = DataSet Test Component :page-source: components/camel-dataset/src/main/docs/dataset-test-component.adoc +:docTitle: DataSet Test +:artifactId: camel-dataset +:description: The dataset-test component extends the mock component by on startup to pull messages from another endpoint to set the expected message bodies. +:since: 1.3 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 1.3* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* Testing of distributed and asynchronous processing is notoriously difficult. The xref:mock-component.adoc[Mock], xref:mock-component.adoc[Test] @@ -29,7 +34,7 @@ This will then set up a properly configured xref:mock-component.adoc[Mock] endpoint, which is only valid if the received messages match the number of expected messages and their message payloads are equal. -The xref:test.adoc[Test] component is provided +The xref:others:test.adoc[Test] component is provided directly in the camel-core. == URI format diff --git a/docs/components/modules/ROOT/pages/debezium-mongodb-component.adoc b/docs/components/modules/ROOT/pages/debezium-mongodb-component.adoc index b7b99be396a55..e88ea25639d6d 100644 --- a/docs/components/modules/ROOT/pages/debezium-mongodb-component.adoc +++ b/docs/components/modules/ROOT/pages/debezium-mongodb-component.adoc @@ -1,12 +1,16 @@ [[debezium-mongodb-component]] = Debezium MongoDB Connector Component :page-source: components/camel-debezium-mongodb/src/main/docs/debezium-mongodb-component.adoc +:docTitle: Debezium MongoDB Connector +:artifactId: camel-debezium-mongodb +:description: Represents a Debezium MongoDB endpoint which is used to capture changes in MongoDB database so that that applications can see those changes and respond to them. +:since: 3.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Debezium MongoDB component is wrapper around https://debezium.io/[Debezium] using https://debezium.io/documentation/reference/0.9/operations/embedded.html[Debezium Embedded], which enables Change Data Capture from MongoDB database using Debezium without the need for Kafka or Kafka Connect. diff --git a/docs/components/modules/ROOT/pages/debezium-mysql-component.adoc b/docs/components/modules/ROOT/pages/debezium-mysql-component.adoc index fd5cadb74ba9a..f76ac5aa95bce 100644 --- a/docs/components/modules/ROOT/pages/debezium-mysql-component.adoc +++ b/docs/components/modules/ROOT/pages/debezium-mysql-component.adoc @@ -1,12 +1,16 @@ [[debezium-mysql-component]] = Debezium MySQL Connector Component :page-source: components/camel-debezium-mysql/src/main/docs/debezium-mysql-component.adoc +:docTitle: Debezium MySQL Connector +:artifactId: camel-debezium-mysql +:description: Represents a Debezium MySQL endpoint which is used to capture changes in MySQL database so that that applications can see those changes and respond to them. +:since: 3.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Debezium MySQL component is wrapper around https://debezium.io/[Debezium] using https://debezium.io/documentation/reference/0.9/operations/embedded.html[Debezium Embedded], which enables Change Data Capture from MySQL database using Debezium without the need for Kafka or Kafka Connect. diff --git a/docs/components/modules/ROOT/pages/debezium-postgres-component.adoc b/docs/components/modules/ROOT/pages/debezium-postgres-component.adoc index 849e7596fdcca..2ed970cd45755 100644 --- a/docs/components/modules/ROOT/pages/debezium-postgres-component.adoc +++ b/docs/components/modules/ROOT/pages/debezium-postgres-component.adoc @@ -1,12 +1,16 @@ [[debezium-postgres-component]] = Debezium PostgresSQL Connector Component :page-source: components/camel-debezium-postgres/src/main/docs/debezium-postgres-component.adoc +:docTitle: Debezium PostgresSQL Connector +:artifactId: camel-debezium-postgres +:description: Represents a Debezium PostgresSQL endpoint which is used to capture changes in PostgresSQL database so that that applications can see those changes and respond to them. +:since: 3.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Debezium PostgresSQL component is wrapper around https://debezium.io/[Debezium] using https://debezium.io/documentation/reference/0.9/operations/embedded.html[Debezium Embedded], which enables Change Data Capture from PostgresSQL database using Debezium without the need for Kafka or Kafka Connect. diff --git a/docs/components/modules/ROOT/pages/debezium-sqlserver-component.adoc b/docs/components/modules/ROOT/pages/debezium-sqlserver-component.adoc index 974868e9a90ce..67b91509fb413 100644 --- a/docs/components/modules/ROOT/pages/debezium-sqlserver-component.adoc +++ b/docs/components/modules/ROOT/pages/debezium-sqlserver-component.adoc @@ -1,12 +1,16 @@ [[debezium-sqlserver-component]] = Debezium SQL Server Connector Component :page-source: components/camel-debezium-sqlserver/src/main/docs/debezium-sqlserver-component.adoc +:docTitle: Debezium SQL Server Connector +:artifactId: camel-debezium-sqlserver +:description: Represents a Debezium SQL Server endpoint which is used to capture changes in SQL Server database so that that applications can see those changes and respond to them. +:since: 3.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Debezium SQL Server component is wrapper around https://debezium.io/[Debezium] using https://debezium.io/documentation/reference/0.10/operations/embedded.html[Debezium Embedded], which enables Change Data Capture from SQL Server database using Debezium without the need for Kafka or Kafka Connect. diff --git a/docs/components/modules/ROOT/pages/digitalocean-component.adoc b/docs/components/modules/ROOT/pages/digitalocean-component.adoc index 19e2f001d560c..9e5c0b5893f71 100644 --- a/docs/components/modules/ROOT/pages/digitalocean-component.adoc +++ b/docs/components/modules/ROOT/pages/digitalocean-component.adoc @@ -1,12 +1,16 @@ [[digitalocean-component]] = DigitalOcean Component :page-source: components/camel-digitalocean/src/main/docs/digitalocean-component.adoc +:docTitle: DigitalOcean +:artifactId: camel-digitalocean +:description: The DigitalOcean component allows you to manage Droplets and resources within the DigitalOcean cloud. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The DigitalOcean component allows you to manage Droplets and resources within the DigitalOcean cloud with **Camel** by encapsulating https://www.digitalocean.com/community/projects/api-client-in-java[digitalocean-api-java]. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through this Camel component. diff --git a/docs/components/modules/ROOT/pages/direct-component.adoc b/docs/components/modules/ROOT/pages/direct-component.adoc index fbbaaa64ab695..b41c323414538 100644 --- a/docs/components/modules/ROOT/pages/direct-component.adoc +++ b/docs/components/modules/ROOT/pages/direct-component.adoc @@ -1,12 +1,17 @@ [[direct-component]] = Direct Component :page-source: components/camel-direct/src/main/docs/direct-component.adoc +:docTitle: Direct +:artifactId: camel-direct +:description: The direct component provides direct, synchronous call to another endpoint from the same CamelContext. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Direct component provides direct, synchronous invocation of any consumers when a producer sends a message exchange. + diff --git a/docs/components/modules/ROOT/pages/direct-vm-component.adoc b/docs/components/modules/ROOT/pages/direct-vm-component.adoc index c4509d4ca14bf..7229836244f88 100644 --- a/docs/components/modules/ROOT/pages/direct-vm-component.adoc +++ b/docs/components/modules/ROOT/pages/direct-vm-component.adoc @@ -1,12 +1,17 @@ [[direct-vm-component]] = Direct VM Component :page-source: components/camel-directvm/src/main/docs/direct-vm-component.adoc +:docTitle: Direct VM +:artifactId: camel-directvm +:description: The direct-vm component provides direct, synchronous call to another endpoint from any CamelContext in the same JVM. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Direct-Vm component provides direct, synchronous invocation of any consumers in the JVM when a producer sends a message exchange. + diff --git a/docs/components/modules/ROOT/pages/disruptor-component.adoc b/docs/components/modules/ROOT/pages/disruptor-component.adoc index a743aa75e046f..fe729ea4bf9a7 100644 --- a/docs/components/modules/ROOT/pages/disruptor-component.adoc +++ b/docs/components/modules/ROOT/pages/disruptor-component.adoc @@ -1,12 +1,16 @@ [[disruptor-component]] = Disruptor Component :page-source: components/camel-disruptor/src/main/docs/disruptor-component.adoc +:docTitle: Disruptor +:artifactId: camel-disruptor +:description: The disruptor component provides asynchronous SEDA behavior using LMAX Disruptor. +:since: 2.12 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Disruptor component provides asynchronous https://en.wikipedia.org/wiki/Staged_event-driven_architecture[SEDA] behavior much as the diff --git a/docs/components/modules/ROOT/pages/djl-component.adoc b/docs/components/modules/ROOT/pages/djl-component.adoc index deabb38237470..654e08737707d 100644 --- a/docs/components/modules/ROOT/pages/djl-component.adoc +++ b/docs/components/modules/ROOT/pages/djl-component.adoc @@ -1,13 +1,18 @@ [[djl-component]] = Deep Java Library Component :page-source: components/camel-djl/src/main/docs/djl-component.adoc +:docTitle: Deep Java Library +:artifactId: camel-djl +:description: The Deep Java Library component is used to infer deep learning models. +:since: 3.3 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.3* +*Since Camel {since}* +*{component-header}* -// HEADER START -*Only producer is supported* -// HEADER END +== Deep Java Library The *Deep Java Library* component is used to infer Deep Learning models from message exchanges data. This component uses https://djl.ai/[Deep Java Library] as underlying library. @@ -210,4 +215,4 @@ context.getRegistry().bind("MyTranslator", translator); from("file:/data/mnist/0/10.png") .to("djl:cv/image_classification?model=MyModel&translator=MyTranslator"); ----- \ No newline at end of file +---- diff --git a/docs/components/modules/ROOT/pages/dns-component.adoc b/docs/components/modules/ROOT/pages/dns-component.adoc index 666b035cb0401..a8f4ebcf31350 100644 --- a/docs/components/modules/ROOT/pages/dns-component.adoc +++ b/docs/components/modules/ROOT/pages/dns-component.adoc @@ -1,12 +1,16 @@ [[dns-component]] = DNS Component :page-source: components/camel-dns/src/main/docs/dns-component.adoc +:docTitle: DNS +:artifactId: camel-dns +:description: To lookup domain information and run DNS queries using DNSJava. +:since: 2.7 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* This is an additional component for Camel to run DNS queries, using DNSJava. The component is a thin layer on top of diff --git a/docs/components/modules/ROOT/pages/docker-component.adoc b/docs/components/modules/ROOT/pages/docker-component.adoc index 2993dd59ef429..7a7660fa0a917 100644 --- a/docs/components/modules/ROOT/pages/docker-component.adoc +++ b/docs/components/modules/ROOT/pages/docker-component.adoc @@ -1,12 +1,16 @@ [[docker-component]] = Docker Component :page-source: components/camel-docker/src/main/docs/docker-component.adoc +:docTitle: Docker +:artifactId: camel-docker +:description: The docker component is used for managing Docker containers. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Camel component for communicating with Docker. diff --git a/docs/components/modules/ROOT/pages/dozer-component.adoc b/docs/components/modules/ROOT/pages/dozer-component.adoc index 2dab0df5038f9..9d358db3c911b 100644 --- a/docs/components/modules/ROOT/pages/dozer-component.adoc +++ b/docs/components/modules/ROOT/pages/dozer-component.adoc @@ -1,12 +1,16 @@ [[dozer-component]] = Dozer Component :page-source: components/camel-dozer/src/main/docs/dozer-component.adoc +:docTitle: Dozer +:artifactId: camel-dozer +:description: The dozer component provides the ability to map between Java beans using the Dozer mapping library. +:since: 2.15 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Dozer component provides the ability to map between Java beans using the http://camel.apache.org/dozer-type-conversion.html[Dozer] diff --git a/docs/components/modules/ROOT/pages/drill-component.adoc b/docs/components/modules/ROOT/pages/drill-component.adoc index e9622190f2691..364a1bb2dd2db 100644 --- a/docs/components/modules/ROOT/pages/drill-component.adoc +++ b/docs/components/modules/ROOT/pages/drill-component.adoc @@ -1,12 +1,16 @@ [[drill-component]] = Drill Component :page-source: components/camel-drill/src/main/docs/drill-component.adoc +:docTitle: Drill +:artifactId: camel-drill +:description: The drill component gives you the ability to quering into apache drill cluster. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Drill component gives you the ability to querying to https://drill.apache.org/[Apache Drill Cluster] diff --git a/docs/components/modules/ROOT/pages/dropbox-component.adoc b/docs/components/modules/ROOT/pages/dropbox-component.adoc index a3b4bfaed7e7d..4e46cf72627fc 100644 --- a/docs/components/modules/ROOT/pages/dropbox-component.adoc +++ b/docs/components/modules/ROOT/pages/dropbox-component.adoc @@ -1,12 +1,16 @@ [[dropbox-component]] = Dropbox Component :page-source: components/camel-dropbox/src/main/docs/dropbox-component.adoc +:docTitle: Dropbox +:artifactId: camel-dropbox +:description: For uploading, downloading and managing files, folders, groups, collaborations, etc on dropbox DOT com. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Dropbox component allows you to treat https://www.dropbox.com[Dropbox] remote folders as a producer or diff --git a/docs/components/modules/ROOT/pages/ehcache-component.adoc b/docs/components/modules/ROOT/pages/ehcache-component.adoc index f2e1a57c42683..6351dcb1bdca9 100644 --- a/docs/components/modules/ROOT/pages/ehcache-component.adoc +++ b/docs/components/modules/ROOT/pages/ehcache-component.adoc @@ -1,12 +1,16 @@ [[ehcache-component]] = Ehcache Component :page-source: components/camel-ehcache/src/main/docs/ehcache-component.adoc +:docTitle: Ehcache +:artifactId: camel-ehcache +:description: The ehcache component enables you to perform caching operations using Ehcache as cache implementation. +:since: 2.18 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Ehcache component enables you to perform caching operations using Ehcache 3 as the Cache Implementation. diff --git a/docs/components/modules/ROOT/pages/elasticsearch-rest-component.adoc b/docs/components/modules/ROOT/pages/elasticsearch-rest-component.adoc index 01c42ee44126f..1be613d758266 100644 --- a/docs/components/modules/ROOT/pages/elasticsearch-rest-component.adoc +++ b/docs/components/modules/ROOT/pages/elasticsearch-rest-component.adoc @@ -1,12 +1,16 @@ [[elasticsearch-rest-component]] = Elastichsearch Rest Component :page-source: components/camel-elasticsearch-rest/src/main/docs/elasticsearch-rest-component.adoc +:docTitle: Elastichsearch Rest +:artifactId: camel-elasticsearch-rest +:description: The elasticsearch component is used for interfacing with ElasticSearch server using REST API. +:since: 2.21 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.21* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* *Since Camel 2.21* diff --git a/docs/components/modules/ROOT/pages/elsql-component.adoc b/docs/components/modules/ROOT/pages/elsql-component.adoc index d1066ca7d207a..47159f256da4a 100644 --- a/docs/components/modules/ROOT/pages/elsql-component.adoc +++ b/docs/components/modules/ROOT/pages/elsql-component.adoc @@ -1,12 +1,16 @@ [[elsql-component]] = ElSQL Component :page-source: components/camel-elsql/src/main/docs/elsql-component.adoc +:docTitle: ElSQL +:artifactId: camel-elsql +:description: The elsql component is an extension to the existing SQL Component that uses ElSql to define the SQL queries. +:since: 2.16 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The ELSQL component is an extension to the existing xref:sql-component.adoc[SQL Component] that uses @@ -45,7 +49,7 @@ The parameters to the SQL queries are named parameters in the elsql mapping files, and maps to corresponding keys from the Camel message, in the given precedence: -1. from message body if xref:components:languages:simple-language.adoc[Simple] +1. from message body if xref:languages:simple-language.adoc[Simple] expression. 2. from message body if its a `java.util.Map` diff --git a/docs/components/modules/ROOT/pages/elytron-component.adoc b/docs/components/modules/ROOT/pages/elytron-component.adoc index 585189381f60b..d25d36d667f0e 100644 --- a/docs/components/modules/ROOT/pages/elytron-component.adoc +++ b/docs/components/modules/ROOT/pages/elytron-component.adoc @@ -1,12 +1,12 @@ [[elytron-component]] = Undertow Elytron Security Provider :page-source: components/camel-elytron/src/main/docs/elytron-component.adoc +//by hand +:since: 3.2 -*Since Camel 3.2* +*Since Camel {since}* -// HEADER START *Replaces component camel-elytron* -// HEADER END *OSGi is not supported* diff --git a/docs/components/modules/ROOT/pages/etcd-keys-component.adoc b/docs/components/modules/ROOT/pages/etcd-keys-component.adoc index aa9e2096cc847..7e81dc7c614cd 100644 --- a/docs/components/modules/ROOT/pages/etcd-keys-component.adoc +++ b/docs/components/modules/ROOT/pages/etcd-keys-component.adoc @@ -1,12 +1,16 @@ [[etcd-keys-component]] = Etcd Keys Component :page-source: components/camel-etcd/src/main/docs/etcd-keys-component.adoc +:docTitle: Etcd Keys +:artifactId: camel-etcd +:description: Camel Etcd support +:since: 2.18 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* *Since Camel 2.18* diff --git a/docs/components/modules/ROOT/pages/etcd-stats-component.adoc b/docs/components/modules/ROOT/pages/etcd-stats-component.adoc index c5450a059ad8c..12e87cf37b979 100644 --- a/docs/components/modules/ROOT/pages/etcd-stats-component.adoc +++ b/docs/components/modules/ROOT/pages/etcd-stats-component.adoc @@ -1,12 +1,16 @@ [[etcd-stats-component]] = Etcd Stats Component :page-source: components/camel-etcd/src/main/docs/etcd-stats-component.adoc +:docTitle: Etcd Stats +:artifactId: camel-etcd +:description: The camel etcd component allows you to work with Etcd, a distributed reliable key-value store. +:since: 2.18 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* *Since Camel 2.18* diff --git a/docs/components/modules/ROOT/pages/etcd-watch-component.adoc b/docs/components/modules/ROOT/pages/etcd-watch-component.adoc index aae99e5d554a0..b4c3cf25c171c 100644 --- a/docs/components/modules/ROOT/pages/etcd-watch-component.adoc +++ b/docs/components/modules/ROOT/pages/etcd-watch-component.adoc @@ -1,12 +1,16 @@ [[etcd-watch-component]] = Etcd Watch Component :page-source: components/camel-etcd/src/main/docs/etcd-watch-component.adoc +:docTitle: Etcd Watch +:artifactId: camel-etcd +:description: The camel etcd component allows you to work with Etcd, a distributed reliable key-value store. +:since: 2.18 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* *Since Camel 2.18* diff --git a/docs/components/modules/ROOT/pages/exec-component.adoc b/docs/components/modules/ROOT/pages/exec-component.adoc index 9d2a5e032d139..cd41a90021972 100644 --- a/docs/components/modules/ROOT/pages/exec-component.adoc +++ b/docs/components/modules/ROOT/pages/exec-component.adoc @@ -1,12 +1,16 @@ [[exec-component]] = Exec Component :page-source: components/camel-exec/src/main/docs/exec-component.adoc +:docTitle: Exec +:artifactId: camel-exec +:description: The exec component can be used to execute OS system commands. +:since: 2.3 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.3* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Exec component can be used to execute system commands. diff --git a/docs/components/modules/ROOT/pages/facebook-component.adoc b/docs/components/modules/ROOT/pages/facebook-component.adoc index 6f93c420a0319..7adb232286bda 100644 --- a/docs/components/modules/ROOT/pages/facebook-component.adoc +++ b/docs/components/modules/ROOT/pages/facebook-component.adoc @@ -1,12 +1,16 @@ [[facebook-component]] = Facebook Component :page-source: components/camel-facebook/src/main/docs/facebook-component.adoc +:docTitle: Facebook +:artifactId: camel-facebook +:description: The Facebook component provides access to all of the Facebook APIs accessible using Facebook4J. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Facebook component provides access to all of the Facebook APIs accessible using https://facebook4j.github.io/en/index.html[Facebook4J]. It diff --git a/docs/components/modules/ROOT/pages/fhir-component.adoc b/docs/components/modules/ROOT/pages/fhir-component.adoc index 006fdb28f8091..0e4bd7cc9a854 100644 --- a/docs/components/modules/ROOT/pages/fhir-component.adoc +++ b/docs/components/modules/ROOT/pages/fhir-component.adoc @@ -1,12 +1,16 @@ [[fhir-component]] = FHIR Component :page-source: components/camel-fhir/camel-fhir-component/src/main/docs/fhir-component.adoc +:docTitle: FHIR +:artifactId: camel-fhir +:description: The fhir component is used for working with the FHIR protocol (health care). +:since: 2.23 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The FHIR component integrates with the http://hapifhir.io/[HAPI-FHIR] library which is an open-source implementation of the @@ -166,4 +170,3 @@ with the following path and query parameters: // endpoint options: END include::camel-spring-boot::page$fhir-starter.adoc[] - diff --git a/docs/components/modules/ROOT/pages/file-component.adoc b/docs/components/modules/ROOT/pages/file-component.adoc index 4d516ddbdd5de..3e3d6986f6f1d 100644 --- a/docs/components/modules/ROOT/pages/file-component.adoc +++ b/docs/components/modules/ROOT/pages/file-component.adoc @@ -1,12 +1,17 @@ [[file-component]] = File Component :page-source: components/camel-file/src/main/docs/file-component.adoc +:docTitle: File +:artifactId: camel-file +:description: The file component is used for reading or writing files. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The File component provides access to file systems, allowing files to be processed by any other Camel Components or @@ -221,7 +226,7 @@ bean completes, and thus the route is completed, the file consumer will perform the move operation and move the file to the `.done` sub-folder. The *move* and the *preMove* options are considered as a directory name -(though if you use an expression such as xref:components:languages:file-language.adoc[File Language], or xref:components:languages:simple-language.adoc[Simple] then the result of the expression +(though if you use an expression such as xref:languages:file-language.adoc[File Language], or xref:languages:simple-language.adoc[Simple] then the result of the expression evaluation is the file name to be used - eg if you set [source] @@ -229,7 +234,7 @@ evaluation is the file name to be used - eg if you set move=../backup/copy-of-${file:name} ---- -then that's using the xref:components:languages:file-language.adoc[File Language] which we +then that's using the xref:languages:file-language.adoc[File Language] which we use return the file name to be used), which can be either relative or absolute. If relative, the directory is created as a sub-folder from within the folder where the file was consumed. @@ -267,10 +272,10 @@ processed and after it's processed, it's moved to the `.done` folder. The *move* and *preMove* options are Expression-based, so we have the full power of -the xref:components:languages:file-language.adoc[File Language] to do advanced configuration +the xref:languages:file-language.adoc[File Language] to do advanced configuration of the directory and name pattern. + Camel will, in fact, internally convert the directory name you enter -into a xref:components:languages:file-language.adoc[File Language] expression. So when we +into a xref:languages:file-language.adoc[File Language] expression. So when we enter `move=.done` Camel will convert this into: `\${file:parent}/.done/${file:onlyname}`. This is only done if Camel detects that you have not provided a $\{ } in the option value @@ -293,7 +298,7 @@ choice. For example to move the files in an error folder with a timestamp you can use `moveFailed=/error/${``file:name.noext``}-${date:now:yyyyMMddHHmmssSSS}.${``file:ext`}. -See more examples at xref:components:languages:file-language.adoc[File Language] +See more examples at xref:languages:file-language.adoc[File Language] == Message Headers @@ -307,7 +312,7 @@ The following headers are supported by this component: |`CamelFileName` |Specifies the name of the file to write (relative to the endpoint directory). This name can be a `String`; a `String` with a -xref:components:languages:file-language.adoc[File Language] or xref:components:languages:simple-language.adoc[Simple] +xref:languages:file-language.adoc[File Language] or xref:languages:simple-language.adoc[Simple] expression; or an Expression object. If it's `null` then Camel will auto-generate a filename based on the message unique ID. @@ -514,8 +519,8 @@ from("direct:report").to("file:target/reports/?fileName=report.txt"); == Filename Expression Filename can be set either using the *expression* option or as a -string-based xref:components:languages:file-language.adoc[File Language] expression in the -`CamelFileName` header. See the xref:components:languages:file-language.adoc[File Language] +string-based xref:languages:file-language.adoc[File Language] expression in the +`CamelFileName` header. See the xref:languages:file-language.adoc[File Language] for syntax and samples. [[File2-Consumingfilesfromfolderswhereothersdropfilesdirectly]] @@ -798,7 +803,7 @@ today's date as a sub-folder name: from("file://inbox?move=backup/${date:now:yyyyMMdd}/${file:name}").to("..."); ---- -See xref:components:languages:file-language.adoc[File Language] for more samples. +See xref:languages:file-language.adoc[File Language] for more samples. == Avoiding reading the same file more than once (idempotent consumer) @@ -999,7 +1004,7 @@ Registry for a bean with the ID, `mySorter`. === Sorting using sortBy Camel supports pluggable sorting strategies. This strategy it to use the -xref:components:languages:file-language.adoc[File Language] to configure the sorting. The +xref:languages:file-language.adoc[File Language] to configure the sorting. The `sortBy` option is configured as follows: [source] @@ -1023,7 +1028,7 @@ This will sort by file name, you can reverse the order by prefixing sortBy=reverse:file:name ---- -As we have the full power of xref:components:languages:file-language.adoc[File Language] we +As we have the full power of xref:languages:file-language.adoc[File Language] we can use some of the other parameters, so if we want to sort by file size we do: @@ -1067,7 +1072,7 @@ sortBy=file:modified;file:name Now there is an issue here, can you spot it? Well the modified timestamp of the file is too fine as it will be in milliseconds, but what if we want to sort by date only and then subgroup by name? + - Well as we have the true power of xref:components:languages:file-language.adoc[File Language] we can use its date command that supports patterns. So this + Well as we have the true power of xref:languages:file-language.adoc[File Language] we can use its date command that supports patterns. So this can be solved as: [source] diff --git a/docs/components/modules/ROOT/pages/file-watch-component.adoc b/docs/components/modules/ROOT/pages/file-watch-component.adoc index cfada59c07460..75aa39f96fc79 100644 --- a/docs/components/modules/ROOT/pages/file-watch-component.adoc +++ b/docs/components/modules/ROOT/pages/file-watch-component.adoc @@ -1,15 +1,19 @@ [[file-watch-component]] = File Watch Component :page-source: components/camel-file-watch/src/main/docs/file-watch-component.adoc +:docTitle: File Watch +:artifactId: camel-file-watch +:description: The file-watch is used to monitor file events in directory using java.nio.file.WatchService +:since: 3.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.0* +*Since Camel {since}* *Since Camel 3.0* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* This component can be used to watch file modification events in folder. It is based on https://github.com/gmethvin/directory-watcher[gmethvin/directory-watcher]. diff --git a/docs/components/modules/ROOT/pages/flatpack-component.adoc b/docs/components/modules/ROOT/pages/flatpack-component.adoc index 51f12371472ee..236c2777f021a 100644 --- a/docs/components/modules/ROOT/pages/flatpack-component.adoc +++ b/docs/components/modules/ROOT/pages/flatpack-component.adoc @@ -1,12 +1,16 @@ [[flatpack-component]] = Flatpack Component :page-source: components/camel-flatpack/src/main/docs/flatpack-component.adoc +:docTitle: Flatpack +:artifactId: camel-flatpack +:description: The flatpack component supports fixed width and delimited file parsing via the FlatPack library. +:since: 1.4 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.4* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Flatpack component supports fixed width and delimited file parsing via the http://flatpack.sourceforge.net[FlatPack library]. + diff --git a/docs/components/modules/ROOT/pages/flink-component.adoc b/docs/components/modules/ROOT/pages/flink-component.adoc index 159b8015b177d..01b646e3597b4 100644 --- a/docs/components/modules/ROOT/pages/flink-component.adoc +++ b/docs/components/modules/ROOT/pages/flink-component.adoc @@ -1,12 +1,16 @@ [[flink-component]] = Flink Component :page-source: components/camel-flink/src/main/docs/flink-component.adoc +:docTitle: Flink +:artifactId: camel-flink +:description: The flink component can be used to send DataSet jobs to Apache Flink cluster. +:since: 2.18 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* *Since Camel 2.18* diff --git a/docs/components/modules/ROOT/pages/fop-component.adoc b/docs/components/modules/ROOT/pages/fop-component.adoc index b0500a3a28ca5..b6152ec4db912 100644 --- a/docs/components/modules/ROOT/pages/fop-component.adoc +++ b/docs/components/modules/ROOT/pages/fop-component.adoc @@ -1,12 +1,16 @@ [[fop-component]] = FOP Component :page-source: components/camel-fop/src/main/docs/fop-component.adoc +:docTitle: FOP +:artifactId: camel-fop +:description: The fop component allows you to render a message into different output formats using Apache FOP. +:since: 2.10 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The FOP component allows you to render a message into different output formats using http://xmlgraphics.apache.org/fop/index.html[Apache FOP]. diff --git a/docs/components/modules/ROOT/pages/freemarker-component.adoc b/docs/components/modules/ROOT/pages/freemarker-component.adoc index cf0d9eb086e40..cc86eaa33c3ed 100644 --- a/docs/components/modules/ROOT/pages/freemarker-component.adoc +++ b/docs/components/modules/ROOT/pages/freemarker-component.adoc @@ -1,12 +1,16 @@ [[freemarker-component]] = Freemarker Component :page-source: components/camel-freemarker/src/main/docs/freemarker-component.adoc +:docTitle: Freemarker +:artifactId: camel-freemarker +:description: Transforms the message using a FreeMarker template. +:since: 2.10 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The *freemarker:* component allows for processing a message using a http://freemarker.org/[FreeMarker] template. This can be ideal when diff --git a/docs/components/modules/ROOT/pages/ftp-component.adoc b/docs/components/modules/ROOT/pages/ftp-component.adoc index a02a000816fbe..0225ffbc9e266 100644 --- a/docs/components/modules/ROOT/pages/ftp-component.adoc +++ b/docs/components/modules/ROOT/pages/ftp-component.adoc @@ -1,12 +1,16 @@ [[ftp-component]] = FTP Component :page-source: components/camel-ftp/src/main/docs/ftp-component.adoc +:docTitle: FTP +:artifactId: camel-ftp +:description: The ftp component is used for uploading or downloading files from FTP servers. +:since: 1.1 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component provides access to remote file systems over the FTP and SFTP protocols. diff --git a/docs/components/modules/ROOT/pages/ftps-component.adoc b/docs/components/modules/ROOT/pages/ftps-component.adoc index ea8f9d1aeba63..7a3fa4c9a7747 100644 --- a/docs/components/modules/ROOT/pages/ftps-component.adoc +++ b/docs/components/modules/ROOT/pages/ftps-component.adoc @@ -1,12 +1,16 @@ [[ftps-component]] = FTPS Component :page-source: components/camel-ftp/src/main/docs/ftps-component.adoc +:docTitle: FTPS +:artifactId: camel-ftp +:description: The ftps (FTP secure SSL/TLS) component is used for uploading or downloading files from FTP servers. +:since: 2.2 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.2* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component provides access to remote file systems over the FTP and SFTP protocols. diff --git a/docs/components/modules/ROOT/pages/ganglia-component.adoc b/docs/components/modules/ROOT/pages/ganglia-component.adoc index 1e1eee800858e..890f43551c4a7 100644 --- a/docs/components/modules/ROOT/pages/ganglia-component.adoc +++ b/docs/components/modules/ROOT/pages/ganglia-component.adoc @@ -1,12 +1,16 @@ [[ganglia-component]] = Ganglia Component :page-source: components/camel-ganglia/src/main/docs/ganglia-component.adoc +:docTitle: Ganglia +:artifactId: camel-ganglia +:description: The ganglia component is used for sending metrics to the Ganglia monitoring system. +:since: 2.15 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* Provides a mechanism to send a value (the message body) as a metric to the http://ganglia.info[Ganglia] monitoring system. Uses the gmetric4j diff --git a/docs/components/modules/ROOT/pages/geocoder-component.adoc b/docs/components/modules/ROOT/pages/geocoder-component.adoc index b28e5f05a870e..3bf5b6eea5bdb 100644 --- a/docs/components/modules/ROOT/pages/geocoder-component.adoc +++ b/docs/components/modules/ROOT/pages/geocoder-component.adoc @@ -1,12 +1,16 @@ [[geocoder-component]] = Geocoder Component :page-source: components/camel-geocoder/src/main/docs/geocoder-component.adoc +:docTitle: Geocoder +:artifactId: camel-geocoder +:description: The geocoder component is used for looking up geocodes (latitude and longitude) for a given address, or reverse lookup. +:since: 2.12 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Geocoder component is used for looking up geocodes (latitude and longitude) for a given address, or reverse lookup. The component uses diff --git a/docs/components/modules/ROOT/pages/git-component.adoc b/docs/components/modules/ROOT/pages/git-component.adoc index a56b1c38cfada..332d8ead7a437 100644 --- a/docs/components/modules/ROOT/pages/git-component.adoc +++ b/docs/components/modules/ROOT/pages/git-component.adoc @@ -1,12 +1,16 @@ [[git-component]] = Git Component :page-source: components/camel-git/src/main/docs/git-component.adoc +:docTitle: Git +:artifactId: camel-git +:description: The git component is used for working with git repositories. +:since: 2.16 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Git component allows you to work with a generic Git repository. diff --git a/docs/components/modules/ROOT/pages/github-component.adoc b/docs/components/modules/ROOT/pages/github-component.adoc index 86d8cff59de14..06864947b0097 100644 --- a/docs/components/modules/ROOT/pages/github-component.adoc +++ b/docs/components/modules/ROOT/pages/github-component.adoc @@ -1,12 +1,16 @@ [[github-component]] = GitHub Component :page-source: components/camel-github/src/main/docs/github-component.adoc +:docTitle: GitHub +:artifactId: camel-github +:description: The github component is used for integrating Camel with github. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The GitHub component interacts with the GitHub API by encapsulating http://org.eclipse.egit.github.core[egit-github]. It diff --git a/docs/components/modules/ROOT/pages/google-bigquery-component.adoc b/docs/components/modules/ROOT/pages/google-bigquery-component.adoc index 0c42733800190..a130b93e0ea60 100644 --- a/docs/components/modules/ROOT/pages/google-bigquery-component.adoc +++ b/docs/components/modules/ROOT/pages/google-bigquery-component.adoc @@ -1,12 +1,16 @@ [[google-bigquery-component]] = Google BigQuery Component :page-source: components/camel-google-bigquery/src/main/docs/google-bigquery-component.adoc +:docTitle: Google BigQuery +:artifactId: camel-google-bigquery +:description: Google BigQuery data warehouse for analytics. +:since: 2.20 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Google Bigquery component provides access to https://cloud.google.com/bigquery/[Cloud BigQuery Infrastructure] via diff --git a/docs/components/modules/ROOT/pages/google-bigquery-sql-component.adoc b/docs/components/modules/ROOT/pages/google-bigquery-sql-component.adoc index c09f3287c8c29..f476f5a2164db 100644 --- a/docs/components/modules/ROOT/pages/google-bigquery-sql-component.adoc +++ b/docs/components/modules/ROOT/pages/google-bigquery-sql-component.adoc @@ -1,12 +1,16 @@ [[google-bigquery-sql-component]] = Google BigQuery Standard SQL Component :page-source: components/camel-google-bigquery/src/main/docs/google-bigquery-sql-component.adoc +:docTitle: Google BigQuery Standard SQL +:artifactId: camel-google-bigquery +:description: Google BigQuery data warehouse for analytics (using SQL queries). +:since: 2.23 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Google BigQuery SQL component provides access to https://cloud.google.com/bigquery/[Cloud BigQuery Infrastructure] via diff --git a/docs/components/modules/ROOT/pages/google-calendar-component.adoc b/docs/components/modules/ROOT/pages/google-calendar-component.adoc index eb71a74163787..700d78405f89b 100644 --- a/docs/components/modules/ROOT/pages/google-calendar-component.adoc +++ b/docs/components/modules/ROOT/pages/google-calendar-component.adoc @@ -1,12 +1,16 @@ [[google-calendar-component]] = Google Calendar Component :page-source: components/camel-google-calendar/src/main/docs/google-calendar-component.adoc +:docTitle: Google Calendar +:artifactId: camel-google-calendar +:description: The google-calendar component provides access to Google Calendar. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Google Calendar component provides access to http://google.com/calendar[Google Calendar] via diff --git a/docs/components/modules/ROOT/pages/google-calendar-stream-component.adoc b/docs/components/modules/ROOT/pages/google-calendar-stream-component.adoc index 91c7b635b1f06..c65bc76649c43 100644 --- a/docs/components/modules/ROOT/pages/google-calendar-stream-component.adoc +++ b/docs/components/modules/ROOT/pages/google-calendar-stream-component.adoc @@ -1,12 +1,16 @@ [[google-calendar-stream-component]] = Google Calendar Stream Component :page-source: components/camel-google-calendar/src/main/docs/google-calendar-stream-component.adoc +:docTitle: Google Calendar Stream +:artifactId: camel-google-calendar +:description: The google-calendar-stream component provides access to Google Calendar in a streaming mode. +:since: 2.23 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Google Calendar component provides access to https://calendar.google.com[Calendar] via diff --git a/docs/components/modules/ROOT/pages/google-drive-component.adoc b/docs/components/modules/ROOT/pages/google-drive-component.adoc index 3f5ede4578f76..b64b69b06d704 100644 --- a/docs/components/modules/ROOT/pages/google-drive-component.adoc +++ b/docs/components/modules/ROOT/pages/google-drive-component.adoc @@ -1,12 +1,16 @@ [[google-drive-component]] = Google Drive Component :page-source: components/camel-google-drive/src/main/docs/google-drive-component.adoc +:docTitle: Google Drive +:artifactId: camel-google-drive +:description: The google-drive component provides access to Google Drive file storage service. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Google Drive component provides access to the http://drive.google.com[Google Drive file storage service] via the diff --git a/docs/components/modules/ROOT/pages/google-mail-component.adoc b/docs/components/modules/ROOT/pages/google-mail-component.adoc index 2ee13dd183744..f6f4a83b7a57a 100644 --- a/docs/components/modules/ROOT/pages/google-mail-component.adoc +++ b/docs/components/modules/ROOT/pages/google-mail-component.adoc @@ -1,12 +1,16 @@ [[google-mail-component]] = Google Mail Component :page-source: components/camel-google-mail/src/main/docs/google-mail-component.adoc +:docTitle: Google Mail +:artifactId: camel-google-mail +:description: The google-mail component provides access to Google Mail. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Google Mail component provides access to http://gmail.com/[Gmail] via diff --git a/docs/components/modules/ROOT/pages/google-mail-stream-component.adoc b/docs/components/modules/ROOT/pages/google-mail-stream-component.adoc index 31b67de745e02..863db8ca97f72 100644 --- a/docs/components/modules/ROOT/pages/google-mail-stream-component.adoc +++ b/docs/components/modules/ROOT/pages/google-mail-stream-component.adoc @@ -1,12 +1,16 @@ [[google-mail-stream-component]] = Google Mail Stream Component :page-source: components/camel-google-mail/src/main/docs/google-mail-stream-component.adoc +:docTitle: Google Mail Stream +:artifactId: camel-google-mail +:description: The google-mail component provides access to Google Mail. +:since: 2.22 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.22* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Google Mail component provides access to http://gmail.com/[Gmail] via diff --git a/docs/components/modules/ROOT/pages/google-pubsub-component.adoc b/docs/components/modules/ROOT/pages/google-pubsub-component.adoc index c2b5559161f41..2aaa155d101d3 100644 --- a/docs/components/modules/ROOT/pages/google-pubsub-component.adoc +++ b/docs/components/modules/ROOT/pages/google-pubsub-component.adoc @@ -1,12 +1,16 @@ [[google-pubsub-component]] = Google Pubsub Component :page-source: components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc +:docTitle: Google Pubsub +:artifactId: camel-google-pubsub +:description: Messaging client for Google Cloud Platform PubSub Service Built on top of the Google Cloud Pub/Sub libraries. +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Google Pubsub component provides access to https://cloud.google.com/pubsub/[Cloud Pub/Sub Infrastructure] via diff --git a/docs/components/modules/ROOT/pages/google-sheets-component.adoc b/docs/components/modules/ROOT/pages/google-sheets-component.adoc index 3f14a24daf46d..35f3899d286c1 100644 --- a/docs/components/modules/ROOT/pages/google-sheets-component.adoc +++ b/docs/components/modules/ROOT/pages/google-sheets-component.adoc @@ -1,12 +1,16 @@ [[google-sheets-component]] = Google Sheets Component :page-source: components/camel-google-sheets/src/main/docs/google-sheets-component.adoc +:docTitle: Google Sheets +:artifactId: camel-google-sheets +:description: The google-sheets component provides access to Google Sheets. +:since: 2.23 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Google Sheets component provides access to http://google.com/sheets[Google Sheets] via diff --git a/docs/components/modules/ROOT/pages/google-sheets-stream-component.adoc b/docs/components/modules/ROOT/pages/google-sheets-stream-component.adoc index 870c99e8be341..1eb9ea67093e1 100644 --- a/docs/components/modules/ROOT/pages/google-sheets-stream-component.adoc +++ b/docs/components/modules/ROOT/pages/google-sheets-stream-component.adoc @@ -1,12 +1,16 @@ [[google-sheets-stream-component]] = Google Sheets Stream Component :page-source: components/camel-google-sheets/src/main/docs/google-sheets-stream-component.adoc +:docTitle: Google Sheets Stream +:artifactId: camel-google-sheets +:description: The google-sheets-stream component provides access to Google Sheets. +:since: 2.23 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Google Sheets component provides access to https://sheets.google.com/[Sheets] via diff --git a/docs/components/modules/ROOT/pages/gora-component.adoc b/docs/components/modules/ROOT/pages/gora-component.adoc index 356db0d66d177..388913662943b 100644 --- a/docs/components/modules/ROOT/pages/gora-component.adoc +++ b/docs/components/modules/ROOT/pages/gora-component.adoc @@ -1,12 +1,16 @@ [[gora-component]] = Gora Component :page-source: components/camel-gora/src/main/docs/gora-component.adoc +:docTitle: Gora +:artifactId: camel-gora +:description: The gora component allows you to work with NoSQL databases using the Apache Gora framework. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* *Camel-Gora* is an http://camel.apache.org/[Apache Camel] component that allows you to work with NoSQL databases using the diff --git a/docs/components/modules/ROOT/pages/grape-component.adoc b/docs/components/modules/ROOT/pages/grape-component.adoc index 8e6486b6ca3c6..77d5094cb8235 100644 --- a/docs/components/modules/ROOT/pages/grape-component.adoc +++ b/docs/components/modules/ROOT/pages/grape-component.adoc @@ -1,12 +1,16 @@ [[grape-component]] = Grape Component :page-source: components/camel-grape/src/main/docs/grape-component.adoc +:docTitle: Grape +:artifactId: camel-grape +:description: The grape component allows you to fetch, load and manage additional jars when CamelContext is running. +:since: 2.16 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* http://docs.groovy-lang.org/latest/html/documentation/grape.html[Grape] component allows you to fetch, load and manage additional jars when @@ -249,4 +253,3 @@ command: setHeader(GrapeConstats.GRAPE_COMMAND, constant(CamelGrapeCommand.clearPatches)). setBody().constant("Installed patches have been deleted."); ----------------------------------------------------------------------------------------- - diff --git a/docs/components/modules/ROOT/pages/graphql-component.adoc b/docs/components/modules/ROOT/pages/graphql-component.adoc index 43df777ab7bdb..ff911090e2b93 100644 --- a/docs/components/modules/ROOT/pages/graphql-component.adoc +++ b/docs/components/modules/ROOT/pages/graphql-component.adoc @@ -1,12 +1,16 @@ [[graphql-component]] = GraphQL Component :page-source: components/camel-graphql/src/main/docs/graphql-component.adoc +:docTitle: GraphQL +:artifactId: camel-graphql +:description: A Camel GraphQL Component +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The GraphQL component is a GraphQL client that communicates over HTTP and supports queries and mutations, but not subscriptions. It uses the https://hc.apache.org/httpcomponents-client-4.5.x/index.html[Apache HttpClient] library. diff --git a/docs/components/modules/ROOT/pages/grpc-component.adoc b/docs/components/modules/ROOT/pages/grpc-component.adoc index 4ca97f431dadc..1a6ccd2a6ab37 100644 --- a/docs/components/modules/ROOT/pages/grpc-component.adoc +++ b/docs/components/modules/ROOT/pages/grpc-component.adoc @@ -1,12 +1,16 @@ [[grpc-component]] = gRPC Component :page-source: components/camel-grpc/src/main/docs/grpc-component.adoc +:docTitle: gRPC +:artifactId: camel-grpc +:description: The gRPC component allows to call and expose remote procedures via HTTP/2 with protobuf dataformat +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The gRPC component allows you to call or expose Remote Procedure Call (RPC) services using https://developers.google.com/protocol-buffers/docs/overview[Protocol Buffers (protobuf)] diff --git a/docs/components/modules/ROOT/pages/guava-eventbus-component.adoc b/docs/components/modules/ROOT/pages/guava-eventbus-component.adoc index 5918340598e09..0eb79d927b080 100644 --- a/docs/components/modules/ROOT/pages/guava-eventbus-component.adoc +++ b/docs/components/modules/ROOT/pages/guava-eventbus-component.adoc @@ -1,12 +1,16 @@ [[guava-eventbus-component]] = Guava EventBus Component :page-source: components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc +:docTitle: Guava EventBus +:artifactId: camel-guava-eventbus +:description: The guava-eventbus component provides integration bridge between Camel and Google Guava EventBus. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The https://google.github.io/guava/releases/19.0/api/docs/com/google/common/eventbus/EventBus.html[Google diff --git a/docs/components/modules/ROOT/pages/hazelcast-atomicvalue-component.adoc b/docs/components/modules/ROOT/pages/hazelcast-atomicvalue-component.adoc index 764df92236b1a..a230227a8799a 100644 --- a/docs/components/modules/ROOT/pages/hazelcast-atomicvalue-component.adoc +++ b/docs/components/modules/ROOT/pages/hazelcast-atomicvalue-component.adoc @@ -1,12 +1,16 @@ [[hazelcast-atomicvalue-component]] = Hazelcast Atomic Number Component :page-source: components/camel-hazelcast/src/main/docs/hazelcast-atomicvalue-component.adoc +:docTitle: Hazelcast Atomic Number +:artifactId: camel-hazelcast +:description: The hazelcast-atomicvalue component is used to access Hazelcast atomic number, which is an object that simply provides a grid wide number (long). +:since: 2.7 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] atomic number component is one of Camel Hazelcast Components which allows you to access Hazelcast atomic number. An atomic number is an object that simply provides a grid wide number (long). diff --git a/docs/components/modules/ROOT/pages/hazelcast-instance-component.adoc b/docs/components/modules/ROOT/pages/hazelcast-instance-component.adoc index 569211e6f68a5..5d4f4f52f22d6 100644 --- a/docs/components/modules/ROOT/pages/hazelcast-instance-component.adoc +++ b/docs/components/modules/ROOT/pages/hazelcast-instance-component.adoc @@ -1,12 +1,16 @@ [[hazelcast-instance-component]] = Hazelcast Instance Component :page-source: components/camel-hazelcast/src/main/docs/hazelcast-instance-component.adoc +:docTitle: Hazelcast Instance +:artifactId: camel-hazelcast +:description: The hazelcast-instance component is used to consume join/leave events of the cache instance in the cluster. +:since: 2.7 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] instance component is one of Camel Hazelcast Components which allows you to consume join/leave events of the cache instance in the cluster. Hazelcast makes sense in one single "server node", but it's extremly powerful in a clustered environment. diff --git a/docs/components/modules/ROOT/pages/hazelcast-list-component.adoc b/docs/components/modules/ROOT/pages/hazelcast-list-component.adoc index fd4f1c657d50b..18805792e6084 100644 --- a/docs/components/modules/ROOT/pages/hazelcast-list-component.adoc +++ b/docs/components/modules/ROOT/pages/hazelcast-list-component.adoc @@ -1,12 +1,16 @@ [[hazelcast-list-component]] = Hazelcast List Component :page-source: components/camel-hazelcast/src/main/docs/hazelcast-list-component.adoc +:docTitle: Hazelcast List +:artifactId: camel-hazelcast +:description: The hazelcast-list component is used to access Hazelcast distributed list. +:since: 2.7 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] List component is one of Camel Hazelcast Components which allows you to access Hazelcast distributed list. diff --git a/docs/components/modules/ROOT/pages/hazelcast-map-component.adoc b/docs/components/modules/ROOT/pages/hazelcast-map-component.adoc index 4cdfc95a4afde..fde5a0995f724 100644 --- a/docs/components/modules/ROOT/pages/hazelcast-map-component.adoc +++ b/docs/components/modules/ROOT/pages/hazelcast-map-component.adoc @@ -1,12 +1,16 @@ [[hazelcast-map-component]] = Hazelcast Map Component :page-source: components/camel-hazelcast/src/main/docs/hazelcast-map-component.adoc +:docTitle: Hazelcast Map +:artifactId: camel-hazelcast +:description: The hazelcast-map component is used to access Hazelcast distributed map. +:since: 2.7 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] Map component is one of Camel Hazelcast Components which allows you to access Hazelcast distributed map. diff --git a/docs/components/modules/ROOT/pages/hazelcast-multimap-component.adoc b/docs/components/modules/ROOT/pages/hazelcast-multimap-component.adoc index 5c965effce128..2ea1c15023008 100644 --- a/docs/components/modules/ROOT/pages/hazelcast-multimap-component.adoc +++ b/docs/components/modules/ROOT/pages/hazelcast-multimap-component.adoc @@ -1,12 +1,16 @@ [[hazelcast-multimap-component]] = Hazelcast Multimap Component :page-source: components/camel-hazelcast/src/main/docs/hazelcast-multimap-component.adoc +:docTitle: Hazelcast Multimap +:artifactId: camel-hazelcast +:description: The hazelcast-multimap component is used to to access Hazelcast distributed multimap. +:since: 2.7 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] Multimap component is one of Camel Hazelcast Components which allows you to access Hazelcast distributed multimap. diff --git a/docs/components/modules/ROOT/pages/hazelcast-queue-component.adoc b/docs/components/modules/ROOT/pages/hazelcast-queue-component.adoc index 90142f15d38ca..cb602e364cc70 100644 --- a/docs/components/modules/ROOT/pages/hazelcast-queue-component.adoc +++ b/docs/components/modules/ROOT/pages/hazelcast-queue-component.adoc @@ -1,12 +1,16 @@ [[hazelcast-queue-component]] = Hazelcast Queue Component :page-source: components/camel-hazelcast/src/main/docs/hazelcast-queue-component.adoc +:docTitle: Hazelcast Queue +:artifactId: camel-hazelcast +:description: The hazelcast-queue component is used to access Hazelcast distributed queue. +:since: 2.7 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] Queue component is one of Camel Hazelcast Components which allows you to access Hazelcast distributed queue. diff --git a/docs/components/modules/ROOT/pages/hazelcast-replicatedmap-component.adoc b/docs/components/modules/ROOT/pages/hazelcast-replicatedmap-component.adoc index 69dd79865d64e..da3461531878c 100644 --- a/docs/components/modules/ROOT/pages/hazelcast-replicatedmap-component.adoc +++ b/docs/components/modules/ROOT/pages/hazelcast-replicatedmap-component.adoc @@ -1,12 +1,16 @@ [[hazelcast-replicatedmap-component]] = Hazelcast Replicated Map Component :page-source: components/camel-hazelcast/src/main/docs/hazelcast-replicatedmap-component.adoc +:docTitle: Hazelcast Replicated Map +:artifactId: camel-hazelcast +:description: The hazelcast-replicatedmap component is used to access Hazelcast replicated map. +:since: 2.16 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] instance component is one of Camel Hazelcast Components which allows you to consume join/leave events of the cache instance in the cluster. A replicated map is a weakly consistent, distributed key-value data structure with no data partition. diff --git a/docs/components/modules/ROOT/pages/hazelcast-ringbuffer-component.adoc b/docs/components/modules/ROOT/pages/hazelcast-ringbuffer-component.adoc index ebf50c5726357..b23acdc56690a 100644 --- a/docs/components/modules/ROOT/pages/hazelcast-ringbuffer-component.adoc +++ b/docs/components/modules/ROOT/pages/hazelcast-ringbuffer-component.adoc @@ -1,12 +1,16 @@ [[hazelcast-ringbuffer-component]] = Hazelcast Ringbuffer Component :page-source: components/camel-hazelcast/src/main/docs/hazelcast-ringbuffer-component.adoc +:docTitle: Hazelcast Ringbuffer +:artifactId: camel-hazelcast +:description: The hazelcast-ringbuffer component is used to access Hazelcast distributed ringbuffer. +:since: 2.16 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] ringbuffer component is one of Camel Hazelcast Components which allows you to access Hazelcast ringbuffer. Ringbuffer is a distributed data structure where the data is stored in a ring-like structure. You can think of it as a circular array with a certain capacity. diff --git a/docs/components/modules/ROOT/pages/hazelcast-seda-component.adoc b/docs/components/modules/ROOT/pages/hazelcast-seda-component.adoc index d825a9099b562..f480f99d2191f 100644 --- a/docs/components/modules/ROOT/pages/hazelcast-seda-component.adoc +++ b/docs/components/modules/ROOT/pages/hazelcast-seda-component.adoc @@ -1,12 +1,16 @@ [[hazelcast-seda-component]] = Hazelcast SEDA Component :page-source: components/camel-hazelcast/src/main/docs/hazelcast-seda-component.adoc +:docTitle: Hazelcast SEDA +:artifactId: camel-hazelcast +:description: The hazelcast-seda component is used to access Hazelcast BlockingQueue. +:since: 2.7 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] SEDA component is one of Camel Hazelcast Components which allows you to access Hazelcast BlockingQueue. SEDA component differs from the rest components provided. It implements a work-queue in order to support asynchronous SEDA architectures, similar to the core "SEDA" component. diff --git a/docs/components/modules/ROOT/pages/hazelcast-set-component.adoc b/docs/components/modules/ROOT/pages/hazelcast-set-component.adoc index 6c3a9114156f8..d954b3b8e9a34 100644 --- a/docs/components/modules/ROOT/pages/hazelcast-set-component.adoc +++ b/docs/components/modules/ROOT/pages/hazelcast-set-component.adoc @@ -1,12 +1,16 @@ [[hazelcast-set-component]] = Hazelcast Set Component :page-source: components/camel-hazelcast/src/main/docs/hazelcast-set-component.adoc +:docTitle: Hazelcast Set +:artifactId: camel-hazelcast +:description: The hazelcast-set component is used to access Hazelcast distributed set. +:since: 2.7 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] Set component is one of Camel Hazelcast Components which allows you to access Hazelcast distributed set. diff --git a/docs/components/modules/ROOT/pages/hazelcast.adoc b/docs/components/modules/ROOT/pages/hazelcast-summary.adoc similarity index 98% rename from docs/components/modules/ROOT/pages/hazelcast.adoc rename to docs/components/modules/ROOT/pages/hazelcast-summary.adoc index 5182d3ec5e1a3..b53ba2c7c2840 100644 --- a/docs/components/modules/ROOT/pages/hazelcast.adoc +++ b/docs/components/modules/ROOT/pages/hazelcast-summary.adoc @@ -1,7 +1,10 @@ = Hazelcast Component -:page-source: components/camel-hazelcast/src/main/docs/hazelcast.adoc +:page-source: components/camel-hazelcast/src/main/docs/hazelcast-summary.adoc +//attributes written by hand, not generated +:docTitle: Hazelcast +:since: 2.7 -*Since Camel 2.7* +*Since Camel {since}* The *hazelcast-* component allows you to work with the http://www.hazelcast.com[Hazelcast] distributed data grid / cache. @@ -31,7 +34,9 @@ for this component: == Hazelcast components -See followings for each component usage: + +See the following for each component usage: + * xref:hazelcast-map-component.adoc[map] * xref:hazelcast-multimap-component.adoc[multimap] * xref:hazelcast-queue-component.adoc[queue] diff --git a/docs/components/modules/ROOT/pages/hazelcast-topic-component.adoc b/docs/components/modules/ROOT/pages/hazelcast-topic-component.adoc index 1fe41913d3e5d..662c2dafcc2e0 100644 --- a/docs/components/modules/ROOT/pages/hazelcast-topic-component.adoc +++ b/docs/components/modules/ROOT/pages/hazelcast-topic-component.adoc @@ -1,12 +1,16 @@ [[hazelcast-topic-component]] = Hazelcast Topic Component :page-source: components/camel-hazelcast/src/main/docs/hazelcast-topic-component.adoc +:docTitle: Hazelcast Topic +:artifactId: camel-hazelcast +:description: The hazelcast-topic component is used to access Hazelcast distributed topic. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The http://www.hazelcast.com/[Hazelcast] Topic component is one of Camel Hazelcast Components which allows you to access Hazelcast distributed topic. diff --git a/docs/components/modules/ROOT/pages/hbase-component.adoc b/docs/components/modules/ROOT/pages/hbase-component.adoc index 2abd6cdab50c5..d9f472129c92b 100644 --- a/docs/components/modules/ROOT/pages/hbase-component.adoc +++ b/docs/components/modules/ROOT/pages/hbase-component.adoc @@ -1,12 +1,16 @@ [[hbase-component]] = HBase Component :page-source: components/camel-hbase/src/main/docs/hbase-component.adoc +:docTitle: HBase +:artifactId: camel-hbase +:description: For reading/writing from/to an HBase store (Hadoop database). +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component provides an idemptotent repository, producers and consumers for http://hbase.apache.org/[Apache HBase]. diff --git a/docs/components/modules/ROOT/pages/hdfs-component.adoc b/docs/components/modules/ROOT/pages/hdfs-component.adoc index 939eb35570e40..45efd1936accf 100644 --- a/docs/components/modules/ROOT/pages/hdfs-component.adoc +++ b/docs/components/modules/ROOT/pages/hdfs-component.adoc @@ -1,12 +1,16 @@ [[hdfs-component]] = HDFS Component :page-source: components/camel-hdfs/src/main/docs/hdfs-component.adoc +:docTitle: HDFS +:artifactId: camel-hdfs +:description: For reading/writing from/to an HDFS filesystem using Hadoop 2.x. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The HDFS component enables you to read and write messages from/to an HDFS file system using Hadoop 2.x. HDFS is the distributed file system diff --git a/docs/components/modules/ROOT/pages/hipchat-component.adoc b/docs/components/modules/ROOT/pages/hipchat-component.adoc index c2a4a545b6aa9..8007e0511048f 100644 --- a/docs/components/modules/ROOT/pages/hipchat-component.adoc +++ b/docs/components/modules/ROOT/pages/hipchat-component.adoc @@ -1,12 +1,16 @@ [[hipchat-component]] = Hipchat Component :page-source: components/camel-hipchat/src/main/docs/hipchat-component.adoc +:docTitle: Hipchat +:artifactId: camel-hipchat +:description: The hipchat component supports producing and consuming messages from/to Hipchat service. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Hipchat component supports producing and consuming messages from/to https://www.hipchat.com[Hipchat] service. diff --git a/docs/components/modules/ROOT/pages/http-component.adoc b/docs/components/modules/ROOT/pages/http-component.adoc index a7df943ab6088..3da11d01c525b 100644 --- a/docs/components/modules/ROOT/pages/http-component.adoc +++ b/docs/components/modules/ROOT/pages/http-component.adoc @@ -1,12 +1,16 @@ [[http-component]] = HTTP Component :page-source: components/camel-http/src/main/docs/http-component.adoc +:docTitle: HTTP +:artifactId: camel-http +:description: For calling out to external HTTP servers using Apache HTTP Client 4.x. +:since: 2.3 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.3* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The HTTP component provides HTTP based endpoints for calling external HTTP resources (as a client to call external diff --git a/docs/components/modules/ROOT/pages/iec60870-client-component.adoc b/docs/components/modules/ROOT/pages/iec60870-client-component.adoc index 930067838d6fc..046b43c96d84a 100644 --- a/docs/components/modules/ROOT/pages/iec60870-client-component.adoc +++ b/docs/components/modules/ROOT/pages/iec60870-client-component.adoc @@ -1,12 +1,16 @@ [[iec60870-client-component]] = IEC 60870 Client Component :page-source: components/camel-iec60870/src/main/docs/iec60870-client-component.adoc +:docTitle: IEC 60870 Client +:artifactId: camel-iec60870 +:description: IEC 60870 component used for telecontrol (supervisory control and data acquisition) such as controlling electric power transmission grids and other geographically widespread control systems. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The IEC 60870-5-104 Client component provides access to IEC 60870 servers using the http://eclipse.org/eclipsescada[Eclipse NeoSCADAâ„¢] implementation. diff --git a/docs/components/modules/ROOT/pages/iec60870-server-component.adoc b/docs/components/modules/ROOT/pages/iec60870-server-component.adoc index 82458b75c1ddc..c2c811f9b9d6b 100644 --- a/docs/components/modules/ROOT/pages/iec60870-server-component.adoc +++ b/docs/components/modules/ROOT/pages/iec60870-server-component.adoc @@ -1,12 +1,16 @@ [[iec60870-server-component]] = IEC 60870 Server Component :page-source: components/camel-iec60870/src/main/docs/iec60870-server-component.adoc +:docTitle: IEC 60870 Server +:artifactId: camel-iec60870 +:description: IEC 60870 component used for telecontrol (supervisory control and data acquisition) such as controlling electric power transmission grids and other geographically widespread control systems. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The *IEC 60870-5-104 Server* component provides access to IEC 60870 servers using the http://eclipse.org/eclipsescada[Eclipse NeoSCADAâ„¢] implementation. diff --git a/docs/components/modules/ROOT/pages/ignite-cache-component.adoc b/docs/components/modules/ROOT/pages/ignite-cache-component.adoc index 4de129158b0c6..e38ac11b87c23 100644 --- a/docs/components/modules/ROOT/pages/ignite-cache-component.adoc +++ b/docs/components/modules/ROOT/pages/ignite-cache-component.adoc @@ -1,12 +1,16 @@ [[ignite-cache-component]] = Ignite Cache Component :page-source: components/camel-ignite/src/main/docs/ignite-cache-component.adoc +:docTitle: Ignite Cache +:artifactId: camel-ignite +:description: The Ignite Cache endpoint is one of camel-ignite endpoints which allows you to interact with an Ignite Cache. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Ignite Cache endpoint is one of camel-ignite endpoints which allows you to interact with an https://apacheignite.readme.io/docs/data-grid[Ignite Cache]. This offers both a Producer (to invoke cache operations on an Ignite cache) and a Consumer (to consume changes from a continuous query). diff --git a/docs/components/modules/ROOT/pages/ignite-compute-component.adoc b/docs/components/modules/ROOT/pages/ignite-compute-component.adoc index 5dd406bd99e0e..9138317d76d73 100644 --- a/docs/components/modules/ROOT/pages/ignite-compute-component.adoc +++ b/docs/components/modules/ROOT/pages/ignite-compute-component.adoc @@ -1,12 +1,16 @@ [[ignite-compute-component]] = Ignite Compute Component :page-source: components/camel-ignite/src/main/docs/ignite-compute-component.adoc +:docTitle: Ignite Compute +:artifactId: camel-ignite +:description: The Ignite Compute endpoint is one of camel-ignite endpoints which allows you to run compute operations on the cluster by passing in an IgniteCallable, an IgniteRunnable, an IgniteClosure, or collections of them, along with their parameters if necessary. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Ignite Compute endpoint is one of camel-ignite endpoints which allows you to run https://apacheignite.readme.io/docs/compute-grid[compute operations] on the cluster by passing in an IgniteCallable, an IgniteRunnable, an IgniteClosure, or collections of them, along with their parameters if necessary. diff --git a/docs/components/modules/ROOT/pages/ignite-events-component.adoc b/docs/components/modules/ROOT/pages/ignite-events-component.adoc index 8031c4ec4b154..b7d6cbfc7fda4 100644 --- a/docs/components/modules/ROOT/pages/ignite-events-component.adoc +++ b/docs/components/modules/ROOT/pages/ignite-events-component.adoc @@ -1,12 +1,16 @@ [[ignite-events-component]] = Ignite Events Component :page-source: components/camel-ignite/src/main/docs/ignite-events-component.adoc +:docTitle: Ignite Events +:artifactId: camel-ignite +:description: The Ignite Events endpoint is one of camel-ignite endpoints which allows you to receive events from the Ignite cluster by creating a local event listener. +:since: 2.17 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Ignite Events endpoint is one of camel-ignite endpoints which allows you to https://apacheignite.readme.io/docs/events[receive events] from the Ignite cluster by creating a local event listener. diff --git a/docs/components/modules/ROOT/pages/ignite-idgen-component.adoc b/docs/components/modules/ROOT/pages/ignite-idgen-component.adoc index 797bb7333a882..8ae3bfceb0a5f 100644 --- a/docs/components/modules/ROOT/pages/ignite-idgen-component.adoc +++ b/docs/components/modules/ROOT/pages/ignite-idgen-component.adoc @@ -1,12 +1,16 @@ [[ignite-idgen-component]] = Ignite ID Generator Component :page-source: components/camel-ignite/src/main/docs/ignite-idgen-component.adoc +:docTitle: Ignite ID Generator +:artifactId: camel-ignite +:description: The Ignite ID Generator endpoint is one of camel-ignite endpoints which allows you to interact with Ignite Atomic Sequences and ID Generators. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Ignite ID Generator endpoint is one of camel-ignite endpoints which allows you to interact with https://apacheignite.readme.io/docs/id-generator[Ignite Atomic Sequences and ID Generators]. diff --git a/docs/components/modules/ROOT/pages/ignite-messaging-component.adoc b/docs/components/modules/ROOT/pages/ignite-messaging-component.adoc index f0e636e5ddd41..783e8be5280f5 100644 --- a/docs/components/modules/ROOT/pages/ignite-messaging-component.adoc +++ b/docs/components/modules/ROOT/pages/ignite-messaging-component.adoc @@ -1,12 +1,16 @@ [[ignite-messaging-component]] = Ignite Messaging Component :page-source: components/camel-ignite/src/main/docs/ignite-messaging-component.adoc +:docTitle: Ignite Messaging +:artifactId: camel-ignite +:description: The Ignite Messaging endpoint is one of camel-ignite endpoints which allows you to send and consume messages from an Ignite topic. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Ignite Messaging endpoint is one of camel-ignite endpoints which allows you to send and consume messages from an https://apacheignite.readme.io/docs/messaging[Ignite topic]. diff --git a/docs/components/modules/ROOT/pages/ignite-queue-component.adoc b/docs/components/modules/ROOT/pages/ignite-queue-component.adoc index f801bbcd0a28e..71900ee1ce3e2 100644 --- a/docs/components/modules/ROOT/pages/ignite-queue-component.adoc +++ b/docs/components/modules/ROOT/pages/ignite-queue-component.adoc @@ -1,12 +1,16 @@ [[ignite-queue-component]] = Ignite Queues Component :page-source: components/camel-ignite/src/main/docs/ignite-queue-component.adoc +:docTitle: Ignite Queues +:artifactId: camel-ignite +:description: The Ignite Queue endpoint is one of camel-ignite endpoints which allows you to interact with Ignite Queue data structures. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Ignite Queue endpoint is one of camel-ignite endpoints which allows you to interact with https://apacheignite.readme.io/docs/queue-and-set[Ignite Queue data structures]. diff --git a/docs/components/modules/ROOT/pages/ignite-set-component.adoc b/docs/components/modules/ROOT/pages/ignite-set-component.adoc index e8a1b2b24c47d..62c539290ab80 100644 --- a/docs/components/modules/ROOT/pages/ignite-set-component.adoc +++ b/docs/components/modules/ROOT/pages/ignite-set-component.adoc @@ -1,12 +1,16 @@ [[ignite-set-component]] = Ignite Sets Component :page-source: components/camel-ignite/src/main/docs/ignite-set-component.adoc +:docTitle: Ignite Sets +:artifactId: camel-ignite +:description: The Ignite Sets endpoint is one of camel-ignite endpoints which allows you to interact with Ignite Set data structures. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Ignite Sets endpoint is one of camel-ignite endpoints which allows you to interact with https://apacheignite.readme.io/docs/queue-and-set[Ignite Set data structures]. diff --git a/docs/components/modules/ROOT/pages/ignite.adoc b/docs/components/modules/ROOT/pages/ignite-summary.adoc similarity index 94% rename from docs/components/modules/ROOT/pages/ignite.adoc rename to docs/components/modules/ROOT/pages/ignite-summary.adoc index 22df121f1250b..ffee4b087f5a3 100644 --- a/docs/components/modules/ROOT/pages/ignite.adoc +++ b/docs/components/modules/ROOT/pages/ignite-summary.adoc @@ -1,7 +1,10 @@ = Ignite endpoints Component -:page-source: components/camel-ignite/src/main/docs/ignite.adoc +:page-source: components/camel-ignite/src/main/docs/ignite-summary.adoc +//attributes written by hand, not generated +:docTitle: Ignite +:since: 2.17 -*Since Camel 2.17* +*Since Camel {since}* https://ignite.apache.org/[Apache Ignite] In-Memory Data Fabric is a high-performance, integrated and distributed in-memory platform for computing and transacting on large-scale data sets in real-time, orders of magnitude faster than possible with traditional disk-based or flash technologies. It is designed to deliver uncompromised performance for a wide set of in-memory computing use cases from high performance computing, to the industry most advanced data grid, highly available service grid, and streaming. See all https://ignite.apache.org/features.html[features]. @@ -28,10 +31,7 @@ To use this component, add the following dependency to your pom.xml: ---- -[IMPORTANT,title=Running in OSGi] -=== -If running in an OSGi container, please don't miss the <> section below. -=== +IMPORTANT: If running in an OSGi container, please consult the <> section below. diff --git a/docs/components/modules/ROOT/pages/index.adoc b/docs/components/modules/ROOT/pages/index.adoc index 950a953d6e413..b8d3dc2e19c4e 100644 --- a/docs/components/modules/ROOT/pages/index.adoc +++ b/docs/components/modules/ROOT/pages/index.adoc @@ -1,761 +1,15 @@ [list-of-camel-components] = Components -:toc: -Component references are references used to place a component in an assembly. Apache Component references +Component references are references used to place a component in an assembly. Apache Component references provides various references that offers services for messaging, sending data, notifcations and various other services that can not only resolve easy messaging and transferring data but also provide securing of data. Below is the list of components that are provided by Apache Camel. -== List of Components - -// components: START -Number of Components: 330 in 263 JAR artifacts (1 deprecated) - -[width="100%",cols="4,1,5",options="header"] -|=== -| Component | Since | Description - -| xref:activemq-component.adoc[ActiveMQ] (camel-activemq) | 1.0 | The activemq component allows messages to be sent to (or consumed from) Apache ActiveMQ. This component extends the Camel JMS component. - -| xref:ahc-component.adoc[AHC] (camel-ahc) | 2.8 | To call external HTTP services using Async Http Client. - -| xref:ahc-ws-component.adoc[AHC Websocket] (camel-ahc-ws) | 2.14 | To exchange data with external Websocket servers using Async Http Client. - -| xref:amqp-component.adoc[AMQP] (camel-amqp) | 1.2 | Messaging with AMQP protocol using Apache QPid Client. - -| xref:apns-component.adoc[APNS] (camel-apns) | 2.8 | For sending notifications to Apple iOS devices. - -| xref:as2-component.adoc[AS2] (camel-as2) | 2.22 | Component used for transferring data secure and reliable over the internet using the AS2 protocol. - -| xref:asterisk-component.adoc[Asterisk] (camel-asterisk) | 2.18 | The asterisk component is used to interact with Asterisk PBX Server. - -| xref:atmos-component.adoc[Atmos] (camel-atmos) | 2.15 | The atmos component is used for integrating with EMC's Atomos Storage. - -| xref:atmosphere-websocket-component.adoc[Atmosphere Websocket] (camel-atmosphere-websocket) | 2.14 | To exchange data with external Websocket clients using Atmosphere. - -| xref:atom-component.adoc[Atom] (camel-atom) | 1.2 | The atom component is used for consuming Atom RSS feeds. - -| xref:atomix-map-component.adoc[Atomix Map] (camel-atomix) | 2.20 | The atomix-map component is used to access Atomix's distributed map. - -| xref:atomix-messaging-component.adoc[Atomix Messaging] (camel-atomix) | 2.20 | The atomix-messaging component is used to access Atomix's group messaging. - -| xref:atomix-multimap-component.adoc[Atomix MultiMap] (camel-atomix) | 2.20 | The atomix-multimap component is used to access Atomix's distributed multi map. - -| xref:atomix-queue-component.adoc[Atomix Queue] (camel-atomix) | 2.20 | The atomix-queue component is used to access Atomix's distributed queue. - -| xref:atomix-set-component.adoc[Atomix Set] (camel-atomix) | 2.20 | The atomix-set component is used to access Atomix's distributed set. - -| xref:atomix-value-component.adoc[Atomix Value] (camel-atomix) | 2.20 | The atomix-value component is used to access Atomix's distributed value. - -| xref:avro-component.adoc[Avro] (camel-avro-rpc) | 2.10 | Working with Apache Avro for data serialization. - -| xref:aws2-cw-component.adoc[AWS 2 CloudWatch] (camel-aws2-cw) | 3.1 | The aws2-cw component is used for sending metrics to an Amazon CloudWatch. - -| xref:aws2-ddb-component.adoc[AWS 2 DynamoDB] (camel-aws2-ddb) | 3.1 | The aws2-ddb component is used for storing and retrieving data from Amazon's DynamoDB service. - -| xref:aws2-ddbstream-component.adoc[AWS 2 DynamoDB Streams] (camel-aws2-ddb) | 3.1 | The aws2-ddbstream component is used for working with Amazon DynamoDB Streams. - -| xref:aws2-ec2-component.adoc[AWS 2 EC2] (camel-aws2-ec2) | 3.1 | The aws2-ec2 is used for managing Amazon EC2 instances. - -| xref:aws2-ecs-component.adoc[AWS 2 ECS] (camel-aws2-ecs) | 3.1 | The aws2-ecs is used for managing Amazon ECS - -| xref:aws2-eks-component.adoc[AWS 2 EKS] (camel-aws2-eks) | 3.1 | The aws2-eks is used for managing Amazon EKS - -| xref:aws2-iam-component.adoc[AWS 2 IAM] (camel-aws2-iam) | 3.1 | The aws2-iam is used for managing Amazon IAM - -| xref:aws2-kinesis-component.adoc[AWS 2 Kinesis] (camel-aws2-kinesis) | 3.2 | The aws2-kinesis component is for consuming and producing records from Amazon Kinesis Streams. - -| xref:aws2-kinesis-firehose-component.adoc[AWS 2 Kinesis Firehose] (camel-aws2-kinesis) | 3.2 | The aws2-kinesis-firehose component is used for producing Amazon's Kinesis Firehose streams. - -| xref:aws2-kms-component.adoc[AWS 2 KMS] (camel-aws2-kms) | 3.1 | The aws2-kms is used for managing Amazon KMS - -| xref:aws2-mq-component.adoc[AWS 2 MQ] (camel-aws2-mq) | 3.1 | The aws2-mq is used for managing Amazon MQ instances. - -| xref:aws2-msk-component.adoc[AWS 2 MSK] (camel-aws2-msk) | 3.1 | The aws2-msk is used for managing Amazon MSK - -| xref:aws2-ses-component.adoc[AWS 2 Simple Email Service] (camel-aws2-ses) | 3.1 | The aws2-ses component is used for sending emails with Amazon's SES service. - -| xref:aws2-sns-component.adoc[AWS 2 Simple Notification System] (camel-aws2-sns) | 3.1 | The aws2-sns component is used for sending messages to an Amazon Simple Notification Topic. - -| xref:aws2-sqs-component.adoc[AWS 2 Simple Queue Service] (camel-aws2-sqs) | 3.1 | The aws2-sqs component is used for sending and receiving messages to Amazon's SQS service. - -| xref:aws2-translate-component.adoc[AWS 2 Translate] (camel-aws2-translate) | 3.1 | The aws2-translate component is used for managing Amazon Translate - -| xref:aws-cw-component.adoc[AWS CloudWatch] (camel-aws-cw) | 2.11 | The aws-cw component is used for sending metrics to an Amazon CloudWatch. - -| xref:aws-ddb-component.adoc[AWS DynamoDB] (camel-aws-ddb) | 2.10 | The aws-ddb component is used for storing and retrieving data from Amazon's DynamoDB service. - -| xref:aws-ddbstream-component.adoc[AWS DynamoDB Streams] (camel-aws-ddb) | 2.17 | The aws-ddbstream component is used for working with Amazon DynamoDB Streams. - -| xref:aws-ec2-component.adoc[AWS EC2] (camel-aws-ec2) | 2.16 | The aws-ec2 is used for managing Amazon EC2 instances. - -| xref:aws-ecs-component.adoc[AWS ECS] (camel-aws-ecs) | 3.0 | The aws-ecs is used for managing Amazon ECS - -| xref:aws-eks-component.adoc[AWS EKS] (camel-aws-eks) | 3.0 | The aws-eks is used for managing Amazon EKS - -| xref:aws-iam-component.adoc[AWS IAM] (camel-aws-iam) | 2.23 | The aws-iam is used for managing Amazon IAM - -| xref:aws-kinesis-component.adoc[AWS Kinesis] (camel-aws-kinesis) | 2.17 | The aws-kinesis component is for consuming and producing records from Amazon Kinesis Streams. - -| xref:aws-kinesis-firehose-component.adoc[AWS Kinesis Firehose] (camel-aws-kinesis) | 2.19 | The aws-kinesis-firehose component is used for producing Amazon's Kinesis Firehose streams. - -| xref:aws-kms-component.adoc[AWS KMS] (camel-aws-kms) | 2.21 | The aws-kms is used for managing Amazon KMS - -| xref:aws-lambda-component.adoc[AWS Lambda] (camel-aws-lambda) | 2.20 | The aws-lambda is used for managing and invoking functions from Amazon Lambda. - -| xref:aws2-lambda-component.adoc[AWS Lambda] (camel-aws2-lambda) | 3.2 | The aws2-lambda is used for managing and invoking functions from Amazon Lambda. - -| xref:aws-mq-component.adoc[AWS MQ] (camel-aws-mq) | 2.21 | The aws-mq is used for managing Amazon MQ instances. - -| xref:aws-msk-component.adoc[AWS MSK] (camel-aws-msk) | 3.0 | The aws-msk is used for managing Amazon MSK - -| xref:aws-s3-component.adoc[AWS S3 Storage Service] (camel-aws-s3) | 2.8 | The aws-s3 component is used for storing and retrieving object from Amazon S3 Storage Service. - -| xref:aws-ses-component.adoc[AWS Simple Email Service] (camel-aws-ses) | 2.9 | The aws-ses component is used for sending emails with Amazon's SES service. - -| xref:aws-sns-component.adoc[AWS Simple Notification System] (camel-aws-sns) | 2.8 | The aws-sns component is used for sending messages to an Amazon Simple Notification Topic. - -| xref:aws-sqs-component.adoc[AWS Simple Queue Service] (camel-aws-sqs) | 2.6 | The aws-sqs component is used for sending and receiving messages to Amazon's SQS service. - -| xref:aws-swf-component.adoc[AWS Simple Workflow] (camel-aws-swf) | 2.13 | The aws-swf component is used for managing workflows from Amazon Simple Workflow. - -| xref:aws-sdb-component.adoc[AWS SimpleDB] (camel-aws-sdb) | 2.9 | The aws-sdb component is for storing and retrieving data from/to Amazon's SDB service. - -| xref:aws-translate-component.adoc[AWS Translate] (camel-aws-translate) | 3.0 | The aws-translate component is used for managing Amazon Translate - -| xref:aws2-s3-component.adoc[AWS2 S3 Storage Service] (camel-aws2-s3) | 3.2 | The aws2-s3 component is used for storing and retrieving object from Amazon S3 Storage Service. - -| xref:azure-blob-component.adoc[Azure Storage Blob Service] (camel-azure) | 2.19 | The azure-blob component is used for storing and retrieving blobs from Azure Storage Blob Service. - -| xref:azure-storage-blob-component.adoc[Azure Storage Blob Service] (camel-azure-storage-blob) | 3.3 | The azure-storage-blob component is used for storing and retrieving blobs from Azure Storage Blob Service using SDK v12. - -| xref:azure-queue-component.adoc[Azure Storage Queue Service] (camel-azure) | 2.19 | The azure-queue component is used for storing and retrieving messages from Azure Storage Queue Service. - -| xref:bean-component.adoc[Bean] (camel-bean) | 1.0 | The bean component is for invoking Java beans from Camel. - -| xref:bean-validator-component.adoc[Bean Validator] (camel-bean-validator) | 2.3 | The Validator component performs bean validation of the message body using the Java Bean Validation API. - -| xref:beanstalk-component.adoc[Beanstalk] (camel-beanstalk) | 2.15 | The beanstalk component is used for job retrieval and post-processing of Beanstalk jobs. - -| xref:bonita-component.adoc[Bonita] (camel-bonita) | 2.19 | Used for communicating with a remote Bonita BPM process engine. - -| xref:box-component.adoc[Box] (camel-box) | 2.14 | For uploading downloading and managing files folders groups collaborations etc on box DOT com. - -| xref:braintree-component.adoc[Braintree] (camel-braintree) | 2.17 | The braintree component is used for integrating with the Braintree Payment System. - -| xref:browse-component.adoc[Browse] (camel-browse) | 1.3 | The browse component is used for viewing the messages received on endpoints that supports BrowsableEndpoint. - -| xref:caffeine-cache-component.adoc[Caffeine Cache] (camel-caffeine) | 2.20 | The caffeine-cache component is used for integration with Caffeine Cache. - -| xref:caffeine-loadcache-component.adoc[Caffeine LoadCache] (camel-caffeine) | 2.20 | The caffeine-loadcache component is used for integration with Caffeine Load Cache. - -| xref:cql-component.adoc[Cassandra CQL] (camel-cassandraql) | 2.15 | The cql component aims at integrating Cassandra 2.0 using the CQL3 API (not the Thrift API). It's based on Cassandra Java Driver provided by DataStax. - -| xref:chatscript-component.adoc[ChatScript] (camel-chatscript) | 3.0 | Represents a ChatScript endpoint. - -| xref:chunk-component.adoc[Chunk] (camel-chunk) | 2.15 | Transforms the message using a Chunk template. - -| xref:class-component.adoc[Class] (camel-bean) | 2.4 | The Class component is for invoking Java classes (Java beans) from Camel. - -| xref:cm-sms-component.adoc[CM SMS Gateway] (camel-cm-sms) | 2.18 | The cm-sms component allows to integrate with CM SMS Gateway. - -| xref:cmis-component.adoc[CMIS] (camel-cmis) | 2.11 | The cmis component uses the Apache Chemistry client API and allows you to add/read nodes to/from a CMIS compliant content repositories. - -| xref:coap-component.adoc[CoAP] (camel-coap) | 2.16 | The coap component is used for sending and receiving messages from COAP capable devices. - -| xref:cometd-component.adoc[CometD] (camel-cometd) | 2.0 | The cometd component is a transport for working with the Jetty implementation of the cometd/bayeux protocol. - -| xref:consul-component.adoc[Consul] (camel-consul) | 2.18 | The camel consul component allows you to work with Consul, a distributed, highly available, datacenter-aware, service discovery and configuration system. - -| xref:controlbus-component.adoc[Control Bus] (camel-controlbus) | 2.11 | The controlbus component provides easy management of Camel applications based on the Control Bus EIP pattern. - -| xref:corda-component.adoc[Corda] (camel-corda) | 2.23 | The corda component uses corda-rpc to interact with corda nodes. - -| xref:couchbase-component.adoc[Couchbase] (camel-couchbase) | 2.19 | Represents a Couchbase endpoint that can query Views with a Poll strategy and/or produce various type of operations. - -| xref:couchdb-component.adoc[CouchDB] (camel-couchdb) | 2.11 | The couchdb component is used for integrate with CouchDB databases. - -| xref:cron-component.adoc[Cron] (camel-cron) | 3.1 | Camel Cron Component - -| xref:crypto-component.adoc[Crypto (JCE)] (camel-crypto) | 2.3 | The crypto component is used for signing and verifying exchanges using the Signature Service of the Java Cryptographic Extension (JCE). - -| xref:crypto-cms-component.adoc[Crypto CMS] (camel-crypto-cms) | 2.20 | *deprecated* The crypto cms component is used for encrypting data in CMS Enveloped Data format, decrypting CMS Enveloped Data, signing data in CMS Signed Data format, and verifying CMS Signed Data. - -| xref:cxf-component.adoc[CXF] (camel-cxf) | 1.0 | The cxf component is used for SOAP WebServices using Apache CXF. - -| xref:cxfrs-component.adoc[CXF-RS] (camel-cxf) | 2.0 | The cxfrs component is used for JAX-RS REST services using Apache CXF. - -| xref:dataformat-component.adoc[Data Format] (camel-dataformat) | 2.12 | The dataformat component is used for working with Data Formats as if it was a regular Component supporting Endpoints and URIs. - -| xref:dataset-component.adoc[Dataset] (camel-dataset) | 1.3 | The dataset component provides a mechanism to easily perform load & soak testing of your system. - -| xref:dataset-test-component.adoc[DataSet Test] (camel-dataset) | 1.3 | The dataset-test component extends the mock component by on startup to pull messages from another endpoint to set the expected message bodies. - -| xref:debezium-mongodb-component.adoc[Debezium MongoDB Connector] (camel-debezium-mongodb) | 3.0 | Represents a Debezium MongoDB endpoint which is used to capture changes in MongoDB database so that that applications can see those changes and respond to them. - -| xref:debezium-mysql-component.adoc[Debezium MySQL Connector] (camel-debezium-mysql) | 3.0 | Represents a Debezium MySQL endpoint which is used to capture changes in MySQL database so that that applications can see those changes and respond to them. - -| xref:debezium-postgres-component.adoc[Debezium PostgresSQL Connector] (camel-debezium-postgres) | 3.0 | Represents a Debezium PostgresSQL endpoint which is used to capture changes in PostgresSQL database so that that applications can see those changes and respond to them. - -| xref:debezium-sqlserver-component.adoc[Debezium SQL Server Connector] (camel-debezium-sqlserver) | 3.0 | Represents a Debezium SQL Server endpoint which is used to capture changes in SQL Server database so that that applications can see those changes and respond to them. - -| xref:djl-component.adoc[Deep Java Library] (camel-djl) | 3.3 | The Deep Java Library component is used to infer deep learning models. - -| xref:digitalocean-component.adoc[DigitalOcean] (camel-digitalocean) | 2.19 | The DigitalOcean component allows you to manage Droplets and resources within the DigitalOcean cloud. - -| xref:direct-component.adoc[Direct] (camel-direct) | 1.0 | The direct component provides direct, synchronous call to another endpoint from the same CamelContext. - -| xref:direct-vm-component.adoc[Direct VM] (camel-directvm) | 2.10 | The direct-vm component provides direct, synchronous call to another endpoint from any CamelContext in the same JVM. - -| xref:disruptor-component.adoc[Disruptor] (camel-disruptor) | 2.12 | The disruptor component provides asynchronous SEDA behavior using LMAX Disruptor. - -| xref:dns-component.adoc[DNS] (camel-dns) | 2.7 | To lookup domain information and run DNS queries using DNSJava. - -| xref:docker-component.adoc[Docker] (camel-docker) | 2.15 | The docker component is used for managing Docker containers. - -| xref:dozer-component.adoc[Dozer] (camel-dozer) | 2.15 | The dozer component provides the ability to map between Java beans using the Dozer mapping library. - -| xref:drill-component.adoc[Drill] (camel-drill) | 2.19 | The drill component gives you the ability to quering into apache drill cluster. - -| xref:dropbox-component.adoc[Dropbox] (camel-dropbox) | 2.14 | For uploading, downloading and managing files, folders, groups, collaborations, etc on dropbox DOT com. - -| xref:ehcache-component.adoc[Ehcache] (camel-ehcache) | 2.18 | The ehcache component enables you to perform caching operations using Ehcache as cache implementation. - -| xref:elasticsearch-rest-component.adoc[Elastichsearch Rest] (camel-elasticsearch-rest) | 2.21 | The elasticsearch component is used for interfacing with ElasticSearch server using REST API. - -| xref:elsql-component.adoc[ElSQL] (camel-elsql) | 2.16 | The elsql component is an extension to the existing SQL Component that uses ElSql to define the SQL queries. - -| xref:etcd-keys-component.adoc[Etcd Keys] (camel-etcd) | 2.18 | Camel Etcd support - -| xref:etcd-stats-component.adoc[Etcd Stats] (camel-etcd) | 2.18 | The camel etcd component allows you to work with Etcd, a distributed reliable key-value store. - -| xref:etcd-watch-component.adoc[Etcd Watch] (camel-etcd) | 2.18 | The camel etcd component allows you to work with Etcd, a distributed reliable key-value store. - -| xref:exec-component.adoc[Exec] (camel-exec) | 2.3 | The exec component can be used to execute OS system commands. - -| xref:facebook-component.adoc[Facebook] (camel-facebook) | 2.14 | The Facebook component provides access to all of the Facebook APIs accessible using Facebook4J. - -| xref:fhir-component.adoc[FHIR] (camel-fhir) | 2.23 | The fhir component is used for working with the FHIR protocol (health care). - -| xref:file-component.adoc[File] (camel-file) | 1.0 | The file component is used for reading or writing files. - -| xref:file-watch-component.adoc[File Watch] (camel-file-watch) | 3.0 | The file-watch is used to monitor file events in directory using java.nio.file.WatchService - -| xref:flatpack-component.adoc[Flatpack] (camel-flatpack) | 1.4 | The flatpack component supports fixed width and delimited file parsing via the FlatPack library. - -| xref:flink-component.adoc[Flink] (camel-flink) | 2.18 | The flink component can be used to send DataSet jobs to Apache Flink cluster. - -| xref:fop-component.adoc[FOP] (camel-fop) | 2.10 | The fop component allows you to render a message into different output formats using Apache FOP. - -| xref:freemarker-component.adoc[Freemarker] (camel-freemarker) | 2.10 | Transforms the message using a FreeMarker template. - -| xref:ftp-component.adoc[FTP] (camel-ftp) | 1.1 | The \ftp component is used for uploading or downloading files from FTP servers. - -| xref:ftps-component.adoc[FTPS] (camel-ftp) | 2.2 | The \ftps (FTP secure SSL/TLS) component is used for uploading or downloading files from FTP servers. - -| xref:ganglia-component.adoc[Ganglia] (camel-ganglia) | 2.15 | The ganglia component is used for sending metrics to the Ganglia monitoring system. - -| xref:geocoder-component.adoc[Geocoder] (camel-geocoder) | 2.12 | The geocoder component is used for looking up geocodes (latitude and longitude) for a given address, or reverse lookup. - -| xref:git-component.adoc[Git] (camel-git) | 2.16 | The git component is used for working with git repositories. - -| xref:github-component.adoc[GitHub] (camel-github) | 2.15 | The github component is used for integrating Camel with github. - -| xref:google-bigquery-component.adoc[Google BigQuery] (camel-google-bigquery) | 2.20 | Google BigQuery data warehouse for analytics. - -| xref:google-bigquery-sql-component.adoc[Google BigQuery Standard SQL] (camel-google-bigquery) | 2.23 | Google BigQuery data warehouse for analytics (using SQL queries). - -| xref:google-calendar-component.adoc[Google Calendar] (camel-google-calendar) | 2.15 | The google-calendar component provides access to Google Calendar. - -| xref:google-calendar-stream-component.adoc[Google Calendar Stream] (camel-google-calendar) | 2.23 | The google-calendar-stream component provides access to Google Calendar in a streaming mode. - -| xref:google-drive-component.adoc[Google Drive] (camel-google-drive) | 2.14 | The google-drive component provides access to Google Drive file storage service. - -| xref:google-mail-component.adoc[Google Mail] (camel-google-mail) | 2.15 | The google-mail component provides access to Google Mail. - -| xref:google-mail-stream-component.adoc[Google Mail Stream] (camel-google-mail) | 2.22 | The google-mail component provides access to Google Mail. - -| xref:google-pubsub-component.adoc[Google Pubsub] (camel-google-pubsub) | 2.19 | Messaging client for Google Cloud Platform PubSub Service Built on top of the Google Cloud Pub/Sub libraries. - -| xref:google-sheets-component.adoc[Google Sheets] (camel-google-sheets) | 2.23 | The google-sheets component provides access to Google Sheets. - -| xref:google-sheets-stream-component.adoc[Google Sheets Stream] (camel-google-sheets) | 2.23 | The google-sheets-stream component provides access to Google Sheets. - -| xref:gora-component.adoc[Gora] (camel-gora) | 2.14 | The gora component allows you to work with NoSQL databases using the Apache Gora framework. - -| xref:grape-component.adoc[Grape] (camel-grape) | 2.16 | The grape component allows you to fetch, load and manage additional jars when CamelContext is running. - -| xref:graphql-component.adoc[GraphQL] (camel-graphql) | 3.0 | A Camel GraphQL Component - -| xref:grpc-component.adoc[gRPC] (camel-grpc) | 2.19 | The gRPC component allows to call and expose remote procedures via HTTP/2 with protobuf dataformat - -| xref:guava-eventbus-component.adoc[Guava EventBus] (camel-guava-eventbus) | 2.10 | The guava-eventbus component provides integration bridge between Camel and Google Guava EventBus. - -| xref:hazelcast-atomicvalue-component.adoc[Hazelcast Atomic Number] (camel-hazelcast) | 2.7 | The hazelcast-atomicvalue component is used to access Hazelcast atomic number, which is an object that simply provides a grid wide number (long). - -| xref:hazelcast-instance-component.adoc[Hazelcast Instance] (camel-hazelcast) | 2.7 | The hazelcast-instance component is used to consume join/leave events of the cache instance in the cluster. - -| xref:hazelcast-list-component.adoc[Hazelcast List] (camel-hazelcast) | 2.7 | The hazelcast-list component is used to access Hazelcast distributed list. - -| xref:hazelcast-map-component.adoc[Hazelcast Map] (camel-hazelcast) | 2.7 | The hazelcast-map component is used to access Hazelcast distributed map. - -| xref:hazelcast-multimap-component.adoc[Hazelcast Multimap] (camel-hazelcast) | 2.7 | The hazelcast-multimap component is used to to access Hazelcast distributed multimap. - -| xref:hazelcast-queue-component.adoc[Hazelcast Queue] (camel-hazelcast) | 2.7 | The hazelcast-queue component is used to access Hazelcast distributed queue. - -| xref:hazelcast-replicatedmap-component.adoc[Hazelcast Replicated Map] (camel-hazelcast) | 2.16 | The hazelcast-replicatedmap component is used to access Hazelcast replicated map. - -| xref:hazelcast-ringbuffer-component.adoc[Hazelcast Ringbuffer] (camel-hazelcast) | 2.16 | The hazelcast-ringbuffer component is used to access Hazelcast distributed ringbuffer. - -| xref:hazelcast-seda-component.adoc[Hazelcast SEDA] (camel-hazelcast) | 2.7 | The hazelcast-seda component is used to access Hazelcast BlockingQueue. - -| xref:hazelcast-set-component.adoc[Hazelcast Set] (camel-hazelcast) | 2.7 | The hazelcast-set component is used to access Hazelcast distributed set. - -| xref:hazelcast-topic-component.adoc[Hazelcast Topic] (camel-hazelcast) | 2.15 | The hazelcast-topic component is used to access Hazelcast distributed topic. - -| xref:hbase-component.adoc[HBase] (camel-hbase) | 2.10 | For reading/writing from/to an HBase store (Hadoop database). - -| xref:hdfs-component.adoc[HDFS] (camel-hdfs) | 2.14 | For reading/writing from/to an HDFS filesystem using Hadoop 2.x. - -| xref:hipchat-component.adoc[Hipchat] (camel-hipchat) | 2.15 | The hipchat component supports producing and consuming messages from/to Hipchat service. - -| xref:http-component.adoc[HTTP] (camel-http) | 2.3 | For calling out to external HTTP servers using Apache HTTP Client 4.x. - -| xref:iec60870-client-component.adoc[IEC 60870 Client] (camel-iec60870) | 2.20 | IEC 60870 component used for telecontrol (supervisory control and data acquisition) such as controlling electric power transmission grids and other geographically widespread control systems. - -| xref:iec60870-server-component.adoc[IEC 60870 Server] (camel-iec60870) | 2.20 | IEC 60870 component used for telecontrol (supervisory control and data acquisition) such as controlling electric power transmission grids and other geographically widespread control systems. - -| xref:ignite-cache-component.adoc[Ignite Cache] (camel-ignite) | 2.17 | The Ignite Cache endpoint is one of camel-ignite endpoints which allows you to interact with an Ignite Cache. - -| xref:ignite-compute-component.adoc[Ignite Compute] (camel-ignite) | 2.17 | The Ignite Compute endpoint is one of camel-ignite endpoints which allows you to run compute operations on the cluster by passing in an IgniteCallable, an IgniteRunnable, an IgniteClosure, or collections of them, along with their parameters if necessary. - -| xref:ignite-events-component.adoc[Ignite Events] (camel-ignite) | 2.17 | The Ignite Events endpoint is one of camel-ignite endpoints which allows you to receive events from the Ignite cluster by creating a local event listener. - -| xref:ignite-idgen-component.adoc[Ignite ID Generator] (camel-ignite) | 2.17 | The Ignite ID Generator endpoint is one of camel-ignite endpoints which allows you to interact with Ignite Atomic Sequences and ID Generators. - -| xref:ignite-messaging-component.adoc[Ignite Messaging] (camel-ignite) | 2.17 | The Ignite Messaging endpoint is one of camel-ignite endpoints which allows you to send and consume messages from an Ignite topic. - -| xref:ignite-queue-component.adoc[Ignite Queues] (camel-ignite) | 2.17 | The Ignite Queue endpoint is one of camel-ignite endpoints which allows you to interact with Ignite Queue data structures. - -| xref:ignite-set-component.adoc[Ignite Sets] (camel-ignite) | 2.17 | The Ignite Sets endpoint is one of camel-ignite endpoints which allows you to interact with Ignite Set data structures. - -| xref:infinispan-component.adoc[Infinispan] (camel-infinispan) | 2.13 | For reading/writing from/to Infinispan distributed key/value store and data grid. - -| xref:influxdb-component.adoc[InfluxDB] (camel-influxdb) | 2.18 | The influxdb component allows you to interact with InfluxDB, a time series database. - -| xref:iota-component.adoc[IOTA] (camel-iota) | 2.23 | Component for integrate IOTA DLT - -| xref:ipfs-component.adoc[IPFS] (camel-ipfs) | 2.23 | The camel-ipfs component provides access to the Interplanetary File System (IPFS). - -| xref:irc-component.adoc[IRC] (camel-irc) | 1.1 | The irc component implements an IRC (Internet Relay Chat) transport. - -| xref:ironmq-component.adoc[IronMQ] (camel-ironmq) | 2.17 | The ironmq provides integration with IronMQ an elastic and durable hosted message queue as a service. - -| xref:websocket-jsr356-component.adoc[Javax Websocket] (camel-websocket-jsr356) | 2.23 | Camel WebSocket using JSR356 (javax) - -| xref:jbpm-component.adoc[JBPM] (camel-jbpm) | 2.6 | The jbpm component provides integration with jBPM (Business Process Management). - -| xref:jcache-component.adoc[JCache] (camel-jcache) | 2.17 | The jcache component enables you to perform caching operations using JSR107/JCache as cache implementation. - -| xref:jclouds-component.adoc[JClouds] (camel-jclouds) | 2.9 | For interacting with cloud compute & blobstore service via jclouds. - -| xref:jcr-component.adoc[JCR] (camel-jcr) | 1.3 | The jcr component allows you to add/read nodes to/from a JCR compliant content repository. - -| xref:jdbc-component.adoc[JDBC] (camel-jdbc) | 1.2 | The jdbc component enables you to access databases through JDBC, where SQL queries are sent in the message body. - -| xref:jetty-component.adoc[Jetty] (camel-jetty) | 1.2 | To use Jetty as a HTTP server as consumer for Camel routes. - -| xref:websocket-component.adoc[Jetty Websocket] (camel-websocket) | 2.10 | The websocket component provides websocket endpoints with Jetty for communicating with clients using websocket. - -| xref:jgroups-component.adoc[JGroups] (camel-jgroups) | 2.13 | The jgroups component provides exchange of messages between Camel and JGroups clusters. - -| xref:jgroups-raft-component.adoc[JGroups raft] (camel-jgroups-raft) | 2.24 | The jgroups component provides exchange of messages between Camel and JGroups clusters. - -| xref:jing-component.adoc[Jing] (camel-jing) | 1.1 | Validates the payload of a message using RelaxNG Syntax using Jing library. - -| xref:jira-component.adoc[Jira] (camel-jira) | 3.0 | The jira component interacts with the JIRA issue tracker. - -| xref:jms-component.adoc[JMS] (camel-jms) | 1.0 | The jms component allows messages to be sent to (or consumed from) a JMS Queue or Topic. - -| xref:jmx-component.adoc[JMX] (camel-jmx) | 2.6 | The jmx component allows to receive JMX notifications. - -| xref:jolt-component.adoc[JOLT] (camel-jolt) | 2.16 | The jolt component allows you to process a JSON messages using an JOLT specification (such as JSON-JSON transformation). - -| xref:jooq-component.adoc[JOOQ] (camel-jooq) | 3.0 | The jooq component enables you to store and retrieve entities from databases using JOOQ - -| xref:jpa-component.adoc[JPA] (camel-jpa) | 1.0 | The jpa component enables you to store and retrieve Java objects from databases using JPA. - -| xref:jslt-component.adoc[JSLT] (camel-jslt) | 3.1 | The jslt component allows you to process a JSON messages using an JSLT transformations. - -| xref:json-validator-component.adoc[JSON Schema Validator] (camel-json-validator) | 2.20 | Validates the payload of a message using NetworkNT JSON Schema library. - -| xref:jt400-component.adoc[JT400] (camel-jt400) | 1.5 | The jt400 component allows you to exchanges messages with an AS/400 system using data queues or program call. - -| xref:kafka-component.adoc[Kafka] (camel-kafka) | 2.13 | The kafka component allows messages to be sent to (or consumed from) Apache Kafka brokers. - -| xref:kubernetes-config-maps-component.adoc[Kubernetes ConfigMap] (camel-kubernetes) | 2.17 | The Kubernetes Configmaps component provides a producer to execute kubernetes configmap operations. - -| xref:kubernetes-deployments-component.adoc[Kubernetes Deployments] (camel-kubernetes) | 2.20 | The Kubernetes Nodes component provides a producer to execute kubernetes node operations and a consumer to consume node events. - -| xref:kubernetes-hpa-component.adoc[Kubernetes HPA] (camel-kubernetes) | 2.23 | The Kubernetes HPA component provides a producer to execute kubernetes hpa operations and a consumer to consume HPA events. - -| xref:kubernetes-job-component.adoc[Kubernetes Job] (camel-kubernetes) | 2.23 | The Kubernetes Jobs component provides a producer to execute kubernetes job operations - -| xref:kubernetes-namespaces-component.adoc[Kubernetes Namespaces] (camel-kubernetes) | 2.17 | The Kubernetes Namespaces component provides a producer to execute kubernetes namespace operations and a consumer to consume namespace events. - -| xref:kubernetes-nodes-component.adoc[Kubernetes Nodes] (camel-kubernetes) | 2.17 | The Kubernetes Nodes component provides a producer to execute kubernetes node operations and a consumer to consume node events. - -| xref:kubernetes-persistent-volumes-component.adoc[Kubernetes Persistent Volume] (camel-kubernetes) | 2.17 | The Kubernetes Persistent Volumes component provides a producer to execute kubernetes persistent volume operations. - -| xref:kubernetes-persistent-volumes-claims-component.adoc[Kubernetes Persistent Volume Claim] (camel-kubernetes) | 2.17 | The Kubernetes Persistent Volumes Claims component provides a producer to execute kubernetes persistent volume claim operations. - -| xref:kubernetes-pods-component.adoc[Kubernetes Pods] (camel-kubernetes) | 2.17 | The Kubernetes Pods component provides a producer to execute kubernetes pod operations and a consumer to consume pod events. - -| xref:kubernetes-replication-controllers-component.adoc[Kubernetes Replication Controller] (camel-kubernetes) | 2.17 | The Kubernetes Replication Controllers component provides a producer to execute kubernetes replication controller operations and a consumer to consume replication controller events. - -| xref:kubernetes-resources-quota-component.adoc[Kubernetes Resources Quota] (camel-kubernetes) | 2.17 | The Kubernetes Resources Quota component provides a producer to execute kubernetes resources quota operations. - -| xref:kubernetes-secrets-component.adoc[Kubernetes Secrets] (camel-kubernetes) | 2.17 | The Kubernetes Secrets component provides a producer to execute kubernetes secret operations. - -| xref:kubernetes-service-accounts-component.adoc[Kubernetes Service Account] (camel-kubernetes) | 2.17 | The Kubernetes Service Accounts component provides a producer to execute service account operations. - -| xref:kubernetes-services-component.adoc[Kubernetes Services] (camel-kubernetes) | 2.17 | The Kubernetes Services component provides a producer to execute service operations and a consumer to consume service events. - -| xref:kudu-component.adoc[Kudu] (camel-kudu) | 3.0 | Represents a Kudu endpoint. A kudu endpoint allows you to interact with Apache Kudu, a free and open source column-oriented data store of the Apache Hadoop ecosystem. - -| xref:language-component.adoc[Language] (camel-language) | 2.5 | The language component allows you to send a message to an endpoint which executes a script by any of the supported Languages in Camel. - -| xref:ldap-component.adoc[LDAP] (camel-ldap) | 1.5 | The ldap component allows you to perform searches in LDAP servers using filters as the message payload. - -| xref:ldif-component.adoc[LDIF] (camel-ldif) | 2.20 | The ldif component allows you to do updates on an LDAP server from a LDIF body content. - -| xref:log-component.adoc[Log] (camel-log) | 1.1 | The log component logs message exchanges to the underlying logging mechanism. - -| xref:lucene-component.adoc[Lucene] (camel-lucene) | 2.2 | To insert or query from Apache Lucene databases. - -| xref:lumberjack-component.adoc[Lumberjack] (camel-lumberjack) | 2.18 | The lumberjack retrieves logs sent over the network using the Lumberjack protocol. - -| xref:mail-component.adoc[Mail] (camel-mail) | 1.0 | To send or receive emails using imap/pop3 or smtp protocols. - -| xref:master-component.adoc[Master] (camel-master) | 2.20 | Represents an endpoint which only becomes active when the CamelClusterView has the leadership. - -| xref:metrics-component.adoc[Metrics] (camel-metrics) | 2.14 | To collect various metrics directly from Camel routes using the DropWizard metrics library. - -| xref:micrometer-component.adoc[Micrometer] (camel-micrometer) | 2.22 | To collect various metrics directly from Camel routes using the Micrometer library. - -| xref:microprofile-metrics-component.adoc[MicroProfile Metrics] (camel-microprofile-metrics) | 3.0 | Camel metrics exposed with Eclipse MicroProfile Metrics - -| xref:mina-component.adoc[Mina] (camel-mina) | 2.10 | Socket level networking using TCP or UDP with the Apache Mina 2.x library. - -| xref:mllp-component.adoc[MLLP] (camel-mllp) | 2.17 | Provides functionality required by Healthcare providers to communicate with other systems using the MLLP protocol. - -| xref:mock-component.adoc[Mock] (camel-mock) | 1.0 | The mock component is used for testing routes and mediation rules using mocks. - -| xref:mongodb-component.adoc[MongoDB] (camel-mongodb) | 2.19 | Component for working with documents stored in MongoDB database. - -| xref:mongodb-gridfs-component.adoc[MongoDB GridFS] (camel-mongodb-gridfs) | 2.18 | Component for working with MongoDB GridFS. - -| xref:msv-component.adoc[MSV] (camel-msv) | 1.1 | Validates the payload of a message using the MSV Library. - -| xref:mustache-component.adoc[Mustache] (camel-mustache) | 2.12 | Transforms the message using a Mustache template. - -| xref:mvel-component.adoc[MVEL] (camel-mvel) | 2.12 | Transforms the message using a MVEL template. - -| xref:mybatis-component.adoc[MyBatis] (camel-mybatis) | 2.7 | Performs a query, poll, insert, update or delete in a relational database using MyBatis. - -| xref:mybatis-bean-component.adoc[MyBatis Bean] (camel-mybatis) | 2.22 | Performs a query, insert, update or delete in a relational database using MyBatis. - -| xref:nagios-component.adoc[Nagios] (camel-nagios) | 2.3 | To send passive checks to Nagios using JSendNSCA. - -| xref:nats-component.adoc[Nats] (camel-nats) | 2.17 | The nats component allows you produce and consume messages from NATS. - -| xref:netty-component.adoc[Netty] (camel-netty) | 2.14 | Socket level networking using TCP or UDP with the Netty 4.x library. - -| xref:netty-http-component.adoc[Netty HTTP] (camel-netty-http) | 2.14 | Netty HTTP server and client using the Netty 4.x library. - -| xref:nitrite-component.adoc[Nitrite] (camel-nitrite) | 3.0 | Used for integrating Camel with Nitrite databases. - -| xref:nsq-component.adoc[NSQ] (camel-nsq) | 2.23 | Represents a nsq endpoint. - -| xref:olingo2-component.adoc[Olingo2] (camel-olingo2) | 2.14 | Communicates with OData 2.0 services using Apache Olingo. - -| xref:olingo4-component.adoc[Olingo4] (camel-olingo4) | 2.19 | Communicates with OData 4.0 services using Apache Olingo OData API. - -| xref:milo-client-component.adoc[OPC UA Client] (camel-milo) | 2.19 | Connect to OPC UA servers using the binary protocol for acquiring telemetry data - -| xref:milo-server-component.adoc[OPC UA Server] (camel-milo) | 2.19 | Make telemetry data available as an OPC UA server - -| xref:openshift-build-configs-component.adoc[Openshift Build Config] (camel-kubernetes) | 2.17 | The Kubernetes Build Config component provides a producer to execute kubernetes build config operations. - -| xref:openshift-builds-component.adoc[Openshift Builds] (camel-kubernetes) | 2.17 | The Openshift Builds component provides a producer to execute openshift build operations. - -| xref:openstack-cinder-component.adoc[OpenStack Cinder] (camel-openstack) | 2.19 | The openstack-cinder component allows messages to be sent to an OpenStack block storage services. - -| xref:openstack-glance-component.adoc[OpenStack Glance] (camel-openstack) | 2.19 | The openstack-glance component allows messages to be sent to an OpenStack image services. - -| xref:openstack-keystone-component.adoc[OpenStack Keystone] (camel-openstack) | 2.19 | The openstack-keystone component allows messages to be sent to an OpenStack identity services. - -| xref:openstack-neutron-component.adoc[OpenStack Neutron] (camel-openstack) | 2.19 | The openstack-neutron component allows messages to be sent to an OpenStack network services. - -| xref:openstack-nova-component.adoc[OpenStack Nova] (camel-openstack) | 2.19 | The openstack-nova component allows messages to be sent to an OpenStack compute services. - -| xref:openstack-swift-component.adoc[OpenStack Swift] (camel-openstack) | 2.19 | The openstack-swift component allows messages to be sent to an OpenStack object storage services. - -| xref:optaplanner-component.adoc[OptaPlanner] (camel-optaplanner) | 2.13 | Solves the planning problem contained in a message with OptaPlanner. - -| xref:paho-component.adoc[Paho] (camel-paho) | 2.16 | Component for communicating with MQTT message brokers using Eclipse Paho MQTT Client. - -| xref:pdf-component.adoc[PDF] (camel-pdf) | 2.16 | The pdf components provides the ability to create, modify or extract content from PDF documents. - -| xref:platform-http-component.adoc[Platform HTTP] (camel-platform-http) | 3.0 | HTTP service leveraging existing runtime platform HTTP server - -| xref:pgevent-component.adoc[PostgresSQL Event] (camel-pgevent) | 2.15 | The pgevent component allows for producing/consuming PostgreSQL events related to the listen/notify commands. - -| xref:pg-replication-slot-component.adoc[PostgresSQL Replication Slot] (camel-pg-replication-slot) | 3.0 | Consumer endpoint to receive from PostgreSQL Replication Slot. - -| xref:lpr-component.adoc[Printer] (camel-printer) | 2.1 | The printer component is used for sending messages to printers as print jobs. - -| xref:pubnub-component.adoc[PubNub] (camel-pubnub) | 2.19 | To send and receive messages to PubNub data stream network for connected devices. - -| xref:pulsar-component.adoc[Pulsar] (camel-pulsar) | 2.24 | Camel Apache Pulsar Component - -| xref:quartz-component.adoc[Quartz] (camel-quartz) | 2.12 | Provides a scheduled delivery of messages using the Quartz 2.x scheduler. - -| xref:quickfix-component.adoc[QuickFix] (camel-quickfix) | 2.1 | The quickfix component allows to send Financial Interchange (FIX) messages to the QuickFix engine. - -| xref:rabbitmq-component.adoc[RabbitMQ] (camel-rabbitmq) | 2.12 | The rabbitmq component allows you produce and consume messages from RabbitMQ instances. - -| xref:reactive-streams-component.adoc[Reactive Streams] (camel-reactive-streams) | 2.19 | Reactive Camel using reactive streams - -| xref:ref-component.adoc[Ref] (camel-ref) | 1.2 | The ref component is used for lookup of existing endpoints bound in the Registry. - -| xref:rest-component.adoc[REST] (camel-rest) | 2.14 | The rest component is used for either hosting REST services (consumer) or calling external REST services (producer). - -| xref:rest-api-component.adoc[REST API] (camel-rest) | 2.16 | The rest-api component is used for providing Swagger API of the REST services which has been defined using the rest-dsl in Camel. - -| xref:rest-openapi-component.adoc[REST OpenApi] (camel-rest-openapi) | 3.1 | An awesome REST endpoint backed by OpenApi specifications. - -| xref:rest-swagger-component.adoc[REST Swagger] (camel-rest-swagger) | 2.19 | An awesome REST endpoint backed by Swagger specifications. - -| xref:robotframework-component.adoc[Robot Framework] (camel-robotframework) | 3.0 | Represents a RobotFramework endpoint. - -| xref:rss-component.adoc[RSS] (camel-rss) | 2.0 | The rss component is used for consuming RSS feeds. - -| xref:saga-component.adoc[Saga] (camel-saga) | 2.21 | The saga component provides access to advanced options for managing the flow in the Saga EIP. - -| xref:salesforce-component.adoc[Salesforce] (camel-salesforce) | 2.12 | The salesforce component is used for integrating Camel with the massive Salesforce API. - -| xref:sap-netweaver-component.adoc[SAP NetWeaver] (camel-sap-netweaver) | 2.12 | The sap-netweaver component integrates with the SAP NetWeaver Gateway using HTTP transports. - -| xref:scheduler-component.adoc[Scheduler] (camel-scheduler) | 2.15 | The scheduler component is used for generating message exchanges when a scheduler fires. - -| xref:schematron-component.adoc[Schematron] (camel-schematron) | 2.15 | Validates the payload of a message using the Schematron Library. - -| xref:scp-component.adoc[SCP] (camel-jsch) | 2.10 | To copy files using the secure copy protocol (SCP). - -| xref:seda-component.adoc[SEDA] (camel-seda) | 1.1 | The seda component provides asynchronous call to another endpoint from any CamelContext in the same JVM. - -| xref:service-component.adoc[Service] (camel-service) | 2.22 | Represents an endpoint which is registered to a Service Registry such as Consul, Etcd. - -| xref:servicenow-component.adoc[ServiceNow] (camel-servicenow) | 2.18 | The servicenow component is used to integrate Camel with ServiceNow cloud services. - -| xref:servlet-component.adoc[Servlet] (camel-servlet) | 2.0 | To use a HTTP Servlet as entry for Camel routes when running in a servlet container. - -| xref:sftp-component.adoc[SFTP] (camel-ftp) | 1.1 | The \sftp (FTP over SSH) component is used for uploading or downloading files from SFTP servers. - -| xref:sjms-component.adoc[Simple JMS] (camel-sjms) | 2.11 | The sjms component (simple jms) allows messages to be sent to (or consumed from) a JMS Queue or Topic (uses JMS 1.x API). - -| xref:sjms-batch-component.adoc[Simple JMS Batch] (camel-sjms) | 2.16 | The sjms-batch component is a specialized for highly performant, transactional batch consumption from a JMS queue. - -| xref:sjms2-component.adoc[Simple JMS2] (camel-sjms2) | 2.19 | The sjms2 component (simple jms) allows messages to be sent to (or consumed from) a JMS Queue or Topic (uses JMS 2.x API). - -| xref:sip-component.adoc[SIP] (camel-sip) | 2.5 | To send and receive messages using the SIP protocol (used in telco and mobile). - -| xref:slack-component.adoc[Slack] (camel-slack) | 2.16 | The slack component allows you to send messages to Slack. - -| xref:smpp-component.adoc[SMPP] (camel-smpp) | 2.2 | To send and receive SMS using a SMSC (Short Message Service Center). - -| xref:snmp-component.adoc[SNMP] (camel-snmp) | 2.1 | The snmp component gives you the ability to poll SNMP capable devices or receiving traps. - -| xref:solr-component.adoc[Solr] (camel-solr) | 2.9 | The solr component allows you to interface with an Apache Lucene Solr server. - -| xref:soroush-component.adoc[Soroush] (camel-soroush) | 3.0 | To integrate with the Soroush chat bot. - -| xref:spark-component.adoc[Spark] (camel-spark) | 2.17 | The spark component can be used to send RDD or DataFrame jobs to Apache Spark cluster. - -| xref:splunk-component.adoc[Splunk] (camel-splunk) | 2.13 | The splunk component allows to publish or search for events in Splunk. - -| xref:spring-batch-component.adoc[Spring Batch] (camel-spring-batch) | 2.10 | The spring-batch component allows to send messages to Spring Batch for further processing. - -| xref:spring-event-component.adoc[Spring Event] (camel-spring) | 1.4 | The spring-event component allows to listen for Spring Application Events. - -| xref:spring-integration-component.adoc[Spring Integration] (camel-spring-integration) | 1.4 | Bridges Camel with Spring Integration. - -| xref:spring-ldap-component.adoc[Spring LDAP] (camel-spring-ldap) | 2.11 | The spring-ldap component allows you to perform searches in LDAP servers using filters as the message payload. - -| xref:spring-redis-component.adoc[Spring Redis] (camel-spring-redis) | 2.11 | The spring-redis component allows sending and receiving messages from Redis. - -| xref:spring-ws-component.adoc[Spring WebService] (camel-spring-ws) | 2.6 | The spring-ws component is used for SOAP WebServices using Spring WebServices. - -| xref:sql-component.adoc[SQL] (camel-sql) | 1.4 | The sql component allows you to work with databases using JDBC SQL queries. - -| xref:sql-stored-component.adoc[SQL Stored Procedure] (camel-sql) | 2.17 | The sql component allows you to work with databases using JDBC Stored Procedure queries. - -| xref:ssh-component.adoc[SSH] (camel-ssh) | 2.10 | The ssh component enables access to SSH servers such that you can send an SSH command, and process the response. - -| xref:stax-component.adoc[StAX] (camel-stax) | 2.9 | The stax component allows messages to be process through a SAX ContentHandler. - -| xref:stomp-component.adoc[Stomp] (camel-stomp) | 2.12 | The stomp component is used for communicating with Stomp compliant message brokers. - -| xref:stream-component.adoc[Stream] (camel-stream) | 1.3 | The stream: component provides access to the system-in, system-out and system-err streams as well as allowing streaming of file. - -| xref:string-template-component.adoc[String Template] (camel-stringtemplate) | 1.2 | Transforms the message using a String template. - -| xref:stub-component.adoc[Stub] (camel-stub) | 2.10 | The stub component provides a simple way to stub out any physical endpoints while in development or testing. - -| xref:telegram-component.adoc[Telegram] (camel-telegram) | 2.18 | The telegram component provides access to the Telegram Bot API. - -| xref:thrift-component.adoc[Thrift] (camel-thrift) | 2.20 | The Thrift component allows to call and expose remote procedures (RPC) with Apache Thrift data format and serialization mechanism - -| xref:tika-component.adoc[Tika] (camel-tika) | 2.19 | This component integrates with Apache Tika to extract content and metadata from thousands of file types. - -| xref:timer-component.adoc[Timer] (camel-timer) | 1.0 | The timer component is used for generating message exchanges when a timer fires. - -| xref:twilio-component.adoc[Twilio] (camel-twilio) | 2.20 | The Twilio component allows you to interact with the Twilio REST APIs using Twilio Java SDK. - -| xref:twitter-directmessage-component.adoc[Twitter Direct Message] (camel-twitter) | 2.10 | The Twitter Direct Message Component consumes/produces user's direct messages. - -| xref:twitter-search-component.adoc[Twitter Search] (camel-twitter) | 2.10 | The Twitter Search component consumes search results. - -| xref:twitter-timeline-component.adoc[Twitter Timeline] (camel-twitter) | 2.10 | The Twitter Timeline component consumes twitter timeline or update the status of specific user. - -| xref:undertow-component.adoc[Undertow] (camel-undertow) | 2.16 | The undertow component provides HTTP and WebSocket based endpoints for consuming and producing HTTP/WebSocket requests. - -| xref:validator-component.adoc[Validator] (camel-validator) | 1.1 | Validates the payload of a message using XML Schema and JAXP Validation. - -| xref:velocity-component.adoc[Velocity] (camel-velocity) | 1.2 | Transforms the message using a Velocity template. - -| xref:vertx-component.adoc[Vert.x] (camel-vertx) | 2.12 | The vertx component is used for sending and receive messages from a vertx event bus. - -| xref:vm-component.adoc[VM] (camel-vm) | 1.1 | The vm component provides asynchronous call to another endpoint from the same CamelContext. - -| xref:weather-component.adoc[Weather] (camel-weather) | 2.12 | Polls the weather information from Open Weather Map. - -| xref:web3j-component.adoc[Web3j Ethereum Blockchain] (camel-web3j) | 2.22 | The web3j component uses the Web3j client API and allows you to add/read nodes to/from a web3j compliant content repositories. - -| xref:webhook-component.adoc[Webhook] (camel-webhook) | 3.0 | The webhook component allows other Camel components that can receive push notifications to expose webhook endpoints and automatically register them with their own webhook provider. - -| xref:weka-component.adoc[Weka] (camel-weka) | 3.1 | The camel-weka component provides Data Mining functionality through Weka. - -| xref:wordpress-component.adoc[Wordpress] (camel-wordpress) | 2.21 | Integrates Camel with Wordpress. - -| xref:workday-component.adoc[Workday] (camel-workday) | 3.1 | Represents a Workday endpoint. - -| xref:xchange-component.adoc[XChange] (camel-xchange) | 2.21 | The camel-xchange component provide access to many bitcoin and altcoin exchanges for trading and accessing market data. - -| xref:xj-component.adoc[XJ] (camel-xj) | 3.0 | Transforms json/xml message back and forth using a XSLT. - -| xref:xmlsecurity-sign-component.adoc[XML Security Sign] (camel-xmlsecurity) | 2.12 | Used to sign exchanges using the XML signature specification. - -| xref:xmlsecurity-verify-component.adoc[XML Security Verify] (camel-xmlsecurity) | 2.12 | Used to verify exchanges using the XML signature specification. - -| xref:xmpp-component.adoc[XMPP] (camel-xmpp) | 1.0 | To send and receive messages from a XMPP (chat) server. - -| xref:xquery-component.adoc[XQuery] (camel-saxon) | 1.0 | Transforms the message using a XQuery template using Saxon. - -| xref:xslt-component.adoc[XSLT] (camel-xslt) | 1.3 | Transforms the message using a XSLT template. - -| xref:xslt-saxon-component.adoc[XSLT Saxon] (camel-xslt-saxon) | 3.0 | Transforms the message using a XSLT template using Saxon. - -| xref:yammer-component.adoc[Yammer] (camel-yammer) | 2.12 | The yammer component allows you to interact with the Yammer enterprise social network. - -| xref:zendesk-component.adoc[Zendesk] (camel-zendesk) | 2.19 | Allows producing messages to manage Zendesk ticket, user, organization, etc. - -| xref:zookeeper-component.adoc[ZooKeeper] (camel-zookeeper) | 2.9 | The zookeeper component allows interaction with a ZooKeeper cluster. - -| xref:zookeeper-master-component.adoc[ZooKeeper Master] (camel-zookeeper-master) | 2.19 | Represents an endpoint which only becomes active when it obtains the master lock - +[{index-table-format}] |=== -// components: END - - -== Miscellaneous Components - -// others: START -Number of Miscellaneous Components: 34 in 34 JAR artifacts (0 deprecated) - -[width="100%",cols="4,1,5",options="header"] +| Component | Artifact | Support Level | Since | Description |=== -| Component | Since | Description - -| xref:attachments.adoc[Attachments] (camel-attachments) | 3.0 | Java Attachments support for Camel Message - -| xref:aws-xray.adoc[AWS XRay] (camel-aws-xray) | 2.21 | Distributed tracing using AWS XRay - -| xref:cdi.adoc[CDI] (camel-cdi) | 2.10 | Using Camel with CDI - -| xref:cxf-transport.adoc[CXF Transport] (camel-cxf-transport) | 2.8 | Camel Transport for Apache CXF - -| xref:hystrix.adoc[Hystrix] (camel-hystrix) | 2.18 | Circuit Breaker EIP using Netflix Hystrix - -| xref:jasypt.adoc[Jasypt] (camel-jasypt) | 2.5 | Security using Jasypt - -| xref:leveldb.adoc[LevelDB] (camel-leveldb) | 2.10 | Using LevelDB as persistent EIP store - -| xref:lra.adoc[LRA] (camel-lra) | 2.21 | Camel saga binding for Long-Running-Action framework - -| xref:microprofile-config.adoc[Microprofile Config] (camel-microprofile-config) | 3.0 | Bridging Eclipse MicroProfile Config with Camel properties - -| xref:microprofile-fault-tolerance.adoc[Microprofile Fault Tolerance] (camel-microprofile-fault-tolerance) | 3.3 | Circuit Breaker EIP using Microprofile Fault Tolerance - -| xref:microprofile-health.adoc[Microprofile Health] (camel-microprofile-health) | 3.0 | Bridging Eclipse MicroProfile Health with Camel health checks +indexTable::[cells="$xref,artifactid,supportlevel,since,description"] -| xref:openapi-java.adoc[Openapi Java] (camel-openapi-java) | 3.1 | Rest-dsl support for using openapi doc - -| xref:opentracing.adoc[OpenTracing] (camel-opentracing) | 2.19 | Distributed tracing using OpenTracing - -| xref:platform-http-vertx.adoc[Platform Http Vertx] (camel-platform-http-vertx) | 3.2 | Implementation of the Platform HTTP Engine based on Vert.x Web - -| xref:reactive-executor-vertx.adoc[Reactive Executor Vert.x] (camel-reactive-executor-vertx) | 3.0 | Reactive Executor for camel-core using Vert.x - -| xref:reactor.adoc[Reactor] (camel-reactor) | 2.20 | Reactor based back-end for Camel's reactive streams component - -| xref:resilience4j.adoc[Resilience4j] (camel-resilience4j) | 3.0 | Circuit Breaker EIP using Resilience4j - -| xref:ribbon.adoc[Ribbon] (camel-ribbon) | 2.18 | Using Netflix Ribbon for client side load balancing - -| xref:rxjava.adoc[RxJava] (camel-rxjava) | 2.22 | RxJava based back-end for Camel's reactive streams component - -| xref:shiro.adoc[Shiro] (camel-shiro) | 2.5 | Security using Shiro - -| xref:spring-javaconfig.adoc[Spring Java Configuration] (camel-spring-javaconfig) | 2.0 | Using Camel with Spring Java Configuration - -| xref:spring-main.adoc[Spring Main] (camel-spring-main) | 3.2 | Camel Spring Main support - -| xref:spring-security.adoc[Spring Security] (camel-spring-security) | 2.3 | Security using Spring Security - -| xref:swagger-java.adoc[Swagger Java] (camel-swagger-java) | 2.16 | Rest-dsl support for using swagger api-doc - -| xref:test.adoc[Test] (camel-test) | 2.9 | Camel unit testing - -| xref:test-cdi.adoc[Test CDI] (camel-test-cdi) | 2.17 | Camel unit testing with CDI - -| xref:test-junit5.adoc[Test JUnit5] (camel-test-junit5) | 3.0 | Camel unit testing with JUnit 5 - -| xref:test-spring.adoc[Test Spring] (camel-test-spring) | 2.10 | Camel unit testing with Spring - -| xref:test-spring-junit5.adoc[Test Spring JUnit5] (camel-test-spring-junit5) | 3.0 | Camel unit testing with Spring and JUnit 5 - -| xref:testcontainers.adoc[Testcontainers] (camel-testcontainers) | 2.22 | Camel support for testcontainers - -| xref:testcontainers-junit5.adoc[Testcontainers JUnit5] (camel-testcontainers-junit5) | 3.0 | Camel support for testcontainers with JUnit 5 - -| xref:testcontainers-spring.adoc[Testcontainers Spring] (camel-testcontainers-spring) | 2.22 | Camel unit testing with Spring and testcontainers - -| xref:testcontainers-spring-junit5.adoc[Testcontainers Spring Junit5] (camel-testcontainers-spring-junit5) | 3.0 | Camel unit testing with Spring, testcontainers and JUnit 5 - -| xref:zipkin.adoc[Zipkin] (camel-zipkin) | 2.18 | Distributed message tracing using Zipkin -|=== -// others: END diff --git a/docs/components/modules/ROOT/pages/infinispan-component.adoc b/docs/components/modules/ROOT/pages/infinispan-component.adoc index 751460dd8ead3..97ea70b97dae1 100644 --- a/docs/components/modules/ROOT/pages/infinispan-component.adoc +++ b/docs/components/modules/ROOT/pages/infinispan-component.adoc @@ -1,12 +1,16 @@ [[infinispan-component]] = Infinispan Component :page-source: components/camel-infinispan/src/main/docs/infinispan-component.adoc +:docTitle: Infinispan +:artifactId: camel-infinispan +:description: For reading/writing from/to Infinispan distributed key/value store and data grid. +:since: 2.13 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.13* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component allows you to interact with http://infinispan.org/[Infinispan] distributed data grid / cache. diff --git a/docs/components/modules/ROOT/pages/influxdb-component.adoc b/docs/components/modules/ROOT/pages/influxdb-component.adoc index bc2ea3ccef9fc..5f37ce7a48fb1 100644 --- a/docs/components/modules/ROOT/pages/influxdb-component.adoc +++ b/docs/components/modules/ROOT/pages/influxdb-component.adoc @@ -1,12 +1,16 @@ [[influxdb-component]] = InfluxDB Component :page-source: components/camel-influxdb/src/main/docs/influxdb-component.adoc +:docTitle: InfluxDB +:artifactId: camel-influxdb +:description: The influxdb component allows you to interact with InfluxDB, a time series database. +:since: 2.18 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* This component allows you to interact with InfluxDB https://influxdata.com/time-series-platform/influxdb/ a time series database. The native body type for this component is diff --git a/docs/components/modules/ROOT/pages/iota-component.adoc b/docs/components/modules/ROOT/pages/iota-component.adoc index 194f077c8d4e1..7f44df1851f0a 100644 --- a/docs/components/modules/ROOT/pages/iota-component.adoc +++ b/docs/components/modules/ROOT/pages/iota-component.adoc @@ -1,12 +1,16 @@ [[iota-component]] = IOTA Component :page-source: components/camel-iota/src/main/docs/iota-component.adoc +:docTitle: IOTA +:artifactId: camel-iota +:description: Component for integrate IOTA DLT +:since: 2.23 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* According to IOTA Official site: "IOTA is the first open-source distributed ledger that is being built to power the future of the Internet of Things with feeless microtransactions and data integrity for machines." diff --git a/docs/components/modules/ROOT/pages/ipfs-component.adoc b/docs/components/modules/ROOT/pages/ipfs-component.adoc index 74d63e8fef769..8f845c8de0d55 100644 --- a/docs/components/modules/ROOT/pages/ipfs-component.adoc +++ b/docs/components/modules/ROOT/pages/ipfs-component.adoc @@ -1,12 +1,16 @@ [[ipfs-component]] = IPFS Component :page-source: components/camel-ipfs/src/main/docs/ipfs-component.adoc +:docTitle: IPFS +:artifactId: camel-ipfs +:description: The camel-ipfs component provides access to the Interplanetary File System (IPFS). +:since: 2.23 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The IPFS component provides access to the Interplanetary File System https://ipfs.io/[(IPFS)]. diff --git a/docs/components/modules/ROOT/pages/irc-component.adoc b/docs/components/modules/ROOT/pages/irc-component.adoc index 795f4a9525e36..a3a1b955992a0 100644 --- a/docs/components/modules/ROOT/pages/irc-component.adoc +++ b/docs/components/modules/ROOT/pages/irc-component.adoc @@ -1,12 +1,16 @@ [[irc-component]] = IRC Component :page-source: components/camel-irc/src/main/docs/irc-component.adoc +:docTitle: IRC +:artifactId: camel-irc +:description: The irc component implements an IRC (Internet Relay Chat) transport. +:since: 1.1 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The IRC component implements an http://en.wikipedia.org/wiki/Internet_Relay_Chat[IRC] (Internet Relay diff --git a/docs/components/modules/ROOT/pages/ironmq-component.adoc b/docs/components/modules/ROOT/pages/ironmq-component.adoc index edf238fedb03c..4b8823668915d 100644 --- a/docs/components/modules/ROOT/pages/ironmq-component.adoc +++ b/docs/components/modules/ROOT/pages/ironmq-component.adoc @@ -1,12 +1,16 @@ [[ironmq-component]] = IronMQ Component :page-source: components/camel-ironmq/src/main/docs/ironmq-component.adoc +:docTitle: IronMQ +:artifactId: camel-ironmq +:description: The ironmq provides integration with IronMQ an elastic and durable hosted message queue as a service. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The IronMQ component provides integration with http://www.iron.io/products/mq[IronMQ] an elastic and durable hosted message queue as a service. diff --git a/docs/components/modules/ROOT/pages/jbpm-component.adoc b/docs/components/modules/ROOT/pages/jbpm-component.adoc index d9e72e64f7b50..55555c93e0a44 100644 --- a/docs/components/modules/ROOT/pages/jbpm-component.adoc +++ b/docs/components/modules/ROOT/pages/jbpm-component.adoc @@ -1,12 +1,16 @@ [[jbpm-component]] = JBPM Component :page-source: components/camel-jbpm/src/main/docs/jbpm-component.adoc +:docTitle: JBPM +:artifactId: camel-jbpm +:description: The jbpm component provides integration with jBPM (Business Process Management). +:since: 2.6 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.6* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The JBPM component provides integration with Business Process Management http://www.jbpm.org/[jBPM]. It uses diff --git a/docs/components/modules/ROOT/pages/jcache-component.adoc b/docs/components/modules/ROOT/pages/jcache-component.adoc index b9b0d7cc399f8..df69a00269d90 100644 --- a/docs/components/modules/ROOT/pages/jcache-component.adoc +++ b/docs/components/modules/ROOT/pages/jcache-component.adoc @@ -1,12 +1,16 @@ [[jcache-component]] = JCache Component :page-source: components/camel-jcache/src/main/docs/jcache-component.adoc +:docTitle: JCache +:artifactId: camel-jcache +:description: The jcache component enables you to perform caching operations using JSR107/JCache as cache implementation. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The JCache component enables you to perform caching operations using JSR107/JCache as cache implementation. diff --git a/docs/components/modules/ROOT/pages/jclouds-component.adoc b/docs/components/modules/ROOT/pages/jclouds-component.adoc index 0245e1087128c..a54c7316fdfee 100644 --- a/docs/components/modules/ROOT/pages/jclouds-component.adoc +++ b/docs/components/modules/ROOT/pages/jclouds-component.adoc @@ -1,12 +1,16 @@ [[jclouds-component]] = JClouds Component :page-source: components/camel-jclouds/src/main/docs/jclouds-component.adoc +:docTitle: JClouds +:artifactId: camel-jclouds +:description: For interacting with cloud compute & blobstore service via jclouds. +:since: 2.9 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.9* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component allows interaction with cloud provider key-value engines (blobstores) and compute services. The component uses diff --git a/docs/components/modules/ROOT/pages/jcr-component.adoc b/docs/components/modules/ROOT/pages/jcr-component.adoc index bec73586187b8..0f394c1450f46 100644 --- a/docs/components/modules/ROOT/pages/jcr-component.adoc +++ b/docs/components/modules/ROOT/pages/jcr-component.adoc @@ -1,12 +1,16 @@ [[jcr-component]] = JCR Component :page-source: components/camel-jcr/src/main/docs/jcr-component.adoc +:docTitle: JCR +:artifactId: camel-jcr +:description: The jcr component allows you to add/read nodes to/from a JCR compliant content repository. +:since: 1.3 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.3* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The JCR component allows you to add/read nodes to/from a JCR compliant content repository (for example, diff --git a/docs/components/modules/ROOT/pages/jdbc-component.adoc b/docs/components/modules/ROOT/pages/jdbc-component.adoc index 1c53dcd6e7b9b..1beb4533f41bf 100644 --- a/docs/components/modules/ROOT/pages/jdbc-component.adoc +++ b/docs/components/modules/ROOT/pages/jdbc-component.adoc @@ -1,12 +1,16 @@ [[jdbc-component]] = JDBC Component :page-source: components/camel-jdbc/src/main/docs/jdbc-component.adoc +:docTitle: JDBC +:artifactId: camel-jdbc +:description: The jdbc component enables you to access databases through JDBC, where SQL queries are sent in the message body. +:since: 1.2 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 1.2* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The JDBC component enables you to access databases through JDBC, where SQL queries (SELECT) and operations (INSERT, UPDATE, etc) are sent in diff --git a/docs/components/modules/ROOT/pages/jetty-component.adoc b/docs/components/modules/ROOT/pages/jetty-component.adoc index e223aaa3a458e..c987097f497b3 100644 --- a/docs/components/modules/ROOT/pages/jetty-component.adoc +++ b/docs/components/modules/ROOT/pages/jetty-component.adoc @@ -1,12 +1,16 @@ [[jetty-component]] = Jetty Component :page-source: components/camel-jetty/src/main/docs/jetty-component.adoc +:docTitle: Jetty +:artifactId: camel-jetty +:description: To use Jetty as a HTTP server as consumer for Camel routes. +:since: 1.2 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 1.2* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Jetty component provides HTTP-based endpoints for consuming and producing HTTP requests. That is, the Jetty component diff --git a/docs/components/modules/ROOT/pages/jgroups-component.adoc b/docs/components/modules/ROOT/pages/jgroups-component.adoc index 6ce1e1b82a0ae..20390e87c87c2 100644 --- a/docs/components/modules/ROOT/pages/jgroups-component.adoc +++ b/docs/components/modules/ROOT/pages/jgroups-component.adoc @@ -1,12 +1,16 @@ [[jgroups-component]] = JGroups Component :page-source: components/camel-jgroups/src/main/docs/jgroups-component.adoc +:docTitle: JGroups +:artifactId: camel-jgroups +:description: The jgroups component provides exchange of messages between Camel and JGroups clusters. +:since: 2.13 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.13* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* http://www.jgroups.org[JGroups] is a toolkit for reliable multicast communication. The *jgroups:* component provides exchange of messages diff --git a/docs/components/modules/ROOT/pages/jgroups-raft-component.adoc b/docs/components/modules/ROOT/pages/jgroups-raft-component.adoc index 0c5255c9e7452..8c955eba1179e 100644 --- a/docs/components/modules/ROOT/pages/jgroups-raft-component.adoc +++ b/docs/components/modules/ROOT/pages/jgroups-raft-component.adoc @@ -1,12 +1,16 @@ [[jgroups-raft-component]] = JGroups raft Component :page-source: components/camel-jgroups-raft/src/main/docs/jgroups-raft-component.adoc +:docTitle: JGroups raft +:artifactId: camel-jgroups-raft +:description: The jgroups component provides exchange of messages between Camel and JGroups clusters. +:since: 2.24 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.24* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* http://belaban.github.io/jgroups-raft/[JGroups-raft] is a https://raftconsensus.github.io/[Raft] implementation in http://www.jgroups.org/[JGroups]. The *jgroups-raft:* component provides interoperability between camel and a JGroups-raft clusters. diff --git a/docs/components/modules/ROOT/pages/jing-component.adoc b/docs/components/modules/ROOT/pages/jing-component.adoc index 9cc4108e65015..c651ae5b197e5 100644 --- a/docs/components/modules/ROOT/pages/jing-component.adoc +++ b/docs/components/modules/ROOT/pages/jing-component.adoc @@ -1,12 +1,16 @@ [[jing-component]] = Jing Component :page-source: components/camel-jing/src/main/docs/jing-component.adoc +:docTitle: Jing +:artifactId: camel-jing +:description: Validates the payload of a message using RelaxNG Syntax using Jing library. +:since: 1.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Jing component uses the http://www.thaiopensource.com/relaxng/jing.html[Jing Library] to perform diff --git a/docs/components/modules/ROOT/pages/jira-component.adoc b/docs/components/modules/ROOT/pages/jira-component.adoc index 91574c6119e0d..0c29ca476c0c4 100644 --- a/docs/components/modules/ROOT/pages/jira-component.adoc +++ b/docs/components/modules/ROOT/pages/jira-component.adoc @@ -1,12 +1,16 @@ [[jira-component]] = Jira Component :page-source: components/camel-jira/src/main/docs/jira-component.adoc +:docTitle: Jira +:artifactId: camel-jira +:description: The jira component interacts with the JIRA issue tracker. +:since: 3.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The JIRA component interacts with the JIRA API by encapsulating Atlassian's https://bitbucket.org/atlassian/jira-rest-java-client/src/master/[REST diff --git a/docs/components/modules/ROOT/pages/jms-component.adoc b/docs/components/modules/ROOT/pages/jms-component.adoc index 514314fc639f0..c65c589343dc2 100644 --- a/docs/components/modules/ROOT/pages/jms-component.adoc +++ b/docs/components/modules/ROOT/pages/jms-component.adoc @@ -1,12 +1,16 @@ [[jms-component]] = JMS Component :page-source: components/camel-jms/src/main/docs/jms-component.adoc +:docTitle: JMS +:artifactId: camel-jms +:description: The jms component allows messages to be sent to (or consumed from) a JMS Queue or Topic. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component allows messages to be sent to (or consumed from) a http://java.sun.com/products/jms/[JMS] Queue or Topic. It uses Spring's diff --git a/docs/components/modules/ROOT/pages/jmx-component.adoc b/docs/components/modules/ROOT/pages/jmx-component.adoc index 850009618dcd7..945f9709f2690 100644 --- a/docs/components/modules/ROOT/pages/jmx-component.adoc +++ b/docs/components/modules/ROOT/pages/jmx-component.adoc @@ -1,12 +1,16 @@ [[jmx-component]] = JMX Component :page-source: components/camel-jmx/src/main/docs/jmx-component.adoc +:docTitle: JMX +:artifactId: camel-jmx +:description: The jmx component allows to receive JMX notifications. +:since: 2.6 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.6* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* Apache Camel has extensive support for JMX to allow you to monitor and control the Camel managed objects with a JMX client. diff --git a/docs/components/modules/ROOT/pages/jolt-component.adoc b/docs/components/modules/ROOT/pages/jolt-component.adoc index e373524fce4a0..9cc59dc00e658 100644 --- a/docs/components/modules/ROOT/pages/jolt-component.adoc +++ b/docs/components/modules/ROOT/pages/jolt-component.adoc @@ -1,12 +1,16 @@ [[jolt-component]] = JOLT Component :page-source: components/camel-jolt/src/main/docs/jolt-component.adoc +:docTitle: JOLT +:artifactId: camel-jolt +:description: The jolt component allows you to process a JSON messages using an JOLT specification (such as JSON-JSON transformation). +:since: 2.16 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Jolt component allows you to process a JSON messages using an https://github.com/bazaarvoice/jolt[JOLT] specification. This can be diff --git a/docs/components/modules/ROOT/pages/jooq-component.adoc b/docs/components/modules/ROOT/pages/jooq-component.adoc index 2a30e1183b360..bc986deb5628d 100644 --- a/docs/components/modules/ROOT/pages/jooq-component.adoc +++ b/docs/components/modules/ROOT/pages/jooq-component.adoc @@ -1,12 +1,16 @@ [[jooq-component]] = JOOQ Component :page-source: components/camel-jooq/src/main/docs/jooq-component.adoc +:docTitle: JOOQ +:artifactId: camel-jooq +:description: The jooq component enables you to store and retrieve entities from databases using JOOQ +:since: 3.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The JOOQ component enables you to store and retrieve Java objects from persistent storage using JOOQ library. diff --git a/docs/components/modules/ROOT/pages/jpa-component.adoc b/docs/components/modules/ROOT/pages/jpa-component.adoc index 4bc1e85d67771..41d2b0f3fa8d3 100644 --- a/docs/components/modules/ROOT/pages/jpa-component.adoc +++ b/docs/components/modules/ROOT/pages/jpa-component.adoc @@ -1,12 +1,16 @@ [[jpa-component]] = JPA Component :page-source: components/camel-jpa/src/main/docs/jpa-component.adoc +:docTitle: JPA +:artifactId: camel-jpa +:description: The jpa component enables you to store and retrieve Java objects from databases using JPA. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The JPA component enables you to store and retrieve Java objects from persistent storage using EJB 3's Java Persistence Architecture (JPA), diff --git a/docs/components/modules/ROOT/pages/jslt-component.adoc b/docs/components/modules/ROOT/pages/jslt-component.adoc index 9f4f7119ef8e3..ddc556338f8dc 100644 --- a/docs/components/modules/ROOT/pages/jslt-component.adoc +++ b/docs/components/modules/ROOT/pages/jslt-component.adoc @@ -1,12 +1,16 @@ [[jslt-component]] = JSLT Component :page-source: components/camel-jslt/src/main/docs/jslt-component.adoc +:docTitle: JSLT +:artifactId: camel-jslt +:description: The jslt component allows you to process a JSON messages using an JSLT transformations. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Jslt component allows you to process a JSON messages using an https://github.com/schibsted/jslt[JSLT] expression. This can be diff --git a/docs/components/modules/ROOT/pages/json-validator-component.adoc b/docs/components/modules/ROOT/pages/json-validator-component.adoc index 2f468498f7223..a5019ed717c2e 100644 --- a/docs/components/modules/ROOT/pages/json-validator-component.adoc +++ b/docs/components/modules/ROOT/pages/json-validator-component.adoc @@ -1,12 +1,16 @@ [[json-validator-component]] = JSON Schema Validator Component :page-source: components/camel-json-validator/src/main/docs/json-validator-component.adoc +:docTitle: JSON Schema Validator +:artifactId: camel-json-validator +:description: Validates the payload of a message using NetworkNT JSON Schema library. +:since: 2.20 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The JSON Schema Validator component performs bean validation of the message body against JSON Schemas v4 draft using the NetworkNT JSON Schema library diff --git a/docs/components/modules/ROOT/pages/jt400-component.adoc b/docs/components/modules/ROOT/pages/jt400-component.adoc index e84ba5bf4a3fb..4042d0aeb903d 100644 --- a/docs/components/modules/ROOT/pages/jt400-component.adoc +++ b/docs/components/modules/ROOT/pages/jt400-component.adoc @@ -1,12 +1,16 @@ [[jt400-component]] = JT400 Component :page-source: components/camel-jt400/src/main/docs/jt400-component.adoc +:docTitle: JT400 +:artifactId: camel-jt400 +:description: The jt400 component allows you to exchanges messages with an AS/400 system using data queues or program call. +:since: 1.5 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.5* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The JT400 component allows you to exchanges messages with an AS/400 system using data queues. diff --git a/docs/components/modules/ROOT/pages/kafka-component.adoc b/docs/components/modules/ROOT/pages/kafka-component.adoc index cf638b0697a72..aef7c70df32a8 100644 --- a/docs/components/modules/ROOT/pages/kafka-component.adoc +++ b/docs/components/modules/ROOT/pages/kafka-component.adoc @@ -1,12 +1,16 @@ [[kafka-component]] = Kafka Component :page-source: components/camel-kafka/src/main/docs/kafka-component.adoc +:docTitle: Kafka +:artifactId: camel-kafka +:description: The kafka component allows messages to be sent to (or consumed from) Apache Kafka brokers. +:since: 2.13 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.13* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Kafka component is used for communicating with http://kafka.apache.org/[Apache Kafka] message broker. diff --git a/docs/components/modules/ROOT/pages/kubernetes-config-maps-component.adoc b/docs/components/modules/ROOT/pages/kubernetes-config-maps-component.adoc index f032c46080fa8..b3c1d79bc69a2 100644 --- a/docs/components/modules/ROOT/pages/kubernetes-config-maps-component.adoc +++ b/docs/components/modules/ROOT/pages/kubernetes-config-maps-component.adoc @@ -1,14 +1,18 @@ [[kubernetes-config-maps-component]] = Kubernetes ConfigMap Component :page-source: components/camel-kubernetes/src/main/docs/kubernetes-config-maps-component.adoc +:docTitle: Kubernetes ConfigMap +:artifactId: camel-kubernetes +:description: The Kubernetes Configmaps component provides a producer to execute kubernetes configmap operations. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* -The Kubernetes ConfigMap component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes ConfigMap component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes ConfigMap operations and a consumer to consume events related to Config maps. diff --git a/docs/components/modules/ROOT/pages/kubernetes-deployments-component.adoc b/docs/components/modules/ROOT/pages/kubernetes-deployments-component.adoc index 14d7af9c21c27..84780d18365fc 100644 --- a/docs/components/modules/ROOT/pages/kubernetes-deployments-component.adoc +++ b/docs/components/modules/ROOT/pages/kubernetes-deployments-component.adoc @@ -1,14 +1,18 @@ [[kubernetes-deployments-component]] = Kubernetes Deployments Component :page-source: components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc +:docTitle: Kubernetes Deployments +:artifactId: camel-kubernetes +:description: The Kubernetes Nodes component provides a producer to execute kubernetes node operations and a consumer to consume node events. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -The Kubernetes Deployments component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Deployments component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes secret operations. diff --git a/docs/components/modules/ROOT/pages/kubernetes-hpa-component.adoc b/docs/components/modules/ROOT/pages/kubernetes-hpa-component.adoc index 982dea074fdb8..c1cbc1624b675 100644 --- a/docs/components/modules/ROOT/pages/kubernetes-hpa-component.adoc +++ b/docs/components/modules/ROOT/pages/kubernetes-hpa-component.adoc @@ -1,14 +1,18 @@ [[kubernetes-hpa-component]] = Kubernetes HPA Component :page-source: components/camel-kubernetes/src/main/docs/kubernetes-hpa-component.adoc +:docTitle: Kubernetes HPA +:artifactId: camel-kubernetes +:description: The Kubernetes HPA component provides a producer to execute kubernetes hpa operations and a consumer to consume HPA events. +:since: 2.23 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -The Kubernetes HPA component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes HPA component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes hpa operations and a consumer to consume kubernetes hpa events. diff --git a/docs/components/modules/ROOT/pages/kubernetes-job-component.adoc b/docs/components/modules/ROOT/pages/kubernetes-job-component.adoc index 86b629e260aef..5295b189f6ed4 100644 --- a/docs/components/modules/ROOT/pages/kubernetes-job-component.adoc +++ b/docs/components/modules/ROOT/pages/kubernetes-job-component.adoc @@ -1,14 +1,18 @@ [[kubernetes-job-component]] = Kubernetes Job Component :page-source: components/camel-kubernetes/src/main/docs/kubernetes-job-component.adoc +:docTitle: Kubernetes Job +:artifactId: camel-kubernetes +:description: The Kubernetes Jobs component provides a producer to execute kubernetes job operations +:since: 2.23 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -The Kubernetes Job component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Job component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes job operations. diff --git a/docs/components/modules/ROOT/pages/kubernetes-namespaces-component.adoc b/docs/components/modules/ROOT/pages/kubernetes-namespaces-component.adoc index 9d9d7bdbfdf92..66940d409bd7a 100644 --- a/docs/components/modules/ROOT/pages/kubernetes-namespaces-component.adoc +++ b/docs/components/modules/ROOT/pages/kubernetes-namespaces-component.adoc @@ -1,14 +1,18 @@ [[kubernetes-namespaces-component]] = Kubernetes Namespaces Component :page-source: components/camel-kubernetes/src/main/docs/kubernetes-namespaces-component.adoc +:docTitle: Kubernetes Namespaces +:artifactId: camel-kubernetes +:description: The Kubernetes Namespaces component provides a producer to execute kubernetes namespace operations and a consumer to consume namespace events. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -The Kubernetes Namespaces component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Namespaces component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes namespace operations and a consumer to consume kubernetes namespace events. diff --git a/docs/components/modules/ROOT/pages/kubernetes-nodes-component.adoc b/docs/components/modules/ROOT/pages/kubernetes-nodes-component.adoc index 1bf3e49977891..547b7def39b1e 100644 --- a/docs/components/modules/ROOT/pages/kubernetes-nodes-component.adoc +++ b/docs/components/modules/ROOT/pages/kubernetes-nodes-component.adoc @@ -1,14 +1,18 @@ [[kubernetes-nodes-component]] = Kubernetes Nodes Component :page-source: components/camel-kubernetes/src/main/docs/kubernetes-nodes-component.adoc +:docTitle: Kubernetes Nodes +:artifactId: camel-kubernetes +:description: The Kubernetes Nodes component provides a producer to execute kubernetes node operations and a consumer to consume node events. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -The Kubernetes Nodes component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Nodes component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes node operations and a consumer to consume kubernetes node events. diff --git a/docs/components/modules/ROOT/pages/kubernetes-persistent-volumes-claims-component.adoc b/docs/components/modules/ROOT/pages/kubernetes-persistent-volumes-claims-component.adoc index 7b506aade0e15..29a1d77853239 100644 --- a/docs/components/modules/ROOT/pages/kubernetes-persistent-volumes-claims-component.adoc +++ b/docs/components/modules/ROOT/pages/kubernetes-persistent-volumes-claims-component.adoc @@ -1,14 +1,18 @@ [[kubernetes-persistent-volumes-claims-component]] = Kubernetes Persistent Volume Claim Component :page-source: components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-claims-component.adoc +:docTitle: Kubernetes Persistent Volume Claim +:artifactId: camel-kubernetes +:description: The Kubernetes Persistent Volumes Claims component provides a producer to execute kubernetes persistent volume claim operations. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* -The Kubernetes Persistent Volume Claim component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Persistent Volume Claim component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes persistent volume claim operations. diff --git a/docs/components/modules/ROOT/pages/kubernetes-persistent-volumes-component.adoc b/docs/components/modules/ROOT/pages/kubernetes-persistent-volumes-component.adoc index 585015d805939..d56222ea77d7b 100644 --- a/docs/components/modules/ROOT/pages/kubernetes-persistent-volumes-component.adoc +++ b/docs/components/modules/ROOT/pages/kubernetes-persistent-volumes-component.adoc @@ -1,14 +1,18 @@ [[kubernetes-persistent-volumes-component]] = Kubernetes Persistent Volume Component :page-source: components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-component.adoc +:docTitle: Kubernetes Persistent Volume +:artifactId: camel-kubernetes +:description: The Kubernetes Persistent Volumes component provides a producer to execute kubernetes persistent volume operations. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* -The Kubernetes Persistent Volume component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Persistent Volume component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes persistent volume operations. diff --git a/docs/components/modules/ROOT/pages/kubernetes-pods-component.adoc b/docs/components/modules/ROOT/pages/kubernetes-pods-component.adoc index e7f535d7dbe13..29ccc8baea1e5 100644 --- a/docs/components/modules/ROOT/pages/kubernetes-pods-component.adoc +++ b/docs/components/modules/ROOT/pages/kubernetes-pods-component.adoc @@ -1,14 +1,18 @@ [[kubernetes-pods-component]] = Kubernetes Pods Component :page-source: components/camel-kubernetes/src/main/docs/kubernetes-pods-component.adoc +:docTitle: Kubernetes Pods +:artifactId: camel-kubernetes +:description: The Kubernetes Pods component provides a producer to execute kubernetes pod operations and a consumer to consume pod events. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -The Kubernetes Pods component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Pods component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes pod operations. diff --git a/docs/components/modules/ROOT/pages/kubernetes-replication-controllers-component.adoc b/docs/components/modules/ROOT/pages/kubernetes-replication-controllers-component.adoc index 4589e578954d7..887c437616b60 100644 --- a/docs/components/modules/ROOT/pages/kubernetes-replication-controllers-component.adoc +++ b/docs/components/modules/ROOT/pages/kubernetes-replication-controllers-component.adoc @@ -1,14 +1,18 @@ [[kubernetes-replication-controllers-component]] = Kubernetes Replication Controller Component :page-source: components/camel-kubernetes/src/main/docs/kubernetes-replication-controllers-component.adoc +:docTitle: Kubernetes Replication Controller +:artifactId: camel-kubernetes +:description: The Kubernetes Replication Controllers component provides a producer to execute kubernetes replication controller operations and a consumer to consume replication controller events. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -The Kubernetes Replication Controller component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Replication Controller component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes replication controller operations and a consumer to consume kubernetes replication controller events. diff --git a/docs/components/modules/ROOT/pages/kubernetes-resources-quota-component.adoc b/docs/components/modules/ROOT/pages/kubernetes-resources-quota-component.adoc index 3a7b15abe1e9a..561e2d5e49d5e 100644 --- a/docs/components/modules/ROOT/pages/kubernetes-resources-quota-component.adoc +++ b/docs/components/modules/ROOT/pages/kubernetes-resources-quota-component.adoc @@ -1,14 +1,18 @@ [[kubernetes-resources-quota-component]] = Kubernetes Resources Quota Component :page-source: components/camel-kubernetes/src/main/docs/kubernetes-resources-quota-component.adoc +:docTitle: Kubernetes Resources Quota +:artifactId: camel-kubernetes +:description: The Kubernetes Resources Quota component provides a producer to execute kubernetes resources quota operations. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* -The Kubernetes Resources Quota component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Resources Quota component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes resource quota operations. diff --git a/docs/components/modules/ROOT/pages/kubernetes-secrets-component.adoc b/docs/components/modules/ROOT/pages/kubernetes-secrets-component.adoc index dddbdd3603d1e..c4318a002f057 100644 --- a/docs/components/modules/ROOT/pages/kubernetes-secrets-component.adoc +++ b/docs/components/modules/ROOT/pages/kubernetes-secrets-component.adoc @@ -1,14 +1,18 @@ [[kubernetes-secrets-component]] = Kubernetes Secrets Component :page-source: components/camel-kubernetes/src/main/docs/kubernetes-secrets-component.adoc +:docTitle: Kubernetes Secrets +:artifactId: camel-kubernetes +:description: The Kubernetes Secrets component provides a producer to execute kubernetes secret operations. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* -The Kubernetes Secrets component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Secrets component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes secret operations. diff --git a/docs/components/modules/ROOT/pages/kubernetes-service-accounts-component.adoc b/docs/components/modules/ROOT/pages/kubernetes-service-accounts-component.adoc index 1414c135e1126..91ae2937d3ad8 100644 --- a/docs/components/modules/ROOT/pages/kubernetes-service-accounts-component.adoc +++ b/docs/components/modules/ROOT/pages/kubernetes-service-accounts-component.adoc @@ -1,14 +1,18 @@ [[kubernetes-service-accounts-component]] = Kubernetes Service Account Component :page-source: components/camel-kubernetes/src/main/docs/kubernetes-service-accounts-component.adoc +:docTitle: Kubernetes Service Account +:artifactId: camel-kubernetes +:description: The Kubernetes Service Accounts component provides a producer to execute service account operations. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* -The Kubernetes Service Account component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Service Account component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes Service Account operations. diff --git a/docs/components/modules/ROOT/pages/kubernetes-services-component.adoc b/docs/components/modules/ROOT/pages/kubernetes-services-component.adoc index 27b434e3e74a2..5ecf73da4ef2c 100644 --- a/docs/components/modules/ROOT/pages/kubernetes-services-component.adoc +++ b/docs/components/modules/ROOT/pages/kubernetes-services-component.adoc @@ -1,14 +1,18 @@ [[kubernetes-services-component]] = Kubernetes Services Component :page-source: components/camel-kubernetes/src/main/docs/kubernetes-services-component.adoc +:docTitle: Kubernetes Services +:artifactId: camel-kubernetes +:description: The Kubernetes Services component provides a producer to execute service operations and a consumer to consume service events. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* -The Kubernetes Services component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Services component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes service operations and a consumer to consume kubernetes service events. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes.adoc b/docs/components/modules/ROOT/pages/kubernetes-summary.adoc similarity index 96% rename from components/camel-kubernetes/src/main/docs/kubernetes.adoc rename to docs/components/modules/ROOT/pages/kubernetes-summary.adoc index 73a94fcf19a86..57a876f41858f 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes.adoc +++ b/docs/components/modules/ROOT/pages/kubernetes-summary.adoc @@ -1,6 +1,10 @@ = Kubernetes Components +:page-source: components/camel-kubernetes/src/main/docs/kubernetes-summary.adoc +//attributes written by hand, not generated +:docTitle: Kubernetes +:since: 2.17 -*Since Camel 2.17* +*Since Camel {since}* The Kubernetes components integrate your application with Kubernetes standalone or on top of Openshift. diff --git a/docs/components/modules/ROOT/pages/kudu-component.adoc b/docs/components/modules/ROOT/pages/kudu-component.adoc index 24ed20cc41508..31b90a9e9cf3a 100644 --- a/docs/components/modules/ROOT/pages/kudu-component.adoc +++ b/docs/components/modules/ROOT/pages/kudu-component.adoc @@ -1,12 +1,16 @@ [[kudu-component]] = Kudu Component :page-source: components/camel-kudu/src/main/docs/kudu-component.adoc +:docTitle: Kudu +:artifactId: camel-kudu +:description: Represents a Kudu endpoint. A kudu endpoint allows you to interact with Apache Kudu, a free and open source column-oriented data store of the Apache Hadoop ecosystem. +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* *Since Camel 3.0* diff --git a/docs/components/modules/ROOT/pages/language-component.adoc b/docs/components/modules/ROOT/pages/language-component.adoc index a3e85c87f7246..5c41bb39af78f 100644 --- a/docs/components/modules/ROOT/pages/language-component.adoc +++ b/docs/components/modules/ROOT/pages/language-component.adoc @@ -1,12 +1,17 @@ [[language-component]] = Language Component :page-source: components/camel-language/src/main/docs/language-component.adoc +:docTitle: Language +:artifactId: camel-language +:description: The language component allows you to send a message to an endpoint which executes a script by any of the supported Languages in Camel. +:since: 2.5 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 2.5* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Language component allows you to send Exchange to an endpoint which executes a script by any of the supported diff --git a/docs/components/modules/ROOT/pages/ldap-component.adoc b/docs/components/modules/ROOT/pages/ldap-component.adoc index fc688f77521bb..fd21d17322e5a 100644 --- a/docs/components/modules/ROOT/pages/ldap-component.adoc +++ b/docs/components/modules/ROOT/pages/ldap-component.adoc @@ -1,12 +1,16 @@ [[ldap-component]] = LDAP Component :page-source: components/camel-ldap/src/main/docs/ldap-component.adoc +:docTitle: LDAP +:artifactId: camel-ldap +:description: The ldap component allows you to perform searches in LDAP servers using filters as the message payload. +:since: 1.5 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 1.5* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The LDAP component allows you to perform searches in LDAP servers using filters as the message payload. + diff --git a/docs/components/modules/ROOT/pages/ldif-component.adoc b/docs/components/modules/ROOT/pages/ldif-component.adoc index de65a8b82db2c..2ad9271c964b9 100644 --- a/docs/components/modules/ROOT/pages/ldif-component.adoc +++ b/docs/components/modules/ROOT/pages/ldif-component.adoc @@ -1,12 +1,16 @@ [[ldif-component]] = LDIF Component :page-source: components/camel-ldif/src/main/docs/ldif-component.adoc +:docTitle: LDIF +:artifactId: camel-ldif +:description: The ldif component allows you to do updates on an LDAP server from a LDIF body content. +:since: 2.20 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The LDIF component allows you to do updates on an LDAP server from a LDIF body content. diff --git a/docs/components/modules/ROOT/pages/log-component.adoc b/docs/components/modules/ROOT/pages/log-component.adoc index b5e73c6ee077e..0dd7500d605ea 100644 --- a/docs/components/modules/ROOT/pages/log-component.adoc +++ b/docs/components/modules/ROOT/pages/log-component.adoc @@ -1,12 +1,17 @@ [[log-component]] = Log Component :page-source: components/camel-log/src/main/docs/log-component.adoc +:docTitle: Log +:artifactId: camel-log +:description: The log component logs message exchanges to the underlying logging mechanism. +:since: 1.1 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Log component logs message exchanges to the underlying logging mechanism. diff --git a/docs/components/modules/ROOT/pages/lpr-component.adoc b/docs/components/modules/ROOT/pages/lpr-component.adoc index f9ae7cb75f96c..7c74527b395af 100644 --- a/docs/components/modules/ROOT/pages/lpr-component.adoc +++ b/docs/components/modules/ROOT/pages/lpr-component.adoc @@ -1,12 +1,16 @@ [[lpr-component]] = Printer Component :page-source: components/camel-printer/src/main/docs/lpr-component.adoc +:docTitle: Printer +:artifactId: camel-printer +:description: The printer component is used for sending messages to printers as print jobs. +:since: 2.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Printer component provides a way to direct payloads on a route to a printer. Obviously the payload has to be a formatted piece of payload diff --git a/docs/components/modules/ROOT/pages/lucene-component.adoc b/docs/components/modules/ROOT/pages/lucene-component.adoc index 3db0fa9c64129..9840dfd2b5500 100644 --- a/docs/components/modules/ROOT/pages/lucene-component.adoc +++ b/docs/components/modules/ROOT/pages/lucene-component.adoc @@ -1,12 +1,16 @@ [[lucene-component]] = Lucene Component :page-source: components/camel-lucene/src/main/docs/lucene-component.adoc +:docTitle: Lucene +:artifactId: camel-lucene +:description: To insert or query from Apache Lucene databases. +:since: 2.2 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.2* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Lucene component is based on the Apache Lucene project. Apache Lucene is a powerful high-performance, full-featured text search engine diff --git a/docs/components/modules/ROOT/pages/lumberjack-component.adoc b/docs/components/modules/ROOT/pages/lumberjack-component.adoc index 88f23b1c19dff..aee0318787283 100644 --- a/docs/components/modules/ROOT/pages/lumberjack-component.adoc +++ b/docs/components/modules/ROOT/pages/lumberjack-component.adoc @@ -1,12 +1,16 @@ [[lumberjack-component]] = Lumberjack Component :page-source: components/camel-lumberjack/src/main/docs/lumberjack-component.adoc +:docTitle: Lumberjack +:artifactId: camel-lumberjack +:description: The lumberjack retrieves logs sent over the network using the Lumberjack protocol. +:since: 2.18 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Lumberjack component retrieves logs sent over the network using the Lumberjack protocol, from https://www.elastic.co/fr/products/beats/filebeat[Filebeat] for instance. diff --git a/docs/components/modules/ROOT/pages/mail-component.adoc b/docs/components/modules/ROOT/pages/mail-component.adoc index 6f8e1b13e3c5f..4ecd1210c3b18 100644 --- a/docs/components/modules/ROOT/pages/mail-component.adoc +++ b/docs/components/modules/ROOT/pages/mail-component.adoc @@ -1,12 +1,16 @@ [[mail-component]] = Mail Component :page-source: components/camel-mail/src/main/docs/mail-component.adoc +:docTitle: Mail +:artifactId: camel-mail +:description: To send or receive emails using imap/pop3 or smtp protocols. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Mail component provides access to Email via Spring's Mail support and the underlying JavaMail system. diff --git a/docs/components/modules/ROOT/pages/master-component.adoc b/docs/components/modules/ROOT/pages/master-component.adoc index 4f2c6020eab20..e15d431062354 100644 --- a/docs/components/modules/ROOT/pages/master-component.adoc +++ b/docs/components/modules/ROOT/pages/master-component.adoc @@ -1,12 +1,16 @@ [[master-component]] = Master Component :page-source: components/camel-master/src/main/docs/master-component.adoc +:docTitle: Master +:artifactId: camel-master +:description: Represents an endpoint which only becomes active when the CamelClusterView has the leadership. +:since: 2.20 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Camel-Master endpoint provides a way to ensure only a single consumer in a cluster consumes from a given endpoint; with automatic failover if that JVM dies. diff --git a/docs/components/modules/ROOT/pages/metrics-component.adoc b/docs/components/modules/ROOT/pages/metrics-component.adoc index 3083af45735bf..355e4bfbd9195 100644 --- a/docs/components/modules/ROOT/pages/metrics-component.adoc +++ b/docs/components/modules/ROOT/pages/metrics-component.adoc @@ -1,12 +1,16 @@ [[metrics-component]] = Metrics Component :page-source: components/camel-metrics/src/main/docs/metrics-component.adoc +:docTitle: Metrics +:artifactId: camel-metrics +:description: To collect various metrics directly from Camel routes using the DropWizard metrics library. +:since: 2.14 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Metrics component allows to collect various metrics directly from Camel routes. Supported metric types diff --git a/docs/components/modules/ROOT/pages/micrometer-component.adoc b/docs/components/modules/ROOT/pages/micrometer-component.adoc index bb4172d3552a8..5837ea6046885 100644 --- a/docs/components/modules/ROOT/pages/micrometer-component.adoc +++ b/docs/components/modules/ROOT/pages/micrometer-component.adoc @@ -1,12 +1,16 @@ [[micrometer-component]] = Micrometer Component :page-source: components/camel-micrometer/src/main/docs/micrometer-component.adoc +:docTitle: Micrometer +:artifactId: camel-micrometer +:description: To collect various metrics directly from Camel routes using the Micrometer library. +:since: 2.22 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.22* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Micrometer component allows to collect various metrics directly from Camel routes. Supported metric types diff --git a/docs/components/modules/ROOT/pages/microprofile-metrics-component.adoc b/docs/components/modules/ROOT/pages/microprofile-metrics-component.adoc index 305b522ceb342..46e2c29ec24f2 100644 --- a/docs/components/modules/ROOT/pages/microprofile-metrics-component.adoc +++ b/docs/components/modules/ROOT/pages/microprofile-metrics-component.adoc @@ -1,12 +1,16 @@ [[microprofile-metrics-component]] = MicroProfile Metrics Component :page-source: components/camel-microprofile-metrics/src/main/docs/microprofile-metrics-component.adoc +:docTitle: MicroProfile Metrics +:artifactId: camel-microprofile-metrics +:description: Camel metrics exposed with Eclipse MicroProfile Metrics +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The MircoProfile Metrics component provides the capability to expose metrics from Camel routes. diff --git a/docs/components/modules/ROOT/pages/milo-client-component.adoc b/docs/components/modules/ROOT/pages/milo-client-component.adoc index ba2c6e7d8d166..7f88912dd06c1 100644 --- a/docs/components/modules/ROOT/pages/milo-client-component.adoc +++ b/docs/components/modules/ROOT/pages/milo-client-component.adoc @@ -1,12 +1,16 @@ [[milo-client-component]] = OPC UA Client Component :page-source: components/camel-milo/src/main/docs/milo-client-component.adoc +:docTitle: OPC UA Client +:artifactId: camel-milo +:description: Connect to OPC UA servers using the binary protocol for acquiring telemetry data +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Milo Client component provides access to OPC UA servers using the http://eclipse.org/milo[Eclipse Miloâ„¢] implementation. diff --git a/docs/components/modules/ROOT/pages/milo-server-component.adoc b/docs/components/modules/ROOT/pages/milo-server-component.adoc index 871b87403f49c..001b9a254b652 100644 --- a/docs/components/modules/ROOT/pages/milo-server-component.adoc +++ b/docs/components/modules/ROOT/pages/milo-server-component.adoc @@ -1,12 +1,16 @@ [[milo-server-component]] = OPC UA Server Component :page-source: components/camel-milo/src/main/docs/milo-server-component.adoc +:docTitle: OPC UA Server +:artifactId: camel-milo +:description: Make telemetry data available as an OPC UA server +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Milo Server component provides an OPC UA server using the http://eclipse.org/milo[Eclipse Miloâ„¢] implementation. diff --git a/docs/components/modules/ROOT/pages/mina-component.adoc b/docs/components/modules/ROOT/pages/mina-component.adoc index b6d9bd66f7451..7bd098b7274d1 100644 --- a/docs/components/modules/ROOT/pages/mina-component.adoc +++ b/docs/components/modules/ROOT/pages/mina-component.adoc @@ -1,12 +1,16 @@ [[mina-component]] = Mina Component :page-source: components/camel-mina/src/main/docs/mina-component.adoc +:docTitle: Mina +:artifactId: camel-mina +:description: Socket level networking using TCP or UDP with the Apache Mina 2.x library. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Mina component is a transport for working with http://mina.apache.org/[Apache MINA 2.x] diff --git a/docs/components/modules/ROOT/pages/mllp-component.adoc b/docs/components/modules/ROOT/pages/mllp-component.adoc index baeb3d3db0f33..7773b40208d61 100644 --- a/docs/components/modules/ROOT/pages/mllp-component.adoc +++ b/docs/components/modules/ROOT/pages/mllp-component.adoc @@ -1,12 +1,16 @@ [[mllp-component]] = MLLP Component :page-source: components/camel-mllp/src/main/docs/mllp-component.adoc +:docTitle: MLLP +:artifactId: camel-mllp +:description: Provides functionality required by Healthcare providers to communicate with other systems using the MLLP protocol. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The MLLP component is specifically designed to handle the nuances of the MLLP protocol and provide the functionality required by Healthcare diff --git a/docs/components/modules/ROOT/pages/mock-component.adoc b/docs/components/modules/ROOT/pages/mock-component.adoc index 8f96373605b8e..e1dfd397edc59 100644 --- a/docs/components/modules/ROOT/pages/mock-component.adoc +++ b/docs/components/modules/ROOT/pages/mock-component.adoc @@ -1,12 +1,17 @@ [[mock-component]] = Mock Component :page-source: components/camel-mock/src/main/docs/mock-component.adoc +:docTitle: Mock +:artifactId: camel-mock +:description: The mock component is used for testing routes and mediation rules using mocks. +:since: 1.0 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* Testing of distributed and asynchronous processing is notoriously difficult. The xref:mock-component.adoc[Mock], xref:mock-component.adoc[Test] @@ -38,7 +43,7 @@ Expression. [NOTE] ==== -There is also the xref:test.adoc[Test endpoint] which is a +There is also the xref:others:test.adoc[Test endpoint] which is a Mock endpoint, but which uses a second endpoint to provide the list of expected message bodies and automatically sets up the Mock endpoint assertions. In other words, it's a Mock endpoint that automatically sets diff --git a/docs/components/modules/ROOT/pages/mongodb-component.adoc b/docs/components/modules/ROOT/pages/mongodb-component.adoc index 0288ab5089ab9..af517d8baa846 100644 --- a/docs/components/modules/ROOT/pages/mongodb-component.adoc +++ b/docs/components/modules/ROOT/pages/mongodb-component.adoc @@ -1,12 +1,16 @@ [[mongodb-component]] = MongoDB Component :page-source: components/camel-mongodb/src/main/docs/mongodb-component.adoc +:docTitle: MongoDB +:artifactId: camel-mongodb +:description: Component for working with documents stored in MongoDB database. +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* [NOTE] ==== diff --git a/docs/components/modules/ROOT/pages/mongodb-gridfs-component.adoc b/docs/components/modules/ROOT/pages/mongodb-gridfs-component.adoc index 5d0477e6977d4..0f94068112743 100644 --- a/docs/components/modules/ROOT/pages/mongodb-gridfs-component.adoc +++ b/docs/components/modules/ROOT/pages/mongodb-gridfs-component.adoc @@ -1,12 +1,16 @@ [[mongodb-gridfs-component]] = MongoDB GridFS Component :page-source: components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc +:docTitle: MongoDB GridFS +:artifactId: camel-mongodb-gridfs +:description: Component for working with MongoDB GridFS. +:since: 2.18 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Maven users will need to add the following dependency to their `pom.xml` for this component: diff --git a/docs/components/modules/ROOT/pages/msv-component.adoc b/docs/components/modules/ROOT/pages/msv-component.adoc index d1fae04a74c04..92c4aedd02840 100644 --- a/docs/components/modules/ROOT/pages/msv-component.adoc +++ b/docs/components/modules/ROOT/pages/msv-component.adoc @@ -1,12 +1,16 @@ [[msv-component]] = MSV Component :page-source: components/camel-msv/src/main/docs/msv-component.adoc +:docTitle: MSV +:artifactId: camel-msv +:description: Validates the payload of a message using the MSV Library. +:since: 1.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The MSV component performs XML validation of the message body using the https://msv.dev.java.net/[MSV Library] and any of the supported XML diff --git a/docs/components/modules/ROOT/pages/mustache-component.adoc b/docs/components/modules/ROOT/pages/mustache-component.adoc index 2fb1310dd59f5..b5c6146c55550 100644 --- a/docs/components/modules/ROOT/pages/mustache-component.adoc +++ b/docs/components/modules/ROOT/pages/mustache-component.adoc @@ -1,12 +1,16 @@ [[mustache-component]] = Mustache Component :page-source: components/camel-mustache/src/main/docs/mustache-component.adoc +:docTitle: Mustache +:artifactId: camel-mustache +:description: Transforms the message using a Mustache template. +:since: 2.12 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Mustache component allows for processing a message using a http://mustache.github.io/[Mustache] template. This can be ideal when diff --git a/docs/components/modules/ROOT/pages/mvel-component.adoc b/docs/components/modules/ROOT/pages/mvel-component.adoc index 05cd7a42d167c..74b91ac86ad75 100644 --- a/docs/components/modules/ROOT/pages/mvel-component.adoc +++ b/docs/components/modules/ROOT/pages/mvel-component.adoc @@ -1,12 +1,16 @@ [[mvel-component]] = MVEL Component :page-source: components/camel-mvel/src/main/docs/mvel-component.adoc +:docTitle: MVEL +:artifactId: camel-mvel +:description: Transforms the message using a MVEL template. +:since: 2.12 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The MVEL component allows you to process a message using an http://mvel.documentnode.com/[MVEL] template. This can be ideal when using diff --git a/docs/components/modules/ROOT/pages/mybatis-bean-component.adoc b/docs/components/modules/ROOT/pages/mybatis-bean-component.adoc index fc4a6a77a8a91..5a06cc528253c 100644 --- a/docs/components/modules/ROOT/pages/mybatis-bean-component.adoc +++ b/docs/components/modules/ROOT/pages/mybatis-bean-component.adoc @@ -1,12 +1,16 @@ [[mybatis-bean-component]] = MyBatis Bean Component :page-source: components/camel-mybatis/src/main/docs/mybatis-bean-component.adoc +:docTitle: MyBatis Bean +:artifactId: camel-mybatis +:description: Performs a query, insert, update or delete in a relational database using MyBatis. +:since: 2.22 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.22* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The MyBatis Bean component allows you to query, insert, update and delete data in a relational database using http://mybatis.org/[MyBatis] bean annotations. diff --git a/docs/components/modules/ROOT/pages/mybatis-component.adoc b/docs/components/modules/ROOT/pages/mybatis-component.adoc index 1ad39187f6cca..aae66742aab41 100644 --- a/docs/components/modules/ROOT/pages/mybatis-component.adoc +++ b/docs/components/modules/ROOT/pages/mybatis-component.adoc @@ -1,12 +1,16 @@ [[mybatis-component]] = MyBatis Component :page-source: components/camel-mybatis/src/main/docs/mybatis-component.adoc +:docTitle: MyBatis +:artifactId: camel-mybatis +:description: Performs a query, poll, insert, update or delete in a relational database using MyBatis. +:since: 2.7 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.7* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The MyBatis component allows you to query, poll, insert, update and delete data in a relational database using http://mybatis.org/[MyBatis]. diff --git a/docs/components/modules/ROOT/pages/nagios-component.adoc b/docs/components/modules/ROOT/pages/nagios-component.adoc index 5e7bcfcf359de..61aaaa8d2decc 100644 --- a/docs/components/modules/ROOT/pages/nagios-component.adoc +++ b/docs/components/modules/ROOT/pages/nagios-component.adoc @@ -1,12 +1,16 @@ [[nagios-component]] = Nagios Component :page-source: components/camel-nagios/src/main/docs/nagios-component.adoc +:docTitle: Nagios +:artifactId: camel-nagios +:description: To send passive checks to Nagios using JSendNSCA. +:since: 2.3 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.3* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The xref:nagios-component.adoc[Nagios] component allows you to send passive checks to http://nagios.org[Nagios]. diff --git a/docs/components/modules/ROOT/pages/nats-component.adoc b/docs/components/modules/ROOT/pages/nats-component.adoc index 159a9d060b8ee..b7279589ac6ff 100644 --- a/docs/components/modules/ROOT/pages/nats-component.adoc +++ b/docs/components/modules/ROOT/pages/nats-component.adoc @@ -1,12 +1,16 @@ [[nats-component]] = Nats Component :page-source: components/camel-nats/src/main/docs/nats-component.adoc +:docTitle: Nats +:artifactId: camel-nats +:description: The nats component allows you produce and consume messages from NATS. +:since: 2.17 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* http://nats.io/[NATS] is a fast and reliable messaging platform. diff --git a/docs/components/modules/ROOT/pages/netty-component.adoc b/docs/components/modules/ROOT/pages/netty-component.adoc index 51ae93e2e0b8e..6070817dfbd8f 100644 --- a/docs/components/modules/ROOT/pages/netty-component.adoc +++ b/docs/components/modules/ROOT/pages/netty-component.adoc @@ -1,12 +1,16 @@ [[netty-component]] = Netty Component :page-source: components/camel-netty/src/main/docs/netty-component.adoc +:docTitle: Netty +:artifactId: camel-netty +:description: Socket level networking using TCP or UDP with the Netty 4.x library. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Netty component in Camel is a socket communication component, based on the http://netty.io/[Netty] project version 4. + diff --git a/docs/components/modules/ROOT/pages/netty-http-component.adoc b/docs/components/modules/ROOT/pages/netty-http-component.adoc index ede5a455e5cd0..7b72591ca0f4e 100644 --- a/docs/components/modules/ROOT/pages/netty-http-component.adoc +++ b/docs/components/modules/ROOT/pages/netty-http-component.adoc @@ -1,12 +1,16 @@ [[netty-http-component]] = Netty HTTP Component :page-source: components/camel-netty-http/src/main/docs/netty-http-component.adoc +:docTitle: Netty HTTP +:artifactId: camel-netty-http +:description: Netty HTTP server and client using the Netty 4.x library. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Netty HTTP component is an extension to xref:netty-component.adoc[Netty] component to facilitiate HTTP transport with xref:netty-component.adoc[Netty]. diff --git a/docs/components/modules/ROOT/pages/nitrite-component.adoc b/docs/components/modules/ROOT/pages/nitrite-component.adoc index 2a0d70945fd9b..6e858c5a5b2e1 100644 --- a/docs/components/modules/ROOT/pages/nitrite-component.adoc +++ b/docs/components/modules/ROOT/pages/nitrite-component.adoc @@ -1,12 +1,16 @@ [[nitrite-component]] = Nitrite Component :page-source: components/camel-nitrite/src/main/docs/nitrite-component.adoc +:docTitle: Nitrite +:artifactId: camel-nitrite +:description: Used for integrating Camel with Nitrite databases. +:since: 3.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Nitrite component is used to access https://github.com/dizitart/nitrite-database[Nitrite NoSQL database] diff --git a/docs/components/modules/ROOT/pages/nsq-component.adoc b/docs/components/modules/ROOT/pages/nsq-component.adoc index 7a11fb07bbe0e..27bd7469c688b 100644 --- a/docs/components/modules/ROOT/pages/nsq-component.adoc +++ b/docs/components/modules/ROOT/pages/nsq-component.adoc @@ -1,12 +1,16 @@ [[nsq-component]] = NSQ Component :page-source: components/camel-nsq/src/main/docs/nsq-component.adoc +:docTitle: NSQ +:artifactId: camel-nsq +:description: Represents a nsq endpoint. +:since: 2.23 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* http://nsq.io/[NSQ] is a realtime distributed messaging platform. diff --git a/docs/components/modules/ROOT/pages/olingo2-component.adoc b/docs/components/modules/ROOT/pages/olingo2-component.adoc index 3e30a237a74e0..0ae2deb48d8fb 100644 --- a/docs/components/modules/ROOT/pages/olingo2-component.adoc +++ b/docs/components/modules/ROOT/pages/olingo2-component.adoc @@ -1,12 +1,16 @@ [[olingo2-component]] = Olingo2 Component :page-source: components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc +:docTitle: Olingo2 +:artifactId: camel-olingo2 +:description: Communicates with OData 2.0 services using Apache Olingo. +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Olingo2 component utilizes http://olingo.apache.org/[Apache Olingo] version 2.0 APIs to interact with OData 2.0 compliant services. @@ -330,4 +334,3 @@ from("olingo2://read/Manufacturers?queryParams=#paramsBean&timeUnit=SECONDS&dela --------------------------------------------------------------------------------------------------------- include::camel-spring-boot::page$olingo2-starter.adoc[] - diff --git a/docs/components/modules/ROOT/pages/olingo4-component.adoc b/docs/components/modules/ROOT/pages/olingo4-component.adoc index 7fc427960f571..c154600f24416 100644 --- a/docs/components/modules/ROOT/pages/olingo4-component.adoc +++ b/docs/components/modules/ROOT/pages/olingo4-component.adoc @@ -1,12 +1,16 @@ [[olingo4-component]] = Olingo4 Component :page-source: components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc +:docTitle: Olingo4 +:artifactId: camel-olingo4 +:description: Communicates with OData 4.0 services using Apache Olingo OData API. +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Olingo4 component utilizes http://olingo.apache.org/[Apache Olingo] version 4.0 APIs to interact with OData 4.0 compliant service. @@ -308,4 +312,3 @@ from("direct:...") ------------------------------------------------------------ include::camel-spring-boot::page$olingo4-starter.adoc[] - diff --git a/docs/components/modules/ROOT/pages/openshift-build-configs-component.adoc b/docs/components/modules/ROOT/pages/openshift-build-configs-component.adoc index aa9c2f15b7c5d..e573d847ead46 100644 --- a/docs/components/modules/ROOT/pages/openshift-build-configs-component.adoc +++ b/docs/components/modules/ROOT/pages/openshift-build-configs-component.adoc @@ -1,14 +1,18 @@ [[openshift-build-configs-component]] = Openshift Build Config Component :page-source: components/camel-kubernetes/src/main/docs/openshift-build-configs-component.adoc +:docTitle: Openshift Build Config +:artifactId: camel-kubernetes +:description: The Kubernetes Build Config component provides a producer to execute kubernetes build config operations. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* -The OpenShift Build Config component is one of xref:kubernetes.adoc[Kubernetes Components] which +The OpenShift Build Config component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes build config operations. diff --git a/docs/components/modules/ROOT/pages/openshift-builds-component.adoc b/docs/components/modules/ROOT/pages/openshift-builds-component.adoc index 71a882c30892c..0a68f1ea4c72f 100644 --- a/docs/components/modules/ROOT/pages/openshift-builds-component.adoc +++ b/docs/components/modules/ROOT/pages/openshift-builds-component.adoc @@ -1,14 +1,18 @@ [[openshift-builds-component]] = Openshift Builds Component :page-source: components/camel-kubernetes/src/main/docs/openshift-builds-component.adoc +:docTitle: Openshift Builds +:artifactId: camel-kubernetes +:description: The Openshift Builds component provides a producer to execute openshift build operations. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* -The Kubernetes Builds component is one of xref:kubernetes.adoc[Kubernetes Components] which +The Kubernetes Builds component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which provides a producer to execute kubernetes build operations. diff --git a/docs/components/modules/ROOT/pages/openstack-cinder-component.adoc b/docs/components/modules/ROOT/pages/openstack-cinder-component.adoc index a045985728530..0615c584ed415 100644 --- a/docs/components/modules/ROOT/pages/openstack-cinder-component.adoc +++ b/docs/components/modules/ROOT/pages/openstack-cinder-component.adoc @@ -1,12 +1,16 @@ [[openstack-cinder-component]] = OpenStack Cinder Component :page-source: components/camel-openstack/src/main/docs/openstack-cinder-component.adoc +:docTitle: OpenStack Cinder +:artifactId: camel-openstack +:description: The openstack-cinder component allows messages to be sent to an OpenStack block storage services. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Openstack Cinder component allows messages to be sent to an OpenStack block storage services. diff --git a/docs/components/modules/ROOT/pages/openstack-glance-component.adoc b/docs/components/modules/ROOT/pages/openstack-glance-component.adoc index 8b691e1af3292..d561cd4ad4787 100644 --- a/docs/components/modules/ROOT/pages/openstack-glance-component.adoc +++ b/docs/components/modules/ROOT/pages/openstack-glance-component.adoc @@ -1,12 +1,16 @@ [[openstack-glance-component]] = OpenStack Glance Component :page-source: components/camel-openstack/src/main/docs/openstack-glance-component.adoc +:docTitle: OpenStack Glance +:artifactId: camel-openstack +:description: The openstack-glance component allows messages to be sent to an OpenStack image services. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Openstack Glance component allows messages to be sent to an OpenStack image services. diff --git a/docs/components/modules/ROOT/pages/openstack-keystone-component.adoc b/docs/components/modules/ROOT/pages/openstack-keystone-component.adoc index 824c40ec75567..fcbc915b3ec0e 100644 --- a/docs/components/modules/ROOT/pages/openstack-keystone-component.adoc +++ b/docs/components/modules/ROOT/pages/openstack-keystone-component.adoc @@ -1,12 +1,16 @@ [[openstack-keystone-component]] = OpenStack Keystone Component :page-source: components/camel-openstack/src/main/docs/openstack-keystone-component.adoc +:docTitle: OpenStack Keystone +:artifactId: camel-openstack +:description: The openstack-keystone component allows messages to be sent to an OpenStack identity services. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Openstack Keystone component allows messages to be sent to an OpenStack identity services. diff --git a/docs/components/modules/ROOT/pages/openstack-neutron-component.adoc b/docs/components/modules/ROOT/pages/openstack-neutron-component.adoc index ed1f6d7d7df71..2105c171c4963 100644 --- a/docs/components/modules/ROOT/pages/openstack-neutron-component.adoc +++ b/docs/components/modules/ROOT/pages/openstack-neutron-component.adoc @@ -1,12 +1,16 @@ [[openstack-neutron-component]] = OpenStack Neutron Component :page-source: components/camel-openstack/src/main/docs/openstack-neutron-component.adoc +:docTitle: OpenStack Neutron +:artifactId: camel-openstack +:description: The openstack-neutron component allows messages to be sent to an OpenStack network services. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Openstack Neutron component allows messages to be sent to an OpenStack network services. diff --git a/docs/components/modules/ROOT/pages/openstack-nova-component.adoc b/docs/components/modules/ROOT/pages/openstack-nova-component.adoc index 29bc378cc93e4..2799583ef171e 100644 --- a/docs/components/modules/ROOT/pages/openstack-nova-component.adoc +++ b/docs/components/modules/ROOT/pages/openstack-nova-component.adoc @@ -1,12 +1,16 @@ [[openstack-nova-component]] = OpenStack Nova Component :page-source: components/camel-openstack/src/main/docs/openstack-nova-component.adoc +:docTitle: OpenStack Nova +:artifactId: camel-openstack +:description: The openstack-nova component allows messages to be sent to an OpenStack compute services. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Openstack Nova component allows messages to be sent to an OpenStack compute services. diff --git a/docs/components/modules/ROOT/pages/openstack.adoc b/docs/components/modules/ROOT/pages/openstack-summary.adoc similarity index 94% rename from docs/components/modules/ROOT/pages/openstack.adoc rename to docs/components/modules/ROOT/pages/openstack-summary.adoc index 23ff0abb4dc42..ea5dbd3b0697b 100644 --- a/docs/components/modules/ROOT/pages/openstack.adoc +++ b/docs/components/modules/ROOT/pages/openstack-summary.adoc @@ -1,8 +1,11 @@ [[Openstack-OpenstackComponent]] = Openstack Component -:page-source: components/camel-openstack/src/main/docs/openstack.adoc +:page-source: components/camel-openstack/src/main/docs/openstack-summary.adoc +//attributes written by hand, not generated +:docTitle: Openstack +:since: 2.19 -*Since Camel 2.19* +*Since Camel {since}* The Openstack component is a component for managing your https://www.openstack.org//[OpenStack] applications. diff --git a/docs/components/modules/ROOT/pages/openstack-swift-component.adoc b/docs/components/modules/ROOT/pages/openstack-swift-component.adoc index 422335306b469..ccb06d16ea172 100644 --- a/docs/components/modules/ROOT/pages/openstack-swift-component.adoc +++ b/docs/components/modules/ROOT/pages/openstack-swift-component.adoc @@ -1,12 +1,16 @@ [[openstack-swift-component]] = OpenStack Swift Component :page-source: components/camel-openstack/src/main/docs/openstack-swift-component.adoc +:docTitle: OpenStack Swift +:artifactId: camel-openstack +:description: The openstack-swift component allows messages to be sent to an OpenStack object storage services. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Openstack Swift component allows messages to be sent to an OpenStack object storage services. diff --git a/docs/components/modules/ROOT/pages/optaplanner-component.adoc b/docs/components/modules/ROOT/pages/optaplanner-component.adoc index 270278a9659bd..7f4252b772bea 100644 --- a/docs/components/modules/ROOT/pages/optaplanner-component.adoc +++ b/docs/components/modules/ROOT/pages/optaplanner-component.adoc @@ -1,12 +1,16 @@ [[optaplanner-component]] = OptaPlanner Component :page-source: components/camel-optaplanner/src/main/docs/optaplanner-component.adoc +:docTitle: OptaPlanner +:artifactId: camel-optaplanner +:description: Solves the planning problem contained in a message with OptaPlanner. +:since: 2.13 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.13* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Optaplanner component solves the planning problem contained in a message with http://www.optaplanner.org/[OptaPlanner]. + diff --git a/docs/components/modules/ROOT/pages/paho-component.adoc b/docs/components/modules/ROOT/pages/paho-component.adoc index fec37bc36fefc..a36d5608353c6 100644 --- a/docs/components/modules/ROOT/pages/paho-component.adoc +++ b/docs/components/modules/ROOT/pages/paho-component.adoc @@ -1,12 +1,16 @@ [[paho-component]] = Paho Component :page-source: components/camel-paho/src/main/docs/paho-component.adoc +:docTitle: Paho +:artifactId: camel-paho +:description: Component for communicating with MQTT message brokers using Eclipse Paho MQTT Client. +:since: 2.16 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Paho component provides connector for the MQTT messaging protocol using the https://eclipse.org/paho/[Eclipse Paho] library. Paho is one of the diff --git a/docs/components/modules/ROOT/pages/pdf-component.adoc b/docs/components/modules/ROOT/pages/pdf-component.adoc index 2a655584f4342..1c5163c91b292 100644 --- a/docs/components/modules/ROOT/pages/pdf-component.adoc +++ b/docs/components/modules/ROOT/pages/pdf-component.adoc @@ -1,12 +1,16 @@ [[pdf-component]] = PDF Component :page-source: components/camel-pdf/src/main/docs/pdf-component.adoc +:docTitle: PDF +:artifactId: camel-pdf +:description: The pdf components provides the ability to create, modify or extract content from PDF documents. +:since: 2.16 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The PDF components provides the ability to create, modify or extract content from PDF documents. This component uses diff --git a/docs/components/modules/ROOT/pages/pg-replication-slot-component.adoc b/docs/components/modules/ROOT/pages/pg-replication-slot-component.adoc index 58692d47e2540..f4eed3365093b 100644 --- a/docs/components/modules/ROOT/pages/pg-replication-slot-component.adoc +++ b/docs/components/modules/ROOT/pages/pg-replication-slot-component.adoc @@ -1,12 +1,16 @@ [[pg-replication-slot-component]] = PostgresSQL Replication Slot Component :page-source: components/camel-pg-replication-slot/src/main/docs/pg-replication-slot-component.adoc +:docTitle: PostgresSQL Replication Slot +:artifactId: camel-pg-replication-slot +:description: Consumer endpoint to receive from PostgreSQL Replication Slot. +:since: 3.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* This is a component for Apache Camel which allows for consuming from PostgreSQL replication slots. The component works with PostgreSQL 10 or later. diff --git a/docs/components/modules/ROOT/pages/pgevent-component.adoc b/docs/components/modules/ROOT/pages/pgevent-component.adoc index 2ca567e37bb4f..80830d8c4ca76 100644 --- a/docs/components/modules/ROOT/pages/pgevent-component.adoc +++ b/docs/components/modules/ROOT/pages/pgevent-component.adoc @@ -1,12 +1,16 @@ [[pgevent-component]] = PostgresSQL Event Component :page-source: components/camel-pgevent/src/main/docs/pgevent-component.adoc +:docTitle: PostgresSQL Event +:artifactId: camel-pgevent +:description: The pgevent component allows for producing/consuming PostgreSQL events related to the listen/notify commands. +:since: 2.15 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This is a component for Apache Camel which allows for Producing/Consuming PostgreSQL events related to the LISTEN/NOTIFY diff --git a/docs/components/modules/ROOT/pages/platform-http-component.adoc b/docs/components/modules/ROOT/pages/platform-http-component.adoc index 1bb1b2b480ff4..32788ff6cab27 100644 --- a/docs/components/modules/ROOT/pages/platform-http-component.adoc +++ b/docs/components/modules/ROOT/pages/platform-http-component.adoc @@ -1,12 +1,16 @@ [[platform-http-component]] = Platform HTTP Component :page-source: components/camel-platform-http/src/main/docs/platform-http-component.adoc +:docTitle: Platform HTTP +:artifactId: camel-platform-http +:description: HTTP service leveraging existing runtime platform HTTP server +:since: 3.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* *Since Camel 3.0* diff --git a/docs/components/modules/ROOT/pages/properties-component.adoc b/docs/components/modules/ROOT/pages/properties-component.adoc index 0a2500d9cf568..d885f28867a33 100644 --- a/docs/components/modules/ROOT/pages/properties-component.adoc +++ b/docs/components/modules/ROOT/pages/properties-component.adoc @@ -1,8 +1,14 @@ [[properties-component]] = Properties Component :page-source: core/camel-base/src/main/docs/properties-component.adoc - -*Since Camel 2.3* +//Written by hand, not generated. +:docTitle: Properties +:artifactId: camel-base +:description: The properties component is used for property placeholders in your Camel application, such as endpoint URIs. +:since: 2.3 +:supportLevel: Stable + +*Since Camel {since}* The properties component is used for property placeholders in your Camel application, such as endpoint URIs. It is *not* a regular Camel component with producer and consumer for routing messages. However for historical diff --git a/docs/components/modules/ROOT/pages/pubnub-component.adoc b/docs/components/modules/ROOT/pages/pubnub-component.adoc index 7c7a2ef832948..25631c9911bbb 100644 --- a/docs/components/modules/ROOT/pages/pubnub-component.adoc +++ b/docs/components/modules/ROOT/pages/pubnub-component.adoc @@ -1,12 +1,16 @@ [[pubnub-component]] = PubNub Component :page-source: components/camel-pubnub/src/main/docs/pubnub-component.adoc +:docTitle: PubNub +:artifactId: camel-pubnub +:description: To send and receive messages to PubNub data stream network for connected devices. +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Camel PubNub component can be used to communicate with the https://www.pubnub.com/[PubNub] data stream network for connected devices. This component uses pubnub https://github.com/pubnub/java[java library]. diff --git a/docs/components/modules/ROOT/pages/pulsar-component.adoc b/docs/components/modules/ROOT/pages/pulsar-component.adoc index 5cbe1e3432cdb..04032ee7f5238 100644 --- a/docs/components/modules/ROOT/pages/pulsar-component.adoc +++ b/docs/components/modules/ROOT/pages/pulsar-component.adoc @@ -1,12 +1,16 @@ [[pulsar-component]] = Pulsar Component :page-source: components/camel-pulsar/src/main/docs/pulsar-component.adoc +:docTitle: Pulsar +:artifactId: camel-pulsar +:description: Camel Apache Pulsar Component +:since: 2.24 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.24* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Maven users will need to add the following dependency to their `pom.xml` for this component. diff --git a/docs/components/modules/ROOT/pages/quartz-component.adoc b/docs/components/modules/ROOT/pages/quartz-component.adoc index 62c234bf5ab3a..6633fa9838c96 100644 --- a/docs/components/modules/ROOT/pages/quartz-component.adoc +++ b/docs/components/modules/ROOT/pages/quartz-component.adoc @@ -1,12 +1,16 @@ [[quartz-component]] = Quartz Component :page-source: components/camel-quartz/src/main/docs/quartz-component.adoc +:docTitle: Quartz +:artifactId: camel-quartz +:description: Provides a scheduled delivery of messages using the Quartz 2.x scheduler. +:since: 2.12 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Quartz component provides a scheduled delivery of messages using the http://www.quartz-scheduler.org/[Quartz Scheduler 2.x]. + diff --git a/docs/components/modules/ROOT/pages/quickfix-component.adoc b/docs/components/modules/ROOT/pages/quickfix-component.adoc index 2a8ef6a2c5daf..9990d21db07e9 100644 --- a/docs/components/modules/ROOT/pages/quickfix-component.adoc +++ b/docs/components/modules/ROOT/pages/quickfix-component.adoc @@ -1,12 +1,16 @@ [[quickfix-component]] = QuickFix Component :page-source: components/camel-quickfix/src/main/docs/quickfix-component.adoc +:docTitle: QuickFix +:artifactId: camel-quickfix +:description: The quickfix component allows to send Financial Interchange (FIX) messages to the QuickFix engine. +:since: 2.1 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.1* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Quickfix component adapts the http://www.quickfixj.org/[QuickFIX/J] FIX engine for using in Camel . diff --git a/docs/components/modules/ROOT/pages/rabbitmq-component.adoc b/docs/components/modules/ROOT/pages/rabbitmq-component.adoc index a6f71d7f90e92..8d541e818ee45 100644 --- a/docs/components/modules/ROOT/pages/rabbitmq-component.adoc +++ b/docs/components/modules/ROOT/pages/rabbitmq-component.adoc @@ -1,12 +1,16 @@ [[rabbitmq-component]] = RabbitMQ Component :page-source: components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc +:docTitle: RabbitMQ +:artifactId: camel-rabbitmq +:description: The rabbitmq component allows you produce and consume messages from RabbitMQ instances. +:since: 2.12 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The RabbitMQ component allows you produce and consume messages from http://www.rabbitmq.com/[RabbitMQ] instances. Using the RabbitMQ AMQP diff --git a/docs/components/modules/ROOT/pages/reactive-streams-component.adoc b/docs/components/modules/ROOT/pages/reactive-streams-component.adoc index 11e05e7a136a8..5c9b068e7b0c3 100644 --- a/docs/components/modules/ROOT/pages/reactive-streams-component.adoc +++ b/docs/components/modules/ROOT/pages/reactive-streams-component.adoc @@ -1,12 +1,16 @@ [[reactive-streams-component]] = Reactive Streams Component :page-source: components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc +:docTitle: Reactive Streams +:artifactId: camel-reactive-streams +:description: Reactive Camel using reactive streams +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Reactive Streams component allows you to exchange messages with reactive stream processing libraries compatible with the diff --git a/docs/components/modules/ROOT/pages/ref-component.adoc b/docs/components/modules/ROOT/pages/ref-component.adoc index 01924b1037832..8a8afb1d259c6 100644 --- a/docs/components/modules/ROOT/pages/ref-component.adoc +++ b/docs/components/modules/ROOT/pages/ref-component.adoc @@ -1,12 +1,17 @@ [[ref-component]] = Ref Component :page-source: components/camel-ref/src/main/docs/ref-component.adoc +:docTitle: Ref +:artifactId: camel-ref +:description: The ref component is used for lookup of existing endpoints bound in the Registry. +:since: 1.2 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 1.2* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Ref component is used for lookup of existing endpoints bound in the Registry. diff --git a/docs/components/modules/ROOT/pages/rest-api-component.adoc b/docs/components/modules/ROOT/pages/rest-api-component.adoc index 4026199ddac8f..803b237699e40 100644 --- a/docs/components/modules/ROOT/pages/rest-api-component.adoc +++ b/docs/components/modules/ROOT/pages/rest-api-component.adoc @@ -1,12 +1,17 @@ [[rest-api-component]] = REST API Component :page-source: components/camel-rest/src/main/docs/rest-api-component.adoc +:docTitle: REST API +:artifactId: camel-rest +:description: The rest-api component is used for providing Swagger API of the REST services which has been defined using the rest-dsl in Camel. +:since: 2.16 +:supportLevel: Stable +:component-header: Only consumer is supported +:core: -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The REST API component is used for providing Swagger API of the REST services which has been defined using the rest-dsl in Camel. diff --git a/docs/components/modules/ROOT/pages/rest-component.adoc b/docs/components/modules/ROOT/pages/rest-component.adoc index c1c446d97ae70..28f2fd7237629 100644 --- a/docs/components/modules/ROOT/pages/rest-component.adoc +++ b/docs/components/modules/ROOT/pages/rest-component.adoc @@ -1,12 +1,17 @@ [[rest-component]] = REST Component :page-source: components/camel-rest/src/main/docs/rest-component.adoc +:docTitle: REST +:artifactId: camel-rest +:description: The rest component is used for either hosting REST services (consumer) or calling external REST services (producer). +:since: 2.14 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 2.14* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The REST component allows to define REST endpoints (consumer) using the Rest DSL and plugin to other Camel components as the diff --git a/docs/components/modules/ROOT/pages/rest-openapi-component.adoc b/docs/components/modules/ROOT/pages/rest-openapi-component.adoc index 1f8a8c9bf78a5..ad8007b97294b 100644 --- a/docs/components/modules/ROOT/pages/rest-openapi-component.adoc +++ b/docs/components/modules/ROOT/pages/rest-openapi-component.adoc @@ -1,15 +1,17 @@ [[rest-openapi-component]] = REST OpenApi Component :page-source: components/camel-rest-openapi/src/main/docs/rest-openapi-component.adoc -= REST OpenApi Component -*Since Camel 3.1* +:docTitle: REST OpenApi +:artifactId: camel-rest-openapi +:description: An awesome REST endpoint backed by OpenApi specifications. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The REST OpenApi* configures rest producers from https://www.openapis.org/[OpenApi] (Open API) specification document and diff --git a/docs/components/modules/ROOT/pages/rest-swagger-component.adoc b/docs/components/modules/ROOT/pages/rest-swagger-component.adoc index 01c341b216b14..b5a12b402a5b1 100644 --- a/docs/components/modules/ROOT/pages/rest-swagger-component.adoc +++ b/docs/components/modules/ROOT/pages/rest-swagger-component.adoc @@ -1,12 +1,16 @@ [[rest-swagger-component]] = REST Swagger Component :page-source: components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc +:docTitle: REST Swagger +:artifactId: camel-rest-swagger +:description: An awesome REST endpoint backed by Swagger specifications. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The REST Swagger* configures rest producers from http://swagger.io/[Swagger] (Open API) specification document and diff --git a/docs/components/modules/ROOT/pages/robotframework-component.adoc b/docs/components/modules/ROOT/pages/robotframework-component.adoc index 0a93364ec8298..32f3d46bceca8 100644 --- a/docs/components/modules/ROOT/pages/robotframework-component.adoc +++ b/docs/components/modules/ROOT/pages/robotframework-component.adoc @@ -1,12 +1,16 @@ [[robotframework-component]] = Robot Framework Component :page-source: components/camel-robotframework/src/main/docs/robotframework-component.adoc +:docTitle: Robot Framework +:artifactId: camel-robotframework +:description: Represents a RobotFramework endpoint. +:since: 3.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The *robotframework:* component allows for processing camel exchanges diff --git a/docs/components/modules/ROOT/pages/rss-component.adoc b/docs/components/modules/ROOT/pages/rss-component.adoc index 4b55b3bbb78bb..44f77643501ac 100644 --- a/docs/components/modules/ROOT/pages/rss-component.adoc +++ b/docs/components/modules/ROOT/pages/rss-component.adoc @@ -1,12 +1,16 @@ [[rss-component]] = RSS Component :page-source: components/camel-rss/src/main/docs/rss-component.adoc +:docTitle: RSS +:artifactId: camel-rss +:description: The rss component is used for consuming RSS feeds. +:since: 2.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The RSS component is used for polling RSS feeds. Camel will default poll the feed every 60th seconds. diff --git a/docs/components/modules/ROOT/pages/saga-component.adoc b/docs/components/modules/ROOT/pages/saga-component.adoc index 189fdffabeae3..fb13fa605b07d 100644 --- a/docs/components/modules/ROOT/pages/saga-component.adoc +++ b/docs/components/modules/ROOT/pages/saga-component.adoc @@ -1,12 +1,17 @@ [[saga-component]] = Saga Component :page-source: components/camel-saga/src/main/docs/saga-component.adoc +:docTitle: Saga +:artifactId: camel-saga +:description: The saga component provides access to advanced options for managing the flow in the Saga EIP. +:since: 2.21 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 2.21* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Saga component provides a bridge to execute custom actions within a route using the Saga EIP. diff --git a/docs/components/modules/ROOT/pages/salesforce-component.adoc b/docs/components/modules/ROOT/pages/salesforce-component.adoc index 098a5c6ffeca6..04450c4f78d65 100644 --- a/docs/components/modules/ROOT/pages/salesforce-component.adoc +++ b/docs/components/modules/ROOT/pages/salesforce-component.adoc @@ -1,12 +1,16 @@ [[salesforce-component]] = Salesforce Component :page-source: components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc +:docTitle: Salesforce +:artifactId: camel-salesforce +:description: The salesforce component is used for integrating Camel with the massive Salesforce API. +:since: 2.12 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component supports producer and consumer endpoints to communicate with Salesforce using Java DTOs. + @@ -818,4 +822,3 @@ with the following path and query parameters: // endpoint options: END include::camel-spring-boot::page$salesforce-starter.adoc[] - diff --git a/docs/components/modules/ROOT/pages/sap-netweaver-component.adoc b/docs/components/modules/ROOT/pages/sap-netweaver-component.adoc index 2df62bc36dc87..d2db0d2551a90 100644 --- a/docs/components/modules/ROOT/pages/sap-netweaver-component.adoc +++ b/docs/components/modules/ROOT/pages/sap-netweaver-component.adoc @@ -1,12 +1,16 @@ [[sap-netweaver-component]] = SAP NetWeaver Component :page-source: components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc +:docTitle: SAP NetWeaver +:artifactId: camel-sap-netweaver +:description: The sap-netweaver component integrates with the SAP NetWeaver Gateway using HTTP transports. +:since: 2.12 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The SAP Netweaver integrates with the http://scn.sap.com/community/developer-center/netweaver-gateway[SAP diff --git a/docs/components/modules/ROOT/pages/scheduler-component.adoc b/docs/components/modules/ROOT/pages/scheduler-component.adoc index 7a7dda80b6b0c..def2fd40fa07a 100644 --- a/docs/components/modules/ROOT/pages/scheduler-component.adoc +++ b/docs/components/modules/ROOT/pages/scheduler-component.adoc @@ -1,12 +1,17 @@ [[scheduler-component]] = Scheduler Component :page-source: components/camel-scheduler/src/main/docs/scheduler-component.adoc +:docTitle: Scheduler +:artifactId: camel-scheduler +:description: The scheduler component is used for generating message exchanges when a scheduler fires. +:since: 2.15 +:supportLevel: Stable +:component-header: Only consumer is supported +:core: -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Scheduler component is used to generate message exchanges when a scheduler fires. This component is similar to the diff --git a/docs/components/modules/ROOT/pages/schematron-component.adoc b/docs/components/modules/ROOT/pages/schematron-component.adoc index 433a24e2e6f4a..d69351458456b 100644 --- a/docs/components/modules/ROOT/pages/schematron-component.adoc +++ b/docs/components/modules/ROOT/pages/schematron-component.adoc @@ -1,12 +1,16 @@ [[schematron-component]] = Schematron Component :page-source: components/camel-schematron/src/main/docs/schematron-component.adoc +:docTitle: Schematron +:artifactId: camel-schematron +:description: Validates the payload of a message using the Schematron Library. +:since: 2.15 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.15* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* http://www.schematron.com/index.html[Schematron] is an XML-based language for validating XML instance documents. It is used to make diff --git a/docs/components/modules/ROOT/pages/scp-component.adoc b/docs/components/modules/ROOT/pages/scp-component.adoc index 4ffb9454bed31..a99bba05b946d 100644 --- a/docs/components/modules/ROOT/pages/scp-component.adoc +++ b/docs/components/modules/ROOT/pages/scp-component.adoc @@ -1,12 +1,16 @@ [[scp-component]] = SCP Component :page-source: components/camel-jsch/src/main/docs/scp-component.adoc +:docTitle: SCP +:artifactId: camel-jsch +:description: To copy files using the secure copy protocol (SCP). +:since: 2.10 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Camel-Jsch component supports the http://en.wikipedia.org/wiki/Secure_copy[SCP protocol] using the Client diff --git a/docs/components/modules/ROOT/pages/seda-component.adoc b/docs/components/modules/ROOT/pages/seda-component.adoc index 9330881c97c50..3e2e23d462c79 100644 --- a/docs/components/modules/ROOT/pages/seda-component.adoc +++ b/docs/components/modules/ROOT/pages/seda-component.adoc @@ -1,12 +1,17 @@ [[seda-component]] = SEDA Component :page-source: components/camel-seda/src/main/docs/seda-component.adoc +:docTitle: SEDA +:artifactId: camel-seda +:description: The seda component provides asynchronous call to another endpoint from any CamelContext in the same JVM. +:since: 1.1 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The SEDA component provides asynchronous https://en.wikipedia.org/wiki/Staged_event-driven_architecture[SEDA] behavior, so that diff --git a/docs/components/modules/ROOT/pages/service-component.adoc b/docs/components/modules/ROOT/pages/service-component.adoc index ae4559e536b69..66cc7becb7d5b 100644 --- a/docs/components/modules/ROOT/pages/service-component.adoc +++ b/docs/components/modules/ROOT/pages/service-component.adoc @@ -1,12 +1,16 @@ [[service-component]] = Service Component :page-source: components/camel-service/src/main/docs/service-component.adoc +:docTitle: Service +:artifactId: camel-service +:description: Represents an endpoint which is registered to a Service Registry such as Consul, Etcd. +:since: 2.22 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.22* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* == Using the service endpoint diff --git a/docs/components/modules/ROOT/pages/servicenow-component.adoc b/docs/components/modules/ROOT/pages/servicenow-component.adoc index 4e6bc5dcd4ff5..3ec1c2628cf02 100644 --- a/docs/components/modules/ROOT/pages/servicenow-component.adoc +++ b/docs/components/modules/ROOT/pages/servicenow-component.adoc @@ -1,12 +1,16 @@ [[servicenow-component]] = ServiceNow Component :page-source: components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc +:docTitle: ServiceNow +:artifactId: camel-servicenow +:description: The servicenow component is used to integrate Camel with ServiceNow cloud services. +:since: 2.18 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The ServiceNow component provides access to ServiceNow platform through their REST API. @@ -358,4 +362,3 @@ FluentProducerTemplate.on(context) ------------------------------------------------------------------------------------------------------------------- include::camel-spring-boot::page$servicenow-starter.adoc[] - diff --git a/docs/components/modules/ROOT/pages/servlet-component.adoc b/docs/components/modules/ROOT/pages/servlet-component.adoc index d6097d54560fc..a03658a824ba3 100644 --- a/docs/components/modules/ROOT/pages/servlet-component.adoc +++ b/docs/components/modules/ROOT/pages/servlet-component.adoc @@ -1,12 +1,16 @@ [[servlet-component]] = Servlet Component :page-source: components/camel-servlet/src/main/docs/servlet-component.adoc +:docTitle: Servlet +:artifactId: camel-servlet +:description: To use a HTTP Servlet as entry for Camel routes when running in a servlet container. +:since: 2.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Servlet component provides HTTP based endpoints for consuming HTTP requests that arrive at diff --git a/docs/components/modules/ROOT/pages/sftp-component.adoc b/docs/components/modules/ROOT/pages/sftp-component.adoc index 60c374dbb83af..2a3a63e5ca996 100644 --- a/docs/components/modules/ROOT/pages/sftp-component.adoc +++ b/docs/components/modules/ROOT/pages/sftp-component.adoc @@ -1,12 +1,16 @@ [[sftp-component]] = SFTP Component :page-source: components/camel-ftp/src/main/docs/sftp-component.adoc +:docTitle: SFTP +:artifactId: camel-ftp +:description: The sftp (FTP over SSH) component is used for uploading or downloading files from SFTP servers. +:since: 1.1 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component provides access to remote file systems over the FTP and SFTP protocols. diff --git a/docs/components/modules/ROOT/pages/sip-component.adoc b/docs/components/modules/ROOT/pages/sip-component.adoc index 9dc52f149127d..d041415de07cf 100644 --- a/docs/components/modules/ROOT/pages/sip-component.adoc +++ b/docs/components/modules/ROOT/pages/sip-component.adoc @@ -1,12 +1,16 @@ [[sip-component]] = SIP Component :page-source: components/camel-sip/src/main/docs/sip-component.adoc +:docTitle: SIP +:artifactId: camel-sip +:description: To send and receive messages using the SIP protocol (used in telco and mobile). +:since: 2.5 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.5* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The SIP component in Camel is a communication component, based on the Jain SIP implementation (available under the JCP license). diff --git a/docs/components/modules/ROOT/pages/sjms-batch-component.adoc b/docs/components/modules/ROOT/pages/sjms-batch-component.adoc index c4dc57e3e4476..bc03158df2e32 100644 --- a/docs/components/modules/ROOT/pages/sjms-batch-component.adoc +++ b/docs/components/modules/ROOT/pages/sjms-batch-component.adoc @@ -1,12 +1,16 @@ [[sjms-batch-component]] = Simple JMS Batch Component :page-source: components/camel-sjms/src/main/docs/sjms-batch-component.adoc +:docTitle: Simple JMS Batch +:artifactId: camel-sjms +:description: The sjms-batch component is a specialized for highly performant, transactional batch consumption from a JMS queue. +:since: 2.16 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* SJMS Batch is a specialized component for highly performant, transactional batch consumption from a JMS queue. It can be thought of diff --git a/docs/components/modules/ROOT/pages/sjms-component.adoc b/docs/components/modules/ROOT/pages/sjms-component.adoc index d45cebb173032..cb3e03a55029c 100644 --- a/docs/components/modules/ROOT/pages/sjms-component.adoc +++ b/docs/components/modules/ROOT/pages/sjms-component.adoc @@ -1,12 +1,16 @@ [[sjms-component]] = Simple JMS Component :page-source: components/camel-sjms/src/main/docs/sjms-component.adoc +:docTitle: Simple JMS +:artifactId: camel-sjms +:description: The sjms component (simple jms) allows messages to be sent to (or consumed from) a JMS Queue or Topic (uses JMS 1.x API). +:since: 2.11 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.11* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Simple JMS Component, or SJMS, is a JMS client for use with Camel that uses well known best practices when it comes to JMS client creation diff --git a/docs/components/modules/ROOT/pages/sjms2-component.adoc b/docs/components/modules/ROOT/pages/sjms2-component.adoc index 199a80e506aaf..f443bb0d52aa0 100644 --- a/docs/components/modules/ROOT/pages/sjms2-component.adoc +++ b/docs/components/modules/ROOT/pages/sjms2-component.adoc @@ -1,12 +1,16 @@ [[sjms2-component]] = Simple JMS2 Component :page-source: components/camel-sjms2/src/main/docs/sjms2-component.adoc +:docTitle: Simple JMS2 +:artifactId: camel-sjms2 +:description: The sjms2 component (simple jms) allows messages to be sent to (or consumed from) a JMS Queue or Topic (uses JMS 2.x API). +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Simple JMS 2.0 Component, or SJMS2, is a JMS client for use with Camel that uses well known best practices when it comes to JMS client creation diff --git a/docs/components/modules/ROOT/pages/slack-component.adoc b/docs/components/modules/ROOT/pages/slack-component.adoc index fb45b07f970fd..73f58af7769f3 100644 --- a/docs/components/modules/ROOT/pages/slack-component.adoc +++ b/docs/components/modules/ROOT/pages/slack-component.adoc @@ -1,12 +1,16 @@ [[slack-component]] = Slack Component :page-source: components/camel-slack/src/main/docs/slack-component.adoc +:docTitle: Slack +:artifactId: camel-slack +:description: The slack component allows you to send messages to Slack. +:since: 2.16 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Slack component allows you to connect to an instance of http://www.slack.com/[Slack] and delivers a message contained in the diff --git a/docs/components/modules/ROOT/pages/smpp-component.adoc b/docs/components/modules/ROOT/pages/smpp-component.adoc index 840d7affca4c5..b067a1d53425b 100644 --- a/docs/components/modules/ROOT/pages/smpp-component.adoc +++ b/docs/components/modules/ROOT/pages/smpp-component.adoc @@ -1,12 +1,16 @@ [[smpp-component]] = SMPP Component :page-source: components/camel-smpp/src/main/docs/smpp-component.adoc +:docTitle: SMPP +:artifactId: camel-smpp +:description: To send and receive SMS using a SMSC (Short Message Service Center). +:since: 2.2 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.2* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component provides access to an SMSC (Short Message Service Center) over the http://smsforum.net/SMPP_v3_4_Issue1_2.zip[SMPP] protocol to diff --git a/docs/components/modules/ROOT/pages/snmp-component.adoc b/docs/components/modules/ROOT/pages/snmp-component.adoc index dcb6ecb212993..d77a0772b6343 100644 --- a/docs/components/modules/ROOT/pages/snmp-component.adoc +++ b/docs/components/modules/ROOT/pages/snmp-component.adoc @@ -1,12 +1,16 @@ [[snmp-component]] = SNMP Component :page-source: components/camel-snmp/src/main/docs/snmp-component.adoc +:docTitle: SNMP +:artifactId: camel-snmp +:description: The snmp component gives you the ability to poll SNMP capable devices or receiving traps. +:since: 2.1 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.1* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The SNMP component gives you the ability to poll SNMP capable devices or receiving traps diff --git a/docs/components/modules/ROOT/pages/solr-component.adoc b/docs/components/modules/ROOT/pages/solr-component.adoc index 92ae3245f026e..ed576879ca01a 100644 --- a/docs/components/modules/ROOT/pages/solr-component.adoc +++ b/docs/components/modules/ROOT/pages/solr-component.adoc @@ -1,12 +1,16 @@ [[solr-component]] = Solr Component :page-source: components/camel-solr/src/main/docs/solr-component.adoc +:docTitle: Solr +:artifactId: camel-solr +:description: The solr component allows you to interface with an Apache Lucene Solr server. +:since: 2.9 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.9* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Solr component allows you to interface with an http://lucene.apache.org/solr/[Apache Lucene Solr] server (based on diff --git a/docs/components/modules/ROOT/pages/soroush-component.adoc b/docs/components/modules/ROOT/pages/soroush-component.adoc index a819e5f997230..19eff8330f45f 100644 --- a/docs/components/modules/ROOT/pages/soroush-component.adoc +++ b/docs/components/modules/ROOT/pages/soroush-component.adoc @@ -1,12 +1,16 @@ [[soroush-component]] = Soroush Component :page-source: components/camel-soroush/src/main/docs/soroush-component.adoc +:docTitle: Soroush +:artifactId: camel-soroush +:description: To integrate with the Soroush chat bot. +:since: 3.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Soroush component provides access to the https://soroush-app.ir/developer.html[Soroush Bot API]. It allows a Camel-based application to send and receive messages by acting as a Bot, i.e. participating in direct conversation with normal users and send and receive message and files diff --git a/docs/components/modules/ROOT/pages/spark-component.adoc b/docs/components/modules/ROOT/pages/spark-component.adoc index 88b740d953553..841b0f3e658aa 100644 --- a/docs/components/modules/ROOT/pages/spark-component.adoc +++ b/docs/components/modules/ROOT/pages/spark-component.adoc @@ -1,12 +1,16 @@ [[spark-component]] = Spark Component :page-source: components/camel-spark/src/main/docs/spark-component.adoc +:docTitle: Spark +:artifactId: camel-spark +:description: The spark component can be used to send RDD or DataFrame jobs to Apache Spark cluster. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* *Since Camel 2.17* diff --git a/docs/components/modules/ROOT/pages/splunk-component.adoc b/docs/components/modules/ROOT/pages/splunk-component.adoc index 8aeaeb5748d2a..82f784192cc09 100644 --- a/docs/components/modules/ROOT/pages/splunk-component.adoc +++ b/docs/components/modules/ROOT/pages/splunk-component.adoc @@ -1,12 +1,16 @@ [[splunk-component]] = Splunk Component :page-source: components/camel-splunk/src/main/docs/splunk-component.adoc +:docTitle: Splunk +:artifactId: camel-splunk +:description: The splunk component allows to publish or search for events in Splunk. +:since: 2.13 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.13* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Splunk component provides access to http://docs.splunk.com/Documentation/Splunk/latest[Splunk] using the diff --git a/docs/components/modules/ROOT/pages/spring-batch-component.adoc b/docs/components/modules/ROOT/pages/spring-batch-component.adoc index b8ee767d1fdae..c973d46de4efd 100644 --- a/docs/components/modules/ROOT/pages/spring-batch-component.adoc +++ b/docs/components/modules/ROOT/pages/spring-batch-component.adoc @@ -1,12 +1,16 @@ [[spring-batch-component]] = Spring Batch Component :page-source: components/camel-spring-batch/src/main/docs/spring-batch-component.adoc +:docTitle: Spring Batch +:artifactId: camel-spring-batch +:description: The spring-batch component allows to send messages to Spring Batch for further processing. +:since: 2.10 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Spring Batch component and support classes provide integration bridge between Camel and http://www.springsource.org/spring-batch[Spring diff --git a/docs/components/modules/ROOT/pages/spring-event-component.adoc b/docs/components/modules/ROOT/pages/spring-event-component.adoc index 7082b69e7d207..b9ca06d76d591 100644 --- a/docs/components/modules/ROOT/pages/spring-event-component.adoc +++ b/docs/components/modules/ROOT/pages/spring-event-component.adoc @@ -1,12 +1,16 @@ [[spring-event-component]] = Spring Event Component :page-source: components/camel-spring/src/main/docs/spring-event-component.adoc +:docTitle: Spring Event +:artifactId: camel-spring +:description: The spring-event component allows to listen for Spring Application Events. +:since: 1.4 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.4* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Spring Event component provides access to the Spring `ApplicationEvent` objects. This allows you to publish diff --git a/docs/components/modules/ROOT/pages/spring-integration-component.adoc b/docs/components/modules/ROOT/pages/spring-integration-component.adoc index 5f19c3ea04c8d..7e2acb029c9fd 100644 --- a/docs/components/modules/ROOT/pages/spring-integration-component.adoc +++ b/docs/components/modules/ROOT/pages/spring-integration-component.adoc @@ -1,12 +1,16 @@ [[spring-integration-component]] = Spring Integration Component :page-source: components/camel-spring-integration/src/main/docs/spring-integration-component.adoc +:docTitle: Spring Integration +:artifactId: camel-spring-integration +:description: Bridges Camel with Spring Integration. +:since: 1.4 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.4* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Spring Integration component provides a bridge for Camel components to talk to diff --git a/docs/components/modules/ROOT/pages/spring-ldap-component.adoc b/docs/components/modules/ROOT/pages/spring-ldap-component.adoc index c6a598ab54a16..644f180fd7d98 100644 --- a/docs/components/modules/ROOT/pages/spring-ldap-component.adoc +++ b/docs/components/modules/ROOT/pages/spring-ldap-component.adoc @@ -1,12 +1,16 @@ [[spring-ldap-component]] = Spring LDAP Component :page-source: components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc +:docTitle: Spring LDAP +:artifactId: camel-spring-ldap +:description: The spring-ldap component allows you to perform searches in LDAP servers using filters as the message payload. +:since: 2.11 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.11* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Spring LDAP component provides a Camel wrapper for http://www.springsource.org/ldap[Spring LDAP]. diff --git a/docs/components/modules/ROOT/pages/spring-main.adoc b/docs/components/modules/ROOT/pages/spring-main.adoc deleted file mode 100644 index 5a768d677080c..0000000000000 --- a/docs/components/modules/ROOT/pages/spring-main.adoc +++ /dev/null @@ -1,5 +0,0 @@ -[[SpringMain-SpringMain]] -= Spring Main -:page-source: components/camel-spring-main/src/main/docs/spring-main.adoc - -This module is used for running Spring standalone via a main class extended from `camel-main`. diff --git a/docs/components/modules/ROOT/pages/spring-redis-component.adoc b/docs/components/modules/ROOT/pages/spring-redis-component.adoc index 19f9ee2d08016..dfb2a003873fe 100644 --- a/docs/components/modules/ROOT/pages/spring-redis-component.adoc +++ b/docs/components/modules/ROOT/pages/spring-redis-component.adoc @@ -1,12 +1,16 @@ [[spring-redis-component]] = Spring Redis Component :page-source: components/camel-spring-redis/src/main/docs/spring-redis-component.adoc +:docTitle: Spring Redis +:artifactId: camel-spring-redis +:description: The spring-redis component allows sending and receiving messages from Redis. +:since: 2.11 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.11* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* This component allows sending and receiving messages from https://redis.io/[Redis]. Redis is advanced key-value store where diff --git a/docs/components/modules/ROOT/pages/spring.adoc b/docs/components/modules/ROOT/pages/spring-summary.adoc similarity index 98% rename from docs/components/modules/ROOT/pages/spring.adoc rename to docs/components/modules/ROOT/pages/spring-summary.adoc index 731ed69a7377f..4a9eb41a66a56 100644 --- a/docs/components/modules/ROOT/pages/spring.adoc +++ b/docs/components/modules/ROOT/pages/spring-summary.adoc @@ -1,6 +1,8 @@ [[SpringSupport-SpringSupport]] = Spring Support -:page-source: components/camel-spring/src/main/docs/spring.adoc +:page-source: components/camel-spring/src/main/docs/spring-summary.adoc +//attributes written by hand, not generated +:docTitle: Spring Apache Camel is designed to work nicely with the Spring Framework in a number of ways. @@ -22,7 +24,7 @@ Type Converter support for Spring Resources etc framework to simplify your unit and integration testing using xref:{eip-vc}:eips:enterprise-integration-patterns.adoc[Enterprise Integration Patterns] and Camel's powerful xref:mock-component.adoc[Mock] and -xref:test.adoc[Test] endpoints +xref:others:test.adoc[Test] endpoints == Using Spring to configure the CamelContext diff --git a/docs/components/modules/ROOT/pages/spring-ws-component.adoc b/docs/components/modules/ROOT/pages/spring-ws-component.adoc index 0af4006773b31..f2338b5d1034f 100644 --- a/docs/components/modules/ROOT/pages/spring-ws-component.adoc +++ b/docs/components/modules/ROOT/pages/spring-ws-component.adoc @@ -1,12 +1,16 @@ [[spring-ws-component]] = Spring WebService Component :page-source: components/camel-spring-ws/src/main/docs/spring-ws-component.adoc +:docTitle: Spring WebService +:artifactId: camel-spring-ws +:description: The spring-ws component is used for SOAP WebServices using Spring WebServices. +:since: 2.6 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.6* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Spring WS component allows you to integrate with http://static.springsource.org/spring-ws/sites/1.5/[Spring Web diff --git a/docs/components/modules/ROOT/pages/sql-component.adoc b/docs/components/modules/ROOT/pages/sql-component.adoc index bffeb8c5d91b7..46152b9ec845c 100644 --- a/docs/components/modules/ROOT/pages/sql-component.adoc +++ b/docs/components/modules/ROOT/pages/sql-component.adoc @@ -1,12 +1,16 @@ [[sql-component]] = SQL Component :page-source: components/camel-sql/src/main/docs/sql-component.adoc +:docTitle: SQL +:artifactId: camel-sql +:description: The sql component allows you to work with databases using JDBC SQL queries. +:since: 1.4 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.4* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The SQL component allows you to work with databases using JDBC queries. The difference between this component and xref:jdbc-component.adoc[JDBC] diff --git a/docs/components/modules/ROOT/pages/sql-stored-component.adoc b/docs/components/modules/ROOT/pages/sql-stored-component.adoc index 49d723f7a45aa..803cc7c42ccba 100644 --- a/docs/components/modules/ROOT/pages/sql-stored-component.adoc +++ b/docs/components/modules/ROOT/pages/sql-stored-component.adoc @@ -1,12 +1,16 @@ [[sql-stored-component]] = SQL Stored Procedure Component :page-source: components/camel-sql/src/main/docs/sql-stored-component.adoc +:docTitle: SQL Stored Procedure +:artifactId: camel-sql +:description: The sql component allows you to work with databases using JDBC Stored Procedure queries. +:since: 2.17 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.17* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The SQL Stored component allows you to work with databases using JDBC Stored Procedure queries. This component is an extension to diff --git a/docs/components/modules/ROOT/pages/ssh-component.adoc b/docs/components/modules/ROOT/pages/ssh-component.adoc index ad77b2ce79100..4c673c5a752c9 100644 --- a/docs/components/modules/ROOT/pages/ssh-component.adoc +++ b/docs/components/modules/ROOT/pages/ssh-component.adoc @@ -1,12 +1,16 @@ [[ssh-component]] = SSH Component :page-source: components/camel-ssh/src/main/docs/ssh-component.adoc +:docTitle: SSH +:artifactId: camel-ssh +:description: The ssh component enables access to SSH servers such that you can send an SSH command, and process the response. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The SSH component enables access to SSH servers such that you can send an SSH command, and process the response. diff --git a/docs/components/modules/ROOT/pages/stax-component.adoc b/docs/components/modules/ROOT/pages/stax-component.adoc index aae3041821ad1..85d1ff1c31bd3 100644 --- a/docs/components/modules/ROOT/pages/stax-component.adoc +++ b/docs/components/modules/ROOT/pages/stax-component.adoc @@ -1,12 +1,16 @@ [[stax-component]] = StAX Component :page-source: components/camel-stax/src/main/docs/stax-component.adoc +:docTitle: StAX +:artifactId: camel-stax +:description: The stax component allows messages to be process through a SAX ContentHandler. +:since: 2.9 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.9* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The StAX component allows messages to be process through a SAX http://download.oracle.com/javase/6/docs/api/org/xml/sax/ContentHandler.html[ContentHandler]. + diff --git a/docs/components/modules/ROOT/pages/stomp-component.adoc b/docs/components/modules/ROOT/pages/stomp-component.adoc index 2c53136af1409..d9dc4ba751c69 100644 --- a/docs/components/modules/ROOT/pages/stomp-component.adoc +++ b/docs/components/modules/ROOT/pages/stomp-component.adoc @@ -1,12 +1,16 @@ [[stomp-component]] = Stomp Component :page-source: components/camel-stomp/src/main/docs/stomp-component.adoc +:docTitle: Stomp +:artifactId: camel-stomp +:description: The stomp component is used for communicating with Stomp compliant message brokers. +:since: 2.12 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Stomp component is used for communicating with http://stomp.github.io/[Stomp] compliant message brokers, like diff --git a/docs/components/modules/ROOT/pages/stream-component.adoc b/docs/components/modules/ROOT/pages/stream-component.adoc index f17cf40e097c4..c51addfc25eda 100644 --- a/docs/components/modules/ROOT/pages/stream-component.adoc +++ b/docs/components/modules/ROOT/pages/stream-component.adoc @@ -1,12 +1,16 @@ [[stream-component]] = Stream Component :page-source: components/camel-stream/src/main/docs/stream-component.adoc +:docTitle: Stream +:artifactId: camel-stream +:description: The stream: component provides access to the system-in, system-out and system-err streams as well as allowing streaming of file. +:since: 1.3 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.3* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Stream component provides access to the `System.in`, `System.out` and `System.err` streams as well as allowing streaming of file. diff --git a/docs/components/modules/ROOT/pages/string-template-component.adoc b/docs/components/modules/ROOT/pages/string-template-component.adoc index d3447cea317ee..4468d101e2956 100644 --- a/docs/components/modules/ROOT/pages/string-template-component.adoc +++ b/docs/components/modules/ROOT/pages/string-template-component.adoc @@ -1,12 +1,16 @@ [[string-template-component]] = String Template Component :page-source: components/camel-stringtemplate/src/main/docs/string-template-component.adoc +:docTitle: String Template +:artifactId: camel-stringtemplate +:description: Transforms the message using a String template. +:since: 1.2 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 1.2* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The String Template component allows you to process a message using a http://www.stringtemplate.org/[String Template]. This can be ideal when diff --git a/docs/components/modules/ROOT/pages/stub-component.adoc b/docs/components/modules/ROOT/pages/stub-component.adoc index b4f51e17faf45..bce5557b85c1b 100644 --- a/docs/components/modules/ROOT/pages/stub-component.adoc +++ b/docs/components/modules/ROOT/pages/stub-component.adoc @@ -1,12 +1,17 @@ [[stub-component]] = Stub Component :page-source: components/camel-stub/src/main/docs/stub-component.adoc +:docTitle: Stub +:artifactId: camel-stub +:description: The stub component provides a simple way to stub out any physical endpoints while in development or testing. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Stub component provides a simple way to stub out any physical endpoints while in development or testing, allowing you for example to diff --git a/docs/components/modules/ROOT/pages/telegram-component.adoc b/docs/components/modules/ROOT/pages/telegram-component.adoc index 0515f61d61838..d1333f66a19c0 100644 --- a/docs/components/modules/ROOT/pages/telegram-component.adoc +++ b/docs/components/modules/ROOT/pages/telegram-component.adoc @@ -1,12 +1,16 @@ [[telegram-component]] = Telegram Component :page-source: components/camel-telegram/src/main/docs/telegram-component.adoc +:docTitle: Telegram +:artifactId: camel-telegram +:description: The telegram component provides access to the Telegram Bot API. +:since: 2.18 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.18* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Telegram component provides access to the https://core.telegram.org/bots/api[Telegram Bot API]. It allows a Camel-based application to send and receive messages by acting as a Bot, participating in diff --git a/docs/components/modules/ROOT/pages/thrift-component.adoc b/docs/components/modules/ROOT/pages/thrift-component.adoc index 3e2231f048d86..3284e00803736 100644 --- a/docs/components/modules/ROOT/pages/thrift-component.adoc +++ b/docs/components/modules/ROOT/pages/thrift-component.adoc @@ -1,12 +1,16 @@ [[thrift-component]] = Thrift Component :page-source: components/camel-thrift/src/main/docs/thrift-component.adoc +:docTitle: Thrift +:artifactId: camel-thrift +:description: The Thrift component allows to call and expose remote procedures (RPC) with Apache Thrift data format and serialization mechanism +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Thrift component allows you to call or expose Remote Procedure Call (RPC) services using https://thrift.apache.org/[Apache Thrift] binary communication protocol and serialization mechanism. diff --git a/docs/components/modules/ROOT/pages/tika-component.adoc b/docs/components/modules/ROOT/pages/tika-component.adoc index 1fa24311b68bc..bdbdfa86f6583 100644 --- a/docs/components/modules/ROOT/pages/tika-component.adoc +++ b/docs/components/modules/ROOT/pages/tika-component.adoc @@ -1,12 +1,16 @@ [[tika-component]] = Tika Component :page-source: components/camel-tika/src/main/docs/tika-component.adoc +:docTitle: Tika +:artifactId: camel-tika +:description: This component integrates with Apache Tika to extract content and metadata from thousands of file types. +:since: 2.19 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The *Tika*: components provides the ability to detect and parse documents with Apache Tika. This component uses diff --git a/docs/components/modules/ROOT/pages/timer-component.adoc b/docs/components/modules/ROOT/pages/timer-component.adoc index 520345819489c..fc861bafab641 100644 --- a/docs/components/modules/ROOT/pages/timer-component.adoc +++ b/docs/components/modules/ROOT/pages/timer-component.adoc @@ -1,12 +1,17 @@ [[timer-component]] = Timer Component :page-source: components/camel-timer/src/main/docs/timer-component.adoc +:docTitle: Timer +:artifactId: camel-timer +:description: The timer component is used for generating message exchanges when a timer fires. +:since: 1.0 +:supportLevel: Stable +:component-header: Only consumer is supported +:core: -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Timer component is used to generate message exchanges when a timer fires You can only consume events from this endpoint. diff --git a/docs/components/modules/ROOT/pages/twilio-component.adoc b/docs/components/modules/ROOT/pages/twilio-component.adoc index ef2a38b0c9605..1ae931260cf76 100644 --- a/docs/components/modules/ROOT/pages/twilio-component.adoc +++ b/docs/components/modules/ROOT/pages/twilio-component.adoc @@ -1,12 +1,16 @@ [[twilio-component]] = Twilio Component :page-source: components/camel-twilio/src/main/docs/twilio-component.adoc +:docTitle: Twilio +:artifactId: camel-twilio +:description: The Twilio component allows you to interact with the Twilio REST APIs using Twilio Java SDK. +:since: 2.20 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.20* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Twilio component provides access to Version 2010-04-01 of Twilio REST APIs accessible using https://github.com/twilio/twilio-java[Twilio Java SDK]. diff --git a/docs/components/modules/ROOT/pages/twitter-directmessage-component.adoc b/docs/components/modules/ROOT/pages/twitter-directmessage-component.adoc index b13ef7a9d6157..dfeee6f7aad7a 100644 --- a/docs/components/modules/ROOT/pages/twitter-directmessage-component.adoc +++ b/docs/components/modules/ROOT/pages/twitter-directmessage-component.adoc @@ -1,12 +1,16 @@ [[twitter-directmessage-component]] = Twitter Direct Message Component :page-source: components/camel-twitter/src/main/docs/twitter-directmessage-component.adoc +:docTitle: Twitter Direct Message +:artifactId: camel-twitter +:description: The Twitter Direct Message Component consumes/produces user's direct messages. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Twitter Direct Message Component consumes/produces a user's direct messages. diff --git a/docs/components/modules/ROOT/pages/twitter-search-component.adoc b/docs/components/modules/ROOT/pages/twitter-search-component.adoc index 74f15ac11044d..06c388997c03b 100644 --- a/docs/components/modules/ROOT/pages/twitter-search-component.adoc +++ b/docs/components/modules/ROOT/pages/twitter-search-component.adoc @@ -1,12 +1,16 @@ [[twitter-search-component]] = Twitter Search Component :page-source: components/camel-twitter/src/main/docs/twitter-search-component.adoc +:docTitle: Twitter Search +:artifactId: camel-twitter +:description: The Twitter Search component consumes search results. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Twitter Search component consumes search results. diff --git a/docs/components/modules/ROOT/pages/twitter-timeline-component.adoc b/docs/components/modules/ROOT/pages/twitter-timeline-component.adoc index 2d2e72f0c2028..57fbc7c348d00 100644 --- a/docs/components/modules/ROOT/pages/twitter-timeline-component.adoc +++ b/docs/components/modules/ROOT/pages/twitter-timeline-component.adoc @@ -1,12 +1,16 @@ [[twitter-timeline-component]] = Twitter Timeline Component :page-source: components/camel-twitter/src/main/docs/twitter-timeline-component.adoc +:docTitle: Twitter Timeline +:artifactId: camel-twitter +:description: The Twitter Timeline component consumes twitter timeline or update the status of specific user. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Twitter Timeline component consumes twitter timeline or update the status of specific user. diff --git a/docs/components/modules/ROOT/pages/undertow-component.adoc b/docs/components/modules/ROOT/pages/undertow-component.adoc index c09d983b719b6..f00825e9daf32 100644 --- a/docs/components/modules/ROOT/pages/undertow-component.adoc +++ b/docs/components/modules/ROOT/pages/undertow-component.adoc @@ -1,12 +1,16 @@ [[undertow-component]] = Undertow Component :page-source: components/camel-undertow/src/main/docs/undertow-component.adoc +:docTitle: Undertow +:artifactId: camel-undertow +:description: The undertow component provides HTTP and WebSocket based endpoints for consuming and producing HTTP/WebSocket requests. +:since: 2.16 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.16* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Undertow component provides HTTP and WebSocket based endpoints for consuming and producing HTTP/WebSocket requests. diff --git a/docs/components/modules/ROOT/pages/validator-component.adoc b/docs/components/modules/ROOT/pages/validator-component.adoc index c336c2a39e521..1557bd501e9f6 100644 --- a/docs/components/modules/ROOT/pages/validator-component.adoc +++ b/docs/components/modules/ROOT/pages/validator-component.adoc @@ -1,12 +1,17 @@ [[validator-component]] = Validator Component :page-source: components/camel-validator/src/main/docs/validator-component.adoc +:docTitle: Validator +:artifactId: camel-validator +:description: Validates the payload of a message using XML Schema and JAXP Validation. +:since: 1.1 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Validation component performs XML validation of the message body using the JAXP Validation API and based on any of the supported XML diff --git a/docs/components/modules/ROOT/pages/velocity-component.adoc b/docs/components/modules/ROOT/pages/velocity-component.adoc index 745af7ff0576c..37cf9cc12b035 100644 --- a/docs/components/modules/ROOT/pages/velocity-component.adoc +++ b/docs/components/modules/ROOT/pages/velocity-component.adoc @@ -1,12 +1,16 @@ [[velocity-component]] = Velocity Component :page-source: components/camel-velocity/src/main/docs/velocity-component.adoc +:docTitle: Velocity +:artifactId: camel-velocity +:description: Transforms the message using a Velocity template. +:since: 1.2 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 1.2* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Velocity component allows you to process a message using an http://velocity.apache.org/[Apache Velocity] template. This can be ideal diff --git a/docs/components/modules/ROOT/pages/vertx-component.adoc b/docs/components/modules/ROOT/pages/vertx-component.adoc index 41e025ba738e8..9f4a20a701e53 100644 --- a/docs/components/modules/ROOT/pages/vertx-component.adoc +++ b/docs/components/modules/ROOT/pages/vertx-component.adoc @@ -1,12 +1,16 @@ [[vertx-component]] = Vert.x Component :page-source: components/camel-vertx/src/main/docs/vertx-component.adoc +:docTitle: Vert.x +:artifactId: camel-vertx +:description: The vertx component is used for sending and receive messages from a vertx event bus. +:since: 2.12 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Vert.x component is for working with the http://vertx.io/[Vertx] https://vertx.io/docs/vertx-core/java/#event_bus[EventBus]. diff --git a/docs/components/modules/ROOT/pages/vm-component.adoc b/docs/components/modules/ROOT/pages/vm-component.adoc index 5b452d60d9ca4..95697897289e2 100644 --- a/docs/components/modules/ROOT/pages/vm-component.adoc +++ b/docs/components/modules/ROOT/pages/vm-component.adoc @@ -1,12 +1,17 @@ [[vm-component]] = VM Component :page-source: components/camel-vm/src/main/docs/vm-component.adoc +:docTitle: VM +:artifactId: camel-vm +:description: The vm component provides asynchronous call to another endpoint from the same CamelContext. +:since: 1.1 +:supportLevel: Stable +:component-header: Both producer and consumer are supported +:core: -*Since Camel 1.1* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The VM component provides asynchronous https://en.wikipedia.org/wiki/Staged_event-driven_architecture[SEDA] behavior, exchanging diff --git a/docs/components/modules/ROOT/pages/weather-component.adoc b/docs/components/modules/ROOT/pages/weather-component.adoc index 139c1f00c3d64..8889e748948cc 100644 --- a/docs/components/modules/ROOT/pages/weather-component.adoc +++ b/docs/components/modules/ROOT/pages/weather-component.adoc @@ -1,12 +1,16 @@ [[weather-component]] = Weather Component :page-source: components/camel-weather/src/main/docs/weather-component.adoc +:docTitle: Weather +:artifactId: camel-weather +:description: Polls the weather information from Open Weather Map. +:since: 2.12 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Weather component is used for polling weather information from http://openweathermap.org[Open Weather Map] - a site that provides free diff --git a/docs/components/modules/ROOT/pages/web3j-component.adoc b/docs/components/modules/ROOT/pages/web3j-component.adoc index 5884af5066d0a..73f710cc0be22 100644 --- a/docs/components/modules/ROOT/pages/web3j-component.adoc +++ b/docs/components/modules/ROOT/pages/web3j-component.adoc @@ -1,12 +1,16 @@ [[web3j-component]] = Web3j Ethereum Blockchain Component :page-source: components/camel-web3j/src/main/docs/web3j-component.adoc +:docTitle: Web3j Ethereum Blockchain +:artifactId: camel-web3j +:description: The web3j component uses the Web3j client API and allows you to add/read nodes to/from a web3j compliant content repositories. +:since: 2.22 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.22* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Ethereum blockchain component uses the https://github.com/web3j/web3j[web3j] client diff --git a/docs/components/modules/ROOT/pages/webhook-component.adoc b/docs/components/modules/ROOT/pages/webhook-component.adoc index beb15fe699a4a..fd63cdbe5b008 100644 --- a/docs/components/modules/ROOT/pages/webhook-component.adoc +++ b/docs/components/modules/ROOT/pages/webhook-component.adoc @@ -1,12 +1,16 @@ [[webhook-component]] = Webhook Component :page-source: components/camel-webhook/src/main/docs/webhook-component.adoc +:docTitle: Webhook +:artifactId: camel-webhook +:description: The webhook component allows other Camel components that can receive push notifications to expose webhook endpoints and automatically register them with their own webhook provider. +:since: 3.0 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The Webhook meta component allows other Camel components to configure webhooks on a remote webhook provider and diff --git a/docs/components/modules/ROOT/pages/websocket-component.adoc b/docs/components/modules/ROOT/pages/websocket-component.adoc index 0c921336ec1aa..9de7a09f64024 100644 --- a/docs/components/modules/ROOT/pages/websocket-component.adoc +++ b/docs/components/modules/ROOT/pages/websocket-component.adoc @@ -1,12 +1,16 @@ [[websocket-component]] = Jetty Websocket Component :page-source: components/camel-websocket/src/main/docs/websocket-component.adoc +:docTitle: Jetty Websocket +:artifactId: camel-websocket +:description: The websocket component provides websocket endpoints with Jetty for communicating with clients using websocket. +:since: 2.10 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.10* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The WebSocket component provides websocket endpoints for communicating with clients using diff --git a/docs/components/modules/ROOT/pages/websocket-jsr356-component.adoc b/docs/components/modules/ROOT/pages/websocket-jsr356-component.adoc index bd1c6451411c6..b07a7a2fe4f1e 100644 --- a/docs/components/modules/ROOT/pages/websocket-jsr356-component.adoc +++ b/docs/components/modules/ROOT/pages/websocket-jsr356-component.adoc @@ -1,12 +1,16 @@ [[websocket-jsr356-component]] = Javax Websocket Component :page-source: components/camel-websocket-jsr356/src/main/docs/websocket-jsr356-component.adoc +:docTitle: Javax Websocket +:artifactId: camel-websocket-jsr356 +:description: Camel WebSocket using JSR356 (javax) +:since: 2.23 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.23* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The JSR356 component provides websocket endpoints for communicating with clients using diff --git a/docs/components/modules/ROOT/pages/weka-component.adoc b/docs/components/modules/ROOT/pages/weka-component.adoc index 18323b096c383..aa482d4d558c5 100644 --- a/docs/components/modules/ROOT/pages/weka-component.adoc +++ b/docs/components/modules/ROOT/pages/weka-component.adoc @@ -1,12 +1,16 @@ [[weka-component]] = Weka Component :page-source: components/camel-weka/src/main/docs/weka-component.adoc +:docTitle: Weka +:artifactId: camel-weka +:description: The camel-weka component provides Data Mining functionality through Weka. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The Weka component provides access to the https://www.cs.waikato.ac.nz/ml/weka[(Weka Data Mining)] toolset. diff --git a/docs/components/modules/ROOT/pages/wordpress-component.adoc b/docs/components/modules/ROOT/pages/wordpress-component.adoc index be2fd688f85fe..7204daa5b295d 100644 --- a/docs/components/modules/ROOT/pages/wordpress-component.adoc +++ b/docs/components/modules/ROOT/pages/wordpress-component.adoc @@ -1,12 +1,16 @@ [[wordpress-component]] = Wordpress Component :page-source: components/camel-wordpress/src/main/docs/wordpress-component.adoc +:docTitle: Wordpress +:artifactId: camel-wordpress +:description: Integrates Camel with Wordpress. +:since: 2.21 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.21* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Camel component for https://developer.wordpress.org/rest-api/reference/[Wordpress API]. diff --git a/docs/components/modules/ROOT/pages/workday-component.adoc b/docs/components/modules/ROOT/pages/workday-component.adoc index e5ad2787a0761..0eddb58b03e45 100644 --- a/docs/components/modules/ROOT/pages/workday-component.adoc +++ b/docs/components/modules/ROOT/pages/workday-component.adoc @@ -1,12 +1,16 @@ [[workday-component]] = Workday Component :page-source: components/camel-workday/src/main/docs/workday-component.adoc +:docTitle: Workday +:artifactId: camel-workday +:description: Represents a Workday endpoint. +:since: 3.1 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.1* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The *Workday*: components provides the ability to detect and parse documents with Workday. diff --git a/docs/components/modules/ROOT/pages/xchange-component.adoc b/docs/components/modules/ROOT/pages/xchange-component.adoc index 8f597f98b45bf..f8e68bdaf4558 100644 --- a/docs/components/modules/ROOT/pages/xchange-component.adoc +++ b/docs/components/modules/ROOT/pages/xchange-component.adoc @@ -1,12 +1,16 @@ [[xchange-component]] = XChange Component :page-source: components/camel-xchange/src/main/docs/xchange-component.adoc +:docTitle: XChange +:artifactId: camel-xchange +:description: The camel-xchange component provide access to many bitcoin and altcoin exchanges for trading and accessing market data. +:since: 2.21 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.21* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The XChange component uses the https://knowm.org/open-source/xchange/[XChange] Java library to provide access to 60+ Bitcoin and Altcoin exchanges. It comes with a consistent interface for trading and accessing market data. diff --git a/docs/components/modules/ROOT/pages/xj-component.adoc b/docs/components/modules/ROOT/pages/xj-component.adoc index e2ec19f8b500d..0650b7a363c08 100644 --- a/docs/components/modules/ROOT/pages/xj-component.adoc +++ b/docs/components/modules/ROOT/pages/xj-component.adoc @@ -1,12 +1,16 @@ [[xj-component]] = XJ Component :page-source: components/camel-xj/src/main/docs/xj-component.adoc +:docTitle: XJ +:artifactId: camel-xj +:description: Transforms json/xml message back and forth using a XSLT. +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The XJ component allows you to convert XML and JSON documents directly forth and back without the need of intermediate java objects. You can even specify an XSLT stylesheet to convert directly to the target diff --git a/docs/components/modules/ROOT/pages/xmlsecurity-sign-component.adoc b/docs/components/modules/ROOT/pages/xmlsecurity-sign-component.adoc index b3b60120ac9df..c276a3e394c91 100644 --- a/docs/components/modules/ROOT/pages/xmlsecurity-sign-component.adoc +++ b/docs/components/modules/ROOT/pages/xmlsecurity-sign-component.adoc @@ -1,16 +1,18 @@ [[xmlsecurity-sign-component]] = XML Security Sign Component :page-source: components/camel-xmlsecurity/src/main/docs/xmlsecurity-sign-component.adoc -*Since Camel 2.12* -*Since Camel 2.12* +:docTitle: XML Security Sign +:artifactId: camel-xmlsecurity +:description: Used to sign exchanges using the XML signature specification. +:since: 2.12 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* With this Apache Camel component, you can generate and validate XML signatures as described in the W3C standard diff --git a/docs/components/modules/ROOT/pages/xmlsecurity-verify-component.adoc b/docs/components/modules/ROOT/pages/xmlsecurity-verify-component.adoc index 02863356b9296..e1250c4be0556 100644 --- a/docs/components/modules/ROOT/pages/xmlsecurity-verify-component.adoc +++ b/docs/components/modules/ROOT/pages/xmlsecurity-verify-component.adoc @@ -1,16 +1,18 @@ [[xmlsecurity-verify-component]] = XML Security Verify Component :page-source: components/camel-xmlsecurity/src/main/docs/xmlsecurity-verify-component.adoc -*Since Camel 2.12* -*Since Camel 2.12* +:docTitle: XML Security Verify +:artifactId: camel-xmlsecurity +:description: Used to verify exchanges using the XML signature specification. +:since: 2.12 +:supportLevel: Stable +:component-header: Only producer is supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* With this Apache Camel component, you can generate and validate XML signatures as described in the W3C standard diff --git a/docs/components/modules/ROOT/pages/xmpp-component.adoc b/docs/components/modules/ROOT/pages/xmpp-component.adoc index b9ffce76eab4f..e1b5ae4a5cf47 100644 --- a/docs/components/modules/ROOT/pages/xmpp-component.adoc +++ b/docs/components/modules/ROOT/pages/xmpp-component.adoc @@ -1,12 +1,16 @@ [[xmpp-component]] = XMPP Component :page-source: components/camel-xmpp/src/main/docs/xmpp-component.adoc +:docTitle: XMPP +:artifactId: camel-xmpp +:description: To send and receive messages from a XMPP (chat) server. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The XMPP component implements an XMPP (Jabber) transport. diff --git a/docs/components/modules/ROOT/pages/xquery-component.adoc b/docs/components/modules/ROOT/pages/xquery-component.adoc index 4572a8bfe37eb..6b00899f50cc8 100644 --- a/docs/components/modules/ROOT/pages/xquery-component.adoc +++ b/docs/components/modules/ROOT/pages/xquery-component.adoc @@ -1,12 +1,16 @@ [[xquery-component]] = XQuery Component :page-source: components/camel-saxon/src/main/docs/xquery-component.adoc +:docTitle: XQuery +:artifactId: camel-saxon +:description: Transforms the message using a XQuery template using Saxon. +:since: 1.0 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 1.0* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* Camel supports http://www.w3.org/TR/xquery/[XQuery] to allow an Expression or Predicate to be diff --git a/docs/components/modules/ROOT/pages/xslt-component.adoc b/docs/components/modules/ROOT/pages/xslt-component.adoc index 8532cb3c46a6b..a3bc6b3c73484 100644 --- a/docs/components/modules/ROOT/pages/xslt-component.adoc +++ b/docs/components/modules/ROOT/pages/xslt-component.adoc @@ -1,12 +1,17 @@ [[xslt-component]] = XSLT Component :page-source: components/camel-xslt/src/main/docs/xslt-component.adoc +:docTitle: XSLT +:artifactId: camel-xslt +:description: Transforms the message using a XSLT template. +:since: 1.3 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 1.3* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The XSLT component allows you to process a message using an http://www.w3.org/TR/xslt[XSLT] template. This can be ideal when using diff --git a/docs/components/modules/ROOT/pages/xslt-saxon-component.adoc b/docs/components/modules/ROOT/pages/xslt-saxon-component.adoc index 5f195faef8016..5ffd48c5df01b 100644 --- a/docs/components/modules/ROOT/pages/xslt-saxon-component.adoc +++ b/docs/components/modules/ROOT/pages/xslt-saxon-component.adoc @@ -1,12 +1,17 @@ [[xslt-saxon-component]] = XSLT Saxon Component :page-source: components/camel-xslt-saxon/src/main/docs/xslt-saxon-component.adoc +:docTitle: XSLT Saxon +:artifactId: camel-xslt-saxon +:description: Transforms the message using a XSLT template using Saxon. +:since: 3.0 +:supportLevel: Stable +:component-header: Only producer is supported +:core: -*Since Camel 3.0* +*Since Camel {since}* -// HEADER START -*Only producer is supported* -// HEADER END +*{component-header}* The XSLT Saxon component allows you to process a message using an http://www.w3.org/TR/xslt[XSLT] template using Saxon. This can be ideal when using diff --git a/docs/components/modules/ROOT/pages/yammer-component.adoc b/docs/components/modules/ROOT/pages/yammer-component.adoc index 2d9ef1122a808..d52e7c81126eb 100644 --- a/docs/components/modules/ROOT/pages/yammer-component.adoc +++ b/docs/components/modules/ROOT/pages/yammer-component.adoc @@ -1,12 +1,16 @@ [[yammer-component]] = Yammer Component :page-source: components/camel-yammer/src/main/docs/yammer-component.adoc +:docTitle: Yammer +:artifactId: camel-yammer +:description: The yammer component allows you to interact with the Yammer enterprise social network. +:since: 2.12 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.12* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Yammer component allows you to interact with the https://www.yammer.com[Yammer] enterprise social network. diff --git a/docs/components/modules/ROOT/pages/zendesk-component.adoc b/docs/components/modules/ROOT/pages/zendesk-component.adoc index 4b383b124f9f7..d90c74d0fb90c 100644 --- a/docs/components/modules/ROOT/pages/zendesk-component.adoc +++ b/docs/components/modules/ROOT/pages/zendesk-component.adoc @@ -1,12 +1,16 @@ [[zendesk-component]] = Zendesk Component :page-source: components/camel-zendesk/src/main/docs/zendesk-component.adoc +:docTitle: Zendesk +:artifactId: camel-zendesk +:description: Allows producing messages to manage Zendesk ticket, user, organization, etc. +:since: 2.19 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The Zendesk component provides access to all of the zendesk.com APIs accessible using https://github.com/cloudbees/zendesk-java-client[zendesk-java-client]. It diff --git a/docs/components/modules/ROOT/pages/zookeeper-component.adoc b/docs/components/modules/ROOT/pages/zookeeper-component.adoc index 5dbd57cf9ad86..5cd589b0e171e 100644 --- a/docs/components/modules/ROOT/pages/zookeeper-component.adoc +++ b/docs/components/modules/ROOT/pages/zookeeper-component.adoc @@ -1,12 +1,16 @@ [[zookeeper-component]] = ZooKeeper Component :page-source: components/camel-zookeeper/src/main/docs/zookeeper-component.adoc +:docTitle: ZooKeeper +:artifactId: camel-zookeeper +:description: The zookeeper component allows interaction with a ZooKeeper cluster. +:since: 2.9 +:supportLevel: Stable +:component-header: Both producer and consumer are supported -*Since Camel 2.9* +*Since Camel {since}* -// HEADER START -*Both producer and consumer is supported* -// HEADER END +*{component-header}* The ZooKeeper component allows interaction with a http://hadoop.apache.org/zookeeper/[ZooKeeper] cluster and exposes the diff --git a/docs/components/modules/ROOT/pages/zookeeper-master-component.adoc b/docs/components/modules/ROOT/pages/zookeeper-master-component.adoc index 09f7dc536cf2c..48a25c5bdc443 100644 --- a/docs/components/modules/ROOT/pages/zookeeper-master-component.adoc +++ b/docs/components/modules/ROOT/pages/zookeeper-master-component.adoc @@ -1,12 +1,16 @@ [[zookeeper-master-component]] = ZooKeeper Master Component :page-source: components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc +:docTitle: ZooKeeper Master +:artifactId: camel-zookeeper-master +:description: Represents an endpoint which only becomes active when it obtains the master lock +:since: 2.19 +:supportLevel: Stable +:component-header: Only consumer is supported -*Since Camel 2.19* +*Since Camel {since}* -// HEADER START -*Only consumer is supported* -// HEADER END +*{component-header}* The **zookeeper-master:** endpoint provides a way to ensure only a single consumer in a cluster consumes from a given endpoint; with automatic failover if that JVM dies. diff --git a/docs/components/modules/dataformats/nav.adoc b/docs/components/modules/dataformats/nav.adoc index 2892f798a652b..f92273671b9fb 100644 --- a/docs/components/modules/dataformats/nav.adoc +++ b/docs/components/modules/dataformats/nav.adoc @@ -2,46 +2,46 @@ // make edits in docs/*nav.adoc.template files instead * xref:dataformats:index.adoc[Data Formats] -** xref:dataformats:any23-dataformat.adoc[Any23 DataFormat] -** xref:dataformats:asn1-dataformat.adoc[ASN.1 File DataFormat] -** xref:dataformats:avro-dataformat.adoc[Avro DataFormat] -** xref:dataformats:barcode-dataformat.adoc[Barcode DataFormat] -** xref:dataformats:base64-dataformat.adoc[Base64 DataFormat] -** xref:dataformats:beanio-dataformat.adoc[BeanIO DataFormat] -** xref:dataformats:bindy-dataformat.adoc[Bindy DataFormat] -** xref:dataformats:cbor-dataformat.adoc[CBOR DataFormat] -** xref:dataformats:crypto-dataformat.adoc[Crypto (Java Cryptographic Extension) DataFormat] -** xref:dataformats:csv-dataformat.adoc[CSV DataFormat] -** xref:dataformats:fhirJson-dataformat.adoc[FHIR JSon DataFormat] -** xref:dataformats:fhirXml-dataformat.adoc[FHIR XML DataFormat] -** xref:dataformats:flatpack-dataformat.adoc[Flatpack DataFormat] -** xref:dataformats:grok-dataformat.adoc[Grok DataFormat] -** xref:dataformats:gzipdeflater-dataformat.adoc[GZip Deflater DataFormat] -** xref:dataformats:hl7-dataformat.adoc[HL7 DataFormat] -** xref:dataformats:ical-dataformat.adoc[iCal DataFormat] -** xref:dataformats:jacksonxml-dataformat.adoc[JacksonXML DataFormat] -** xref:dataformats:jaxb-dataformat.adoc[JAXB DataFormat] -** xref:dataformats:json-fastjson-dataformat.adoc[JSon Fastjson DataFormat] -** xref:dataformats:json-gson-dataformat.adoc[JSon GSon DataFormat] -** xref:dataformats:json-jackson-dataformat.adoc[JSon Jackson DataFormat] -** xref:dataformats:json-johnzon-dataformat.adoc[JSon Johnzon DataFormat] -** xref:dataformats:json-xstream-dataformat.adoc[JSon XStream DataFormat] -** xref:dataformats:jsonApi-dataformat.adoc[JSonApi DataFormat] -** xref:dataformats:lzf-dataformat.adoc[LZF Deflate Compression DataFormat] -** xref:dataformats:mime-multipart-dataformat.adoc[MIME Multipart DataFormat] -** xref:dataformats:pgp-dataformat.adoc[PGP DataFormat] -** xref:dataformats:protobuf-dataformat.adoc[Protobuf DataFormat] -** xref:dataformats:rss-dataformat.adoc[RSS DataFormat] -** xref:dataformats:soapjaxb-dataformat.adoc[SOAP DataFormat] -** xref:dataformats:syslog-dataformat.adoc[Syslog DataFormat] -** xref:dataformats:tarfile-dataformat.adoc[Tar File DataFormat] -** xref:dataformats:thrift-dataformat.adoc[Thrift DataFormat] -** xref:dataformats:tidyMarkup-dataformat.adoc[TidyMarkup DataFormat] -** xref:dataformats:univocity-csv-dataformat.adoc[uniVocity CSV DataFormat] -** xref:dataformats:univocity-fixed-dataformat.adoc[uniVocity Fixed Length DataFormat] -** xref:dataformats:univocity-tsv-dataformat.adoc[uniVocity TSV DataFormat] -** xref:dataformats:secureXML-dataformat.adoc[XML Security DataFormat] -** xref:dataformats:xstream-dataformat.adoc[XStream DataFormat] -** xref:dataformats:yaml-snakeyaml-dataformat.adoc[YAML SnakeYAML DataFormat] -** xref:dataformats:zipdeflater-dataformat.adoc[Zip Deflate Compression DataFormat] -** xref:dataformats:zipfile-dataformat.adoc[Zip File DataFormat] +** xref:dataformats:any23-dataformat.adoc[Any23] +** xref:dataformats:asn1-dataformat.adoc[ASN.1 File] +** xref:dataformats:avro-dataformat.adoc[Avro] +** xref:dataformats:barcode-dataformat.adoc[Barcode] +** xref:dataformats:base64-dataformat.adoc[Base64] +** xref:dataformats:beanio-dataformat.adoc[BeanIO] +** xref:dataformats:bindy-dataformat.adoc[Bindy] +** xref:dataformats:cbor-dataformat.adoc[CBOR] +** xref:dataformats:crypto-dataformat.adoc[Crypto (Java Cryptographic Extension)] +** xref:dataformats:csv-dataformat.adoc[CSV] +** xref:dataformats:fhirJson-dataformat.adoc[FHIR JSon] +** xref:dataformats:fhirXml-dataformat.adoc[FHIR XML] +** xref:dataformats:flatpack-dataformat.adoc[Flatpack] +** xref:dataformats:grok-dataformat.adoc[Grok] +** xref:dataformats:gzipdeflater-dataformat.adoc[GZip Deflater] +** xref:dataformats:hl7-dataformat.adoc[HL7] +** xref:dataformats:ical-dataformat.adoc[iCal] +** xref:dataformats:jacksonxml-dataformat.adoc[JacksonXML] +** xref:dataformats:jaxb-dataformat.adoc[JAXB] +** xref:dataformats:json-fastjson-dataformat.adoc[JSon Fastjson] +** xref:dataformats:json-gson-dataformat.adoc[JSon GSon] +** xref:dataformats:json-jackson-dataformat.adoc[JSon Jackson] +** xref:dataformats:json-johnzon-dataformat.adoc[JSon Johnzon] +** xref:dataformats:json-xstream-dataformat.adoc[JSon XStream] +** xref:dataformats:jsonApi-dataformat.adoc[JSonApi] +** xref:dataformats:lzf-dataformat.adoc[LZF Deflate Compression] +** xref:dataformats:mime-multipart-dataformat.adoc[MIME Multipart] +** xref:dataformats:pgp-dataformat.adoc[PGP] +** xref:dataformats:protobuf-dataformat.adoc[Protobuf] +** xref:dataformats:rss-dataformat.adoc[RSS] +** xref:dataformats:soapjaxb-dataformat.adoc[SOAP] +** xref:dataformats:syslog-dataformat.adoc[Syslog] +** xref:dataformats:tarfile-dataformat.adoc[Tar File] +** xref:dataformats:thrift-dataformat.adoc[Thrift] +** xref:dataformats:tidyMarkup-dataformat.adoc[TidyMarkup] +** xref:dataformats:univocity-csv-dataformat.adoc[uniVocity CSV] +** xref:dataformats:univocity-fixed-dataformat.adoc[uniVocity Fixed Length] +** xref:dataformats:univocity-tsv-dataformat.adoc[uniVocity TSV] +** xref:dataformats:secureXML-dataformat.adoc[XML Security] +** xref:dataformats:xstream-dataformat.adoc[XStream] +** xref:dataformats:yaml-snakeyaml-dataformat.adoc[YAML SnakeYAML] +** xref:dataformats:zipdeflater-dataformat.adoc[Zip Deflate Compression] +** xref:dataformats:zipfile-dataformat.adoc[Zip File] diff --git a/docs/components/modules/dataformats/pages/any23-dataformat.adoc b/docs/components/modules/dataformats/pages/any23-dataformat.adoc index de99310827a29..544f0e30a30ff 100644 --- a/docs/components/modules/dataformats/pages/any23-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/any23-dataformat.adoc @@ -1,12 +1,16 @@ [[any23-dataformat]] = Any23 DataFormat :page-source: components/camel-any23/src/main/docs/any23-dataformat.adoc -Camel Any23 is a DataFormat that uses the Apache Anything To Triples (Any23) library to extract structured data in RDF from a variety of documents on the web. -*Since Camel 3.0* +:docTitle: Any23 +:artifactId: camel-any23 +:description: Any23 data format is used for parsing data to RDF. +:since: 3.0 +:supportLevel: Stable -*Since Camel 3.0* +*Since Camel {since}* +Camel Any23 is a DataFormat that uses the Apache Anything To Triples (Any23) library to extract structured data in RDF from a variety of documents on the web. The main functionality of this DataFormat focuses on its Unmarshal method which extracts RDF triplets from compatible pages, in a wide variety of RDF syntaxes. Any23 is a Data Format that is intended to convert HTML from a site (or file) into rdf. diff --git a/docs/components/modules/dataformats/pages/asn1-dataformat.adoc b/docs/components/modules/dataformats/pages/asn1-dataformat.adoc index f4fd2cc81cc47..a3a9cdbac4284 100644 --- a/docs/components/modules/dataformats/pages/asn1-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/asn1-dataformat.adoc @@ -1,8 +1,13 @@ [[asn1-dataformat]] = ASN.1 File DataFormat :page-source: components/camel-asn1/src/main/docs/asn1-dataformat.adoc +:docTitle: ASN.1 File +:artifactId: camel-asn1 +:description: The ASN.1 data format is used for file transfer with telecommunications protocols. +:since: 2.20 +:supportLevel: Stable -*Since Camel 2.20* +*Since Camel {since}* The ASN.1 Data Format Data Format [Intoduction to ASN.1](https://www.itu.int/en/ITU-T/asn1/Pages/introduction.aspx) is a Camel Frameworks's data format implementation based on Bouncy Castle's bcprov-jdk15on library and jASN.1's java compiler for the formal notation used for describing data transmitted by telecommunications protocols, regardless of language implementation and physical representation of these data, whatever the application, whether complex or very simple. Messages can be unmarshalled (conversion to simple Java POJO(s)) to plain Java objects. By the help of Camel's routing engine and data transformations you can then play with POJO(s) and apply customised formatting and call other Camel Component's to convert and send messages to upstream systems. diff --git a/docs/components/modules/dataformats/pages/avro-dataformat.adoc b/docs/components/modules/dataformats/pages/avro-dataformat.adoc index 5f4501dcc9057..4a08710fea64a 100644 --- a/docs/components/modules/dataformats/pages/avro-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/avro-dataformat.adoc @@ -1,8 +1,13 @@ [[avro-dataformat]] = Avro DataFormat :page-source: components/camel-avro/src/main/docs/avro-dataformat.adoc +:docTitle: Avro +:artifactId: camel-avro +:description: The Avro data format is used for serialization and deserialization of messages using Apache Avro binary dataformat. +:since: 2.14 +:supportLevel: Stable -*Since Camel 2.14* +*Since Camel {since}* This component provides a dataformat for avro, which allows serialization and deserialization of messages using Apache Avro's binary diff --git a/docs/components/modules/dataformats/pages/barcode-dataformat.adoc b/docs/components/modules/dataformats/pages/barcode-dataformat.adoc index f1f394b468df6..e1f0ac578c19e 100644 --- a/docs/components/modules/dataformats/pages/barcode-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/barcode-dataformat.adoc @@ -1,8 +1,13 @@ [[barcode-dataformat]] = Barcode DataFormat :page-source: components/camel-barcode/src/main/docs/barcode-dataformat.adoc +:docTitle: Barcode +:artifactId: camel-barcode +:description: The Barcode data format is used for creating barccode images (such as QR-Code) +:since: 2.14 +:supportLevel: Stable -*Since Camel 2.14* +*Since Camel {since}* The Barcode data format is based on the https://github.com/zxing/zxing[zxing library]. The goal of this diff --git a/docs/components/modules/dataformats/pages/base64-dataformat.adoc b/docs/components/modules/dataformats/pages/base64-dataformat.adoc index 180e2abc6fcd5..5dda676a4dffc 100644 --- a/docs/components/modules/dataformats/pages/base64-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/base64-dataformat.adoc @@ -1,8 +1,13 @@ [[base64-dataformat]] = Base64 DataFormat :page-source: components/camel-base64/src/main/docs/base64-dataformat.adoc +:docTitle: Base64 +:artifactId: camel-base64 +:description: The Base64 data format is used for base64 encoding and decoding. +:since: 2.11 +:supportLevel: Stable -*Since Camel 2.11* +*Since Camel {since}* The Base64 data format is used for base64 encoding and decoding. diff --git a/docs/components/modules/dataformats/pages/beanio-dataformat.adoc b/docs/components/modules/dataformats/pages/beanio-dataformat.adoc index 47c90b19e9595..589938d39770f 100644 --- a/docs/components/modules/dataformats/pages/beanio-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/beanio-dataformat.adoc @@ -1,8 +1,13 @@ [[beanio-dataformat]] = BeanIO DataFormat :page-source: components/camel-beanio/src/main/docs/beanio-dataformat.adoc +:docTitle: BeanIO +:artifactId: camel-beanio +:description: The BeanIO data format is used for working with flat payloads (such as CSV, delimited, or fixed length formats). +:since: 2.10 +:supportLevel: Stable -*Since Camel 2.10* +*Since Camel {since}* The BeanIO Data Format uses http://beanio.org/[BeanIO] to handle flat payloads (such as XML, CSV, diff --git a/docs/components/modules/dataformats/pages/bindy-dataformat.adoc b/docs/components/modules/dataformats/pages/bindy-dataformat.adoc index 1cfbd61186815..9bc798f0c7d63 100644 --- a/docs/components/modules/dataformats/pages/bindy-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/bindy-dataformat.adoc @@ -1,8 +1,13 @@ [[bindy-dataformat]] = Bindy DataFormat :page-source: components/camel-bindy/src/main/docs/bindy-dataformat.adoc +:docTitle: Bindy +:artifactId: camel-bindy +:description: The Bindy data format is used for working with flat payloads (such as CSV, delimited, fixed length formats, or FIX messages). +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* The goal of this component is to allow the parsing/binding of non-structured data (or to be more precise non-XML data) + diff --git a/docs/components/modules/dataformats/pages/cbor-dataformat.adoc b/docs/components/modules/dataformats/pages/cbor-dataformat.adoc index 8cb13a06b726e..1a079fd679782 100644 --- a/docs/components/modules/dataformats/pages/cbor-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/cbor-dataformat.adoc @@ -1,8 +1,13 @@ [[cbor-dataformat]] = CBOR DataFormat :page-source: components/camel-cbor/src/main/docs/cbor-dataformat.adoc +:docTitle: CBOR +:artifactId: camel-cbor +:description: CBOR data format is used for unmarshal a CBOR payload to POJO or to marshal POJO back to CBOR payload. +:since: 3.0 +:supportLevel: Stable -*Since Camel 3.0* +*Since Camel {since}* CBOR is a Data Format which uses the http://wiki.fasterxml.com/JacksonHome/[Jackson library] with the diff --git a/docs/components/modules/dataformats/pages/crypto-dataformat.adoc b/docs/components/modules/dataformats/pages/crypto-dataformat.adoc index 9cc87b0715cde..4752ad9477c05 100644 --- a/docs/components/modules/dataformats/pages/crypto-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/crypto-dataformat.adoc @@ -1,8 +1,13 @@ [[crypto-dataformat]] = Crypto (Java Cryptographic Extension) DataFormat :page-source: components/camel-crypto/src/main/docs/crypto-dataformat.adoc +:docTitle: Crypto (Java Cryptographic Extension) +:artifactId: camel-crypto +:description: Crypto data format is used for encrypting and decrypting of messages using Java Cryptographic Extension. +:since: 2.3 +:supportLevel: Stable -*Since Camel 2.3* +*Since Camel {since}* The Crypto Data Format integrates the Java Cryptographic Extension into Camel, allowing simple and flexible diff --git a/docs/components/modules/dataformats/pages/csv-dataformat.adoc b/docs/components/modules/dataformats/pages/csv-dataformat.adoc index eea0d9205d81a..0321381d925ed 100644 --- a/docs/components/modules/dataformats/pages/csv-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/csv-dataformat.adoc @@ -1,8 +1,13 @@ [[csv-dataformat]] = CSV DataFormat :page-source: components/camel-csv/src/main/docs/csv-dataformat.adoc +:docTitle: CSV +:artifactId: camel-csv +:description: The CSV data format is used for handling CSV payloads. +:since: 1.3 +:supportLevel: Stable -*Since Camel 1.3* +*Since Camel {since}* The CSV Data Format uses http://commons.apache.org/proper/commons-csv/[Apache Commons CSV] to diff --git a/docs/components/modules/dataformats/pages/fhirJson-dataformat.adoc b/docs/components/modules/dataformats/pages/fhirJson-dataformat.adoc index 82479cfe5a1b4..20f4bafd61ef7 100644 --- a/docs/components/modules/dataformats/pages/fhirJson-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/fhirJson-dataformat.adoc @@ -1,8 +1,13 @@ [[fhirJson-dataformat]] = FHIR JSon DataFormat :page-source: components/camel-fhir/camel-fhir-component/src/main/docs/fhirJson-dataformat.adoc +:docTitle: FHIR JSon +:artifactId: camel-fhir +:description: The FHIR JSon data format is used to marshall/unmarshall to/from FHIR objects to/from JSON. +:since: 2.21 +:supportLevel: Stable -*Since Camel 2.21* +*Since Camel {since}* The FHIR-JSON Data Format leverages https://github.com/jamesagnew/hapi-fhir/blob/master/hapi-fhir-base/src/main/java/ca/uhn/fhir/parser/JsonParser.java[HAPI-FHIR's] diff --git a/docs/components/modules/dataformats/pages/fhirXml-dataformat.adoc b/docs/components/modules/dataformats/pages/fhirXml-dataformat.adoc index a5a9dcc75cb62..600c16264c881 100644 --- a/docs/components/modules/dataformats/pages/fhirXml-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/fhirXml-dataformat.adoc @@ -1,8 +1,13 @@ [[fhirXml-dataformat]] = FHIR XML DataFormat :page-source: components/camel-fhir/camel-fhir-component/src/main/docs/fhirXml-dataformat.adoc +:docTitle: FHIR XML +:artifactId: camel-fhir +:description: The FHIR XML data format is used to marshall/unmarshall from/to FHIR objects to/from XML. +:since: 2.21 +:supportLevel: Stable -*Since Camel 2.21* +*Since Camel {since}* The FHIR-XML Data Format leverages https://github.com/jamesagnew/hapi-fhir/blob/master/hapi-fhir-base/src/main/java/ca/uhn/fhir/parser/XmlParser.java[HAPI-FHIR's] diff --git a/docs/components/modules/dataformats/pages/flatpack-dataformat.adoc b/docs/components/modules/dataformats/pages/flatpack-dataformat.adoc index 5a01a94cf8005..efb7528f6ac62 100644 --- a/docs/components/modules/dataformats/pages/flatpack-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/flatpack-dataformat.adoc @@ -1,8 +1,13 @@ [[flatpack-dataformat]] = Flatpack DataFormat :page-source: components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc +:docTitle: Flatpack +:artifactId: camel-flatpack +:description: The Flatpack data format is used for working with flat payloads (such as CSV, delimited, or fixed length formats). +:since: 2.1 +:supportLevel: Stable -*Since Camel 2.1* +*Since Camel {since}* The xref:ROOT:flatpack-component.adoc[Flatpack] component ships with the Flatpack data format that can be used to format between fixed width or delimited text diff --git a/docs/components/modules/dataformats/pages/grok-dataformat.adoc b/docs/components/modules/dataformats/pages/grok-dataformat.adoc index 39c9f3c71c5c9..7b25f40bf90e4 100644 --- a/docs/components/modules/dataformats/pages/grok-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/grok-dataformat.adoc @@ -1,8 +1,13 @@ [[grok-dataformat]] = Grok DataFormat :page-source: components/camel-grok/src/main/docs/grok-dataformat.adoc +:docTitle: Grok +:artifactId: camel-grok +:description: The Grok data format is used for unmarshalling unstructured data to objects using Logstash based Grok patterns. +:since: 3.0 +:supportLevel: Stable -*Since Camel 3.0* +*Since Camel {since}* This component provides dataformat for processing inputs with grok patterns. Grok patterns are used to process unstructured data into structured objects - `List>`. diff --git a/docs/components/modules/dataformats/pages/gzipdeflater-dataformat.adoc b/docs/components/modules/dataformats/pages/gzipdeflater-dataformat.adoc index 0e255f8be5c80..44e2819b15b35 100644 --- a/docs/components/modules/dataformats/pages/gzipdeflater-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/gzipdeflater-dataformat.adoc @@ -1,8 +1,13 @@ [[gzipdeflater-dataformat]] = GZip Deflater DataFormat :page-source: components/camel-zip-deflater/src/main/docs/gzipdeflater-dataformat.adoc +:docTitle: GZip Deflater +:artifactId: camel-zip-deflater +:description: The GZip data format is a message compression and de-compression format (which works with the popular gzip/gunzip tools). +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* The GZip Deflater Data Format is a message compression and de-compression format. It uses the same deflate algorithm that is used diff --git a/docs/components/modules/dataformats/pages/hl7-dataformat.adoc b/docs/components/modules/dataformats/pages/hl7-dataformat.adoc index 1d7bdb1ed817e..7ba2d16bc0d40 100644 --- a/docs/components/modules/dataformats/pages/hl7-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/hl7-dataformat.adoc @@ -1,8 +1,13 @@ [[hl7-dataformat]] = HL7 DataFormat :page-source: components/camel-hl7/src/main/docs/hl7-dataformat.adoc +:docTitle: HL7 +:artifactId: camel-hl7 +:description: The HL7 data format can be used to marshal or unmarshal HL7 (Health Care) model objects. +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* The HL7 component is used for working with the HL7 MLLP protocol and http://www.hl7.org/implement/standards/product_brief.cfm?product_id=185[HL7 diff --git a/docs/components/modules/dataformats/pages/ical-dataformat.adoc b/docs/components/modules/dataformats/pages/ical-dataformat.adoc index d683e9c7f37c4..d363b1f9f390b 100644 --- a/docs/components/modules/dataformats/pages/ical-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/ical-dataformat.adoc @@ -1,8 +1,13 @@ [[ical-dataformat]] = iCal DataFormat :page-source: components/camel-ical/src/main/docs/ical-dataformat.adoc +:docTitle: iCal +:artifactId: camel-ical +:description: The iCal dataformat is used for working with iCalendar messages. +:since: 2.12 +:supportLevel: Stable -*Since Camel 2.12* +*Since Camel {since}* The ICal dataformat is used for working with http://en.wikipedia.org/wiki/ICalendar[iCalendar] messages. diff --git a/docs/components/modules/dataformats/pages/index.adoc b/docs/components/modules/dataformats/pages/index.adoc index 6f2a394427485..77ac5c8080968 100644 --- a/docs/components/modules/dataformats/pages/index.adoc +++ b/docs/components/modules/dataformats/pages/index.adoc @@ -1,105 +1,13 @@ [list-of-camel-data-formats] = Data Formats -Below are the list of data formats that are provided by Apache Camel. +Below is the list of data formats that are provided by Apache Camel. +Number of Data Formats: indexCount:[] in indexUniqueCount:[unique=artifactid] JAR artifacts (indexCount:[attributes=deprecated] deprecated) -// dataformats: START -Number of Data Formats: 45 in 37 JAR artifacts (0 deprecated) - -[width="100%",cols="4,1,5",options="header"] +[{index-table-format}] |=== -| Data Format | Since | Description - -| xref:dataformats:any23-dataformat.adoc[Any23] (camel-any23) | 3.0 | Any23 data format is used for parsing data to RDF. - -| xref:dataformats:asn1-dataformat.adoc[ASN.1 File] (camel-asn1) | 2.20 | The ASN.1 data format is used for file transfer with telecommunications protocols. - -| xref:dataformats:avro-dataformat.adoc[Avro] (camel-avro) | 2.14 | The Avro data format is used for serialization and deserialization of messages using Apache Avro binary dataformat. - -| xref:dataformats:barcode-dataformat.adoc[Barcode] (camel-barcode) | 2.14 | The Barcode data format is used for creating barccode images (such as QR-Code) - -| xref:dataformats:base64-dataformat.adoc[Base64] (camel-base64) | 2.11 | The Base64 data format is used for base64 encoding and decoding. - -| xref:dataformats:beanio-dataformat.adoc[BeanIO] (camel-beanio) | 2.10 | The BeanIO data format is used for working with flat payloads (such as CSV, delimited, or fixed length formats). - -| xref:dataformats:bindy-dataformat.adoc[Bindy CSV] (camel-bindy) | 2.0 | The Bindy data format is used for working with flat payloads (such as CSV, delimited, fixed length formats, or FIX messages). - -| xref:dataformats:bindy-dataformat.adoc[Bindy Fixed Length] (camel-bindy) | 2.0 | The Bindy data format is used for working with flat payloads (such as CSV, delimited, fixed length formats, or FIX messages). - -| xref:dataformats:bindy-dataformat.adoc[Bindy Key Value Pair] (camel-bindy) | 2.0 | The Bindy data format is used for working with flat payloads (such as CSV, delimited, fixed length formats, or FIX messages). - -| xref:dataformats:cbor-dataformat.adoc[CBOR] (camel-cbor) | 3.0 | CBOR data format is used for unmarshal a CBOR payload to POJO or to marshal POJO back to CBOR payload. - -| xref:dataformats:crypto-dataformat.adoc[Crypto (Java Cryptographic Extension)] (camel-crypto) | 2.3 | Crypto data format is used for encrypting and decrypting of messages using Java Cryptographic Extension. - -| xref:dataformats:csv-dataformat.adoc[CSV] (camel-csv) | 1.3 | The CSV data format is used for handling CSV payloads. - -| xref:dataformats:fhirJson-dataformat.adoc[FHIR JSon] (camel-fhir) | 2.21 | The FHIR JSon data format is used to marshall/unmarshall to/from FHIR objects to/from JSON. - -| xref:dataformats:fhirXml-dataformat.adoc[FHIR XML] (camel-fhir) | 2.21 | The FHIR XML data format is used to marshall/unmarshall from/to FHIR objects to/from XML. - -| xref:dataformats:flatpack-dataformat.adoc[Flatpack] (camel-flatpack) | 2.1 | The Flatpack data format is used for working with flat payloads (such as CSV, delimited, or fixed length formats). - -| xref:dataformats:grok-dataformat.adoc[Grok] (camel-grok) | 3.0 | The Grok data format is used for unmarshalling unstructured data to objects using Logstash based Grok patterns. - -| xref:dataformats:gzipdeflater-dataformat.adoc[GZip Deflater] (camel-zip-deflater) | 2.0 | The GZip data format is a message compression and de-compression format (which works with the popular gzip/gunzip tools). - -| xref:dataformats:hl7-dataformat.adoc[HL7] (camel-hl7) | 2.0 | The HL7 data format can be used to marshal or unmarshal HL7 (Health Care) model objects. - -| xref:dataformats:ical-dataformat.adoc[iCal] (camel-ical) | 2.12 | The iCal dataformat is used for working with iCalendar messages. - -| xref:dataformats:jacksonxml-dataformat.adoc[JacksonXML] (camel-jacksonxml) | 2.16 | JacksonXML data format is used for unmarshal a XML payload to POJO or to marshal POJO back to XML payload. - -| xref:dataformats:jaxb-dataformat.adoc[JAXB] (camel-jaxb) | 1.0 | JAXB data format uses the JAXB2 XML marshalling standard to unmarshal an XML payload into Java objects or to marshal Java objects into an XML payload. - -| xref:dataformats:json-fastjson-dataformat.adoc[JSon Fastjson] (camel-fastjson) | 2.20 | JSon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload. - -| xref:dataformats:json-gson-dataformat.adoc[JSon GSon] (camel-gson) | 2.10 | JSon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload. - -| xref:dataformats:json-jackson-dataformat.adoc[JSon Jackson] (camel-jackson) | 2.0 | JSon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload. - -| xref:dataformats:json-johnzon-dataformat.adoc[JSon Johnzon] (camel-johnzon) | 2.18 | JSon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload. - -| xref:dataformats:json-xstream-dataformat.adoc[JSon XStream] (camel-xstream) | 2.0 | JSon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload. - -| xref:dataformats:jsonApi-dataformat.adoc[JSonApi] (camel-jsonapi) | 3.0 | JSonApi data format is used for marshal and unmarshal Json API object. - -| xref:dataformats:lzf-dataformat.adoc[LZF Deflate Compression] (camel-lzf) | 2.17 | The LZF data format is a message compression and de-compression format (uses the LZF deflate algorithm). - -| xref:dataformats:mime-multipart-dataformat.adoc[MIME Multipart] (camel-mail) | 2.17 | The MIME Multipart data format is used for marshalling Camel messages with attachments into MIME-Multipart message, and vise-versa. - -| xref:dataformats:pgp-dataformat.adoc[PGP] (camel-crypto) | 2.9 | PGP data format is used for encrypting and decrypting of messages using Java Cryptographic Extension and PGP. - -| xref:dataformats:protobuf-dataformat.adoc[Protobuf] (camel-protobuf) | 2.2 | The Protobuf data format is used for serializing between Java objects and the Google Protobuf protocol. - -| xref:dataformats:rss-dataformat.adoc[RSS] (camel-rss) | 2.1 | RSS data format is used for working with RSS sync feed Java Objects and transforming to XML and vice-versa. - -| xref:dataformats:soapjaxb-dataformat.adoc[SOAP] (camel-soap) | 2.3 | SOAP is a data format which uses JAXB2 and JAX-WS annotations to marshal and unmarshal SOAP payloads. - -| xref:dataformats:syslog-dataformat.adoc[Syslog] (camel-syslog) | 2.6 | The Syslog dataformat is used for working with RFC3164 and RFC5424 messages (logging and monitoring). - -| xref:dataformats:tarfile-dataformat.adoc[Tar File] (camel-tarfile) | 2.16 | The Tar File data format is a message compression and de-compression format of tar files. - -| xref:dataformats:thrift-dataformat.adoc[Thrift] (camel-thrift) | 2.20 | The Thrift data format is used for serialization and deserialization of messages using Apache Thrift binary dataformat. - -| xref:dataformats:tidyMarkup-dataformat.adoc[TidyMarkup] (camel-tagsoup) | 2.0 | TidyMarkup data format is used for parsing HTML and return it as pretty well-formed HTML. - -| xref:dataformats:univocity-csv-dataformat.adoc[uniVocity CSV] (camel-univocity-parsers) | 2.15 | The uniVocity CSV data format is used for working with CSV (Comma Separated Values) flat payloads. - -| xref:dataformats:univocity-fixed-dataformat.adoc[uniVocity Fixed Length] (camel-univocity-parsers) | 2.15 | The uniVocity Fixed Length data format is used for working with fixed length flat payloads. - -| xref:dataformats:univocity-tsv-dataformat.adoc[uniVocity TSV] (camel-univocity-parsers) | 2.15 | The uniVocity TSV data format is used for working with TSV (Tabular Separated Values) flat payloads. - -| xref:dataformats:secureXML-dataformat.adoc[XML Security] (camel-xmlsecurity) | 2.0 | The XML Security data format facilitates encryption and decryption of XML payloads. - -| xref:dataformats:xstream-dataformat.adoc[XStream] (camel-xstream) | 1.3 | XStream data format is used for unmarshal a XML payload to POJO or to marshal POJO back to XML payload. - -| xref:dataformats:yaml-snakeyaml-dataformat.adoc[YAML SnakeYAML] (camel-snakeyaml) | 2.17 | YAML is a data format to marshal and unmarshal Java objects to and from YAML. - -| xref:dataformats:zipdeflater-dataformat.adoc[Zip Deflate Compression] (camel-zip-deflater) | 2.12 | Zip Deflate Compression data format is a message compression and de-compression format (not zip files). - -| xref:dataformats:zipfile-dataformat.adoc[Zip File] (camel-zipfile) | 2.11 | The Zip File data format is a message compression and de-compression format of zip files. +| Data Format | Artifact | Support Level | Since | Description |=== -// dataformats: END +indexTable::[cells="$xref,artifactid,supportlevel,since,description"] diff --git a/docs/components/modules/dataformats/pages/jacksonxml-dataformat.adoc b/docs/components/modules/dataformats/pages/jacksonxml-dataformat.adoc index 66315e4267d91..dbe9c7cb53df4 100644 --- a/docs/components/modules/dataformats/pages/jacksonxml-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/jacksonxml-dataformat.adoc @@ -1,8 +1,13 @@ [[jacksonxml-dataformat]] = JacksonXML DataFormat :page-source: components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc +:docTitle: JacksonXML +:artifactId: camel-jacksonxml +:description: JacksonXML data format is used for unmarshal a XML payload to POJO or to marshal POJO back to XML payload. +:since: 2.16 +:supportLevel: Stable -*Since Camel 2.16* +*Since Camel {since}* Jackson XML is a Data Format which uses the http://wiki.fasterxml.com/JacksonHome/[Jackson library] with the diff --git a/docs/components/modules/dataformats/pages/jaxb-dataformat.adoc b/docs/components/modules/dataformats/pages/jaxb-dataformat.adoc index 3243cc99a0e8f..0e720f542ff4d 100644 --- a/docs/components/modules/dataformats/pages/jaxb-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/jaxb-dataformat.adoc @@ -1,8 +1,13 @@ [[jaxb-dataformat]] = JAXB DataFormat :page-source: components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc +:docTitle: JAXB +:artifactId: camel-jaxb +:description: JAXB data format uses the JAXB2 XML marshalling standard to unmarshal an XML payload into Java objects or to marshal Java objects into an XML payload. +:since: 1.0 +:supportLevel: Stable -*Since Camel 1.0* +*Since Camel {since}* JAXB is a Data Format which uses the JAXB2 XML marshalling standard which is included in Java 6 to unmarshal an XML diff --git a/docs/components/modules/dataformats/pages/json-fastjson-dataformat.adoc b/docs/components/modules/dataformats/pages/json-fastjson-dataformat.adoc index 6fe4b1dad0384..17c33a7b9a9b6 100644 --- a/docs/components/modules/dataformats/pages/json-fastjson-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/json-fastjson-dataformat.adoc @@ -1,8 +1,13 @@ [[json-fastjson-dataformat]] = JSon Fastjson DataFormat :page-source: components/camel-fastjson/src/main/docs/json-fastjson-dataformat.adoc +:docTitle: JSon Fastjson +:artifactId: camel-fastjson +:description: JSon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload. +:since: 2.20 +:supportLevel: Stable -*Since Camel 2.20* +*Since Camel {since}* Fastjson is a Data Format which uses the https://github.com/alibaba/fastjson[Fastjson Library] diff --git a/docs/components/modules/dataformats/pages/json-gson-dataformat.adoc b/docs/components/modules/dataformats/pages/json-gson-dataformat.adoc index c200950971610..7f24e1af20750 100644 --- a/docs/components/modules/dataformats/pages/json-gson-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/json-gson-dataformat.adoc @@ -1,8 +1,13 @@ [[json-gson-dataformat]] = JSon GSon DataFormat :page-source: components/camel-gson/src/main/docs/json-gson-dataformat.adoc +:docTitle: JSon GSon +:artifactId: camel-gson +:description: JSon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload. +:since: 2.10 +:supportLevel: Stable -*Since Camel 2.10* +*Since Camel {since}* Gson is a Data Format which uses the https://github.com/google/gson[Gson Library] diff --git a/docs/components/modules/dataformats/pages/json-jackson-dataformat.adoc b/docs/components/modules/dataformats/pages/json-jackson-dataformat.adoc index a56ede085f483..5133f36b2a6d5 100644 --- a/docs/components/modules/dataformats/pages/json-jackson-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/json-jackson-dataformat.adoc @@ -1,8 +1,13 @@ [[json-jackson-dataformat]] = JSon Jackson DataFormat :page-source: components/camel-jackson/src/main/docs/json-jackson-dataformat.adoc +:docTitle: JSon Jackson +:artifactId: camel-jackson +:description: JSon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload. +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* Jackson is a Data Format which uses the https://github.com/FasterXML/jackson-core[Jackson Library] diff --git a/docs/components/modules/dataformats/pages/json-johnzon-dataformat.adoc b/docs/components/modules/dataformats/pages/json-johnzon-dataformat.adoc index 1f0ad2e001566..1d2bfcafc37b8 100644 --- a/docs/components/modules/dataformats/pages/json-johnzon-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/json-johnzon-dataformat.adoc @@ -1,8 +1,13 @@ [[json-johnzon-dataformat]] = JSon Johnzon DataFormat :page-source: components/camel-johnzon/src/main/docs/json-johnzon-dataformat.adoc +:docTitle: JSon Johnzon +:artifactId: camel-johnzon +:description: JSon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload. +:since: 2.18 +:supportLevel: Stable -*Since Camel 2.18* +*Since Camel {since}* Johnzon is a Data Format which uses the http://johnzon.apache.org/[Johnzon Library] diff --git a/docs/components/modules/dataformats/pages/json-xstream-dataformat.adoc b/docs/components/modules/dataformats/pages/json-xstream-dataformat.adoc index 2b89e01e5c386..30de6c5c0aa69 100644 --- a/docs/components/modules/dataformats/pages/json-xstream-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/json-xstream-dataformat.adoc @@ -1,8 +1,13 @@ [[json-xstream-dataformat]] = JSon XStream DataFormat :page-source: components/camel-xstream/src/main/docs/json-xstream-dataformat.adoc +:docTitle: JSon XStream +:artifactId: camel-xstream +:description: JSon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload. +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* XStream is a Data Format which uses the http://xstream.codehaus.org/[XStream library] to marshal and unmarshal diff --git a/docs/components/modules/dataformats/pages/jsonApi-dataformat.adoc b/docs/components/modules/dataformats/pages/jsonApi-dataformat.adoc index 4fd139a01db31..e59cc87173ddf 100644 --- a/docs/components/modules/dataformats/pages/jsonApi-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/jsonApi-dataformat.adoc @@ -1,8 +1,13 @@ [[jsonApi-dataformat]] = JSonApi DataFormat :page-source: components/camel-jsonapi/src/main/docs/jsonApi-dataformat.adoc +:docTitle: JSonApi +:artifactId: camel-jsonapi +:description: JSonApi data format is used for marshal and unmarshal Json API object. +:since: 3.0 +:supportLevel: Stable -*Since Camel 3.0* +*Since Camel {since}* // dataformat options: START The JSonApi dataformat supports 3 options, which are listed below. diff --git a/docs/components/modules/dataformats/pages/lzf-dataformat.adoc b/docs/components/modules/dataformats/pages/lzf-dataformat.adoc index b4ce7c2244884..650423b0a9adf 100644 --- a/docs/components/modules/dataformats/pages/lzf-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/lzf-dataformat.adoc @@ -1,8 +1,13 @@ [[lzf-dataformat]] = LZF Deflate Compression DataFormat :page-source: components/camel-lzf/src/main/docs/lzf-dataformat.adoc +:docTitle: LZF Deflate Compression +:artifactId: camel-lzf +:description: The LZF data format is a message compression and de-compression format (uses the LZF deflate algorithm). +:since: 2.17 +:supportLevel: Stable -*Since Camel 2.17* +*Since Camel {since}* The LZF xref:manual::data-format.adoc[Data Format] is a message compression diff --git a/docs/components/modules/dataformats/pages/mime-multipart-dataformat.adoc b/docs/components/modules/dataformats/pages/mime-multipart-dataformat.adoc index 8ba6f94173c49..1b0a29146c721 100644 --- a/docs/components/modules/dataformats/pages/mime-multipart-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/mime-multipart-dataformat.adoc @@ -1,8 +1,13 @@ [[mime-multipart-dataformat]] = MIME Multipart DataFormat :page-source: components/camel-mail/src/main/docs/mime-multipart-dataformat.adoc +:docTitle: MIME Multipart +:artifactId: camel-mail +:description: The MIME Multipart data format is used for marshalling Camel messages with attachments into MIME-Multipart message, and vise-versa. +:since: 2.17 +:supportLevel: Stable -*Since Camel 2.17* +*Since Camel {since}* This data format that can convert a Camel message with attachments into a Camel message having a MIME-Multipart message as message body (and no diff --git a/docs/components/modules/dataformats/pages/pgp-dataformat.adoc b/docs/components/modules/dataformats/pages/pgp-dataformat.adoc index c7367e9415101..2e8e0437347f4 100644 --- a/docs/components/modules/dataformats/pages/pgp-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/pgp-dataformat.adoc @@ -1,8 +1,13 @@ [[pgp-dataformat]] = PGP DataFormat :page-source: components/camel-crypto/src/main/docs/pgp-dataformat.adoc +:docTitle: PGP +:artifactId: camel-crypto +:description: PGP data format is used for encrypting and decrypting of messages using Java Cryptographic Extension and PGP. +:since: 2.9 +:supportLevel: Stable -*Since Camel 2.9* +*Since Camel {since}* The PGP Data Format integrates the Java Cryptographic Extension into Camel, allowing simple and flexible diff --git a/docs/components/modules/dataformats/pages/protobuf-dataformat.adoc b/docs/components/modules/dataformats/pages/protobuf-dataformat.adoc index fd56a808075ce..217e747d817f7 100644 --- a/docs/components/modules/dataformats/pages/protobuf-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/protobuf-dataformat.adoc @@ -1,8 +1,13 @@ [[protobuf-dataformat]] = Protobuf DataFormat :page-source: components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc -[[Protobuf-Protobuf-ProtocolBuffers]] -*Since Camel 2.2.0* +:docTitle: Protobuf +:artifactId: camel-protobuf +:description: The Protobuf data format is used for serializing between Java objects and the Google Protobuf protocol. +:since: 2.2 +:supportLevel: Stable + +*Since Camel {since}* Protobuf - Protocol Buffers --------------------------- diff --git a/docs/components/modules/dataformats/pages/rss-dataformat.adoc b/docs/components/modules/dataformats/pages/rss-dataformat.adoc index 04c014a19dc1c..0fa31b1695d6e 100644 --- a/docs/components/modules/dataformats/pages/rss-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/rss-dataformat.adoc @@ -1,8 +1,13 @@ [[rss-dataformat]] = RSS DataFormat :page-source: components/camel-rss/src/main/docs/rss-dataformat.adoc +:docTitle: RSS +:artifactId: camel-rss +:description: RSS data format is used for working with RSS sync feed Java Objects and transforming to XML and vice-versa. +:since: 2.1 +:supportLevel: Stable -*Since Camel 2.1* +*Since Camel {since}* The RSS component ships with an RSS dataformat that can be used to convert between String (as XML) and ROME RSS model objects. diff --git a/docs/components/modules/dataformats/pages/secureXML-dataformat.adoc b/docs/components/modules/dataformats/pages/secureXML-dataformat.adoc index b302e7959f2c5..94e5c7b2b87c7 100644 --- a/docs/components/modules/dataformats/pages/secureXML-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/secureXML-dataformat.adoc @@ -1,8 +1,13 @@ [[secureXML-dataformat]] = XML Security DataFormat :page-source: components/camel-xmlsecurity/src/main/docs/secureXML-dataformat.adoc +:docTitle: XML Security +:artifactId: camel-xmlsecurity +:description: The XML Security data format facilitates encryption and decryption of XML payloads. +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* The XMLSecurity Data Format facilitates encryption and decryption of XML payloads at the Document, Element, and Element Content levels (including diff --git a/docs/components/modules/dataformats/pages/soapjaxb-dataformat.adoc b/docs/components/modules/dataformats/pages/soapjaxb-dataformat.adoc index 17add2abebd9a..f7cf6ae92d99c 100644 --- a/docs/components/modules/dataformats/pages/soapjaxb-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/soapjaxb-dataformat.adoc @@ -1,8 +1,13 @@ [[soapjaxb-dataformat]] = SOAP DataFormat :page-source: components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc +:docTitle: SOAP +:artifactId: camel-soap +:description: SOAP is a data format which uses JAXB2 and JAX-WS annotations to marshal and unmarshal SOAP payloads. +:since: 2.3 +:supportLevel: Stable -*Since Camel 2.3* +*Since Camel {since}* SOAP is a Data Format which uses JAXB2 and JAX-WS annotations to marshal and unmarshal SOAP payloads. It provides the diff --git a/docs/components/modules/dataformats/pages/syslog-dataformat.adoc b/docs/components/modules/dataformats/pages/syslog-dataformat.adoc index d9acde3370451..a1aa09d5daad5 100644 --- a/docs/components/modules/dataformats/pages/syslog-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/syslog-dataformat.adoc @@ -1,8 +1,13 @@ [[syslog-dataformat]] = Syslog DataFormat :page-source: components/camel-syslog/src/main/docs/syslog-dataformat.adoc +:docTitle: Syslog +:artifactId: camel-syslog +:description: The Syslog dataformat is used for working with RFC3164 and RFC5424 messages (logging and monitoring). +:since: 2.6 +:supportLevel: Stable -*Since Camel 2.6* +*Since Camel {since}* The Syslog dataformat is used for working with http://www.ietf.org/rfc/rfc3164.txt[RFC3164] and RFC5424 messages. diff --git a/docs/components/modules/dataformats/pages/tarfile-dataformat.adoc b/docs/components/modules/dataformats/pages/tarfile-dataformat.adoc index 62598e19f6d83..5b5eef335d8cf 100644 --- a/docs/components/modules/dataformats/pages/tarfile-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/tarfile-dataformat.adoc @@ -1,8 +1,13 @@ [[tarfile-dataformat]] = Tar File DataFormat :page-source: components/camel-tarfile/src/main/docs/tarfile-dataformat.adoc +:docTitle: Tar File +:artifactId: camel-tarfile +:description: The Tar File data format is a message compression and de-compression format of tar files. +:since: 2.16 +:supportLevel: Stable -*Since Camel 2.16* +*Since Camel {since}* The Tar File Data Format is a message compression and de-compression format. Messages can be marshalled (compressed) to diff --git a/docs/components/modules/dataformats/pages/thrift-dataformat.adoc b/docs/components/modules/dataformats/pages/thrift-dataformat.adoc index d9853cc77fa5d..3db6db6dc5807 100644 --- a/docs/components/modules/dataformats/pages/thrift-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/thrift-dataformat.adoc @@ -1,8 +1,13 @@ [[thrift-dataformat]] = Thrift DataFormat :page-source: components/camel-thrift/src/main/docs/thrift-dataformat.adoc +:docTitle: Thrift +:artifactId: camel-thrift +:description: The Thrift data format is used for serialization and deserialization of messages using Apache Thrift binary dataformat. +:since: 2.20 +:supportLevel: Stable -*Since Camel 2.20* +*Since Camel {since}* Camel provides a Data Format to serialize between diff --git a/docs/components/modules/dataformats/pages/tidyMarkup-dataformat.adoc b/docs/components/modules/dataformats/pages/tidyMarkup-dataformat.adoc index 157570e12e065..d449a84401c01 100644 --- a/docs/components/modules/dataformats/pages/tidyMarkup-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/tidyMarkup-dataformat.adoc @@ -1,8 +1,13 @@ [[tidyMarkup-dataformat]] = TidyMarkup DataFormat :page-source: components/camel-tagsoup/src/main/docs/tidyMarkup-dataformat.adoc +:docTitle: TidyMarkup +:artifactId: camel-tagsoup +:description: TidyMarkup data format is used for parsing HTML and return it as pretty well-formed HTML. +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* TidyMarkup is a Data Format that uses the http://www.ccil.org/~cowan/XML/tagsoup/[TagSoup] to tidy up HTML. It can diff --git a/docs/components/modules/dataformats/pages/univocity-csv-dataformat.adoc b/docs/components/modules/dataformats/pages/univocity-csv-dataformat.adoc index ea119377aeff8..7dfff22cf8438 100644 --- a/docs/components/modules/dataformats/pages/univocity-csv-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/univocity-csv-dataformat.adoc @@ -1,8 +1,13 @@ [[univocity-csv-dataformat]] = uniVocity CSV DataFormat :page-source: components/camel-univocity-parsers/src/main/docs/univocity-csv-dataformat.adoc +:docTitle: uniVocity CSV +:artifactId: camel-univocity-parsers +:description: The uniVocity CSV data format is used for working with CSV (Comma Separated Values) flat payloads. +:since: 2.15 +:supportLevel: Stable -*Since Camel 2.15* +*Since Camel {since}* This xref:manual::data-format.adoc[Data Format] uses http://www.univocity.com/pages/about-parsers[uniVocity-parsers] diff --git a/docs/components/modules/dataformats/pages/univocity-fixed-dataformat.adoc b/docs/components/modules/dataformats/pages/univocity-fixed-dataformat.adoc index a899afabd1211..76a052bc1c7a3 100644 --- a/docs/components/modules/dataformats/pages/univocity-fixed-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/univocity-fixed-dataformat.adoc @@ -1,8 +1,13 @@ [[univocity-fixed-dataformat]] = uniVocity Fixed Length DataFormat :page-source: components/camel-univocity-parsers/src/main/docs/univocity-fixed-dataformat.adoc +:docTitle: uniVocity Fixed Length +:artifactId: camel-univocity-parsers +:description: The uniVocity Fixed Length data format is used for working with fixed length flat payloads. +:since: 2.15 +:supportLevel: Stable -*Since Camel 2.15* +*Since Camel {since}* This xref:manual::data-format.adoc[Data Format] uses http://www.univocity.com/pages/about-parsers[uniVocity-parsers] diff --git a/docs/components/modules/dataformats/pages/univocity-tsv-dataformat.adoc b/docs/components/modules/dataformats/pages/univocity-tsv-dataformat.adoc index e548bc1a6309c..bbfd84a4dce7e 100644 --- a/docs/components/modules/dataformats/pages/univocity-tsv-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/univocity-tsv-dataformat.adoc @@ -1,8 +1,13 @@ [[univocity-tsv-dataformat]] = uniVocity TSV DataFormat :page-source: components/camel-univocity-parsers/src/main/docs/univocity-tsv-dataformat.adoc +:docTitle: uniVocity TSV +:artifactId: camel-univocity-parsers +:description: The uniVocity TSV data format is used for working with TSV (Tabular Separated Values) flat payloads. +:since: 2.15 +:supportLevel: Stable -*Since Camel 2.15* +*Since Camel {since}* This xref:manual::data-format.adoc[Data Format] uses http://www.univocity.com/pages/about-parsers[uniVocity-parsers] diff --git a/docs/components/modules/dataformats/pages/xstream-dataformat.adoc b/docs/components/modules/dataformats/pages/xstream-dataformat.adoc index e63e7be8bfa68..f71081bf49040 100644 --- a/docs/components/modules/dataformats/pages/xstream-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/xstream-dataformat.adoc @@ -1,8 +1,13 @@ [[xstream-dataformat]] = XStream DataFormat :page-source: components/camel-xstream/src/main/docs/xstream-dataformat.adoc +:docTitle: XStream +:artifactId: camel-xstream +:description: XStream data format is used for unmarshal a XML payload to POJO or to marshal POJO back to XML payload. +:since: 1.3 +:supportLevel: Stable -*Since Camel 1.3* +*Since Camel {since}* XStream is a Data Format which uses the http://x-stream.github.io/[XStream library] to marshal and unmarshal diff --git a/docs/components/modules/dataformats/pages/yaml-snakeyaml-dataformat.adoc b/docs/components/modules/dataformats/pages/yaml-snakeyaml-dataformat.adoc index f7b4d73de554a..63f30762ab5fd 100644 --- a/docs/components/modules/dataformats/pages/yaml-snakeyaml-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/yaml-snakeyaml-dataformat.adoc @@ -1,8 +1,13 @@ [[yaml-snakeyaml-dataformat]] = YAML SnakeYAML DataFormat :page-source: components/camel-snakeyaml/src/main/docs/yaml-snakeyaml-dataformat.adoc +:docTitle: YAML SnakeYAML +:artifactId: camel-snakeyaml +:description: YAML is a data format to marshal and unmarshal Java objects to and from YAML. +:since: 2.17 +:supportLevel: Stable -*Since Camel 2.17* +*Since Camel {since}* YAML is a Data Format to marshal and unmarshal Java objects to and from http://www.yaml.org/[YAML]. diff --git a/docs/components/modules/dataformats/pages/zipdeflater-dataformat.adoc b/docs/components/modules/dataformats/pages/zipdeflater-dataformat.adoc index 01d9f176fe079..e6ea12667dffc 100644 --- a/docs/components/modules/dataformats/pages/zipdeflater-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/zipdeflater-dataformat.adoc @@ -1,8 +1,13 @@ [[zipdeflater-dataformat]] = Zip Deflate Compression DataFormat :page-source: components/camel-zip-deflater/src/main/docs/zipdeflater-dataformat.adoc +:docTitle: Zip Deflate Compression +:artifactId: camel-zip-deflater +:description: Zip Deflate Compression data format is a message compression and de-compression format (not zip files). +:since: 2.12 +:supportLevel: Stable -*Since Camel 2.12* +*Since Camel {since}* The Zip Deflater Data Format is a message compression and diff --git a/docs/components/modules/dataformats/pages/zipfile-dataformat.adoc b/docs/components/modules/dataformats/pages/zipfile-dataformat.adoc index b67ef40f8b860..ff5095ad989a9 100644 --- a/docs/components/modules/dataformats/pages/zipfile-dataformat.adoc +++ b/docs/components/modules/dataformats/pages/zipfile-dataformat.adoc @@ -1,8 +1,13 @@ [[zipfile-dataformat]] = Zip File DataFormat :page-source: components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc +:docTitle: Zip File +:artifactId: camel-zipfile +:description: The Zip File data format is a message compression and de-compression format of zip files. +:since: 2.11 +:supportLevel: Stable -*Since Camel 2.11* +*Since Camel {since}* The Zip File Data Format is a message compression and de-compression format. Messages can be marshalled (compressed) to diff --git a/docs/components/modules/languages/nav.adoc b/docs/components/modules/languages/nav.adoc index c22ba56f53423..375ec1d3241c3 100644 --- a/docs/components/modules/languages/nav.adoc +++ b/docs/components/modules/languages/nav.adoc @@ -2,20 +2,20 @@ // make edits in docs/*nav.adoc.template files instead * xref:languages:index.adoc[Languages] -** xref:languages:bean-language.adoc[Bean method Language] -** xref:languages:constant-language.adoc[Constant Language] -** xref:languages:exchangeProperty-language.adoc[ExchangeProperty Language] -** xref:languages:file-language.adoc[File Language] -** xref:languages:groovy-language.adoc[Groovy Language] -** xref:languages:header-language.adoc[Header Language] -** xref:languages:hl7terser-language.adoc[HL7 Terser Language] -** xref:languages:jsonpath-language.adoc[JsonPath Language] -** xref:languages:mvel-language.adoc[MVEL Language] -** xref:languages:ognl-language.adoc[OGNL Language] -** xref:languages:ref-language.adoc[Ref Language] -** xref:languages:simple-language.adoc[Simple Language] -** xref:languages:spel-language.adoc[SpEL Language] -** xref:languages:tokenize-language.adoc[Tokenize Language] -** xref:languages:xtokenize-language.adoc[XML Tokenize Language] -** xref:languages:xpath-language.adoc[XPath Language] -** xref:languages:xquery-language.adoc[XQuery Language] +** xref:languages:bean-language.adoc[Bean method] +** xref:languages:constant-language.adoc[Constant] +** xref:languages:exchangeProperty-language.adoc[ExchangeProperty] +** xref:languages:file-language.adoc[File] +** xref:languages:groovy-language.adoc[Groovy] +** xref:languages:header-language.adoc[Header] +** xref:languages:hl7terser-language.adoc[HL7 Terser] +** xref:languages:jsonpath-language.adoc[JsonPath] +** xref:languages:mvel-language.adoc[MVEL] +** xref:languages:ognl-language.adoc[OGNL] +** xref:languages:ref-language.adoc[Ref] +** xref:languages:simple-language.adoc[Simple] +** xref:languages:spel-language.adoc[SpEL] +** xref:languages:tokenize-language.adoc[Tokenize] +** xref:languages:xtokenize-language.adoc[XML Tokenize] +** xref:languages:xpath-language.adoc[XPath] +** xref:languages:xquery-language.adoc[XQuery] diff --git a/docs/components/modules/languages/pages/bean-language.adoc b/docs/components/modules/languages/pages/bean-language.adoc index f23e748665913..2db2f8856936e 100644 --- a/docs/components/modules/languages/pages/bean-language.adoc +++ b/docs/components/modules/languages/pages/bean-language.adoc @@ -1,13 +1,18 @@ [[bean-language]] = Bean method Language :page-source: components/camel-bean/src/main/docs/bean-language.adoc -== Bean Language -*Since Camel 1.3* +:docTitle: Bean method +:artifactId: camel-bean +:description: To use a Java bean (aka method call) in Camel expressions or predicates. +:since: 1.3 +:supportLevel: Stable + +*Since Camel {since}* The purpose of the Bean Language is to be able to implement an xref:manual::expression.adoc[Expression] or xref:manual::predicate.adoc[Predicate] using a simple method on a bean. The bean name is resolved using a xref:manual::registry.adoc[Registry], such as the -xref:manual::spring.adoc[Spring] *`ApplicationContext`*, then a method is +xref:ROOT:spring-summary.adoc[Spring] *`ApplicationContext`*, then a method is invoked to evaluate the xref:manual::expression.adoc[Expression] or xref:manual::predicate.adoc[Predicate]. If no method name is provided then one is chosen using the rules for xref:manual::bean-binding.adoc[Bean Binding]; @@ -117,7 +122,7 @@ The xref:bean-language.adoc[Bean Language] also supports invoking beans that isn't registered in the xref:manual::registry.adoc[Registry]. This is usable for quickly to invoke a bean from Java DSL where you don't need to register the bean in the xref:manual::registry.adoc[Registry] such as the -xref:ROOT:spring.adoc[Spring] *`ApplicationContext`*. Camel can instantiate +xref:ROOT:spring-summary.adoc[Spring] *`ApplicationContext`*. Camel can instantiate the bean and invoke the method if given a class or invoke an already existing instance. diff --git a/docs/components/modules/languages/pages/groovy-language.adoc b/docs/components/modules/languages/pages/groovy-language.adoc index bd4ed1951d05a..c8ae2929106d5 100644 --- a/docs/components/modules/languages/pages/groovy-language.adoc +++ b/docs/components/modules/languages/pages/groovy-language.adoc @@ -1,8 +1,13 @@ [[groovy-language]] = Groovy Language :page-source: components/camel-groovy/src/main/docs/groovy-language.adoc +:docTitle: Groovy +:artifactId: camel-groovy +:description: To use Groovy scripts in Camel expressions or predicates. +:since: 1.3 +:supportLevel: Stable -*Since Camel 1.3* +*Since Camel {since}* Camel supports http://groovy.codehaus.org/[Groovy] among other Scripting Languages to allow an diff --git a/docs/components/modules/languages/pages/hl7terser-language.adoc b/docs/components/modules/languages/pages/hl7terser-language.adoc index 39b464d4119d8..e6f630d4c2042 100644 --- a/docs/components/modules/languages/pages/hl7terser-language.adoc +++ b/docs/components/modules/languages/pages/hl7terser-language.adoc @@ -1,8 +1,13 @@ [[hl7terser-language]] = HL7 Terser Language :page-source: components/camel-hl7/src/main/docs/hl7terser-language.adoc +:docTitle: HL7 Terser +:artifactId: camel-hl7 +:description: To use HL7 terser scripts in Camel expressions or predicates. +:since: 2.11 +:supportLevel: Stable -*Since Camel 2.11* +*Since Camel {since}* http://hl7api.sourceforge.net[HAPI] provides a http://hl7api.sourceforge.net/base/apidocs/ca/uhn/hl7v2/util/Terser.html[Terser] diff --git a/docs/components/modules/languages/pages/index.adoc b/docs/components/modules/languages/pages/index.adoc index df1b335d17298..bb878b0cdf971 100644 --- a/docs/components/modules/languages/pages/index.adoc +++ b/docs/components/modules/languages/pages/index.adoc @@ -3,46 +3,11 @@ Below is the list of expression languages that are provided by Apache Camel. +Number of Languages: indexCount:[] in indexUniqueCount:[unique=artifactid] JAR artifacts (indexCount:[attributes=deprecated] deprecated) -// languages: START -Number of Languages: 17 in 11 JAR artifacts (0 deprecated) - -[width="100%",cols="4,1,5",options="header"] +[{index-table-format}] |=== -| Language | Since | Description - -| xref:languages:bean-language.adoc[Bean method] (camel-bean) | 1.3 | To use a Java bean (aka method call) in Camel expressions or predicates. - -| xref:languages:constant-language.adoc[Constant] (camel-core-languages) | 1.5 | To use a constant value in Camel expressions or predicates. Important: this is a fixed constant value that is only set once during starting up the route, do not use this if you want dynamic values during routing. - -| xref:languages:exchangeProperty-language.adoc[ExchangeProperty] (camel-core-languages) | 2.0 | To use a Camel Exchange property in expressions or predicates. - -| xref:languages:file-language.adoc[File] (camel-core-languages) | 1.1 | For expressions and predicates using the file/simple language. - -| xref:languages:groovy-language.adoc[Groovy] (camel-groovy) | 1.3 | To use Groovy scripts in Camel expressions or predicates. - -| xref:languages:header-language.adoc[Header] (camel-core-languages) | 1.5 | To use a Camel Message header in expressions or predicates. - -| xref:languages:hl7terser-language.adoc[HL7 Terser] (camel-hl7) | 2.11 | To use HL7 terser scripts in Camel expressions or predicates. - -| xref:languages:jsonpath-language.adoc[JsonPath] (camel-jsonpath) | 2.13 | To use JsonPath in Camel expressions or predicates. - -| xref:languages:mvel-language.adoc[MVEL] (camel-mvel) | 2.0 | To use MVEL scripts in Camel expressions or predicates. - -| xref:languages:ognl-language.adoc[OGNL] (camel-ognl) | 1.1 | To use OGNL scripts in Camel expressions or predicates. - -| xref:languages:ref-language.adoc[Ref] (camel-core-languages) | 2.8 | Reference to an existing Camel expression or predicate, which is looked up from the Camel registry. - -| xref:languages:simple-language.adoc[Simple] (camel-core-languages) | 1.1 | To use Camels built-in Simple language in Camel expressions or predicates. - -| xref:languages:spel-language.adoc[SpEL] (camel-spring) | 2.7 | To use Spring Expression Language (SpEL) in Camel expressions or predicates. - -| xref:languages:tokenize-language.adoc[Tokenize] (camel-core-languages) | 2.0 | To use Camel message body or header with a tokenizer in Camel expressions or predicates. - -| xref:languages:xtokenize-language.adoc[XML Tokenize] (camel-xml-jaxp) | 2.14 | To use Camel message body or header with a XML tokenizer in Camel expressions or predicates. - -| xref:languages:xpath-language.adoc[XPath] (camel-xpath) | 1.1 | To use XPath (XML) in Camel expressions or predicates. - -| xref:languages:xquery-language.adoc[XQuery] (camel-saxon) | 1.0 | To use XQuery (XML) in Camel expressions or predicates. +| Language | Artifact | Support Level | Since | Description |=== -// languages: END +indexTable::[cells="$xref,artifactid,supportlevel,since,description"] + diff --git a/docs/components/modules/languages/pages/jsonpath-language.adoc b/docs/components/modules/languages/pages/jsonpath-language.adoc index d9cf497dba96c..64900b73d2c13 100644 --- a/docs/components/modules/languages/pages/jsonpath-language.adoc +++ b/docs/components/modules/languages/pages/jsonpath-language.adoc @@ -1,8 +1,13 @@ [[jsonpath-language]] = JsonPath Language :page-source: components/camel-jsonpath/src/main/docs/jsonpath-language.adoc +:docTitle: JsonPath +:artifactId: camel-jsonpath +:description: To use JsonPath in Camel expressions or predicates. +:since: 2.13 +:supportLevel: Stable -*Since Camel 2.13* +*Since Camel {since}* Camel supports https://code.google.com/p/json-path/[JSonPath] to allow using Expression or Predicate diff --git a/docs/components/modules/languages/pages/mvel-language.adoc b/docs/components/modules/languages/pages/mvel-language.adoc index 2189330176cb8..86f97ddb29a41 100644 --- a/docs/components/modules/languages/pages/mvel-language.adoc +++ b/docs/components/modules/languages/pages/mvel-language.adoc @@ -1,8 +1,13 @@ [[mvel-language]] = MVEL Language :page-source: components/camel-mvel/src/main/docs/mvel-language.adoc +:docTitle: MVEL +:artifactId: camel-mvel +:description: To use MVEL scripts in Camel expressions or predicates. +:since: 2.0 +:supportLevel: Stable -*Since Camel 2.0* +*Since Camel {since}* Camel allows Mvel to be used as an Expression or Predicate the DSL or diff --git a/docs/components/modules/languages/pages/ognl-language.adoc b/docs/components/modules/languages/pages/ognl-language.adoc index a801d8b83f8c1..224657e75d0c3 100644 --- a/docs/components/modules/languages/pages/ognl-language.adoc +++ b/docs/components/modules/languages/pages/ognl-language.adoc @@ -1,8 +1,13 @@ [[ognl-language]] = OGNL Language :page-source: components/camel-ognl/src/main/docs/ognl-language.adoc +:docTitle: OGNL +:artifactId: camel-ognl +:description: To use OGNL scripts in Camel expressions or predicates. +:since: 1.1 +:supportLevel: Stable -*Since Camel 1.1* +*Since Camel {since}* Camel allows http://commons.apache.org/proper/commons-ognl/[OGNL] to be used as an Expression or diff --git a/docs/components/modules/languages/pages/spel-language.adoc b/docs/components/modules/languages/pages/spel-language.adoc index 0ea6f322ca7e3..d939cfc8670e4 100644 --- a/docs/components/modules/languages/pages/spel-language.adoc +++ b/docs/components/modules/languages/pages/spel-language.adoc @@ -1,8 +1,13 @@ [[spel-language]] = SpEL Language :page-source: components/camel-spring/src/main/docs/spel-language.adoc +:docTitle: SpEL +:artifactId: camel-spring +:description: To use Spring Expression Language (SpEL) in Camel expressions or predicates. +:since: 2.7 +:supportLevel: Stable -*Since Camel 2.7* +*Since Camel {since}* Camel allows https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#expressions[Spring Expression Language (SpEL)] diff --git a/docs/components/modules/languages/pages/xpath-language.adoc b/docs/components/modules/languages/pages/xpath-language.adoc index f8b03711cb73f..162d62974ef39 100644 --- a/docs/components/modules/languages/pages/xpath-language.adoc +++ b/docs/components/modules/languages/pages/xpath-language.adoc @@ -1,8 +1,13 @@ [[xpath-language]] = XPath Language :page-source: components/camel-xpath/src/main/docs/xpath-language.adoc +:docTitle: XPath +:artifactId: camel-xpath +:description: To use XPath (XML) in Camel expressions or predicates. +:since: 1.1 +:supportLevel: Stable -*Since Camel 1.1* +*Since Camel {since}* Camel supports http://www.w3.org/TR/xpath[XPath] to allow an Expression or Predicate to be diff --git a/docs/components/modules/languages/pages/xquery-language.adoc b/docs/components/modules/languages/pages/xquery-language.adoc index 0149b8fa3ca72..28858488d2e56 100644 --- a/docs/components/modules/languages/pages/xquery-language.adoc +++ b/docs/components/modules/languages/pages/xquery-language.adoc @@ -1,8 +1,13 @@ [[xquery-language]] = XQuery Language :page-source: components/camel-saxon/src/main/docs/xquery-language.adoc +:docTitle: XQuery +:artifactId: camel-saxon +:description: To use XQuery (XML) in Camel expressions or predicates. +:since: 1.0 +:supportLevel: Stable -*Since Camel 1.0* +*Since Camel {since}* Camel supports http://www.w3.org/TR/xquery/[XQuery] to allow an Expression or Predicate to be diff --git a/docs/components/modules/others/nav.adoc b/docs/components/modules/others/nav.adoc new file mode 100644 index 0000000000000..6a1e994fe307e --- /dev/null +++ b/docs/components/modules/others/nav.adoc @@ -0,0 +1,38 @@ +// this file is auto generated and changes to it will be overwritten +// make edits in docs/*nav.adoc.template files instead + +* xref:others:index.adoc[Miscellaneous Components] +** xref:attachments.adoc[Attachments] +** xref:aws-xray.adoc[AWS XRay] +** xref:cdi.adoc[CDI] +** xref:cxf-transport.adoc[CXF Transport] +** xref:hystrix.adoc[Hystrix] +** xref:jasypt.adoc[Jasypt] +** xref:leveldb.adoc[LevelDB] +** xref:lra.adoc[LRA] +** xref:microprofile-config.adoc[Microprofile Config] +** xref:microprofile-fault-tolerance.adoc[Microprofile Fault Tolerance] +** xref:microprofile-health.adoc[Microprofile Health] +** xref:openapi-java.adoc[Openapi Java] +** xref:opentracing.adoc[OpenTracing] +** xref:platform-http-vertx.adoc[Platform Http Vertx] +** xref:reactive-executor-vertx.adoc[Reactive Executor Vert.x] +** xref:reactor.adoc[Reactor] +** xref:resilience4j.adoc[Resilience4j] +** xref:ribbon.adoc[Ribbon] +** xref:rxjava.adoc[RxJava] +** xref:shiro.adoc[Shiro] +** xref:spring-javaconfig.adoc[Spring Java Configuration] +** xref:spring-main.adoc[Spring Main] +** xref:spring-security.adoc[Spring Security] +** xref:swagger-java.adoc[Swagger Java] +** xref:test.adoc[Test] +** xref:test-cdi.adoc[Test CDI] +** xref:test-junit5.adoc[Test JUnit5] +** xref:test-spring.adoc[Test Spring] +** xref:test-spring-junit5.adoc[Test Spring JUnit5] +** xref:testcontainers.adoc[Testcontainers] +** xref:testcontainers-junit5.adoc[Testcontainers JUnit5] +** xref:testcontainers-spring.adoc[Testcontainers Spring] +** xref:testcontainers-spring-junit5.adoc[Testcontainers Spring Junit5] +** xref:zipkin.adoc[Zipkin] diff --git a/docs/components/modules/ROOT/pages/attachments.adoc b/docs/components/modules/others/pages/attachments.adoc similarity index 83% rename from docs/components/modules/ROOT/pages/attachments.adoc rename to docs/components/modules/others/pages/attachments.adoc index edc901dd38ab6..71163a21ef2de 100644 --- a/docs/components/modules/ROOT/pages/attachments.adoc +++ b/docs/components/modules/others/pages/attachments.adoc @@ -1,5 +1,13 @@ +[[attachments-component]] = Attachments Component :page-source: components/camel-attachments/src/main/docs/attachments.adoc +:docTitle: Attachments +:artifactId: camel-attachments +:description: Java Attachments support for Camel Message +:since: 3.0 +:supportLevel: Stable + +*Since Camel {since}* The attachments component provides the `javax.attachments` API support for Apache Camel. A few Camel component uses attachments such as mail and web-service components. diff --git a/docs/components/modules/ROOT/pages/aws-xray.adoc b/docs/components/modules/others/pages/aws-xray.adoc similarity index 97% rename from docs/components/modules/ROOT/pages/aws-xray.adoc rename to docs/components/modules/others/pages/aws-xray.adoc index 4e34a1b3b60ac..044d5754d87d3 100644 --- a/docs/components/modules/ROOT/pages/aws-xray.adoc +++ b/docs/components/modules/others/pages/aws-xray.adoc @@ -1,8 +1,13 @@ -[[AWSXRay-AWSXRayComponent]] +[[aws-xray-component]] = AWS XRay Component :page-source: components/camel-aws-xray/src/main/docs/aws-xray.adoc +:docTitle: AWS XRay +:artifactId: camel-aws-xray +:description: Distributed tracing using AWS XRay +:since: 2.21 +:supportLevel: Stable -*Since Camel 2.21* +*Since Camel {since}* The camel-aws-xray component is used for tracing and timing incoming and outgoing Camel messages using https://aws.amazon.com/xray/[AWS XRay]. diff --git a/docs/components/modules/ROOT/pages/cdi.adoc b/docs/components/modules/others/pages/cdi.adoc similarity index 99% rename from docs/components/modules/ROOT/pages/cdi.adoc rename to docs/components/modules/others/pages/cdi.adoc index 6263770d3e0bc..97419b13b5d0e 100644 --- a/docs/components/modules/ROOT/pages/cdi.adoc +++ b/docs/components/modules/others/pages/cdi.adoc @@ -1,6 +1,13 @@ [[cdi-component]] -= Camel CDI += CDI Component :page-source: components/camel-cdi/src/main/docs/cdi.adoc +:docTitle: CDI +:artifactId: camel-cdi +:description: Using Camel with CDI +:since: 2.10 +:supportLevel: Stable + +*Since Camel {since}* The Camel CDI component provides auto-configuration for Apache Camel using CDI as dependency injection framework based @@ -841,5 +848,3 @@ a Camel CDI Maven project, e.g.: ---- mvn archetype:generate -DarchetypeGroupId=org.apache.camel.archetypes -DarchetypeArtifactId=camel-archetype-cdi ---- - - diff --git a/docs/components/modules/ROOT/pages/cxf-transport.adoc b/docs/components/modules/others/pages/cxf-transport.adoc similarity index 98% rename from docs/components/modules/ROOT/pages/cxf-transport.adoc rename to docs/components/modules/others/pages/cxf-transport.adoc index 4ac38ea40eaf5..bd481b844d963 100644 --- a/docs/components/modules/ROOT/pages/cxf-transport.adoc +++ b/docs/components/modules/others/pages/cxf-transport.adoc @@ -1,5 +1,13 @@ +[[cxf-transport-component]] = CXF Transport Component :page-source: components/camel-cxf-transport/src/main/docs/cxf-transport.adoc +:docTitle: CXF Transport +:artifactId: camel-cxf-transport +:description: Camel Transport for Apache CXF +:since: 2.8 +:supportLevel: Stable + +*Since Camel {since}* [[CamelTransportforCXF-WhatstheCamelTransportforCXF]] == What's the Camel Transport for CXF @@ -253,4 +261,3 @@ context in the camel destination. This example shows how to use the camel load balancing feature in CXF. You need to load the configuration file in CXF and publish the endpoints on the address "camel://direct:EndpointA" and "camel://direct:EndpointB" - diff --git a/docs/components/modules/ROOT/pages/hystrix.adoc b/docs/components/modules/others/pages/hystrix.adoc similarity index 76% rename from docs/components/modules/ROOT/pages/hystrix.adoc rename to docs/components/modules/others/pages/hystrix.adoc index f314f47213c53..632bab17c4258 100644 --- a/docs/components/modules/ROOT/pages/hystrix.adoc +++ b/docs/components/modules/others/pages/hystrix.adoc @@ -1,7 +1,13 @@ +[[hystrix-component]] = Hystrix Component :page-source: components/camel-hystrix/src/main/docs/hystrix.adoc +:docTitle: Hystrix +:artifactId: camel-hystrix +:description: Circuit Breaker EIP using Netflix Hystrix +:since: 2.18 +:supportLevel: Stable -*Since Camel 2.18* +*Since Camel {since}* The Hystrix component integrates Netflix Hystrix circuit breaker in Camel routes. diff --git a/docs/components/modules/others/pages/index.adoc b/docs/components/modules/others/pages/index.adoc new file mode 100644 index 0000000000000..deefea2c8d4a1 --- /dev/null +++ b/docs/components/modules/others/pages/index.adoc @@ -0,0 +1,17 @@ +[list-of-camel-components] += Miscellaneous Components + +Component references are references used to place a component in an assembly. Apache Component references +provides various references that offers services for messaging, sending data, notifcations and various other +services that can not only resolve easy messaging and transferring data but also provide securing of data. + +Number of Miscellaneous Components: indexCount:[] in indexUniqueCount:[unique=artifactid] JAR artifacts (indexCount:[attributes=deprecated] deprecated) + +[{index-table-format}] +|=== +| Component | Artifact | Support Level | Since | Description +|=== +indexTable::[cells="$xref,artifactid,supportlevel,since,description"] + + + diff --git a/docs/components/modules/ROOT/pages/jasypt.adoc b/docs/components/modules/others/pages/jasypt.adoc similarity index 94% rename from docs/components/modules/ROOT/pages/jasypt.adoc rename to docs/components/modules/others/pages/jasypt.adoc index 61d122bf59deb..9406d7feb6cee 100644 --- a/docs/components/modules/ROOT/pages/jasypt.adoc +++ b/docs/components/modules/others/pages/jasypt.adoc @@ -1,11 +1,17 @@ -= Jasypt component +[[jasypt-component]] += Jasypt Component :page-source: components/camel-jasypt/src/main/docs/jasypt.adoc +:docTitle: Jasypt +:artifactId: camel-jasypt +:description: Security using Jasypt +:since: 2.5 +:supportLevel: Stable -*Since Camel 2.5* +*Since Camel {since}* http://www.jasypt.org/[Jasypt] is a simplified encryption library which makes encryption and decryption easy. Camel integrates with Jasypt to -allow sensitive information in xref:properties-component.adoc[Properties] files to +allow sensitive information in xref:ROOT:properties-component.adoc[Properties] files to be encrypted. By dropping *`camel-jasypt`* on the classpath those encrypted values will automatically be decrypted on-the-fly by Camel. This ensures that human eyes can't easily spot sensitive information @@ -98,7 +104,7 @@ Decrypted text: tiger --------------------- The idea is then to use those encrypted values in your -xref:properties-component.adoc[Properties] files. Notice how the password value is +xref:ROOT:properties-component.adoc[Properties] files. Notice how the password value is encrypted and the value has the tokens surrounding `ENC(value here)` [TIP] @@ -157,7 +163,7 @@ The `password` option is then a matter of defining as follows: In Java DSL you need to configure Jasypt as a `JasyptPropertiesParser` instance and set it on the -xref:properties-component.adoc[Properties] component as show below: +xref:ROOT:properties-component.adoc[Properties] component as show below: The properties file `myproperties.properties` then contain the encrypted value, such as shown below. Notice how the password value is encrypted @@ -166,7 +172,7 @@ and the value has the tokens surrounding `ENC(value here)` == Example with Spring XML In Spring XML you need to configure the `JasyptPropertiesParser` which -is shown below. Then the Camel xref:properties-component.adoc[Properties] +is shown below. Then the Camel xref:ROOT:properties-component.adoc[Properties] component is told to use `jasypt` as the properties parser, which means Jasypt has its chance to decrypt values looked up in the properties. @@ -187,7 +193,7 @@ the properties. ----------------------------------------------------------------------------------------------------------- -The xref:properties-component.adoc[Properties] component can also be inlined +The xref:ROOT:properties-component.adoc[Properties] component can also be inlined inside the `` tag which is shown below. Notice how we use the `propertiesParserRef` attribute to refer to Jasypt. @@ -217,7 +223,7 @@ Jasypt. In Blueprint XML you need to configure the `JasyptPropertiesParser` which is shown below. Then the -Camel xref:properties-component.adoc[Properties] component is told to +Camel xref:ROOT:properties-component.adoc[Properties] component is told to use `jasypt` as the properties parser, which means Jasypt has its chance to decrypt values looked up in the properties. @@ -257,7 +263,7 @@ up in the properties. ---------------------------------------------------------------------------------------------------------------- -The xref:properties-component.adoc[Properties] component can also be inlined +The xref:ROOT:properties-component.adoc[Properties] component can also be inlined inside the `` tag which is shown below. Notice how we use the `propertiesParserRef` attribute to refer to Jasypt. @@ -288,4 +294,3 @@ to Jasypt. ---------------------------------------------------------------------------------------------------------------- - diff --git a/docs/components/modules/ROOT/pages/leveldb.adoc b/docs/components/modules/others/pages/leveldb.adoc similarity index 96% rename from docs/components/modules/ROOT/pages/leveldb.adoc rename to docs/components/modules/others/pages/leveldb.adoc index 77e10f553d66a..139ab07d5d96d 100644 --- a/docs/components/modules/ROOT/pages/leveldb.adoc +++ b/docs/components/modules/others/pages/leveldb.adoc @@ -1,8 +1,13 @@ -[[LevelDB-LevelDB]] -= LevelDB +[[leveldb-component]] += LevelDB Component :page-source: components/camel-leveldb/src/main/docs/leveldb.adoc +:docTitle: LevelDB +:artifactId: camel-leveldb +:description: Using LevelDB as persistent EIP store +:since: 2.10 +:supportLevel: Stable -*Since Camel 2.10* +*Since Camel {since}* https://code.google.com/p/leveldb/[Leveldb] is a very lightweight and embedable key value database. It allows together with Camel to provide @@ -149,4 +154,3 @@ the download page for the latest versions). x.y.z ---------------------------------------- - diff --git a/docs/components/modules/ROOT/pages/lra.adoc b/docs/components/modules/others/pages/lra.adoc similarity index 77% rename from docs/components/modules/ROOT/pages/lra.adoc rename to docs/components/modules/others/pages/lra.adoc index 3b41fa8e788d6..cb24afee0b8b2 100644 --- a/docs/components/modules/ROOT/pages/lra.adoc +++ b/docs/components/modules/others/pages/lra.adoc @@ -1,7 +1,13 @@ +[[lra-component]] = LRA Component :page-source: components/camel-lra/src/main/docs/lra.adoc +:docTitle: LRA +:artifactId: camel-lra +:description: Camel saga binding for Long-Running-Action framework +:since: 2.21 +:supportLevel: Stable -*Since Camel 2.21.0* +*Since Camel {since}* The LRA module provides bindings of the Saga EIP with any https://github.com/eclipse/microprofile-sandbox/tree/master/proposals/0009-LRA[Microprofile compatible LRA Coordinator (sandbox)]. diff --git a/docs/components/modules/ROOT/pages/microprofile-config.adoc b/docs/components/modules/others/pages/microprofile-config.adoc similarity index 73% rename from docs/components/modules/ROOT/pages/microprofile-config.adoc rename to docs/components/modules/others/pages/microprofile-config.adoc index 50f556582c769..69602d0f252e7 100644 --- a/docs/components/modules/ROOT/pages/microprofile-config.adoc +++ b/docs/components/modules/others/pages/microprofile-config.adoc @@ -1,8 +1,13 @@ -[[MicroProfileConfig]] -= MicroProfile Config +[[microprofile-config-component]] += Microprofile Config Component :page-source: components/camel-microprofile-config/src/main/docs/microprofile-config.adoc +:docTitle: Microprofile Config +:artifactId: camel-microprofile-config +:description: Bridging Eclipse MicroProfile Config with Camel properties +:since: 3.0 +:supportLevel: Stable -*Since Camel 3.0* +*Since Camel {since}* The microprofile-config component is used for bridging the Eclipse MicroProfile Config with Camels properties component. This allows to use configuration management from Eclipse MicroProfile with Camel. diff --git a/docs/components/modules/ROOT/pages/microprofile-fault-tolerance.adoc b/docs/components/modules/others/pages/microprofile-fault-tolerance.adoc similarity index 71% rename from docs/components/modules/ROOT/pages/microprofile-fault-tolerance.adoc rename to docs/components/modules/others/pages/microprofile-fault-tolerance.adoc index 58021fd2696d1..b95000452a076 100644 --- a/docs/components/modules/ROOT/pages/microprofile-fault-tolerance.adoc +++ b/docs/components/modules/others/pages/microprofile-fault-tolerance.adoc @@ -1,7 +1,13 @@ +[[microprofile-fault-tolerance-component]] = Microprofile Fault Tolerance Component :page-source: components/camel-microprofile-fault-tolerance/src/main/docs/microprofile-fault-tolerance.adoc +:docTitle: Microprofile Fault Tolerance +:artifactId: camel-microprofile-fault-tolerance +:description: Circuit Breaker EIP using Microprofile Fault Tolerance +:since: 3.3 +:supportLevel: Preview -*Since Camel 3.3* +*Since Camel {since}* This component supports the Circuit Breaker EIP with the Microprofile Fault Tolerance library. @@ -19,4 +25,3 @@ for this component: ---- - diff --git a/docs/components/modules/ROOT/pages/microprofile-health.adoc b/docs/components/modules/others/pages/microprofile-health.adoc similarity index 89% rename from docs/components/modules/ROOT/pages/microprofile-health.adoc rename to docs/components/modules/others/pages/microprofile-health.adoc index 0fed98a8ed512..12f05e7e8d702 100644 --- a/docs/components/modules/ROOT/pages/microprofile-health.adoc +++ b/docs/components/modules/others/pages/microprofile-health.adoc @@ -1,8 +1,13 @@ -[[MicroProfileHealth-MicroProfileHealthComponent]] -= MicroProfile Health +[[microprofile-health-component]] += Microprofile Health Component :page-source: components/camel-microprofile-health/src/main/docs/microprofile-health.adoc +:docTitle: Microprofile Health +:artifactId: camel-microprofile-health +:description: Bridging Eclipse MicroProfile Health with Camel health checks +:since: 3.0 +:supportLevel: Stable -*Since Camel 3.0* +*Since Camel {since}* The microprofile-health component is used for bridging https://microprofile.io/project/eclipse/microprofile-health[Eclipse MicroProfile Health] checks with Camel's own Health Check API. diff --git a/docs/components/modules/ROOT/pages/openapi-java.adoc b/docs/components/modules/others/pages/openapi-java.adoc similarity index 97% rename from docs/components/modules/ROOT/pages/openapi-java.adoc rename to docs/components/modules/others/pages/openapi-java.adoc index f6a221979763c..0cc97d6963f28 100644 --- a/docs/components/modules/ROOT/pages/openapi-java.adoc +++ b/docs/components/modules/others/pages/openapi-java.adoc @@ -1,7 +1,13 @@ -= OpenApi Java Component +[[openapi-java-component]] += Openapi Java Component :page-source: components/camel-openapi-java/src/main/docs/openapi-java.adoc +:docTitle: Openapi Java +:artifactId: camel-openapi-java +:description: Rest-dsl support for using openapi doc +:since: 3.1 +:supportLevel: Stable -*Available as of Camel 3.1.0* +*Since Camel {since}* The Rest DSL can be integrated with the `camel-openapi-java` module which is used for exposing the REST diff --git a/docs/components/modules/ROOT/pages/opentracing.adoc b/docs/components/modules/others/pages/opentracing.adoc similarity index 96% rename from docs/components/modules/ROOT/pages/opentracing.adoc rename to docs/components/modules/others/pages/opentracing.adoc index 7c0984103025f..345da12fefc56 100644 --- a/docs/components/modules/ROOT/pages/opentracing.adoc +++ b/docs/components/modules/others/pages/opentracing.adoc @@ -1,8 +1,13 @@ -[[OpenTracing-OpenTracingComponent]] +[[opentracing-component]] = OpenTracing Component :page-source: components/camel-opentracing/src/main/docs/opentracing.adoc +:docTitle: OpenTracing +:artifactId: camel-opentracing +:description: Distributed tracing using OpenTracing +:since: 2.19 +:supportLevel: Stable -*Since Camel 2.19* +*Since Camel {since}* The OpenTracing component is used for tracing and timing incoming and outgoing Camel messages using http://opentracing.io/[OpenTracing]. diff --git a/docs/components/modules/ROOT/pages/platform-http-vertx.adoc b/docs/components/modules/others/pages/platform-http-vertx.adoc similarity index 84% rename from docs/components/modules/ROOT/pages/platform-http-vertx.adoc rename to docs/components/modules/others/pages/platform-http-vertx.adoc index 53aa1c197ad86..c8b04236c2d7c 100644 --- a/docs/components/modules/ROOT/pages/platform-http-vertx.adoc +++ b/docs/components/modules/others/pages/platform-http-vertx.adoc @@ -1,7 +1,13 @@ -= PlatformHttp VertX +[[platform-http-vertx-component]] += Platform Http Vertx Component :page-source: components/camel-platform-http-vertx/src/main/docs/platform-http-vertx.adoc +:docTitle: Platform Http Vertx +:artifactId: camel-platform-http-vertx +:description: Implementation of the Platform HTTP Engine based on Vert.x Web +:since: 3.2 +:supportLevel: Stable -*Since Camel 3.2* +*Since Camel {since}* The camel-platform-http-vertx is a Vert.x based implementation of the `PlatformHttp` SPI. @@ -43,4 +49,4 @@ context.addRoutes(new RouteBuilder() { }); context.start(); ----- \ No newline at end of file +---- diff --git a/docs/components/modules/ROOT/pages/reactive-executor-vertx.adoc b/docs/components/modules/others/pages/reactive-executor-vertx.adoc similarity index 85% rename from docs/components/modules/ROOT/pages/reactive-executor-vertx.adoc rename to docs/components/modules/others/pages/reactive-executor-vertx.adoc index b75e621f0ae97..c77a8a5679f4c 100644 --- a/docs/components/modules/ROOT/pages/reactive-executor-vertx.adoc +++ b/docs/components/modules/others/pages/reactive-executor-vertx.adoc @@ -1,7 +1,13 @@ -= ReactiveExecutor VertX +[[reactive-executor-vertx-component]] += Reactive Executor Vert.x Component :page-source: components/camel-reactive-executor-vertx/src/main/docs/reactive-executor-vertx.adoc +:docTitle: Reactive Executor Vert.x +:artifactId: camel-reactive-executor-vertx +:description: Reactive Executor for camel-core using Vert.x +:since: 3.0 +:supportLevel: Experimental -*Since Camel 3.0* +*Since Camel {since}* The camel-reactive-executor-vertx is a VertX based implementation of the `ReactiveExecutor` SPI. diff --git a/docs/components/modules/ROOT/pages/reactor.adoc b/docs/components/modules/others/pages/reactor.adoc similarity index 72% rename from docs/components/modules/ROOT/pages/reactor.adoc rename to docs/components/modules/others/pages/reactor.adoc index 1af11e870188d..28b3928f13da5 100644 --- a/docs/components/modules/ROOT/pages/reactor.adoc +++ b/docs/components/modules/others/pages/reactor.adoc @@ -1,7 +1,13 @@ +[[reactor-component]] = Reactor Component :page-source: components/camel-reactor/src/main/docs/reactor.adoc +:docTitle: Reactor +:artifactId: camel-reactor +:description: Reactor based back-end for Camel's reactive streams component +:since: 2.20 +:supportLevel: Stable -*Since Camel 2.20* +*Since Camel {since}* Maven users will need to add the following dependency to their `pom.xml` for this component: diff --git a/docs/components/modules/ROOT/pages/resilience4j.adoc b/docs/components/modules/others/pages/resilience4j.adoc similarity index 74% rename from docs/components/modules/ROOT/pages/resilience4j.adoc rename to docs/components/modules/others/pages/resilience4j.adoc index 361d706c8af69..9bba2095d7a07 100644 --- a/docs/components/modules/ROOT/pages/resilience4j.adoc +++ b/docs/components/modules/others/pages/resilience4j.adoc @@ -1,7 +1,13 @@ +[[resilience4j-component]] = Resilience4j Component :page-source: components/camel-resilience4j/src/main/docs/resilience4j.adoc +:docTitle: Resilience4j +:artifactId: camel-resilience4j +:description: Circuit Breaker EIP using Resilience4j +:since: 3.0 +:supportLevel: Stable -*Since Camel 3.0* +*Since Camel {since}* This component supports the Circuit Breaker EIP with the Resilience4j library. @@ -19,4 +25,3 @@ for this component: ---- - diff --git a/docs/components/modules/ROOT/pages/ribbon.adoc b/docs/components/modules/others/pages/ribbon.adoc similarity index 90% rename from docs/components/modules/ROOT/pages/ribbon.adoc rename to docs/components/modules/others/pages/ribbon.adoc index fdeb6f6b191c0..539da53dbc75f 100644 --- a/docs/components/modules/ROOT/pages/ribbon.adoc +++ b/docs/components/modules/others/pages/ribbon.adoc @@ -1,7 +1,13 @@ +[[ribbon-component]] = Ribbon Component :page-source: components/camel-ribbon/src/main/docs/ribbon.adoc +:docTitle: Ribbon +:artifactId: camel-ribbon +:description: Using Netflix Ribbon for client side load balancing +:since: 2.18 +:supportLevel: Stable -*Since Camel 2.18* +*Since Camel {since}* The Ribbon component provides use of Netflix Ribbon for client side load balancing. @@ -74,4 +80,3 @@ from("direct:start") ---- - diff --git a/docs/components/modules/ROOT/pages/rxjava.adoc b/docs/components/modules/others/pages/rxjava.adoc similarity index 76% rename from docs/components/modules/ROOT/pages/rxjava.adoc rename to docs/components/modules/others/pages/rxjava.adoc index 42a2b2bd78ed5..be3f19ba03dd1 100644 --- a/docs/components/modules/ROOT/pages/rxjava.adoc +++ b/docs/components/modules/others/pages/rxjava.adoc @@ -1,7 +1,13 @@ +[[rxjava-component]] = RxJava Component :page-source: components/camel-rxjava/src/main/docs/rxjava.adoc +:docTitle: RxJava +:artifactId: camel-rxjava +:description: RxJava based back-end for Camel's reactive streams component +:since: 2.22 +:supportLevel: Stable -*Since Camel 2.22* +*Since Camel {since}* RxJava based back-end for Camel's reactive streams component. diff --git a/docs/components/modules/ROOT/pages/shiro.adoc b/docs/components/modules/others/pages/shiro.adoc similarity index 98% rename from docs/components/modules/ROOT/pages/shiro.adoc rename to docs/components/modules/others/pages/shiro.adoc index 000f9b65d2339..4a398d9a03fcf 100644 --- a/docs/components/modules/ROOT/pages/shiro.adoc +++ b/docs/components/modules/others/pages/shiro.adoc @@ -1,8 +1,13 @@ -[[ShiroSecurity-ShiroSecurityComponent]] -= Shiro Security Component +[[shiro-component]] += Shiro Component :page-source: components/camel-shiro/src/main/docs/shiro.adoc +:docTitle: Shiro +:artifactId: camel-shiro +:description: Security using Shiro +:since: 2.5 +:supportLevel: Stable -*Since Camel 2.5* +*Since Camel {since}* The Shiro Security component in Camel is a security focused component, based on the Apache Shiro security project. @@ -132,7 +137,7 @@ of the roles in the list are applicable. these or pass in your own Cipher implementation |`base64` |`false` |`boolean` |To use base64 encoding for the security token header, -which allows transferring the header over xref:jms-component.adoc[JMS] etc. This +which allows transferring the header over xref:ROOT:jms-component.adoc[JMS] etc. This option must also be set on `ShiroSecurityTokenInjector` as well. |`allPermissionsRequired` |`false` |`boolean` |The default is that authorization is granted if any of the diff --git a/docs/components/modules/ROOT/pages/spring-javaconfig.adoc b/docs/components/modules/others/pages/spring-javaconfig.adoc similarity index 92% rename from docs/components/modules/ROOT/pages/spring-javaconfig.adoc rename to docs/components/modules/others/pages/spring-javaconfig.adoc index b9ae2ec557259..bc310a47cff89 100644 --- a/docs/components/modules/ROOT/pages/spring-javaconfig.adoc +++ b/docs/components/modules/others/pages/spring-javaconfig.adoc @@ -1,6 +1,13 @@ -[[SpringJavaConfig-SpringJavaConfig]] -= Spring Java Config +[[spring-javaconfig-component]] += Spring Java Configuration Component :page-source: components/camel-spring-javaconfig/src/main/docs/spring-javaconfig.adoc +:docTitle: Spring Java Configuration +:artifactId: camel-spring-javaconfig +:description: Using Camel with Spring Java Configuration +:since: 2.0 +:supportLevel: Stable + +*Since Camel {since}* Spring started life using XML Config to wire beans together. However some folks don't like using XML and would rather use diff --git a/docs/components/modules/others/pages/spring-main.adoc b/docs/components/modules/others/pages/spring-main.adoc new file mode 100644 index 0000000000000..c7964c49c3a0c --- /dev/null +++ b/docs/components/modules/others/pages/spring-main.adoc @@ -0,0 +1,12 @@ +[[spring-main-component]] += Spring Main Component +:page-source: components/camel-spring-main/src/main/docs/spring-main.adoc +:docTitle: Spring Main +:artifactId: camel-spring-main +:description: Camel Spring Main support +:since: 3.2 +:supportLevel: Stable + +*Since Camel {since}* + +This module is used for running Spring standalone via a main class extended from `camel-main`. diff --git a/docs/components/modules/ROOT/pages/spring-security.adoc b/docs/components/modules/others/pages/spring-security.adoc similarity index 95% rename from docs/components/modules/ROOT/pages/spring-security.adoc rename to docs/components/modules/others/pages/spring-security.adoc index 056946c6f9fa1..ef1cb7f47aeac 100644 --- a/docs/components/modules/ROOT/pages/spring-security.adoc +++ b/docs/components/modules/others/pages/spring-security.adoc @@ -1,8 +1,13 @@ -[[SpringSecurity-SpringSecurity]] -= Spring Security +[[spring-security-component]] += Spring Security Component :page-source: components/camel-spring-security/src/main/docs/spring-security.adoc +:docTitle: Spring Security +:artifactId: camel-spring-security +:description: Security using Spring Security +:since: 2.3 +:supportLevel: Stable -*Since Camel 2.3* +*Since Camel {since}* The Camel Spring Security component provides role-based authorization for Camel routes. It leverages the authentication and user services @@ -85,7 +90,7 @@ authorization is not specified by this component. You can write your own processors or components which get authentication information from the exchange depending on your needs. For example, you might create a processor that gets credentials from an HTTP request header originating -in the xref:jetty-component.adoc[Jetty] component. No matter how the credentials +in the xref:ROOT:jetty-component.adoc[Jetty] component. No matter how the credentials are collected, they need to be placed in the In message or the `SecurityContextHolder` so the Camel xref:spring-security.adoc[Spring Security] component can access them: @@ -144,7 +149,7 @@ implementation of the `org.apache.camel.component.spring.security.AuthenticationAdapter` to your `` bean. This can be useful if you are working with components that do not use Spring Security but do provide a -`Subject`. At this time, only the xref:cxf-component.adoc[CXF] component populates +`Subject`. At this time, only the xref:ROOT:cxf-component.adoc[CXF] component populates the `Exchange.AUTHENTICATION` header. [[SpringSecurity-Handlingauthenticationandauthorizationerrors]] @@ -198,4 +203,3 @@ for this component: This dependency will also pull in `org.springframework.security:spring-security-core:3.0.3.RELEASE` and `org.springframework.security:spring-security-config:3.0.3.RELEASE`. - diff --git a/docs/components/modules/ROOT/pages/swagger-java.adoc b/docs/components/modules/others/pages/swagger-java.adoc similarity index 97% rename from docs/components/modules/ROOT/pages/swagger-java.adoc rename to docs/components/modules/others/pages/swagger-java.adoc index 64d3de3b572b3..253e73c963288 100644 --- a/docs/components/modules/ROOT/pages/swagger-java.adoc +++ b/docs/components/modules/others/pages/swagger-java.adoc @@ -1,7 +1,13 @@ +[[swagger-java-component]] = Swagger Java Component :page-source: components/camel-swagger-java/src/main/docs/swagger-java.adoc +:docTitle: Swagger Java +:artifactId: camel-swagger-java +:description: Rest-dsl support for using swagger api-doc +:since: 2.16 +:supportLevel: Stable -*Since Camel 2.16* +*Since Camel {since}* The Rest DSL can be integrated with the `camel-swagger-java` module which is used for exposing the REST diff --git a/docs/components/modules/ROOT/pages/test-cdi.adoc b/docs/components/modules/others/pages/test-cdi.adoc similarity index 98% rename from docs/components/modules/ROOT/pages/test-cdi.adoc rename to docs/components/modules/others/pages/test-cdi.adoc index 04105b4f09736..c0d51efd432a3 100644 --- a/docs/components/modules/ROOT/pages/test-cdi.adoc +++ b/docs/components/modules/others/pages/test-cdi.adoc @@ -1,6 +1,13 @@ -[[CDITesting-CDITesting]] -= CDI Testing +[[test-cdi-component]] += Test CDI Component :page-source: components/camel-test-cdi/src/main/docs/test-cdi.adoc +:docTitle: Test CDI +:artifactId: camel-test-cdi +:description: Camel unit testing with CDI +:since: 2.17 +:supportLevel: Stable + +*Since Camel {since}* http://camel.apache.org/testing.html[Testing] is a crucial part of any development or integration work. In case you're using the Camel CDI @@ -279,7 +286,7 @@ Using ShrinkWarp Descriptors, you have a complete control over the configuration and kind of Camel CDI applications you want to test. For example, to test a Camel CDI application that uses the Camel REST DSL configured with the -xref:servlet-component.adoc[Servlet component], you need to create a Web archive, +xref:ROOT:servlet-component.adoc[Servlet component], you need to create a Web archive, e.g.: [source,java] @@ -633,7 +640,7 @@ Camel context bean provided by the Camel CDI component. can _advice_ an existing route before its being tested. It allows to add http://camel.apache.org/intercept.html[Intercept] or _weave_ routes for testing purpose, for example using -the xref:mock-component.adoc[Mock] component. +the xref:ROOT:mock-component.adoc[Mock] component. It is recommended to only advice routes which are not started already. To meet that requirement, you can use the `CamelContextStartingEvent` @@ -727,4 +734,3 @@ public class CamelCdiTest { }; } ---- - diff --git a/docs/components/modules/ROOT/pages/test-junit5.adoc b/docs/components/modules/others/pages/test-junit5.adoc similarity index 95% rename from docs/components/modules/ROOT/pages/test-junit5.adoc rename to docs/components/modules/others/pages/test-junit5.adoc index 1e985e134b059..462d0ef88029b 100644 --- a/docs/components/modules/ROOT/pages/test-junit5.adoc +++ b/docs/components/modules/others/pages/test-junit5.adoc @@ -1,6 +1,13 @@ -[[Test]] -= Test Module +[[test-junit5-component]] += Test JUnit5 Component :page-source: components/camel-test-junit5/src/main/docs/test-junit5.adoc +:docTitle: Test JUnit5 +:artifactId: camel-test-junit5 +:description: Camel unit testing with JUnit 5 +:since: 3.0 +:supportLevel: Stable + +*Since Camel {since}* The `camel-test-junit5` module is used for unit testing Camel. diff --git a/docs/components/modules/ROOT/pages/test-spring-junit5.adoc b/docs/components/modules/others/pages/test-spring-junit5.adoc similarity index 90% rename from docs/components/modules/ROOT/pages/test-spring-junit5.adoc rename to docs/components/modules/others/pages/test-spring-junit5.adoc index bf265172778ed..fd76ffda29330 100644 --- a/docs/components/modules/ROOT/pages/test-spring-junit5.adoc +++ b/docs/components/modules/others/pages/test-spring-junit5.adoc @@ -1,7 +1,13 @@ -= Camel Test Spring JUnit 5 +[[test-spring-junit5-component]] += Test Spring JUnit5 Component :page-source: components/camel-test-spring-junit5/src/main/docs/test-spring-junit5.adoc +:docTitle: Test Spring JUnit5 +:artifactId: camel-test-spring-junit5 +:description: Camel unit testing with Spring and JUnit 5 +:since: 3.0 +:supportLevel: Stable -*Available since 3.0* +*Since Camel {since}* The `camel-test-spring-junit5` module makes it possible to test Camel Spring based applications with JUnit 5. @@ -35,7 +41,7 @@ public class SimpleMockTest extends CamelSpringTestSupport { } ---- -This approach provides feature parity with `org.apache.camel.test.junit5.CamelTestSupport` from xref:components::test-junit5.adoc[camel-test-junit5] but does not support Spring annotations on the test class such as `@Autowired`, `@DirtiesContext`, and `@ContextConfiguration`. +This approach provides feature parity with `org.apache.camel.test.junit5.CamelTestSupport` from xref:test-junit5.adoc[camel-test-junit5] but does not support Spring annotations on the test class such as `@Autowired`, `@DirtiesContext`, and `@ContextConfiguration`. Instead of instantiating the `CamelContext` and routes programmatically, this class relies on a Spring context to wire the needed components together. If your test extends this class, you must provide the Spring context by implementing the following method. [source,java] @@ -135,7 +141,7 @@ Tips: It's possible to run JUnit 4 & JUnit 5 based Camel Spring tests side by si `camel-test-spring-junit5` and `junit-vintage-engine`. This configuration allows to migrate a Camel Spring test at once. === Typical migration steps linked to JUnit 5 support in Camel Test Spring -* Migration steps linked to xref:components::test-junit5.adoc[JUnit 5 support in Camel Test itself] should have been applied first +* Migration steps linked to xref:test-junit5.adoc[JUnit 5 support in Camel Test itself] should have been applied first * Imports of `org.apache.camel.test.spring.\*` should be replaced with `org.apache.camel.test.spring.junit5.*` * Usage of `@RunWith(CamelSpringRunner.class)` should be replaced with `@CamelSpringTest` * Usage of `@BootstrapWith(CamelTestContextBootstrapper.class)` should be replaced with `@CamelSpringTest` diff --git a/docs/components/modules/ROOT/pages/test-spring.adoc b/docs/components/modules/others/pages/test-spring.adoc similarity index 96% rename from docs/components/modules/ROOT/pages/test-spring.adoc rename to docs/components/modules/others/pages/test-spring.adoc index 59f446a5533c3..1f51849ab127b 100644 --- a/docs/components/modules/ROOT/pages/test-spring.adoc +++ b/docs/components/modules/others/pages/test-spring.adoc @@ -1,7 +1,13 @@ -= Test Spring +[[test-spring-component]] += Test Spring Component :page-source: components/camel-test-spring/src/main/docs/test-spring.adoc +:docTitle: Test Spring +:artifactId: camel-test-spring +:description: Camel unit testing with Spring +:since: 2.10 +:supportLevel: Stable -*Available since 2.10* +*Since Camel {since}* Allows to test Camel with Spring applications such as Spring XML files or Spring-Boot. @@ -12,7 +18,7 @@ This documentation is old and needs to be updated xref:manual::testing.adoc[Testing] is a crucial part of any development or integration work. The Spring Framework offers a number of features that makes it easy to test while using Spring for Inversion of Control which works with JUnit 3.x and JUnit 4.x. -We can use Spring for IoC and the Camel xref:components::mock-component.adoc[Mock] and xref:components::test.adoc[Test] endpoints to create sophisticated integration/unit tests that are easy to run and debug inside your IDE. There are three supported approaches for testing with Spring in Camel. +We can use Spring for IoC and the Camel xref:ROOT:mock-component.adoc[Mock] and xref:test.adoc[Test] endpoints to create sophisticated integration/unit tests that are easy to run and debug inside your IDE. There are three supported approaches for testing with Spring in Camel. [width="100%",cols="1,1,4,1",options="header",] |======================================================================= |Name |Testing Frameworks Supported |Description |Required Camel Test Dependencies @@ -26,7 +32,7 @@ Provided by: * `org.apache.camel.test.CamelSpringTestSupport` * `org.apache.camel.test.junit4.CamelSpringTestSupport` -These base classes provide feature parity with the simple `CamelTestSupport` classes from xref:components::test.adoc[Camel Test] but do not support Spring annotations on the test class such as `@Autowired`, `@DirtiesContext`, and `@ContextConfiguration`. +These base classes provide feature parity with the simple `CamelTestSupport` classes from xref:test.adoc[Camel Test] but do not support Spring annotations on the test class such as `@Autowired`, `@DirtiesContext`, and `@ContextConfiguration`. a| * JUnit 3.x (deprecated) - camel-test-spring @@ -409,5 +415,3 @@ public class Foo { } } ---- - - diff --git a/docs/components/modules/ROOT/pages/test.adoc b/docs/components/modules/others/pages/test.adoc similarity index 89% rename from docs/components/modules/ROOT/pages/test.adoc rename to docs/components/modules/others/pages/test.adoc index 9d82ee4f3affc..8e3383690b423 100644 --- a/docs/components/modules/ROOT/pages/test.adoc +++ b/docs/components/modules/others/pages/test.adoc @@ -1,6 +1,13 @@ -[[Test]] -= Test Module +[[test-component]] += Test Component :page-source: components/camel-test/src/main/docs/test.adoc +:docTitle: Test +:artifactId: camel-test +:description: Camel unit testing +:since: 2.9 +:supportLevel: Stable + +*Since Camel {since}* The `camel-test` module is used for unit testing Camel. @@ -45,4 +52,3 @@ public class SimpleMockTest extends CamelTestSupport { } ---- - diff --git a/docs/components/modules/ROOT/pages/testcontainers-junit5.adoc b/docs/components/modules/others/pages/testcontainers-junit5.adoc similarity index 93% rename from docs/components/modules/ROOT/pages/testcontainers-junit5.adoc rename to docs/components/modules/others/pages/testcontainers-junit5.adoc index b8d7d43f21aec..160fc0e7fbdfc 100644 --- a/docs/components/modules/ROOT/pages/testcontainers-junit5.adoc +++ b/docs/components/modules/others/pages/testcontainers-junit5.adoc @@ -1,7 +1,13 @@ -= Testcontainers +[[testcontainers-junit5-component]] += Testcontainers JUnit5 Component :page-source: components/camel-testcontainers-junit5/src/main/docs/testcontainers-junit5.adoc +:docTitle: Testcontainers JUnit5 +:artifactId: camel-testcontainers-junit5 +:description: Camel support for testcontainers with JUnit 5 +:since: 3.0 +:supportLevel: Stable -*Available since 3.0.0* +*Since Camel {since}* Testing camel components is sometime complex because the 3rd party system a component interacts with does not provide testing facilities and/or is only available as a native application. To reduce this complexity, *Camel Testcontainers JUnit 5* extends standard camel test support providing a way to create and interact with containerized applications. @@ -133,5 +139,5 @@ Tips: It's possible to run JUnit4 & JUnit5 based camel tests side by side includ `camel-testcontainers-junit5` and `junit-vintage-engine`. This configuration allows to migrate a camel test at once. === Typical migration steps linked to JUnit 5 support in Camel Testcontainers -* Migration steps linked to xref:components::test-junit5.adoc[JUnit 5 support in Camel Test itself] should have been applied first +* Migration steps linked to xref:test-junit5.adoc[JUnit 5 support in Camel Test itself] should have been applied first * Imports of `org.apache.camel.test.testcontainers.\*` should be replaced with `org.apache.camel.test.testcontainers.junit5.*` diff --git a/docs/components/modules/ROOT/pages/testcontainers-spring-junit5.adoc b/docs/components/modules/others/pages/testcontainers-spring-junit5.adoc similarity index 79% rename from docs/components/modules/ROOT/pages/testcontainers-spring-junit5.adoc rename to docs/components/modules/others/pages/testcontainers-spring-junit5.adoc index 10fb12d26f66d..91878363292cd 100644 --- a/docs/components/modules/ROOT/pages/testcontainers-spring-junit5.adoc +++ b/docs/components/modules/others/pages/testcontainers-spring-junit5.adoc @@ -1,7 +1,13 @@ -= Testcontainers Spring +[[testcontainers-spring-junit5-component]] += Testcontainers Spring Junit5 Component :page-source: components/camel-testcontainers-spring-junit5/src/main/docs/testcontainers-spring-junit5.adoc +:docTitle: Testcontainers Spring Junit5 +:artifactId: camel-testcontainers-spring-junit5 +:description: Camel unit testing with Spring, testcontainers and JUnit 5 +:since: 3.0 +:supportLevel: Stable -*Available since 3.0.0* +*Since Camel {since}* Testing camel components is sometime complex because the 3th party system a component interacts with does not provide testing facilities and/or is only available as a native application. To reduce this complexity, *Camel Testcontainers Spring JUnit 5* extends camel spring test support providing a way to create and interact with containerized applications. @@ -25,5 +31,5 @@ Tips: It's possible to run JUnit4 & JUnit5 based camel tests side by side includ `camel-testcontainers-spring-junit5` and `junit-vintage-engine`. This configuration allows to migrate a camel test at once. === Typical migration steps linked to JUnit 5 support in Camel Testcontainers Spring -* Migration steps linked to xref:components::testcontainers-junit5.adoc[JUnit 5 support in Camel Testcontainers itself] should have been applied first +* Migration steps linked to xref:testcontainers-junit5.adoc[JUnit 5 support in Camel Testcontainers itself] should have been applied first * Imports of `org.apache.camel.test.testcontainers.spring.\*` should be replaced with `org.apache.camel.test.testcontainers.spring.junit5.*` diff --git a/docs/components/modules/ROOT/pages/testcontainers-spring.adoc b/docs/components/modules/others/pages/testcontainers-spring.adoc similarity index 69% rename from docs/components/modules/ROOT/pages/testcontainers-spring.adoc rename to docs/components/modules/others/pages/testcontainers-spring.adoc index fbc8ee4ebc46f..9d98441a30de3 100644 --- a/docs/components/modules/ROOT/pages/testcontainers-spring.adoc +++ b/docs/components/modules/others/pages/testcontainers-spring.adoc @@ -1,10 +1,15 @@ -= Testcontainers Spring +[[testcontainers-spring-component]] += Testcontainers Spring Component :page-source: components/camel-testcontainers-spring/src/main/docs/testcontainers-spring.adoc +:docTitle: Testcontainers Spring +:artifactId: camel-testcontainers-spring +:description: Camel unit testing with Spring and testcontainers +:since: 2.22 +:supportLevel: Stable -*Available since 2.22.0* +*Since Camel {since}* Testing camel components is sometime complex because the 3th party system a component interacts with does not provide testing facilities and/or is only available as a native application. To reduce this complexity, *Camel Testcontainers Spring* extends camel spring test support providing a way to create and interact with containerized applications. This module is an extension to the camel-testcontainers component to add support for Spring. Therefore see the documentation for testcontainers for more details. - diff --git a/docs/components/modules/ROOT/pages/testcontainers.adoc b/docs/components/modules/others/pages/testcontainers.adoc similarity index 94% rename from docs/components/modules/ROOT/pages/testcontainers.adoc rename to docs/components/modules/others/pages/testcontainers.adoc index ccfeabc702967..2260a3f5d7a35 100644 --- a/docs/components/modules/ROOT/pages/testcontainers.adoc +++ b/docs/components/modules/others/pages/testcontainers.adoc @@ -1,7 +1,13 @@ -= Testcontainers +[[testcontainers-component]] += Testcontainers Component :page-source: components/camel-testcontainers/src/main/docs/testcontainers.adoc +:docTitle: Testcontainers +:artifactId: camel-testcontainers +:description: Camel support for testcontainers +:since: 2.22 +:supportLevel: Stable -*Available since 2.22.0* +*Since Camel {since}* Testing camel components is sometime complex because the 3th party system a component interacts with does not provide testing facilities and/or is only available as a native application. To reduce this complexity, *Camel Testcontainers* extends standard camel test support providing a way to create and interact with containerized applications. diff --git a/docs/components/modules/ROOT/pages/zipkin.adoc b/docs/components/modules/others/pages/zipkin.adoc similarity index 98% rename from docs/components/modules/ROOT/pages/zipkin.adoc rename to docs/components/modules/others/pages/zipkin.adoc index a91557f409cb6..3d7f932b15239 100644 --- a/docs/components/modules/ROOT/pages/zipkin.adoc +++ b/docs/components/modules/others/pages/zipkin.adoc @@ -1,8 +1,13 @@ -[[Zipkin-ZipkinComponent]] +[[zipkin-component]] = Zipkin Component :page-source: components/camel-zipkin/src/main/docs/zipkin.adoc +:docTitle: Zipkin +:artifactId: camel-zipkin +:description: Distributed message tracing using Zipkin +:since: 2.18 +:supportLevel: Stable -*Since Camel 2.18* +*Since Camel {since}* The Camel Zipkin component is used for tracing and timing incoming and outgoing Camel messages using http://zipkin.io/[zipkin]. diff --git a/docs/gulpfile.js b/docs/gulpfile.js index 7aa5c3c441523..8241899ad2973 100644 --- a/docs/gulpfile.js +++ b/docs/gulpfile.js @@ -36,7 +36,28 @@ function deleteComponentImageSymlinks() { } function createComponentSymlinks() { - const f = filter(['**','!**/*-language.adoc', '!**/*-dataformat.adoc']) + return src(['../core/camel-base/src/main/docs/*-component.adoc', '../components/{*,*/*}/src/main/docs/*-component.adoc', '../components/{*,*/*}/src/main/docs/*-summary.adoc']) + .pipe(map((file, done) => { + // this flattens the output to just .../pages/....adoc + // instead of .../pages/camel-.../src/main/docs/....adoc + file.base = path.dirname(file.path); + done(null, file); + })) + // Antora disabled symlinks, there is an issue open + // https://gitlab.com/antora/antora/issues/188 + // to reinstate symlink support, until that's resolved + // we'll simply copy over instead of creating symlinks + // .pipe(symlink('components/modules/ROOT/pages/', { + // relativeSymlinks: true + // })); + // uncomment above .pipe() and remove the .pipe() below + // when antora#188 is resolved + .pipe(insertSourceAttribute()) + .pipe(dest('components/modules/ROOT/pages/')); +} + +function createComponentOthersSymlinks() { + const f = filter(['**','!**/*-language.adoc', '!**/*-dataformat.adoc', '!**/*-component.adoc', '!**/*-summary.adoc']) return src(['../core/camel-base/src/main/docs/*.adoc','../components/{*,*/*}/src/main/docs/*.adoc']) .pipe(f) .pipe(map((file, done) => { @@ -55,7 +76,7 @@ function createComponentSymlinks() { // uncomment above .pipe() and remove the .pipe() below // when antora#188 is resolved .pipe(insertSourceAttribute()) - .pipe(dest('components/modules/ROOT/pages/')); + .pipe(dest('components/modules/others/pages/')); } function createComponentDataFormatSymlinks() { @@ -121,9 +142,14 @@ function createComponentImageSymlinks() { } function titleFrom(file) { - const maybeName = /(?:=|#) (.*)/.exec(file.contents.toString()) + var maybeName = /(?::docTitle: )(.*)/.exec(file.contents.toString()) if (maybeName == null) { - throw new Error(`${file.path} doesn't contain Asciidoc heading ('= ') or ('# <Title')`); + //TODO investigate these... why dont they have them? + // console.warn(`${file.path} doesn't contain Asciidoc docTitle attribute (':docTitle: <Title>'`); + maybeName = /(?:=|#) (.*)/.exec(file.contents.toString()) + if (maybeName == null) { + throw new Error(`${file.path} also doesn't contain Asciidoc heading ('= <Title>') or ('# <Title')`); + } } return maybeName[1]; @@ -166,6 +192,22 @@ function createComponentNav() { .pipe(dest('components/modules/ROOT/')) } +function createComponentOthersNav() { + return src('component-others-nav.adoc.template') + .pipe(insertGeneratedNotice()) + .pipe(inject(src(['components/modules/others/pages/**/*.adoc', '!components/modules/others/pages/index.adoc']) + .pipe(sort(compare)), { + removeTags: true, + transform: (filename, file) => { + const filepath = path.basename(filename); + const title = titleFrom(file); + return `** xref:${filepath}[${title}]`; + } + })) + .pipe(rename('nav.adoc')) + .pipe(dest('components/modules/others/')) +} + function createComponentDataFormatsNav() { return src('component-dataformats-nav.adoc.template') .pipe(insertGeneratedNotice()) @@ -273,10 +315,10 @@ function createComponentExamples() { } const symlinks = parallel( - series(deleteComponentSymlinks, createComponentSymlinks, createComponentDataFormatSymlinks, createComponentLanguageSymlinks), + series(deleteComponentSymlinks, createComponentSymlinks, createComponentOthersSymlinks, createComponentDataFormatSymlinks, createComponentLanguageSymlinks), series(deleteComponentImageSymlinks, createComponentImageSymlinks) ); -const nav = parallel(createComponentNav, createComponentDataFormatsNav, createComponentLanguagesNav, createEIPNav); +const nav = parallel(createComponentNav, createComponentOthersNav, createComponentDataFormatsNav, createComponentLanguagesNav, createEIPNav); const examples = series(deleteExamples, createUserManualExamples, createFAQExamples, createEIPExamples, createUserManualLanguageExamples, createComponentExamples); exports.symlinks = symlinks; diff --git a/docs/user-manual/modules/ROOT/pages/camel-boot.adoc b/docs/user-manual/modules/ROOT/pages/camel-boot.adoc index d9cdb613de96a..64cc0975dc977 100644 --- a/docs/user-manual/modules/ROOT/pages/camel-boot.adoc +++ b/docs/user-manual/modules/ROOT/pages/camel-boot.adoc @@ -15,13 +15,13 @@ The following camel boot options are supported: [[CamelBoot-CDI]] == CDI -Using the xref:components::cdi.adoc[camel-cdi module] you can boot up your Camel +Using the xref:components:others:cdi.adoc[camel-cdi module] you can boot up your Camel Java process using the *org.apache.camel.cdi.Main* class [[CamelBoot-Spring]] == Spring -Using the xref:spring.adoc[Spring] you can boot your +Using the xref:components:others:spring-main.adoc[Spring] you can boot your Camel Java process using the *org.apache.camel.spring.Main* class [[CamelBoot-SpringBoot]] diff --git a/docs/user-manual/modules/ROOT/pages/camel-run-maven-goal.adoc b/docs/user-manual/modules/ROOT/pages/camel-run-maven-goal.adoc index 3d42e0ce7f2d2..40e4845b5c518 100644 --- a/docs/user-manual/modules/ROOT/pages/camel-run-maven-goal.adoc +++ b/docs/user-manual/modules/ROOT/pages/camel-run-maven-goal.adoc @@ -106,7 +106,7 @@ the configuration admin service properties file. == Running CDI From *Camel 2.11* onwards the `camel:run` plugin also supports running a -xref:components::cdi.adoc[CDI] application +xref:components:others:cdi.adoc[CDI] application You would need to configure the camel:run plugin to use CDI, by setting useCDI to true as shown below diff --git a/docs/user-manual/modules/ROOT/pages/configuring-camel.adoc b/docs/user-manual/modules/ROOT/pages/configuring-camel.adoc index ec8702be22101..0124d90742e50 100644 --- a/docs/user-manual/modules/ROOT/pages/configuring-camel.adoc +++ b/docs/user-manual/modules/ROOT/pages/configuring-camel.adoc @@ -41,7 +41,7 @@ will auto-discover your component and register it. The `FooComponent` can then be auto-injected with resources using the https://www.javadoc.io/doc/org.apache.camel/camel-api/current/org/apache/camel/spi/Injector.html[Injector], -such as to support xref:components::spring.adoc[Spring] based auto-wiring, or to +such as to support xref:components::spring-summary.adoc[Spring] based auto-wiring, or to support `@Resource` (EJB3 style) injection or Guice style `@Inject` injection. diff --git a/docs/user-manual/modules/ROOT/pages/dsl.adoc b/docs/user-manual/modules/ROOT/pages/dsl.adoc index 00f5e24d9fa53..17864e90d48aa 100644 --- a/docs/user-manual/modules/ROOT/pages/dsl.adoc +++ b/docs/user-manual/modules/ROOT/pages/dsl.adoc @@ -8,7 +8,7 @@ languages (DSL) as listed below. * xref:java-dsl.adoc[Java DSL] - A Java based DSL using the fluent builder style. -* xref:components::spring.adoc[Spring XML] - A XML based DSL in Spring XML files +* xref:components::spring-summary.adoc[Spring XML] - A XML based DSL in Spring XML files * xref:using-osgi-blueprint-with-camel.adoc[Blueprint XML] - A XML based DSL in OSGi Blueprint XML files * xref:rest-dsl.adoc[Rest DSL] - A DSL to define REST services using a diff --git a/docs/user-manual/modules/ROOT/pages/index.adoc b/docs/user-manual/modules/ROOT/pages/index.adoc index fe4300a6e1fde..62f4b3419b3fa 100644 --- a/docs/user-manual/modules/ROOT/pages/index.adoc +++ b/docs/user-manual/modules/ROOT/pages/index.adoc @@ -50,7 +50,7 @@ For a deeper and better understanding of Apache Camel, an xref:faq:what-is-camel * xref:book-getting-started.adoc[Longer Getting Started Guide] * xref:camel-jar-dependencies.adoc[Camel JAR Dependencies] * xref:camel-boot.adoc[Camel Boot] -* xref:components::cdi.adoc[Working with Camel and CDI] +* xref:components:others:cdi.adoc[Working with Camel and CDI] * xref:spring.adoc[Working with Camel and Spring] * xref:faq:how-do-i-configure-endpoints.adoc[How do I configure endpoints?] * xref:bean-integration.adoc[Bean Integration] @@ -127,397 +127,36 @@ camel routes without them knowing * xref:java-dsl.adoc[Java DSL] * xref:bean-integration.adoc[Java Annotation DSL] -* xref:components::spring.adoc[Spring XML DSL] +* xref:components::spring-summary.adoc[Spring XML DSL] * xref:using-osgi-blueprint-with-camel.adoc[OSGi Blueprint XML DSL] * xref:rest-dsl.adoc[Rest DSL] === Components -// <!-- core components: START --> - * Core Components -** xref:components::bean-component.adoc[Bean] -** xref:components::browse-component.adoc[Browse] -** xref:components::class-component.adoc[Class] -** xref:components::controlbus-component.adoc[Control Bus] -** xref:components::dataformat-component.adoc[Data Format] -** xref:components::dataset-component.adoc[Dataset] -** xref:components::direct-component.adoc[Direct] -** xref:components::direct-vm-component.adoc[Direct VM] -** xref:components::file-component.adoc[File] -** xref:components::language-component.adoc[Language] -** xref:components::log-component.adoc[Log] -** xref:components::mock-component.adoc[Mock] -** xref:components::properties-component.adoc[Properties] -** xref:components::ref-component.adoc[Ref] -** xref:components::rest-component.adoc[REST] -** xref:components::rest-api-component.adoc[REST API] -** xref:components::saga-component.adoc[Saga] -** xref:components::scheduler-component.adoc[Scheduler] -** xref:components::seda-component.adoc[SEDA] -** xref:components::stub-component.adoc[Stub] -** xref:components::timer-component.adoc[Timer] -** xref:components::validator-component.adoc[Validator] -** xref:components::vm-component.adoc[VM] -** xref:components::xslt-component.adoc[XSLT] - -// <!-- core components: END --> - -// <!-- components: START --> + +indexList::[component=components,version=latest,module=ROOT,attributes=core,level=2] * Components -** xref:components::ahc-component.adoc[AHC] -** xref:components::ahc-ws-component.adoc[AHC Websocket] -** xref:components::amqp-component.adoc[AMQP] -** xref:components::flink-component.adoc[Apache Flink] -** xref:components::spark-component.adoc[Apache Spark] -** xref:components::apns-component.adoc[APNS] -** xref:components::as2-component.adoc[AS2] -** xref:components::asterisk-component.adoc[Asterisk] -** xref:components::atmos-component.adoc[Atmos] -** xref:components::atmosphere-websocket-component.adoc[Atmosphere Websocket] -** xref:components::atom-component.adoc[Atom] -** xref:components::atomix-map-component.adoc[Atomix Map] -** xref:components::atomix-messaging-component.adoc[Atomix Messaging] -** xref:components::atomix-multimap-component.adoc[Atomix MultiMap] -** xref:components::atomix-queue-component.adoc[Atomix Queue] -** xref:components::atomix-set-component.adoc[Atomix Set] -** xref:components::atomix-value-component.adoc[Atomix Value] -** xref:components::avro-component.adoc[Avro] -** xref:components::aws-cw-component.adoc[AWS CloudWatch] -** xref:components::aws-ddb-component.adoc[AWS DynamoDB] -** xref:components::aws-ddbstream-component.adoc[AWS DynamoDB Streams] -** xref:components::aws-ec2-component.adoc[AWS EC2] -** xref:components::aws-iam-component.adoc[AWS IAM] -** xref:components::aws-kinesis-component.adoc[AWS Kinesis] -** xref:components::aws-kinesis-firehose-component.adoc[AWS Kinesis Firehose] -** xref:components::aws-kms-component.adoc[AWS KMS] -** xref:components::aws-lambda-component.adoc[AWS Lambda] -** xref:components::aws-mq-component.adoc[AWS MQ] -** xref:components::aws-s3-component.adoc[AWS S3 Storage Service] -** xref:components::aws-ses-component.adoc[AWS Simple Email Service] -** xref:components::aws-sns-component.adoc[AWS Simple Notification System] -** xref:components::aws-sqs-component.adoc[AWS Simple Queue Service] -** xref:components::aws-swf-component.adoc[AWS Simple Workflow] -** xref:components::aws-sdb-component.adoc[AWS Translate] -** xref:components::aws-translate-component.adoc[AWS SimpleDB] -** xref:components::azure-blob-component.adoc[Azure Storage Blob Service] -** xref:components::azure-queue-component.adoc[Azure Storage Queue Service] -** xref:components::bean-validator-component.adoc[Bean Validator] -** xref:components::beanstalk-component.adoc[Beanstalk] -** xref:components::bonita-component.adoc[Bonita] -** xref:components::box-component.adoc[Box] -** xref:components::braintree-component.adoc[Braintree] -** xref:components::caffeine-cache-component.adoc[Caffeine Cache] -** xref:components::caffeine-loadcache-component.adoc[Caffeine LoadCache] -** xref:components::cql-component.adoc[Cassandra CQL] -** xref:components::chunk-component.adoc[Chunk] -** xref:components::cm-sms-component.adoc[CM SMS Gateway] -** xref:components::cmis-component.adoc[CMIS] -** xref:components::coap-component.adoc[CoAP] -** xref:components::cometd-component.adoc[CometD] -** xref:components::consul-component.adoc[Consul] -** xref:components::corda-component.adoc[corda] -** xref:components::couchbase-component.adoc[Couchbase] -** xref:components::couchdb-component.adoc[CouchDB] -** xref:components::crypto-component.adoc[Crypto (JCE)] -** xref:components::crypto-cms-component.adoc[Crypto CMS] -** xref:components::cxf-component.adoc[CXF] -** xref:components::cxfrs-component.adoc[CXF-RS] -** xref:components::debezium-mysql-component.adoc[Debezium Mysql] -** xref:components::digitalocean-component.adoc[DigitalOcean] -** xref:components::disruptor-component.adoc[Disruptor] -** xref:components::dns-component.adoc[DNS] -** xref:components::docker-component.adoc[Docker] -** xref:components::dozer-component.adoc[Dozer] -** xref:components::drill-component.adoc[Drill] -** xref:components::dropbox-component.adoc[Dropbox] -** xref:components::ehcache-component.adoc[Ehcache] -** xref:components::elasticsearch-rest-component.adoc[Elastichsearch Rest] -** xref:components::elsql-component.adoc[ElSQL] -** xref:components::exec-component.adoc[Exec] -** xref:components::facebook-component.adoc[Facebook] -** xref:components::fhir-component.adoc[FHIR] -** xref:components::flatpack-component.adoc[Flatpack] -** xref:components::fop-component.adoc[FOP] -** xref:components::freemarker-component.adoc[Freemarker] -** xref:components::ftp-component.adoc[FTP] -** xref:components::ftps-component.adoc[FTPS] -** xref:components::ganglia-component.adoc[Ganglia] -** xref:components::geocoder-component.adoc[Geocoder] -** xref:components::git-component.adoc[Git] -** xref:components::github-component.adoc[GitHub] -** xref:components::google-bigquery-component.adoc[Google BigQuery] -** xref:components::google-bigquery-sql-component.adoc[Google BigQuery Standard SQL] -** xref:components::google-calendar-component.adoc[Google Calendar] -** xref:components::google-calendar-stream-component.adoc[Google Calendar Stream] -** xref:components::google-drive-component.adoc[Google Drive] -** xref:components::google-mail-component.adoc[Google Mail] -** xref:components::google-mail-stream-component.adoc[Google Mail Stream] -** xref:components::google-pubsub-component.adoc[Google Pubsub] -** xref:components::google-sheets-component.adoc[Google Sheets] -** xref:components::google-sheets-stream-component.adoc[Google Sheets Stream] -** xref:components::gora-component.adoc[Gora] -** xref:components::grape-component.adoc[Grape] -** xref:components::grpc-component.adoc[gRPC] -** xref:components::guava-eventbus-component.adoc[Guava EventBus] -** xref:components::hazelcast-atomicvalue-component.adoc[Hazelcast Atomic Number] -** xref:components::hazelcast-instance-component.adoc[Hazelcast Instance] -** xref:components::hazelcast-list-component.adoc[Hazelcast List] -** xref:components::hazelcast-map-component.adoc[Hazelcast Map] -** xref:components::hazelcast-multimap-component.adoc[Hazelcast Multimap] -** xref:components::hazelcast-queue-component.adoc[Hazelcast Queue] -** xref:components::hazelcast-replicatedmap-component.adoc[Hazelcast Replicated Map] -** xref:components::hazelcast-ringbuffer-component.adoc[Hazelcast Ringbuffer] -** xref:components::hazelcast-seda-component.adoc[Hazelcast SEDA] -** xref:components::hazelcast-set-component.adoc[Hazelcast Set] -** xref:components::hazelcast-topic-component.adoc[Hazelcast Topic] -** xref:components::hbase-component.adoc[HBase] -** xref:components::hdfs-component.adoc[HDFS] -** xref:components::hipchat-component.adoc[Hipchat] -** xref:components::http-component.adoc[HTTP] -** xref:components::iec60870-client-component.adoc[IEC 60870 Client] -** xref:components::iec60870-server-component.adoc[IEC 60870 Server] -** xref:components::ignite-cache-component.adoc[Ignite Cache] -** xref:components::ignite-compute-component.adoc[Ignite Compute] -** xref:components::ignite-events-component.adoc[Ignite Events] -** xref:components::ignite-idgen-component.adoc[Ignite ID Generator] -** xref:components::ignite-messaging-component.adoc[Ignite Messaging] -** xref:components::ignite-queue-component.adoc[Ignite Queues] -** xref:components::ignite-set-component.adoc[Ignite Sets] -** xref:components::infinispan-component.adoc[Infinispan] -** xref:components::influxdb-component.adoc[InfluxDB] -** xref:components::ipfs-component.adoc[IPFS] -** xref:components::irc-component.adoc[IRC] -** xref:components::ironmq-component.adoc[IronMQ] -** xref:components::websocket-jsr356-component.adoc[Javax Websocket] -** xref:components::jbpm-component.adoc[JBPM] -** xref:components::jcache-component.adoc[JCache] -** xref:components::jclouds-component.adoc[JClouds] -** xref:components::jcr-component.adoc[JCR] -** xref:components::jdbc-component.adoc[JDBC] -** xref:components::jetty-component.adoc[Jetty 9] -** xref:components::websocket-component.adoc[Jetty Websocket] -** xref:components::jgroups-component.adoc[JGroups] -** xref:components::jgroups-raft-component.adoc[JGroups raft] -** xref:components::jing-component.adoc[Jing] -** xref:components::jms-component.adoc[JMS] -** xref:components::jmx-component.adoc[JMX] -** xref:components::jolt-component.adoc[JOLT] -** xref:components::jpa-component.adoc[JPA] -** xref:components::json-validator-component.adoc[JSON Schema Validator] -** xref:components::jt400-component.adoc[JT400] -** xref:components::kafka-component.adoc[Kafka] -** xref:components::kubernetes-config-maps-component.adoc[Kubernetes ConfigMap] -** xref:components::kubernetes-deployments-component.adoc[Kubernetes Deployments] -** xref:components::kubernetes-hpa-component.adoc[Kubernetes HPA] -** xref:components::kubernetes-job-component.adoc[Kubernetes Job] -** xref:components::kubernetes-namespaces-component.adoc[Kubernetes Namespaces] -** xref:components::kubernetes-nodes-component.adoc[Kubernetes Nodes] -** xref:components::kubernetes-persistent-volumes-component.adoc[Kubernetes Persistent Volume] -** xref:components::kubernetes-persistent-volumes-claims-component.adoc[Kubernetes Persistent Volume Claim] -** xref:components::kubernetes-pods-component.adoc[Kubernetes Pods] -** xref:components::kubernetes-replication-controllers-component.adoc[Kubernetes Replication Controller] -** xref:components::kubernetes-resources-quota-component.adoc[Kubernetes Resources Quota] -** xref:components::kubernetes-secrets-component.adoc[Kubernetes Secrets] -** xref:components::kubernetes-service-accounts-component.adoc[Kubernetes Service Account] -** xref:components::kubernetes-services-component.adoc[Kubernetes Services] -** xref:components::ldap-component.adoc[LDAP] -** xref:components::ldif-component.adoc[LDIF] -** xref:components::lucene-component.adoc[Lucene] -** xref:components::lumberjack-component.adoc[Lumberjack] -** xref:components::master-component.adoc[Master] -** xref:components::metrics-component.adoc[Metrics] -** xref:components::micrometer-component.adoc[Micrometer] -** xref:components::mina-component.adoc[Mina] -** xref:components::mllp-component.adoc[MLLP] -** xref:components::mongodb-component.adoc[MongoDB] -** xref:components::mongodb-gridfs-component.adoc[MongoDB GridFS] -** xref:components::msv-component.adoc[MSV] -** xref:components::mustache-component.adoc[Mustache] -** xref:components::mvel-component.adoc[MVEL] -** xref:components::mybatis-component.adoc[MyBatis] -** xref:components::mybatis-bean-component.adoc[MyBatis Bean] -** xref:components::nagios-component.adoc[Nagios] -** xref:components::nats-component.adoc[Nats] -** xref:components::netty-component.adoc[Netty] -** xref:components::netty-http-component.adoc[Netty HTTP] -** xref:components::nsq-component.adoc[NSQ] -** xref:components::olingo2-component.adoc[Olingo2] -** xref:components::olingo4-component.adoc[Olingo4] -** xref:components::milo-client-component.adoc[OPC UA Client] -** xref:components::milo-server-component.adoc[OPC UA Server] -** xref:components::openshift-build-configs-component.adoc[Openshift Build Config] -** xref:components::openshift-builds-component.adoc[Openshift Builds] -** xref:components::openstack-cinder-component.adoc[OpenStack Cinder] -** xref:components::openstack-glance-component.adoc[OpenStack Glance] -** xref:components::openstack-keystone-component.adoc[OpenStack Keystone] -** xref:components::openstack-neutron-component.adoc[OpenStack Neutron] -** xref:components::openstack-nova-component.adoc[OpenStack Nova] -** xref:components::openstack-swift-component.adoc[OpenStack Swift] -** xref:components::optaplanner-component.adoc[OptaPlanner] -** xref:components::paho-component.adoc[Paho] -** xref:components::pdf-component.adoc[PDF] -** xref:components::pgevent-component.adoc[PostgresSQL Event] -** xref:components::lpr-component.adoc[Printer] -** xref:components::pubnub-component.adoc[PubNub] -** xref:components::quartz-component.adoc[Quartz] -** xref:components::quickfix-component.adoc[QuickFix] -** xref:components::rabbitmq-component.adoc[RabbitMQ] -** xref:components::reactive-streams-component.adoc[Reactive Streams] -** xref:components::rest-swagger-component.adoc[REST Swagger] -** xref:components::rss-component.adoc[RSS] -** xref:components::salesforce-component.adoc[Salesforce] -** xref:components::sap-netweaver-component.adoc[SAP NetWeaver] -** xref:components::schematron-component.adoc[Schematron] -** xref:components::scp-component.adoc[SCP] -** xref:components::service-component.adoc[Service] -** xref:components::servicenow-component.adoc[ServiceNow] -** xref:components::servlet-component.adoc[Servlet] -** xref:components::sftp-component.adoc[SFTP] -** xref:components::sjms-component.adoc[Simple JMS] -** xref:components::sjms-batch-component.adoc[Simple JMS Batch] -** xref:components::sjms2-component.adoc[Simple JMS2] -** xref:components::sip-component.adoc[SIP] -** xref:components::slack-component.adoc[Slack] -** xref:components::smpp-component.adoc[SMPP] -** xref:components::snmp-component.adoc[SNMP] -** xref:components::solr-component.adoc[Solr] -** xref:components::splunk-component.adoc[Splunk] -** xref:components::spring-batch-component.adoc[Spring Batch] -** xref:components::spring-event-component.adoc[Spring Event] -** xref:components::spring-integration-component.adoc[Spring Integration] -** xref:components::spring-ldap-component.adoc[Spring LDAP] -** xref:components::spring-redis-component.adoc[Spring Redis] -** xref:components::spring-ws-component.adoc[Spring WebService] -** xref:components::sql-component.adoc[SQL] -** xref:components::sql-stored-component.adoc[SQL Stored Procedure] -** xref:components::ssh-component.adoc[SSH] -** xref:components::stax-component.adoc[StAX] -** xref:components::stomp-component.adoc[Stomp] -** xref:components::stream-component.adoc[Stream] -** xref:components::string-template-component.adoc[String Template] -** xref:components::telegram-component.adoc[Telegram] -** xref:components::thrift-component.adoc[Thrift] -** xref:components::tika-component.adoc[Tika] -** xref:components::twilio-component.adoc[Twilio] -** xref:components::twitter-directmessage-component.adoc[Twitter Direct Message] -** xref:components::twitter-search-component.adoc[Twitter Search] -** xref:components::twitter-timeline-component.adoc[Twitter Timeline] -** xref:components::undertow-component.adoc[Undertow] -** xref:components::velocity-component.adoc[Velocity] -** xref:components::vertx-component.adoc[Vert.x] -** xref:components::weather-component.adoc[Weather] -** xref:components::web3j-component.adoc[Web3j Ethereum Blockchain] -** xref:components::wordpress-component.adoc[Wordpress] -** xref:components::xchange-component.adoc[XChange] -** xref:components::xmpp-component.adoc[XMPP] -** xref:components::xj-component.adoc[XJ] -** xref:components::xquery-component.adoc[XQuery] -** xref:components::yammer-component.adoc[Yammer] -** xref:components::zendesk-component.adoc[Zendesk] -** xref:components::zookeeper-component.adoc[ZooKeeper] -** xref:components::zookeeper-master-component.adoc[ZooKeeper Master] - -// <!-- components: END --> - -// <!-- others: START --> + +indexList::[component=components,version=latest,module=ROOT,attributes="!core",level=2] * Miscellaneous Components -** xref:components::cdi.adoc[CDI] -** xref:components::cxf-transport.adoc[CXF Transport] -** xref:components::hystrix.adoc[Hystrix] -** xref:components::jasypt.adoc[Jasypt] -** xref:components::leveldb.adoc[LevelDB] -** xref:components::lra.adoc[Lra] -** xref:components::opentracing.adoc[OpenTracing] -** xref:components::reactor.adoc[Reactor] -** xref:components::ribbon.adoc[Ribbon] -** xref:components::rxjava.adoc[Rxjava] -** xref:components::shiro.adoc[Shiro] -** xref:components::spring-javaconfig.adoc[Spring Java Configuration] -** xref:components::spring-security.adoc[Spring Security] -** xref:components::swagger-java.adoc[Swagger Java] -** xref:components::test.adoc[Test] -** xref:components::test-cdi.adoc[Test CDI] -** xref:components::test-spring.adoc[Test Spring] -** xref:components::testcontainers.adoc[Testcontainers] -** xref:components::testcontainers-spring.adoc[Testcontainers Spring] -** xref:components::aws-xray.adoc[XRay] -** xref:components::zipkin.adoc[Zipkin] - -// <!-- others: END --> -=== Data Formats +indexList::[component=components,version=latest,module=others,level=2] -// <!-- dataformats: START --> +=== Data Formats * Data Formats -** xref:components:dataformats:asn1-dataformat.adoc[ASN.1 File] -** xref:components:dataformats:avro-dataformat.adoc[Avro] -** xref:components:dataformats:barcode-dataformat.adoc[Barcode] -** xref:components:dataformats:base64-dataformat.adoc[Base64] -** xref:components:dataformats:beanio-dataformat.adoc[BeanIO] -** xref:components:dataformats:bindy-dataformat.adoc[Bindy CSV] -** xref:components:dataformats:bindy-dataformat.adoc[Bindy Fixed Length] -** xref:components:dataformats:bindy-dataformat.adoc[Bindy Key Value Pair] -** xref:components:dataformats:crypto-dataformat.adoc[Crypto (Java Cryptographic Extension)] -** xref:components:dataformats:csv-dataformat.adoc[CSV] -** xref:components:dataformats:fhirJson-dataformat.adoc[FHIR JSon] -** xref:components:dataformats:fhirXml-dataformat.adoc[FHIR XML] -** xref:components:dataformats:flatpack-dataformat.adoc[Flatpack] -** xref:components:dataformats:hl7-dataformat.adoc[HL7] -** xref:components:dataformats:ical-dataformat.adoc[iCal] -** xref:components:dataformats:jacksonxml-dataformat.adoc[JacksonXML] -** xref:components:dataformats:jaxb-dataformat.adoc[JAXB] -** xref:components:dataformats:json-fastjson-dataformat.adoc[JSon Fastjson] -** xref:components:dataformats:json-gson-dataformat.adoc[JSon GSon] -** xref:components:dataformats:json-jackson-dataformat.adoc[JSon Jackson] -** xref:components:dataformats:json-johnzon-dataformat.adoc[JSon Johnzon] -** xref:components:dataformats:json-xstream-dataformat.adoc[JSon XStream] -** xref:components:dataformats:lzf-dataformat.adoc[LZF Deflate Compression] -** xref:components:dataformats:mime-multipart-dataformat.adoc[MIME Multipart] -** xref:components:dataformats:pgp-dataformat.adoc[PGP] -** xref:components:dataformats:protobuf-dataformat.adoc[Protobuf] -** xref:components:dataformats:rss-dataformat.adoc[RSS] -** xref:components:dataformats:soapjaxb-dataformat.adoc[SOAP] -** xref:components:dataformats:syslog-dataformat.adoc[Syslog] -** xref:components:dataformats:tarfile-dataformat.adoc[Tar File] -** xref:components:dataformats:thrift-dataformat.adoc[Thrift] -** xref:components:dataformats:tidyMarkup-dataformat.adoc[TidyMarkup] -** xref:components:dataformats:univocity-csv-dataformat.adoc[uniVocity CSV] -** xref:components:dataformats:univocity-fixed-dataformat.adoc[uniVocity Fixed Length] -** xref:components:dataformats:univocity-tsv-dataformat.adoc[uniVocity TSV] -** xref:components:dataformats:secureXML-dataformat.adoc[XML Security] -** xref:components:dataformats:xstream-dataformat.adoc[XStream] -** xref:components:dataformats:yaml-snakeyaml-dataformat.adoc[YAML SnakeYAML] -** xref:components:dataformats:zipfile-dataformat.adoc[Zip File] - -// <!-- dataformats: END --> -=== xref:languages.adoc[Languages] +indexList::[component=components,version=latest,module=dataformats,level=2] -// <!-- languages: START --> +=== xref:languages.adoc[Languages] * Expression Languages -** xref:components:languages:bean-language.adoc[Bean method] -** xref:components:languages:constant-language.adoc[Constant] -** xref:components:languages:exchangeProperty-language.adoc[ExchangeProperty] -** xref:components:languages:file-language.adoc[File] -** xref:components:languages:groovy-language.adoc[Groovy] -** xref:components:languages:header-language.adoc[Header] -** xref:components:languages:hl7terser-language.adoc[HL7 Terser] -** xref:components:languages:mvel-language.adoc[MVEL] -** xref:components:languages:ognl-language.adoc[OGNL] -** xref:components:languages:ref-language.adoc[Ref] -** xref:components:languages:simple-language.adoc[Simple] -** xref:components:languages:spel-language.adoc[SpEL] -** xref:components:languages:tokenize-language.adoc[Tokenize] -** xref:components:languages:xpath-language.adoc[XPath] -** xref:components:languages:xquery-language.adoc[XQuery] - -// <!-- languages: END --> + +indexList::[component=components,version=latest,module=languages,level=2] == Community diff --git a/docs/user-manual/modules/ROOT/pages/jndi.adoc b/docs/user-manual/modules/ROOT/pages/jndi.adoc index fdd09e0134447..2237a519879f4 100644 --- a/docs/user-manual/modules/ROOT/pages/jndi.adoc +++ b/docs/user-manual/modules/ROOT/pages/jndi.adoc @@ -2,7 +2,7 @@ = JNDI Camel will use JNDI as the default xref:registry.adoc[Registry] -implementation if you do not use xref:components::spring.adoc[Spring]. This means +implementation if you do not use xref:components::spring-summary.adoc[Spring]. This means that using a DefaultCamelContext will try and create a https://www.javadoc.io/doc/org.apache.camel/camel-core-engine/current/org/apache/camel/impl/JndiRegistry.html[JndiRegistry] which uses the JNDI InitialContext as the registry. diff --git a/docs/user-manual/modules/ROOT/pages/security.adoc b/docs/user-manual/modules/ROOT/pages/security.adoc index 8d803e63e47f9..e4fe5892e89c9 100644 --- a/docs/user-manual/modules/ROOT/pages/security.adoc +++ b/docs/user-manual/modules/ROOT/pages/security.adoc @@ -28,8 +28,8 @@ etc) on sections/segments of a camel route. The components offering authentication and authorization Services utilizing Route Policies are -* xref:components::shiro.adoc[Shiro Security] -* xref:components::spring-security.adoc[Spring Security] +* xref:components:others:shiro.adoc[Shiro Security] +* xref:components:others:spring-security.adoc[Spring Security] [[Security-PayloadSecurity-DataFormatsandProducers/Consumersofferingencryption/decryptionservices]] == Payload Security - Data Formats and Producers/Consumers offering encryption/decryption services @@ -79,7 +79,7 @@ externalize configuration values to properties files. Those values could contain sensitive information such as usernames and passwords. Those values can be encrypted and automatic decrypted by Camel. -* xref:components::jasypt.adoc[Jasypt] +* xref:components:others:jasypt.adoc[Jasypt] *Since Camel 2.8* diff --git a/docs/user-manual/modules/ROOT/pages/spring-testing.adoc b/docs/user-manual/modules/ROOT/pages/spring-testing.adoc index b11179a0c641c..30a0aebe2afa9 100644 --- a/docs/user-manual/modules/ROOT/pages/spring-testing.adoc +++ b/docs/user-manual/modules/ROOT/pages/spring-testing.adoc @@ -7,7 +7,7 @@ makes it easy to test while using Spring for Inversion of Control which works with JUnit 3.x or JUnit 4.x. We can use Spring for IoC and the Camel xref:components::mock-component.adoc[Mock] and -xref:components::test.adoc[Test] endpoints to create sophisticated integration/unit +xref:components:others:test.adoc[Test] endpoints to create sophisticated integration/unit tests that are easy to run and debug inside your IDE. There are three supported approaches for testing with Spring in Camel. diff --git a/docs/user-manual/modules/ROOT/pages/testing.adoc b/docs/user-manual/modules/ROOT/pages/testing.adoc index 39854c5a871b7..7db2184e0c42b 100644 --- a/docs/user-manual/modules/ROOT/pages/testing.adoc +++ b/docs/user-manual/modules/ROOT/pages/testing.adoc @@ -141,7 +141,7 @@ using Java Config]: include::{examplesdir}/components/camel-spring-javaconfig/src/test/java/org/apache/camel/spring/javaconfig/patterns/FilterTest.java[tags=example] ---- -For more information see xref:components::spring-javaconfig.adoc[Spring Java +For more information see xref:components:others:spring-javaconfig.adoc[Spring Java Config]. This is similar to the XML Config example above except that there is no @@ -215,7 +215,7 @@ correctly |xref:components::mock-component.adoc[Mock] |For testing routes and mediation rules using mocks and allowing assertions to be added to an endpoint -|xref:components::test.adoc[Test] |Creates a xref:components::mock-component.adoc[Mock] endpoint which +|xref:components:others:test.adoc[Test] |Creates a xref:components::mock-component.adoc[Mock] endpoint which expects to receive all the message bodies that could be polled from the given underlying endpoint |======================================================================= diff --git a/docs/user-manual/modules/ROOT/pages/xml-configuration.adoc b/docs/user-manual/modules/ROOT/pages/xml-configuration.adoc index 4797fa463506e..972cc4d534665 100644 --- a/docs/user-manual/modules/ROOT/pages/xml-configuration.adoc +++ b/docs/user-manual/modules/ROOT/pages/xml-configuration.adoc @@ -6,11 +6,11 @@ completion and functionality while being the most expressive. However if you wish to put your routing rules in XML you can via the Camel XML language. -Camel XML uses xref:components::spring.adoc[Spring] 2 namespaces; so that you can +Camel XML uses xref:components::spring-summary.adoc[Spring] 2 namespaces; so that you can configure your routing rules within your -xref:components::spring.adoc[Spring XML configuration file]; you can also use +xref:components::spring-summary.adoc[Spring XML configuration file]; you can also use xref:faq:how-do-i-configure-endpoints.adoc[Java code to configure components and endpoints]. For examples on how to use Camel XML, see the -xref:{eip-vc}:eips:enterprise-integration-patterns.adoc[Enterprise Integration Patterns] or refer to the xref:components::spring.adoc[Spring Support]. +xref:{eip-vc}:eips:enterprise-integration-patterns.adoc[Enterprise Integration Patterns] or refer to the xref:components::spring-summary.adoc[Spring Support]. diff --git a/docs/user-manual/modules/ROOT/pages/xml-reference.adoc b/docs/user-manual/modules/ROOT/pages/xml-reference.adoc index 15d3a5efdd8f6..ae84194137f92 100644 --- a/docs/user-manual/modules/ROOT/pages/xml-reference.adoc +++ b/docs/user-manual/modules/ROOT/pages/xml-reference.adoc @@ -1402,7 +1402,7 @@ available. [[XMLReference-UsingtheXSDsinconfigurationfiles]] == Using the XSDs in configuration files -When you are using xref:components::spring.adoc[Spring]'s 2.5 XML handling to parse +When you are using xref:components::spring-summary.adoc[Spring]'s 2.5 XML handling to parse the XML then you need to refer to the XSD locations in your XML document. diff --git a/docs/user-manual/modules/faq/pages/exception-javaxnamingnoinitialcontextexception.adoc b/docs/user-manual/modules/faq/pages/exception-javaxnamingnoinitialcontextexception.adoc index e0670de586718..db4e95e879482 100644 --- a/docs/user-manual/modules/faq/pages/exception-javaxnamingnoinitialcontextexception.adoc +++ b/docs/user-manual/modules/faq/pages/exception-javaxnamingnoinitialcontextexception.adoc @@ -1,7 +1,7 @@ [[Exception-javax.naming.NoInitialContextException-Exceptionjavax.naming.NoInitialContextException]] = Exception: `javax.naming.NoInitialContextException` -If you try to use Camel without xref:components::spring.adoc[Spring] using code +If you try to use Camel without xref:ROOT:spring.adoc[Spring] using code something like this: [source,java] diff --git a/docs/user-manual/modules/faq/pages/how-does-camel-compare-to-servicemix.adoc b/docs/user-manual/modules/faq/pages/how-does-camel-compare-to-servicemix.adoc index 516b1e36ad021..77a94af01b159 100644 --- a/docs/user-manual/modules/faq/pages/how-does-camel-compare-to-servicemix.adoc +++ b/docs/user-manual/modules/faq/pages/how-does-camel-compare-to-servicemix.adoc @@ -18,13 +18,13 @@ xref:how-does-camel-compare-to-servicemix-eip.adoc[ServiceMix EIP component]. To work with Camel and ServiceMix you take your Camel -xref:components::spring.adoc[Spring] configuration and turn it into a JBI Service +xref:ROOT:spring.adoc[Spring] configuration and turn it into a JBI Service Unit using the maven plugin or archetype. For more details see http://incubator.apache.org/servicemix/servicemix-camel.html[ServiceMix Camel plugin]. So you could start out using Camel routing inside your application via -xref:ROOT:dsl.adoc[Java] or xref:components::spring.adoc[Spring]; then later on if you +xref:ROOT:dsl.adoc[Java] or xref:ROOT:spring.adoc[Spring]; then later on if you choose to you could wrap up your routing and mediation rules as a JBI deployment unit and drop it into your ServiceMix ESB. This provides a nice agile approach to integration; start small & simple on an endpoint diff --git a/docs/user-manual/modules/faq/pages/how-does-camel-compare-to-synapse.adoc b/docs/user-manual/modules/faq/pages/how-does-camel-compare-to-synapse.adoc index d0debd0fe8ff4..3c7828ecc93ae 100644 --- a/docs/user-manual/modules/faq/pages/how-does-camel-compare-to-synapse.adoc +++ b/docs/user-manual/modules/faq/pages/how-does-camel-compare-to-synapse.adoc @@ -22,7 +22,7 @@ http://www.nabble.com/Apache-f90.html[very popular too]. * Camel is designed from the ground up around xref:{eip-vc}:eips:enterprise-integration-patterns.adoc[Enterprise Integration Patterns] -- having an EIP pattern language implemented in -xref:ROOT:dsl.adoc[Java] and xref:components::spring.adoc[Spring XML]. +xref:ROOT:dsl.adoc[Java] and xref:ROOT:spring.adoc[Spring XML]. * Camel is designed to work with pretty much all kinds of xref:ROOT:transport.adoc[transport] as well as working with any xref:ROOT:data-format.adoc[Data Format]. When we first looked at Synapse it diff --git a/docs/user-manual/modules/faq/pages/how-does-camel-work-with-servicemix.adoc b/docs/user-manual/modules/faq/pages/how-does-camel-work-with-servicemix.adoc index 0de78d4abcdc7..5cdaa7797a960 100644 --- a/docs/user-manual/modules/faq/pages/how-does-camel-work-with-servicemix.adoc +++ b/docs/user-manual/modules/faq/pages/how-does-camel-work-with-servicemix.adoc @@ -7,7 +7,7 @@ Patterns] inside of the JBI container, routing between existing JBI components together with communicating with any of the other Camel xref:ROOT:component.adoc[Components]. -To do this you take your Camel xref:components::spring.adoc[Spring] configuration +To do this you take your Camel xref:ROOT:spring.adoc[Spring] configuration and turn it into a JBI Service Unit using the maven plugin or archetype. For more details see diff --git a/docs/user-manual/modules/faq/pages/is-camel-ioc-friendly.adoc b/docs/user-manual/modules/faq/pages/is-camel-ioc-friendly.adoc index e3e14ab0743c9..4004a577a583d 100644 --- a/docs/user-manual/modules/faq/pages/is-camel-ioc-friendly.adoc +++ b/docs/user-manual/modules/faq/pages/is-camel-ioc-friendly.adoc @@ -8,7 +8,7 @@ Now for the longer answer... == Spring In particular we've gone out of our way to make Camel work great with -xref:components::spring.adoc[Spring] and to reuse all of Spring 2.x's power. For +xref:ROOT:spring.adoc[Spring] and to reuse all of Spring 2.x's power. For example: * the CamelContext, Components and Endpoints and their dependent beans @@ -34,7 +34,7 @@ Spring is clearly the leading IoC container; though there are some others such as Guice, OSGi, Pico, HiveMind & Plexus so we have made the IoC pluggable in Camel. For example camel-core has no dependencies on anything other than -commons-logging; camel-spring contains all the xref:components::spring.adoc[Spring] +commons-logging; camel-spring contains all the xref:ROOT:spring.adoc[Spring] integration, etc. We hope to have closer integration to other IoC containers. diff --git a/docs/user-manual/modules/faq/pages/is-there-an-ide.adoc b/docs/user-manual/modules/faq/pages/is-there-an-ide.adoc index 3fc79a9163280..13ea101993140 100644 --- a/docs/user-manual/modules/faq/pages/is-there-an-ide.adoc +++ b/docs/user-manual/modules/faq/pages/is-there-an-ide.adoc @@ -7,7 +7,7 @@ You could use your Java IDE for smart completion when creating xref:ROOT:routes.adoc[Java routing rules] via the xref:ROOT:dsl.adoc[DSL] which will give you smart completion in Java code. Or you can use your XML IDE (with XSD smart completion) to edit the -xref:components::spring.adoc[routing rules in XML] using the +xref:ROOT:spring.adoc[routing rules in XML] using the xref:ROOT:xml-configuration.adoc[XML Configuration] Some of the xref:ROOT:commercial-camel-offerings.adoc[Commercial Companies] diff --git a/docs/user-manual/modules/faq/pages/running-camel-standalone.adoc b/docs/user-manual/modules/faq/pages/running-camel-standalone.adoc index 5c0a1fe785ff6..1527c44b8fc44 100644 --- a/docs/user-manual/modules/faq/pages/running-camel-standalone.adoc +++ b/docs/user-manual/modules/faq/pages/running-camel-standalone.adoc @@ -4,7 +4,7 @@ Yes, Camel can run standalone or in any container. Running Standalone is as simple just to create a xref:ROOT:camelcontext.adoc[CamelContext], add routes and start it. If you don't want to write your own Java main, you -could use the one from xref:components::spring.adoc[camel-spring] +could use the one from xref:ROOT:spring.adoc[camel-spring] (https://www.javadoc.io/doc/org.apache.camel/camel-spring/current/index.html) also used by the xref:ROOT:camel-maven-plugin.adoc[Camel Maven Plugin]. diff --git a/docs/user-manual/modules/faq/pages/what-is-camel.adoc b/docs/user-manual/modules/faq/pages/what-is-camel.adoc index 0243a5f631900..02356b2df1d3d 100644 --- a/docs/user-manual/modules/faq/pages/what-is-camel.adoc +++ b/docs/user-manual/modules/faq/pages/what-is-camel.adoc @@ -28,7 +28,7 @@ out-of-box. Apache Camel provides support for xref:ROOT:bean-binding.adoc[Bean Binding] and seamless integration with popular frameworks such as -xref:components::cdi.adoc[CDI], xref:ROOT:spring.adoc[Spring] and +xref:components:others:cdi.adoc[CDI], xref:ROOT:spring.adoc[Spring] and xref:ROOT:using-osgi-blueprint-with-camel.adoc[Blueprint]. Camel also has extensive support for xref:ROOT:testing.adoc[unit testing] your routes. diff --git a/docs/user-manual/modules/faq/pages/why-does-camel-use-too-many-threads-with-producertemplate.adoc b/docs/user-manual/modules/faq/pages/why-does-camel-use-too-many-threads-with-producertemplate.adoc index feff18f1d3853..43597e2f6a38f 100644 --- a/docs/user-manual/modules/faq/pages/why-does-camel-use-too-many-threads-with-producertemplate.adoc +++ b/docs/user-manual/modules/faq/pages/why-does-camel-use-too-many-threads-with-producertemplate.adoc @@ -12,11 +12,11 @@ Also when you have finished using the `ProducerTemplate` you should call the `stop()` method to close down all the resources it has been using. It's better to either explicitly create one on startup or get your IoC -container (xref:components::spring.adoc[Spring]) to inject +container (xref:ROOT:spring.adoc[Spring]) to inject it into your `Processor` or bean then it can take care of creating it and destroying all the resources when you have finished with it. -For instance using xref:components::spring.adoc[Spring] you can define a template +For instance using xref:ROOT:spring.adoc[Spring] you can define a template and have Spring handle the lifecycle of it: [source,java] diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareUserGuideMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareUserGuideMojo.java deleted file mode 100644 index 4e49fcec1ff42..0000000000000 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareUserGuideMojo.java +++ /dev/null @@ -1,503 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.camel.maven.packaging; - -import java.io.File; -import java.io.IOException; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; -import java.util.Set; -import java.util.TreeSet; - -import org.apache.camel.tooling.model.BaseModel; -import org.apache.camel.tooling.model.ComponentModel; -import org.apache.camel.tooling.model.DataFormatModel; -import org.apache.camel.tooling.model.JsonMapper; -import org.apache.camel.tooling.model.LanguageModel; -import org.apache.camel.tooling.model.OtherModel; -import org.apache.camel.tooling.util.PackageHelper; -import org.apache.camel.tooling.util.Strings; -import org.apache.maven.plugin.AbstractMojo; -import org.apache.maven.plugin.MojoExecutionException; -import org.apache.maven.plugin.MojoFailureException; -import org.apache.maven.plugins.annotations.Component; -import org.apache.maven.plugins.annotations.Mojo; -import org.apache.maven.plugins.annotations.Parameter; -import org.apache.maven.project.MavenProject; -import org.apache.maven.project.MavenProjectHelper; - -/** - * Prepares the user guide to keep the table of content up to date with the - * components, data formats, and languages. - */ -@Mojo(name = "prepare-user-guide", threadSafe = true) -public class PrepareUserGuideMojo extends AbstractMojo { - - /** - * The maven project. - */ - @Parameter(property = "project", required = true, readonly = true) - protected MavenProject project; - - /** - * The directory for components catalog - */ - @Parameter(defaultValue = "${project.build.directory}/classes/org/apache/camel/catalog/components") - protected File componentsDir; - - /** - * The directory for data formats catalog - */ - @Parameter(defaultValue = "${project.build.directory}/classes/org/apache/camel/catalog/dataformats") - protected File dataFormatsDir; - - /** - * The directory for languages catalog - */ - @Parameter(defaultValue = "${project.build.directory}/classes/org/apache/camel/catalog/languages") - protected File languagesDir; - - /** - * The directory for others catalog - */ - @Parameter(defaultValue = "${project.build.directory}/classes/org/apache/camel/catalog/others") - protected File othersDir; - - /** - * The directory for the user guide - */ - @Parameter(defaultValue = "${project.directory}/../../../docs/user-manual/en") - protected File userGuideDir; - - /** - * Maven ProjectHelper. - */ - @Component - private MavenProjectHelper projectHelper; - - /** - * Execute goal. - * - * @throws MojoExecutionException execution of the main class or one of the - * threads it generated failed. - * @throws MojoFailureException something bad happened... - */ - @Override - public void execute() throws MojoExecutionException, MojoFailureException { - executeComponents(); - executeOthers(); - executeDataFormats(); - executeLanguages(); - } - - protected void executeComponents() throws MojoExecutionException, MojoFailureException { - Set<File> componentFiles = new TreeSet<>(); - - if (componentsDir != null && componentsDir.isDirectory()) { - File[] files = componentsDir.listFiles(); - if (files != null) { - componentFiles.addAll(Arrays.asList(files)); - } - } - - try { - List<ComponentModel> models = new ArrayList<>(); - for (File file : componentFiles) { - String json = PackageHelper.loadText(file); - ComponentModel model = JsonMapper.generateComponentModel(json); - - // filter out alternative schemas which reuses documentation - boolean add = true; - if (!Strings.isNullOrEmpty(model.getAlternativeSchemes())) { - String first = model.getAlternativeSchemes().split(",")[0]; - if (!model.getScheme().equals(first)) { - add = false; - } - } - if (add) { - models.add(model); - } - } - - // sor the models - models.sort(ComponentModel.compareTitle()); - - // the summary file has the TOC - File file = new File(userGuideDir, "SUMMARY.md"); - - // update core components - StringBuilder core = new StringBuilder(); - core.append("* Core Components\n"); - for (ComponentModel model : models) { - if (model.getLabel().contains("core")) { - String line = "\t* " + link(model) + "\n"; - core.append(line); - } - } - boolean updated = updateCoreComponents(file, core.toString()); - - // update regular components - StringBuilder regular = new StringBuilder(); - regular.append("* Components\n"); - for (ComponentModel model : models) { - if (!model.getLabel().contains("core")) { - String line = "\t* " + link(model) + "\n"; - regular.append(line); - } - } - updated |= updateComponents(file, regular.toString()); - - if (updated) { - getLog().info("Updated user guide file: " + file); - } else { - getLog().debug("No changes to user guide file: " + file); - } - - } catch (IOException e) { - throw new MojoFailureException("Error due " + e.getMessage(), e); - } - } - - protected void executeOthers() throws MojoExecutionException, MojoFailureException { - Set<File> otherFiles = new TreeSet<>(); - - if (othersDir != null && othersDir.isDirectory()) { - File[] files = othersDir.listFiles(); - if (files != null) { - otherFiles.addAll(Arrays.asList(files)); - } - } - - List<OtherModel> models = new ArrayList<>(); - for (File file : otherFiles) { - try { - String json = PackageHelper.loadText(file); - OtherModel model = JsonMapper.generateOtherModel(json); - models.add(model); - } catch (Exception e) { - throw new MojoFailureException("Error reading file: " + file, e); - } - } - - // sort the models - models.sort(BaseModel.compareTitle()); - - // the summary file has the TOC - File file = new File(userGuideDir, "SUMMARY.md"); - - // update core components - StringBuilder other = new StringBuilder(); - other.append("* Miscellaneous Components\n"); - for (OtherModel model : models) { - String line = "\t* " + link(model) + "\n"; - other.append(line); - } - boolean updated = updateOthers(file, other.toString()); - - if (updated) { - getLog().info("Updated user guide file: " + file); - } else { - getLog().debug("No changes to user guide file: " + file); - } - } - - protected void executeDataFormats() throws MojoExecutionException, MojoFailureException { - Set<File> dataFormatFiles = new TreeSet<>(); - - if (dataFormatsDir != null && dataFormatsDir.isDirectory()) { - File[] files = dataFormatsDir.listFiles(); - if (files != null) { - dataFormatFiles.addAll(Arrays.asList(files)); - } - } - - try { - List<DataFormatModel> models = new ArrayList<>(); - for (File file : dataFormatFiles) { - String json = PackageHelper.loadText(file); - DataFormatModel model = JsonMapper.generateDataFormatModel(json); - models.add(model); - } - - // sort the models - models.sort(BaseModel.compareTitle()); - - // the summary file has the TOC - File file = new File(userGuideDir, "SUMMARY.md"); - - // update data formats - StringBuilder dataFormats = new StringBuilder(); - dataFormats.append("* Data Formats\n"); - for (DataFormatModel model : models) { - String line = "\t* " + link(model) + "\n"; - dataFormats.append(line); - } - boolean updated = updateDataFormats(file, dataFormats.toString()); - - if (updated) { - getLog().info("Updated user guide file: " + file); - } else { - getLog().debug("No changes to user guide file: " + file); - } - - } catch (IOException e) { - throw new MojoFailureException("Error due " + e.getMessage(), e); - } - } - - protected void executeLanguages() throws MojoExecutionException, MojoFailureException { - Set<File> languageFiles = new TreeSet<>(); - - if (languagesDir != null && languagesDir.isDirectory()) { - File[] files = languagesDir.listFiles(); - if (files != null) { - languageFiles.addAll(Arrays.asList(files)); - } - } - - try { - List<LanguageModel> models = new ArrayList<>(); - for (File file : languageFiles) { - String json = PackageHelper.loadText(file); - LanguageModel model = JsonMapper.generateLanguageModel(json); - models.add(model); - } - - // sort the models - models.sort(BaseModel.compareTitle()); - - // the summary file has the TOC - File file = new File(userGuideDir, "SUMMARY.md"); - - // update languages - StringBuilder languages = new StringBuilder(); - languages.append("* Expression Languages\n"); - for (LanguageModel model : models) { - String line = "\t* " + link(model) + "\n"; - languages.append(line); - } - boolean updated = updateLanguages(file, languages.toString()); - - if (updated) { - getLog().info("Updated user guide file: " + file); - } else { - getLog().debug("No changes to user guide file: " + file); - } - - } catch (IOException e) { - throw new MojoFailureException("Error due " + e.getMessage(), e); - } - } - - private boolean updateCoreComponents(File file, String changed) throws MojoExecutionException { - if (!file.exists()) { - return false; - } - - try { - String text = PackageHelper.loadText(file); - - String existing = Strings.between(text, "<!-- core components: START -->", "<!-- core components: END -->"); - if (existing != null) { - // remove leading line breaks etc - existing = existing.trim(); - changed = changed.trim(); - if (existing.equals(changed)) { - return false; - } else { - String before = Strings.before(text, "<!-- core components: START -->"); - String after = Strings.after(text, "<!-- core components: END -->"); - text = before + "<!-- core components: START -->\n" + changed + "\n<!-- core components: END -->" + after; - PackageHelper.writeText(file, text); - return true; - } - } else { - getLog().warn("Cannot find markers in file " + file); - getLog().warn("Add the following markers"); - getLog().warn("\t<!-- core components: START -->"); - getLog().warn("\t<!-- core components: END -->"); - return false; - } - } catch (Exception e) { - throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e); - } - } - - private boolean updateComponents(File file, String changed) throws MojoExecutionException { - if (!file.exists()) { - return false; - } - - try { - String text = PackageHelper.loadText(file); - - String existing = Strings.between(text, "<!-- components: START -->", "<!-- components: END -->"); - if (existing != null) { - // remove leading line breaks etc - existing = existing.trim(); - changed = changed.trim(); - if (existing.equals(changed)) { - return false; - } else { - String before = Strings.before(text, "<!-- components: START -->"); - String after = Strings.after(text, "<!-- components: END -->"); - text = before + "<!-- components: START -->\n" + changed + "\n<!-- components: END -->" + after; - PackageHelper.writeText(file, text); - return true; - } - } else { - getLog().warn("Cannot find markers in file " + file); - getLog().warn("Add the following markers"); - getLog().warn("\t<!-- components: START -->"); - getLog().warn("\t<!-- components: END -->"); - return false; - } - } catch (Exception e) { - throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e); - } - } - - private boolean updateOthers(File file, String changed) throws MojoExecutionException { - if (!file.exists()) { - return false; - } - - try { - String text = PackageHelper.loadText(file); - - String existing = Strings.between(text, "<!-- others: START -->", "<!-- others: END -->"); - if (existing != null) { - // remove leading line breaks etc - existing = existing.trim(); - changed = changed.trim(); - if (existing.equals(changed)) { - return false; - } else { - String before = Strings.before(text, "<!-- others: START -->"); - String after = Strings.after(text, "<!-- others: END -->"); - text = before + "<!-- others: START -->\n" + changed + "\n<!-- others: END -->" + after; - PackageHelper.writeText(file, text); - return true; - } - } else { - getLog().warn("Cannot find markers in file " + file); - getLog().warn("Add the following markers"); - getLog().warn("\t<!-- others: START -->"); - getLog().warn("\t<!-- others: END -->"); - return false; - } - } catch (Exception e) { - throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e); - } - } - - private boolean updateDataFormats(File file, String changed) throws MojoExecutionException { - if (!file.exists()) { - return false; - } - - try { - String text = PackageHelper.loadText(file); - - String existing = Strings.between(text, "<!-- dataformats: START -->", "<!-- dataformats: END -->"); - if (existing != null) { - // remove leading line breaks etc - existing = existing.trim(); - changed = changed.trim(); - if (existing.equals(changed)) { - return false; - } else { - String before = Strings.before(text, "<!-- dataformats: START -->"); - String after = Strings.after(text, "<!-- dataformats: END -->"); - text = before + "<!-- dataformats: START -->\n" + changed + "\n<!-- dataformats: END -->" + after; - PackageHelper.writeText(file, text); - return true; - } - } else { - getLog().warn("Cannot find markers in file " + file); - getLog().warn("Add the following markers"); - getLog().warn("\t<!-- dataformats: START -->"); - getLog().warn("\t<!-- dataformats: END -->"); - return false; - } - } catch (Exception e) { - throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e); - } - } - - private boolean updateLanguages(File file, String changed) throws MojoExecutionException { - if (!file.exists()) { - return false; - } - - try { - String text = PackageHelper.loadText(file); - - String existing = Strings.between(text, "<!-- languages: START -->", "<!-- languages: END -->"); - if (existing != null) { - // remove leading line breaks etc - existing = existing.trim(); - changed = changed.trim(); - if (existing.equals(changed)) { - return false; - } else { - String before = Strings.before(text, "<!-- languages: START -->"); - String after = Strings.after(text, "<!-- languages: END -->"); - text = before + "<!-- languages: START -->\n" + changed + "\n<!-- languages: END -->" + after; - PackageHelper.writeText(file, text); - return true; - } - } else { - getLog().warn("Cannot find markers in file " + file); - getLog().warn("Add the following markers"); - getLog().warn("\t<!-- languages: START -->"); - getLog().warn("\t<!-- languages: END -->"); - return false; - } - } catch (Exception e) { - throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e); - } - } - - private static String link(ComponentModel model) { - return "[" + model.getTitle() + "](" + model.getScheme() + "-component.adoc)"; - } - - private static String link(OtherModel model) { - return "[" + model.getTitle() + "](" + model.getName() + ".adoc)"; - } - - private static String link(DataFormatModel model) { - // special for some data formats - String name = asDataFormatName(model.getName()); - return "[" + model.getTitle() + "](" + name + "-dataformat.adoc)"; - } - - private static String link(LanguageModel model) { - return "[" + model.getTitle() + "](" + model.getName() + "-language.adoc)"; - } - - private static String asDataFormatName(String name) { - // special for some dataformats which share the same readme file - if (name.startsWith("bindy")) { - return "bindy"; - } else { - return name; - } - } -} diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateDocComponentListMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateDocComponentListMojo.java deleted file mode 100644 index 178eadf57a44a..0000000000000 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateDocComponentListMojo.java +++ /dev/null @@ -1,523 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.camel.maven.packaging; - -import java.io.File; -import java.io.IOException; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.TreeSet; - -import org.apache.camel.tooling.model.BaseModel; -import org.apache.camel.tooling.model.ComponentModel; -import org.apache.camel.tooling.model.DataFormatModel; -import org.apache.camel.tooling.model.JsonMapper; -import org.apache.camel.tooling.model.LanguageModel; -import org.apache.camel.tooling.model.OtherModel; -import org.apache.camel.tooling.util.PackageHelper; -import org.apache.camel.tooling.util.Strings; -import org.apache.maven.plugin.AbstractMojo; -import org.apache.maven.plugin.MojoExecutionException; -import org.apache.maven.plugin.MojoFailureException; -import org.apache.maven.plugins.annotations.Component; -import org.apache.maven.plugins.annotations.Mojo; -import org.apache.maven.plugins.annotations.Parameter; -import org.apache.maven.project.MavenProject; -import org.apache.maven.project.MavenProjectHelper; -import org.mvel2.templates.TemplateRuntime; - -/** - * Updates the website docs with the component list to be up to date with all - * the artifacts that Apache Camel ships. - */ -@Mojo(name = "update-doc-component-list", threadSafe = true) -public class UpdateDocComponentListMojo extends AbstractMojo { - - /** - * The maven project. - */ - @Parameter(property = "project", required = true, readonly = true) - protected MavenProject project; - - /** - * The directory for components catalog - */ - @Parameter(defaultValue = "${project.build.directory}/classes/org/apache/camel/catalog/components") - protected File componentsDir; - - /** - * The directory for data formats catalog - */ - @Parameter(defaultValue = "${project.build.directory}/classes/org/apache/camel/catalog/dataformats") - protected File dataFormatsDir; - - /** - * The directory for languages catalog - */ - @Parameter(defaultValue = "${project.build.directory}/classes/org/apache/camel/catalog/languages") - protected File languagesDir; - - /** - * The directory for others catalog - */ - @Parameter(defaultValue = "${project.build.directory}/classes/org/apache/camel/catalog/others") - protected File othersDir; - - /** - * The website index page for components - */ - @Parameter(defaultValue = "${project.directory}/../../../docs/components/modules/ROOT/pages/index.adoc") - protected File websiteComponentsIndex; - - /** - * The website index page for data formats - */ - @Parameter(defaultValue = "${project.directory}/../../../docs/components/modules/dataformats/pages/index.adoc") - protected File websiteDataFormatsIndex; - - /** - * The website index page for expression languages - */ - @Parameter(defaultValue = "${project.directory}/../../../docs/components/modules/languages/pages/index.adoc") - protected File websiteLanguagesIndex; - - /** - * Maven ProjectHelper. - */ - @Component - private MavenProjectHelper projectHelper; - - /** - * Execute goal. - * - * @throws MojoExecutionException execution of the main class or one of the - * threads it generated failed. - * @throws MojoFailureException something bad happened... - */ - @Override - public void execute() throws MojoExecutionException, MojoFailureException { - executeComponentsList(); - executeDataFormatsList(); - executeLanguagesList(); - executeOthersReadme(); - } - - protected void executeComponentsList() throws MojoExecutionException, MojoFailureException { - Set<File> componentFiles = new TreeSet<>(); - - if (componentsDir != null && componentsDir.isDirectory()) { - File[] files = componentsDir.listFiles(); - if (files != null) { - componentFiles.addAll(Arrays.asList(files)); - } - } - - try { - List<ComponentModel> models = new ArrayList<>(); - for (File file : componentFiles) { - String json = PackageHelper.loadText(file); - ComponentModel model = JsonMapper.generateComponentModel(json); - - // filter out alternative schemas which reuses documentation - boolean add = true; - if (!Strings.isNullOrEmpty(model.getAlternativeSchemes())) { - String first = model.getAlternativeSchemes().split(",")[0]; - if (!model.getScheme().equals(first)) { - add = false; - } - } - if (add) { - models.add(model); - - // special for camel-mail where we want to refer its imap - // scheme to mail so its mail.adoc in the doc link - if ("imap".equals(model.getScheme())) { - model.setScheme("mail"); - model.setTitle("Mail"); - } - } - } - - // sort the models - models.sort((m1, m2) -> m1.getTitle().compareToIgnoreCase(m2.getTitle())); - - // how many different artifacts - long count = models.stream().map(ComponentModel::getArtifactId).distinct().count(); - - // how many deprecated - long deprecated = models.stream().filter(BaseModel::isDeprecated).count(); - - // update doc in the website dir - File file = websiteComponentsIndex; - boolean exists = file.exists(); - String changed = templateComponents(models, count, deprecated); - boolean updated = updateComponents(file, changed); - if (updated) { - getLog().info("Updated website doc file: " + file); - } else if (exists) { - getLog().debug("No changes to website doc file: " + file); - } else { - getLog().warn("No website doc file: " + file); - } - } catch (IOException e) { - throw new MojoFailureException("Error due " + e.getMessage(), e); - } - } - - protected void executeOthersReadme() throws MojoExecutionException, MojoFailureException { - Set<File> otherFiles = new TreeSet<>(); - - if (othersDir != null && othersDir.isDirectory()) { - File[] files = othersDir.listFiles(); - if (files != null) { - otherFiles.addAll(Arrays.asList(files)); - } - } - - try { - List<OtherModel> models = new ArrayList<>(); - for (File file : otherFiles) { - String json = PackageHelper.loadText(file); - OtherModel model = JsonMapper.generateOtherModel(json); - models.add(model); - } - - // sort the models - models.sort((m1, m2) -> m1.getTitle().compareToIgnoreCase(m2.getTitle())); - - // how many different artifacts - long count = models.stream().map(OtherModel::getArtifactId).distinct().count(); - - // how many deprecated - long deprecated = models.stream().filter(BaseModel::isDeprecated).count(); - - // update doc in the website dir - File file = websiteComponentsIndex; - boolean exists = file.exists(); - String changed = templateOthers(models, count, deprecated); - boolean updated = updateOthers(file, changed); - if (updated) { - getLog().info("Updated website doc file: " + file); - } else if (exists) { - getLog().debug("No changes to website doc file: " + file); - } else { - getLog().warn("No website doc file: " + file); - } - - } catch (IOException e) { - throw new MojoFailureException("Error due " + e.getMessage(), e); - } - } - - protected void executeDataFormatsList() throws MojoExecutionException, MojoFailureException { - Set<File> dataFormatFiles = new TreeSet<>(); - - if (dataFormatsDir != null && dataFormatsDir.isDirectory()) { - File[] files = dataFormatsDir.listFiles(); - if (files != null) { - dataFormatFiles.addAll(Arrays.asList(files)); - } - } - - try { - List<DataFormatModel> models = new ArrayList<>(); - for (File file : dataFormatFiles) { - String json = PackageHelper.loadText(file); - DataFormatModel model = JsonMapper.generateDataFormatModel(json); - - // special for bindy as we have one common file - if (model.getName().startsWith("bindy")) { - model.setName("bindy"); - } - - models.add(model); - } - - // sort the models - models.sort((m1, m2) -> m1.getTitle().compareToIgnoreCase(m2.getTitle())); - - // how many different artifacts - long count = models.stream().map(DataFormatModel::getArtifactId).distinct().count(); - - // how many deprecated - long deprecated = models.stream().filter(BaseModel::isDeprecated).count(); - - // update doc in the website dir - File file = websiteDataFormatsIndex; - boolean exists = file.exists(); - String changed = templateDataFormats(models, count, deprecated); - boolean updated = updateDataFormats(file, changed); - if (updated) { - getLog().info("Updated website doc file: " + file); - } else if (exists) { - getLog().debug("No changes to website doc file: " + file); - } else { - getLog().warn("No website doc file: " + file); - } - - } catch (IOException e) { - throw new MojoFailureException("Error due " + e.getMessage(), e); - } - } - - protected void executeLanguagesList() throws MojoExecutionException, MojoFailureException { - Set<File> languageFiles = new TreeSet<>(); - - if (languagesDir != null && languagesDir.isDirectory()) { - File[] files = languagesDir.listFiles(); - if (files != null) { - languageFiles.addAll(Arrays.asList(files)); - } - } - - try { - List<LanguageModel> models = new ArrayList<>(); - for (File file : languageFiles) { - String json = PackageHelper.loadText(file); - LanguageModel model = JsonMapper.generateLanguageModel(json); - models.add(model); - } - - // sort the models - models.sort((m1, m2) -> m1.getTitle().compareToIgnoreCase(m2.getTitle())); - - // how many different artifacts - long count = models.stream().map(LanguageModel::getArtifactId).distinct().count(); - - // how many deprecated - long deprecated = models.stream().filter(BaseModel::isDeprecated).count(); - - // update doc in the website dir - File file = websiteLanguagesIndex; - boolean exists = file.exists(); - String changed = templateLanguages(models, count, deprecated); - boolean updated = updateLanguages(file, changed); - if (updated) { - getLog().info("Updated website doc file: " + file); - } else if (exists) { - getLog().debug("No changes to website doc file: " + file); - } else { - getLog().warn("No website doc file: " + file); - } - - } catch (IOException e) { - throw new MojoFailureException("Error due " + e.getMessage(), e); - } - } - - private String templateComponents(List<ComponentModel> models, long artifacts, long deprecated) throws MojoExecutionException { - try { - String template = loadResource("website-components-list.mvel"); - Map<String, Object> map = new HashMap<>(); - map.put("components", models); - map.put("numberOfArtifacts", artifacts); - map.put("numberOfDeprecated", deprecated); - String out = (String)TemplateRuntime.eval(template, map, Collections.singletonMap("util", MvelHelper.INSTANCE)); - return out; - } catch (Exception e) { - throw new MojoExecutionException("Error processing mvel template. Reason: " + e, e); - } - } - - private String templateOthers(List<OtherModel> models, long artifacts, long deprecated) throws MojoExecutionException { - try { - String template = loadResource("website-others-list.mvel"); - Map<String, Object> map = new HashMap<>(); - map.put("others", models); - map.put("numberOfArtifacts", artifacts); - map.put("numberOfDeprecated", deprecated); - String out = (String)TemplateRuntime.eval(template, map, Collections.singletonMap("util", MvelHelper.INSTANCE)); - return out; - } catch (Exception e) { - throw new MojoExecutionException("Error processing mvel template. Reason: " + e, e); - } - } - - private String templateDataFormats(List<DataFormatModel> models, long artifacts, long deprecated) throws MojoExecutionException { - try { - String template = loadResource("website-dataformats-list.mvel"); - Map<String, Object> map = new HashMap<>(); - map.put("dataformats", models); - map.put("numberOfArtifacts", artifacts); - map.put("numberOfDeprecated", deprecated); - String out = (String)TemplateRuntime.eval(template, map, Collections.singletonMap("util", MvelHelper.INSTANCE)); - return out; - } catch (Exception e) { - throw new MojoExecutionException("Error processing mvel template. Reason: " + e, e); - } - } - - private String templateLanguages(List<LanguageModel> models, long artifacts, long deprecated) throws MojoExecutionException { - try { - String template = loadResource("website-languages-list.mvel"); - Map<String, Object> map = new HashMap<>(); - map.put("languages", models); - map.put("numberOfArtifacts", artifacts); - map.put("numberOfDeprecated", deprecated); - String out = (String)TemplateRuntime.eval(template, map, Collections.singletonMap("util", MvelHelper.INSTANCE)); - return out; - } catch (Exception e) { - throw new MojoExecutionException("Error processing mvel template. Reason: " + e, e); - } - } - - private String loadResource(String name) throws IOException { - return PackageHelper.loadText(UpdateReadmeMojo.class.getClassLoader().getResourceAsStream(name)); - } - - private boolean updateComponents(File file, String changed) throws MojoExecutionException { - if (!file.exists()) { - return false; - } - - try { - String text = PackageHelper.loadText(file); - - String existing = Strings.between(text, "// components: START", "// components: END"); - if (existing != null) { - // remove leading line breaks etc - existing = existing.trim(); - changed = changed.trim(); - if (existing.equals(changed)) { - return false; - } else { - String before = Strings.before(text, "// components: START"); - String after = Strings.after(text, "// components: END"); - text = before + "// components: START\n" + changed + "\n// components: END" + after; - PackageHelper.writeText(file, text); - return true; - } - } else { - getLog().warn("Cannot find markers in file " + file); - getLog().warn("Add the following markers"); - getLog().warn("\t// components: START"); - getLog().warn("\t// components: END"); - return false; - } - } catch (Exception e) { - throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e); - } - } - - private boolean updateOthers(File file, String changed) throws MojoExecutionException { - if (!file.exists()) { - return false; - } - - try { - String text = PackageHelper.loadText(file); - - String existing = Strings.between(text, "// others: START", "// others: END"); - if (existing != null) { - // remove leading line breaks etc - existing = existing.trim(); - changed = changed.trim(); - if (existing.equals(changed)) { - return false; - } else { - String before = Strings.before(text, "// others: START"); - String after = Strings.after(text, "// others: END"); - text = before + "// others: START\n" + changed + "\n// others: END" + after; - PackageHelper.writeText(file, text); - return true; - } - } else { - getLog().warn("Cannot find markers in file " + file); - getLog().warn("Add the following markers"); - getLog().warn("\t// others: START"); - getLog().warn("\t// others: END"); - return false; - } - } catch (Exception e) { - throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e); - } - } - - private boolean updateDataFormats(File file, String changed) throws MojoExecutionException { - if (!file.exists()) { - return false; - } - - try { - String text = PackageHelper.loadText(file); - - String existing = Strings.between(text, "// dataformats: START", "// dataformats: END"); - if (existing != null) { - // remove leading line breaks etc - existing = existing.trim(); - changed = changed.trim(); - if (existing.equals(changed)) { - return false; - } else { - String before = Strings.before(text, "// dataformats: START"); - String after = Strings.after(text, "// dataformats: END"); - text = before + "// dataformats: START\n" + changed + "\n// dataformats: END" + after; - PackageHelper.writeText(file, text); - return true; - } - } else { - getLog().warn("Cannot find markers in file " + file); - getLog().warn("Add the following markers"); - getLog().warn("\t// dataformats: START"); - getLog().warn("\t// dataformats: END"); - return false; - } - } catch (Exception e) { - throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e); - } - } - - private boolean updateLanguages(File file, String changed) throws MojoExecutionException { - if (!file.exists()) { - return false; - } - - try { - String text = PackageHelper.loadText(file); - - String existing = Strings.between(text, "// languages: START", "// languages: END"); - if (existing != null) { - // remove leading line breaks etc - existing = existing.trim(); - changed = changed.trim(); - if (existing.equals(changed)) { - return false; - } else { - String before = Strings.before(text, "// languages: START"); - String after = Strings.after(text, "// languages: END"); - text = before + "// languages: START\n" + changed + "\n// languages: END" + after; - PackageHelper.writeText(file, text); - return true; - } - } else { - getLog().warn("Cannot find markers in file " + file); - getLog().warn("Add the following markers"); - getLog().warn("\t// languages: START"); - getLog().warn("\t// languages: END"); - return false; - } - } catch (Exception e) { - throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e); - } - } - -} diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java index 9b09b3dfaf4eb..75b150dbf16bd 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java @@ -20,23 +20,12 @@ import java.io.IOException; import java.io.InputStream; import java.nio.file.Paths; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.List; -import java.util.Objects; -import java.util.Set; -import java.util.TreeSet; -import java.util.stream.Collectors; +import java.util.*; import java.util.stream.Stream; +import java.util.regex.Pattern; -import org.apache.camel.tooling.model.BaseOptionModel; -import org.apache.camel.tooling.model.ComponentModel; -import org.apache.camel.tooling.model.DataFormatModel; -import org.apache.camel.tooling.model.EipModel; +import org.apache.camel.tooling.model.*; import org.apache.camel.tooling.model.EipModel.EipOptionModel; -import org.apache.camel.tooling.model.JsonMapper; -import org.apache.camel.tooling.model.LanguageModel; import org.apache.camel.tooling.util.PackageHelper; import org.apache.camel.tooling.util.Strings; import org.apache.maven.plugin.MojoExecutionException; @@ -76,9 +65,15 @@ public class UpdateReadmeMojo extends AbstractGeneratorMojo { /** * The language documentation directory */ - @Parameter(defaultValue = "${project.basedir}/src/main/docs/modules/languages/pages") + @Parameter(defaultValue = "${project.basedir}/src/main/docs") protected File languageDocDir; + /** + * The other language documentation directory + */ + @Parameter(defaultValue = "${project.basedir}/src/main/docs/modules/languages/pages") + protected File languageDocDir2; + /** * The EIP documentation directory */ @@ -96,14 +91,17 @@ public void execute(MavenProject project, MavenProjectHelper projectHelper, Buil buildDir = new File(project.getBuild().getDirectory()); componentDocDir = new File(project.getBasedir(), "src/main/docs"); dataformatDocDir = new File(project.getBasedir(), "src/main/docs"); - languageDocDir = new File(project.getBasedir(), "/src/main/docs/modules/languages/pages"); + languageDocDir = new File(project.getBasedir(), "/src/main/docs"); + languageDocDir2 = new File(project.getBasedir(), "/src/main/docs/modules/languages/pages"); eipDocDir = new File(project.getBasedir(), "src/main/docs/modules/eips/pages"); super.execute(project, projectHelper, buildContext); } @Override public void execute() throws MojoExecutionException { + getLog().warn("UpdateReadmeMojo execute"); executeComponent(); + executeOther(); executeDataFormat(); executeLanguage(); executeEips(); @@ -126,6 +124,7 @@ private void executeComponent() throws MojoExecutionException { componentName = asComponentName(componentName); File file = new File(componentDocDir, componentName + "-component.adoc"); + boolean exists = file.exists(); ComponentModel model = generateComponentModel(json); String title = asComponentTitle(model.getScheme(), model.getTitle()); @@ -140,18 +139,10 @@ private void executeComponent() throws MojoExecutionException { } } - String docTitle = model.getTitle() + " Component"; - boolean deprecated = model.isDeprecated(); - if (deprecated) { - docTitle += " (deprecated)"; - } + boolean updated = updateHeader(componentName, file, model, " Component", "-component"); - boolean exists = file.exists(); - boolean updated; - updated = updateLink(file, componentName + "-component"); - updated |= updateTitles(file, docTitle); - updated |= updateAvailableFrom(file, model.getFirstVersion()); - updated |= updateComponentHeader(file, model); + checkComponentHeader(file, model); + checkSince(file, model); // resolvePropertyPlaceholders is an option which only make // sense to use if the component has other options @@ -188,6 +179,50 @@ private void executeComponent() throws MojoExecutionException { } } + private void executeOther() throws MojoExecutionException { + // find the component names + List<String> componentNames = listDescriptorNamesOfType("other"); + + final Set<File> jsonFiles = new TreeSet<>(); + PackageHelper.findJsonFiles(buildDir, jsonFiles); + getLog().warn("UpdateReadmeMojo jsonFiles: " + jsonFiles); + + // only if there is components we should update the documentation files + if (!jsonFiles.isEmpty()) { + getLog().debug("Found " + jsonFiles.size() + "miscellaneous components"); + for (File jsonFile : jsonFiles) { + String json = loadJsonFrom(jsonFile, "other"); + if (json != null) { + // special for some components + OtherModel model = generateOtherModel(json); + String title = model.getTitle(); + model.setTitle(title); + + String componentName = asComponentName(model.getName()); + + File file = new File(componentDocDir, componentName + ".adoc"); + boolean exists = file.exists(); + + + // we only want the first scheme as the alternatives do not + boolean updated = updateHeader(componentName, file, model, " Component", "-component"); + checkSince(file, model); + + if (updated) { + getLog().info("Updated doc file: " + file); + } else if (exists) { + getLog().debug("No changes to doc file: " + file); + } else { + getLog().warn("No component doc file: " + file); + if (isFailFast()) { + throw new MojoExecutionException("Failed build due failFast=true"); + } + } + } + } + } + } + private void executeDataFormat() throws MojoExecutionException { // find the dataformat names List<String> dataFormatNames = listDescriptorNamesOfType("dataformat"); @@ -217,17 +252,9 @@ private void executeDataFormat() throws MojoExecutionException { String title = asDataFormatTitle(model.getName(), model.getTitle()); model.setTitle(title); - String docTitle = model.getTitle() + " DataFormat"; - boolean deprecated = model.isDeprecated(); - if (deprecated) { - docTitle += " (deprecated)"; - } - boolean exists = file.exists(); - boolean updated; - updated = updateLink(file, dataFormatName + "-dataformat"); - updated |= updateTitles(file, docTitle); - updated |= updateAvailableFrom(file, model.getFirstVersion()); + boolean updated = updateHeader(dataFormatName, file, model, " DataFormat", "-dataformat"); + checkSince(file, model); String options = evaluateTemplate("dataformat-options.mvel", model); updated |= updateOptionsIn(file, "dataformat", options); @@ -270,6 +297,11 @@ private void executeLanguage() throws MojoExecutionException { String json = loadJsonFrom(jsonFiles, "language", languageName); if (json != null) { File file = new File(languageDocDir, languageName + "-language.adoc"); + boolean exists = file.exists(); + if (!exists) { + file = new File(languageDocDir2, languageName + "-language.adoc"); + exists = file.exists(); + } LanguageModel model = JsonMapper.generateLanguageModel(json); // skip option named id @@ -287,17 +319,10 @@ private void executeLanguage() throws MojoExecutionException { option.setDescription(desc); }); - String docTitle = model.getTitle() + " Language"; - boolean deprecated = model.isDeprecated(); - if (deprecated) { - docTitle += " (deprecated)"; - } - - boolean exists = file.exists(); - boolean updated; - updated = updateLink(file, languageName + "-language"); - updated |= updateTitles(file, docTitle); - updated |= updateAvailableFrom(file, model.getFirstVersion()); + String titleSuffix = " Language"; + String linkSuffix = "-language"; + boolean updated = updateHeader(languageName, file, model, titleSuffix, linkSuffix); + checkSince(file, model); String options = evaluateTemplate("language-options.mvel", model); updated |= updateOptionsIn(file, "language", options); @@ -369,17 +394,9 @@ private void executeEips() throws MojoExecutionException { } File file = new File(eipDocDir, eipName + "-eip.adoc"); - - String docTitle = model.getTitle() + " EIP"; - boolean deprecated = model.isDeprecated(); - if (deprecated) { - docTitle += " (deprecated)"; - } - boolean exists = file.exists(); - boolean updated; - updated = updateLink(file, eipName + "-eip"); - updated |= updateTitles(file, docTitle); + + boolean updated = updateHeader(eipName, file, model, " EIP", "-eip"); String options = evaluateTemplate("eip-options.mvel", model); updated |= updateOptionsIn(file, "eip", options); @@ -426,104 +443,86 @@ private static String asDataFormatTitle(String name, String title) { return title; } - private static boolean updateLink(File file, String link) throws MojoExecutionException { - if (!file.exists()) { + Pattern copyRE = Pattern.compile("(\\[\\[.*)|(= .*)|(//.*)"); + Pattern attrRE = Pattern.compile(":([a-zA-Z0-9_-]*):( .*)?"); + private boolean updateHeader(String name, final File file, final BaseModel<? extends BaseOptionModel> model, String titleSuffix, String linkSuffix) throws MojoExecutionException { + getLog().warn("updateHeader " + file); + + if (model == null || !file.exists()) { return false; } boolean updated = false; - try { - List<String> newLines = new ArrayList<>(); String text = PackageHelper.loadText(file); + String[] lines = text.split("\n"); - for (int i = 0; i < lines.length; i++) { - String line = lines[i]; - if (i == 0) { - // first line is the link - String newLine = "[[" + link + "]]"; - newLines.add(newLine); - updated = !line.equals(newLine); - if (updated) { - // its some old text so keep it - newLines.add(line); - } - } else { - newLines.add(line); - } + // check first if it is a standard documentation file, we expect at + // least five lines + if (lines.length < 5) { + return false; } - if (updated) { - // build the new updated text - String newText = newLines.stream().collect(Collectors.joining("\n")); - PackageHelper.writeText(file, newText); - } - } catch (Exception e) { - throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e); - } + List<String> newLines = new ArrayList<>(lines.length + 8); - return updated; - } + //link + newLines.add("[[" + name + linkSuffix + "]]"); - private static boolean updateTitles(File file, String title) throws MojoExecutionException { - if (!file.exists()) { - return false; - } + //title + String title = model.getTitle() + titleSuffix; + if (model.isDeprecated()) { + title += " (deprecated)"; + } + newLines.add("= " + title); + newLines.add(":docTitle: " + model.getTitle()); - boolean updated = false; + if (model instanceof ArtifactModel<?>) { + newLines.add(":artifactId: " + ((ArtifactModel<?>)model).getArtifactId()); + } + newLines.add(":description: " + model.getDescription()); + newLines.add(":since: " + model.getFirstVersionShort()); + //TODO put the deprecation into the actual support level. + newLines.add(":supportLevel: " + model.getSupportLevel().toString() + (model.isDeprecated()? "-deprecated": "")); + if (model.isDeprecated()) newLines.add(":deprecated: *deprecated*"); + if (model instanceof ComponentModel) { + newLines.add(":component-header: " + generateComponentHeader((ComponentModel)model)); + if (Arrays.asList(model.getLabel().split(",")).contains("core")) { + newLines.add(":core:"); + } + } - try { - List<String> newLines = new ArrayList<>(); + newLines.add(""); - String text = PackageHelper.loadText(file); - String[] lines = text.split("\n"); - // line 0 is the link - for (int i = 1; i < lines.length; i++) { - String line = lines[i]; - - if (i == 1) { - // first line is the title to make the text less noisy we - // use level 2 - String newLine = "= " + title; - newLines.add(newLine); - updated = !line.equals(newLine); - continue; + for (int i = 0; i < lines.length; i++) { + if (i == newLines.size() || newLines.get(i) != lines[i]) { + updated = true; + break; } + } +// getLog().warn("updateHeader updated: " + updated); - // use single line headers with # as level instead of the - // cumbersome adoc weird style - if (line.startsWith("^^^") || line.startsWith("~~~") || line.startsWith("+++")) { - String level = line.startsWith("+++") ? "===" : "=="; - - // transform legacy heading into new style - int idx = newLines.size() - 1; - String prev = newLines.get(idx); - - newLines.set(idx, level + " " + prev); - - // okay if 2nd-prev line is a [[title]] we need to remove - // that too - // so we have nice clean sub titles - idx = newLines.size() - 2; - if (idx >= 0) { - prev = newLines.get(idx); - if (prev.startsWith("[[")) { - // remove - newLines.remove(idx); - } + boolean copy = false; + if (updated) { + for (int i = 0; i < lines.length; i++) { + if (!copy && lines[i].isEmpty()) { +// getLog().warn("updateHeader empty line found: " + i); + copy = true; + } else if (copy) { +// getLog().warn("updateHeader copying line " + i); + newLines.add(lines[i]); } - - updated = true; - } else { - // okay normal text so just add it - newLines.add(line); } } + if (!copy) { + throw new MojoFailureException("File " + file + " has unexpected structure with no empty line."); + } if (updated) { // build the new updated text - String newText = newLines.stream().collect(Collectors.joining("\n")); + if (!newLines.get(newLines.size() - 1).isEmpty()) newLines.add(""); + String newText = String.join("\n", newLines); +// getLog().warn("updateHeader newText:\n\n" + newText + "\n\n"); PackageHelper.writeText(file, newText); } } catch (Exception e) { @@ -533,133 +532,56 @@ private static boolean updateTitles(File file, String title) throws MojoExecutio return updated; } - private boolean updateComponentHeader(final File file, final ComponentModel model) throws MojoExecutionException { + private void checkComponentHeader(final File file, final ComponentModel model) throws MojoExecutionException { if (!file.exists()) { - return false; + return; } - final String markerStart = "// HEADER START"; - final String markerEnd = "// HEADER END"; - - final String headerText = generateHeaderTextData(model); + final String headerText = "*{component-header}*"; + String loadedText; try { - final String loadedText = PackageHelper.loadText(file); + loadedText = PackageHelper.loadText(file); - String existing = Strings.between(loadedText, markerStart, markerEnd); + } catch (Exception e) { + throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e); + } + if (!loadedText.contains(headerText)) { + throw new MojoExecutionException("File " + file + " does not contain required string `" + headerText + "'"); + } + } - if (existing != null) { - // remove leading line breaks etc - existing = existing.trim(); - if (existing.equals(headerText)) { - return false; - } + private void checkSince(final File file, final ArtifactModel<?> model) throws MojoExecutionException { + if (!file.exists()) { + return; + } - final String before = Strings.before(loadedText, markerStart); - final String after = Strings.after(loadedText, markerEnd); - final String updatedHeaderText = before + markerStart + "\n" + headerText + "\n" + markerEnd + after; + final String sinceText = "*Since Camel {since}*"; + String loadedText; - PackageHelper.writeText(file, updatedHeaderText); - return true; - } else { - // so we don't have the marker, so we add it somewhere after the - // camel version - final String sinceVersion = "*Since Camel " + shortenVersion(model.getFirstVersion()) + "*"; - final String before = Strings.before(loadedText, sinceVersion); - final String after = Strings.after(loadedText, sinceVersion); - final String updatedHeaderText = before + sinceVersion + "\n\n" + markerStart + "\n" + headerText + "\n" + markerEnd + after; - - PackageHelper.writeText(file, updatedHeaderText); - return true; - } + try { + loadedText = PackageHelper.loadText(file); } catch (Exception e) { throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e); } + if (!loadedText.contains(sinceText)) { + throw new MojoExecutionException("File " + file + " does not contain required string '" + sinceText + "'"); + } } - private static String generateHeaderTextData(final ComponentModel model) { + private static String generateComponentHeader(final ComponentModel model) { final boolean consumerOnly = model.isConsumerOnly(); final boolean producerOnly = model.isProducerOnly(); // if we have only producer support if (!consumerOnly && producerOnly) { - return "*Only producer is supported*"; + return "Only producer is supported"; } // if we have only consumer support if (consumerOnly && !producerOnly) { - return "*Only consumer is supported*"; - } - - return "*Both producer and consumer is supported*"; - } - - private static boolean updateAvailableFrom(final File file, final String firstVersion) throws MojoExecutionException { - if (firstVersion == null || !file.exists()) { - return false; - } - - final String version = shortenVersion(firstVersion); - - boolean updated = false; - - try { - String text = PackageHelper.loadText(file); - - String[] lines = text.split("\n"); - - List<String> newLines = new ArrayList<>(); - - // copy over to all new lines - newLines.addAll(Arrays.asList(lines)); - - // check first if it is a standard documentation file, we expect at - // least five lines - if (lines.length < 5) { - return false; - } - - // check the first four lines (ignoring the first line) - boolean title = lines[1].startsWith("#") || lines[1].startsWith("="); - boolean empty = lines[2].trim().isEmpty(); - boolean since = lines[3].trim().contains("Since Camel"); - boolean empty2 = lines[4].trim().isEmpty(); - - if (title && empty && since) { - String newLine = "*Since Camel " + version + "*"; - if (!newLine.equals(lines[3])) { - newLines.set(3, newLine); - updated = true; - } - if (!empty2) { - newLines.add(4, ""); - updated = true; - } - } else if (!since) { - String newLine = "*Since Camel " + version + "*"; - newLines.add(3, newLine); - newLines.add(4, ""); - updated = true; - } - - if (updated) { - // build the new updated text - String newText = String.join("\n", newLines); - PackageHelper.writeText(file, newText); - } - } catch (Exception e) { - throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e); + return "Only consumer is supported"; } - return updated; - } - - private static String shortenVersion(final String firstVersion) { - String version = firstVersion; - // cut last digit so its not 2.18.0 but 2.18 - String[] parts = firstVersion.split("\\."); - if (parts.length == 3 && parts[2].equals("0")) { - version = parts[0] + "." + parts[1]; - } - return version; + return "Both producer and consumer are supported"; } private boolean updateOptionsIn(final File file, final String kind, final String changed) throws MojoExecutionException { @@ -716,6 +638,21 @@ private static String loadJsonFrom(Set<File> jsonFiles, String kind, String name return null; } + private static String loadJsonFrom(File file, String kind) { + if (file.getName().endsWith(PackageHelper.JSON_SUFIX)) { + try { + String json = PackageHelper.loadText(file); + if (Objects.equals(kind, PackageHelper.getSchemaKind(json))) { + return json; + } + } catch (IOException ignored) { + // ignored + } + } + + return null; + } + private static String loadEipJson(File file) { try { String json = PackageHelper.loadText(file); @@ -755,6 +692,33 @@ private ComponentModel generateComponentModel(String json) { return component; } + private OtherModel generateOtherModel(String json) { + OtherModel other = JsonMapper.generateOtherModel(json); +// Stream.concat(other.getComponentOptions().stream(), other.getEndpointOptions().stream()).filter(BaseOptionModel::isRequired).forEach(option -> { +// String desc = "*Required* " + option.getDescription(); +// option.setDescription(desc); +// }); +// Stream.concat(other.getComponentOptions().stream(), other.getEndpointOptions().stream()).filter(BaseOptionModel::isDeprecated).forEach(option -> { +// String desc = "*Deprecated* " + option.getDescription(); +// if (!Strings.isEmpty(option.getDeprecationNote())) { +// if (!desc.endsWith(".")) { +// desc += "."; +// } +// desc = desc + " Deprecation note: " + option.getDeprecationNote(); +// } +// option.setDescription(desc); +// }); +// Stream.concat(other.getComponentOptions().stream(), other.getEndpointOptions().stream()).filter(o -> o.getEnums() != null).forEach(option -> { +// String desc = option.getDescription(); +// if (!desc.endsWith(".")) { +// desc = desc + "."; +// } +// desc = desc + " The value can be one of: " + wrapEnumValues(option.getEnums()); +// option.setDescription(desc); +// }); + return other; + } + private DataFormatModel generateDataFormatModel(String json) { DataFormatModel model = JsonMapper.generateDataFormatModel(json); // skip option named id diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/website-components-list.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/website-components-list.mvel deleted file mode 100644 index 2df56eda573cb..0000000000000 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/website-components-list.mvel +++ /dev/null @@ -1,13 +0,0 @@ -@if{!components.isEmpty()} - -Number of Components: @{components.size} in @{numberOfArtifacts} JAR artifacts (@{numberOfDeprecated} deprecated) - -[width="100%",cols="4,1,5",options="header"] -|=== -| Component | Since | Description -@foreach{row : components} -| xref:${row.scheme}-component.adoc[@{row.title}] (@{row.artifactId}) | @{row.firstVersionShort} | @if{row.deprecated}*deprecated* @end{}@{util.escape(row.description)} -@end{} -|=== - -@end{} \ No newline at end of file diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/website-dataformats-list.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/website-dataformats-list.mvel deleted file mode 100644 index a073778e9fca1..0000000000000 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/website-dataformats-list.mvel +++ /dev/null @@ -1,12 +0,0 @@ -@if{!dataformats.isEmpty()} - -Number of Data Formats: @{dataformats.size} in @{numberOfArtifacts} JAR artifacts (@{numberOfDeprecated} deprecated) - -[width="100%",cols="4,1,5",options="header"] -|=== -| Data Format | Since | Description -@foreach{row : dataformats} -| xref:dataformats:${row.name}-dataformat.adoc[@{row.title}] (@{row.artifactId}) | @{row.firstVersionShort} | @if{row.deprecated}*deprecated* @end{}@{util.escape(row.description)} -@end{}|=== - -@end{} \ No newline at end of file diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/website-languages-list.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/website-languages-list.mvel deleted file mode 100644 index 9662f8d47d463..0000000000000 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/website-languages-list.mvel +++ /dev/null @@ -1,12 +0,0 @@ -@if{!languages.isEmpty()} - -Number of Languages: @{languages.size} in @{numberOfArtifacts} JAR artifacts (@{numberOfDeprecated} deprecated) - -[width="100%",cols="4,1,5",options="header"] -|=== -| Language | Since | Description -@foreach{row : languages} -| xref:languages:${row.name}-language.adoc[@{row.title}] (@{row.artifactId}) | @{row.firstVersionShort} | @if{row.deprecated}*deprecated* @end{}@{util.escape(row.description)} -@end{}|=== - -@end{} \ No newline at end of file diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/website-others-list.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/website-others-list.mvel deleted file mode 100644 index 330ab9fda6265..0000000000000 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/website-others-list.mvel +++ /dev/null @@ -1,12 +0,0 @@ -@if{!others.isEmpty()} - -Number of Miscellaneous Components: @{others.size} in @{numberOfArtifacts} JAR artifacts (@{numberOfDeprecated} deprecated) - -[width="100%",cols="4,1,5",options="header"] -|=== -| Component | Since | Description -@foreach{row : others} -| xref:${row.name}.adoc[@{row.title}] (@{row.artifactId}) | @{row.firstVersionShort} | @if{row.deprecated}*deprecated* @end{}@{util.escape(row.description)} -@end{}|=== - -@end{} \ No newline at end of file diff --git a/tooling/maven/camel-package-maven-plugin/src/test/java/org/apache/camel/maven/packaging/EndpointHelperTest.java b/tooling/maven/camel-package-maven-plugin/src/test/java/org/apache/camel/maven/packaging/EndpointHelperTest.java index 5f1733ebbd7fc..134c432322813 100644 --- a/tooling/maven/camel-package-maven-plugin/src/test/java/org/apache/camel/maven/packaging/EndpointHelperTest.java +++ b/tooling/maven/camel-package-maven-plugin/src/test/java/org/apache/camel/maven/packaging/EndpointHelperTest.java @@ -18,8 +18,14 @@ import java.io.File; import java.io.IOException; +import java.util.Map; import java.util.Objects; +import java.util.TreeMap; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.regex.Matcher; +import java.util.regex.Pattern; import java.util.stream.Collectors; +import java.util.stream.Stream; import org.apache.camel.tooling.model.ComponentModel; import org.apache.camel.tooling.model.ComponentModel.ComponentOptionModel; @@ -27,6 +33,7 @@ import org.apache.camel.tooling.util.PackageHelper; import org.junit.jupiter.api.Test; +import static org.junit.jupiter.api.Assertions.assertTrue; import static org.junit.jupiter.api.Assertions.assertEquals; public class EndpointHelperTest { @@ -60,4 +67,31 @@ public void testSort2() throws IOException { .map(ComponentOptionModel::getName).collect(Collectors.joining(","))); } + @Test + public void testRE() throws Exception { + Pattern copyRE = Pattern.compile("(\\[\\[.*)|(= .*)|(//.*)"); + Pattern attrRE = Pattern.compile(":[a-zA-Z0-9_-]*:( .*)?"); + + String[] lines = { + "[[any23-dataformat]]", + "//= Any23 DataFormat", + "= Any23 DataFormat" + }; + Stream.of(lines).forEach(line -> { + Matcher copy = copyRE.matcher(line); + assertTrue(copy.matches(), line); + }); + String[] attrlines = { + ":attribute:", + ":attribute: value", + ":attri-bute: value", + ":attri_bute: value", + ":attribute: value", + ":attribute: value \\" + }; + Stream.of(attrlines).forEach(line -> { + Matcher copy = attrRE.matcher(line); + assertTrue(copy.matches(), line); + }); + } }