You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by GitBox <gi...@apache.org> on 2021/01/26 18:05:34 UTC
[GitHub] [camel] davsclaus commented on a change in pull request #4935: CAMEL-16080: Migrate camel-kamelet component from camel-k-runtime to camel
davsclaus commented on a change in pull request #4935:
URL: https://github.com/apache/camel/pull/4935#discussion_r564716563
##########
File path: catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/kamelet-component.adoc
##########
@@ -0,0 +1,144 @@
+[[kamelet-component]]
+= Kamelet Component
+:docTitle: Kamelet
+:artifactId: camel-kamelet
+:description: The Kamelet Component provides support for interacting with the Camel Route Template engine
+:since: 3.8
+:supportLevel: Preview
+:component-header: Both producer and consumer are supported
+:core:
+include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/kamelet.adoc[opts=optional]
+
+*Since Camel {since}*
+
+*{component-header}*
+
+The Kamelet Component provides support for interacting with the https://camel.apache.org/manual/latest/route-template.html[Camel Route Template] engine using Endpoint semantic.
+
+== URI format
+
+[source]
+----
+kamelet:kamelet:templateId/routeId[?options]
Review comment:
kamelet is duplicated
##########
File path: catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/kamelet-component.adoc
##########
@@ -0,0 +1,144 @@
+[[kamelet-component]]
+= Kamelet Component
+:docTitle: Kamelet
+:artifactId: camel-kamelet
+:description: The Kamelet Component provides support for interacting with the Camel Route Template engine
+:since: 3.8
+:supportLevel: Preview
+:component-header: Both producer and consumer are supported
+:core:
+include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/kamelet.adoc[opts=optional]
+
+*Since Camel {since}*
+
+*{component-header}*
+
+The Kamelet Component provides support for interacting with the https://camel.apache.org/manual/latest/route-template.html[Camel Route Template] engine using Endpoint semantic.
+
+== URI format
+
+[source]
+----
+kamelet:kamelet:templateId/routeId[?options]
+----
+
+== Options
+
+
+
+// component options: START
+The Kamelet component supports 7 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *routeProperties* (common) | Set route local parameters. | | Map
+| *templateProperties* (common) | Set template local parameters. | | Map
+| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
+| *block* (producer) | If sending a message to a kamelet endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active. | true | boolean
+| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
+| *timeout* (producer) | The timeout value to use if block is enabled. | 30000 | long
+| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean
+|===
+// component options: END
+
+
+
+
+// endpoint options: START
+The Kamelet endpoint is configured using URI syntax:
+
+----
+kamelet:templateId/routeId
+----
+
+with the following path and query parameters:
+
+=== Path Parameters (2 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *templateId* | *Required* The Route Template ID | | String
+| *routeId* | The Route ID. Default value notice: The ID will be auto-generated if not provided | | String
+|===
+
+
+=== Query Parameters (7 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
+| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut | | ExchangePattern
+| *block* (producer) | If sending a message to a direct endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active. | true | boolean
+| *failIfNoConsumers* (producer) | Whether the producer should fail by throwing an exception, when sending to a kamelet endpoint with no active consumers. | true | boolean
+| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
+| *timeout* (producer) | The timeout value to use if block is enabled. | 30000 | long
+|===
+// endpoint options: END
+
+[NOTE]
+====
+The *kamelet* endpoint is *lenient*, which means that the endpoint accepts additional parameters that are passed to the ROute Templkate engine and consumed upon route materialization.
+====
+
+== Samples
+
+
+Kamelets can be used as if they were standard Camel components.
+For example, suppose that we have created a Route Template as follows:
+
+[source,java]
+----
+routeTemplate("setBody")
Review comment:
setMyBody
##########
File path: catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/kamelet-component.adoc
##########
@@ -0,0 +1,144 @@
+[[kamelet-component]]
+= Kamelet Component
+:docTitle: Kamelet
+:artifactId: camel-kamelet
+:description: The Kamelet Component provides support for interacting with the Camel Route Template engine
+:since: 3.8
+:supportLevel: Preview
+:component-header: Both producer and consumer are supported
+:core:
+include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/kamelet.adoc[opts=optional]
+
+*Since Camel {since}*
+
+*{component-header}*
+
+The Kamelet Component provides support for interacting with the https://camel.apache.org/manual/latest/route-template.html[Camel Route Template] engine using Endpoint semantic.
+
+== URI format
+
+[source]
+----
+kamelet:kamelet:templateId/routeId[?options]
+----
+
+== Options
+
+
+
+// component options: START
+The Kamelet component supports 7 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *routeProperties* (common) | Set route local parameters. | | Map
+| *templateProperties* (common) | Set template local parameters. | | Map
+| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
+| *block* (producer) | If sending a message to a kamelet endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active. | true | boolean
+| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
+| *timeout* (producer) | The timeout value to use if block is enabled. | 30000 | long
+| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean
+|===
+// component options: END
+
+
+
+
+// endpoint options: START
+The Kamelet endpoint is configured using URI syntax:
+
+----
+kamelet:templateId/routeId
+----
+
+with the following path and query parameters:
+
+=== Path Parameters (2 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *templateId* | *Required* The Route Template ID | | String
+| *routeId* | The Route ID. Default value notice: The ID will be auto-generated if not provided | | String
+|===
+
+
+=== Query Parameters (7 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
+| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut | | ExchangePattern
+| *block* (producer) | If sending a message to a direct endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active. | true | boolean
+| *failIfNoConsumers* (producer) | Whether the producer should fail by throwing an exception, when sending to a kamelet endpoint with no active consumers. | true | boolean
+| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
+| *timeout* (producer) | The timeout value to use if block is enabled. | 30000 | long
+|===
+// endpoint options: END
+
+[NOTE]
+====
+The *kamelet* endpoint is *lenient*, which means that the endpoint accepts additional parameters that are passed to the ROute Templkate engine and consumed upon route materialization.
+====
+
+== Samples
+
+
+Kamelets can be used as if they were standard Camel components.
+For example, suppose that we have created a Route Template as follows:
+
+[source,java]
+----
+routeTemplate("setBody")
+ .templateParameter("bodyValue")
+ .from("kamelet:source")
+ .setBody().constant("{{bodyValue}}");
+----
+
+[IMPORTANT]
+====
+To let the *Kamelet* component wiring the materialized route to the caller processor, we need to be able to identify the input and output endpoint of the route and this is done by using `kamele:source` to mark the input endpoint and `kamelet:sink` for the output endpoint.
+====
+
+Then the template can be instantiated and invoked as shown below:
+
+[source,java]
+----
+from("direct:template")
Review comment:
myTemplate
##########
File path: components/camel-kamelet/pom.xml
##########
@@ -0,0 +1,97 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+ 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.
+
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>components</artifactId>
+ <version>3.8.0-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>camel-kamelet</artifactId>
+ <packaging>jar</packaging>
+
+ <name>Camel :: Kamelet</name>
+ <description>The Kamelet Component provides support for interacting with the Camel Route Template engine</description>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.camel</groupId>
Review comment:
camel-api and camel-util are transparet from camel-support
##########
File path: catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/kamelet-component.adoc
##########
@@ -0,0 +1,144 @@
+[[kamelet-component]]
+= Kamelet Component
+:docTitle: Kamelet
+:artifactId: camel-kamelet
+:description: The Kamelet Component provides support for interacting with the Camel Route Template engine
+:since: 3.8
+:supportLevel: Preview
+:component-header: Both producer and consumer are supported
+:core:
+include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/kamelet.adoc[opts=optional]
+
+*Since Camel {since}*
+
+*{component-header}*
+
+The Kamelet Component provides support for interacting with the https://camel.apache.org/manual/latest/route-template.html[Camel Route Template] engine using Endpoint semantic.
Review comment:
This need some kind of xref to refer to an existing doc page instead of http link
##########
File path: catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/kamelet-component.adoc
##########
@@ -0,0 +1,144 @@
+[[kamelet-component]]
+= Kamelet Component
+:docTitle: Kamelet
+:artifactId: camel-kamelet
+:description: The Kamelet Component provides support for interacting with the Camel Route Template engine
+:since: 3.8
+:supportLevel: Preview
+:component-header: Both producer and consumer are supported
+:core:
+include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/kamelet.adoc[opts=optional]
+
+*Since Camel {since}*
+
+*{component-header}*
+
+The Kamelet Component provides support for interacting with the https://camel.apache.org/manual/latest/route-template.html[Camel Route Template] engine using Endpoint semantic.
+
+== URI format
+
+[source]
+----
+kamelet:kamelet:templateId/routeId[?options]
+----
+
+== Options
+
+
+
+// component options: START
+The Kamelet component supports 7 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *routeProperties* (common) | Set route local parameters. | | Map
+| *templateProperties* (common) | Set template local parameters. | | Map
+| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
+| *block* (producer) | If sending a message to a kamelet endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active. | true | boolean
+| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
+| *timeout* (producer) | The timeout value to use if block is enabled. | 30000 | long
+| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean
+|===
+// component options: END
+
+
+
+
+// endpoint options: START
+The Kamelet endpoint is configured using URI syntax:
+
+----
+kamelet:templateId/routeId
+----
+
+with the following path and query parameters:
+
+=== Path Parameters (2 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *templateId* | *Required* The Route Template ID | | String
+| *routeId* | The Route ID. Default value notice: The ID will be auto-generated if not provided | | String
+|===
+
+
+=== Query Parameters (7 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
+| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut | | ExchangePattern
+| *block* (producer) | If sending a message to a direct endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active. | true | boolean
+| *failIfNoConsumers* (producer) | Whether the producer should fail by throwing an exception, when sending to a kamelet endpoint with no active consumers. | true | boolean
+| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
+| *timeout* (producer) | The timeout value to use if block is enabled. | 30000 | long
+|===
+// endpoint options: END
+
+[NOTE]
+====
+The *kamelet* endpoint is *lenient*, which means that the endpoint accepts additional parameters that are passed to the ROute Templkate engine and consumed upon route materialization.
+====
+
+== Samples
+
+
+Kamelets can be used as if they were standard Camel components.
+For example, suppose that we have created a Route Template as follows:
+
+[source,java]
+----
+routeTemplate("setBody")
+ .templateParameter("bodyValue")
+ .from("kamelet:source")
+ .setBody().constant("{{bodyValue}}");
+----
+
+[IMPORTANT]
+====
+To let the *Kamelet* component wiring the materialized route to the caller processor, we need to be able to identify the input and output endpoint of the route and this is done by using `kamele:source` to mark the input endpoint and `kamelet:sink` for the output endpoint.
+====
+
+Then the template can be instantiated and invoked as shown below:
+
+[source,java]
+----
+from("direct:template")
+ .to("kamelet:setBody?bodyValue=kamelet");
Review comment:
Can we use mykamelet as bodyValue to make it more obvious that kamelet is not some special value
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org