[[kamelet-component]]
= Kamelet Component
//THIS FILE IS COPIED: EDIT THE SOURCE FILE:
:page-source: components/camel-kamelet/src/main/docs/kamelet-component.adoc
:docTitle: Kamelet
:artifactId: camel-kamelet
:description: To call Kamelets
:since: 3.8
:supportLevel: Stable
: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 xref:manual::route-template.adoc[Camel Route Template] engine using Endpoint semantic.

== URI format

[source]
----
kamelet:templateId/routeId[?options]
----

== Options



// component options: START
The Kamelet component supports 9 options, which are listed below.



[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *location* (common) | The location(s) of the Kamelets on the file system. Multiple locations can be set separated by comma. | classpath:/kamelets | String
| *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
| *routeTemplateLoaderListener* (advanced) | *Autowired* To plugin a custom listener for when the Kamelet component is loading Kamelets from external resources. |  | RouteTemplateLoaderListener
|===
// 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 (8 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *location* (common) | Location of the Kamelet to use which can be specified as a resource from file system, classpath etc. The location cannot use wildcards, and must refer to a file including extension, for example file:/etc/foo-kamelet.xml |  | String
| *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 xref:manual::route-template.adoc[Route Template] engine and consumed upon route materialization.
====

== Discovery

If a xref:manual::route-template.adoc[Route Template] is not found, the *kamelet* endpoint tries to load the related *kamelet* definition from the file system (by default `classpath:/kamelets`). The default resolution mechanism expect kamelet files to have the extension `.kamelet.yaml`.

== 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("setMyBody")
    .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:setMyBody")
    .to("kamelet:setMyBody?bodyValue=myKamelet");
----


Behind the scenes, the *Kamelet* component does the following things:

1. it instantiates a route out of the Route Template identified by the given `templateId` path parameter (in this case `setBody`)
2. it will act like the `direct` component and connect the current route to the materialized one.

If you had to do it programmatically, it would have been something like:

[source,java]
----
routeTemplate("setMyBody")
    .templateParameter("bodyValue")
    .from("direct:{{foo}}")
        .setBody().constant("{{bodyValue}}");

TemplatedRouteBuilder.builder(context, "setMyBody")
    .parameter("foo", "bar")
    .parameter("bodyValue", "myKamelet")
    .add();

from("direct:template")
    .to("direct:bar");

----


//include::{page-component-version}@camel-spring-boot::page$kamelet-starter.adoc[]
