camel-freemarker-kafka-connector sink configuration

When using camel-freemarker-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-freemarker-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this Sink connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.freemarker.CamelFreemarkerSinkConnector

The camel-freemarker sink connector supports 15 options, which are listed below.

Name	Description	Default	Required	Priority
camel.sink.path.resourceUri	Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod.	null	true	HIGH
camel.sink.endpoint.allowContextMapAll	Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API.	false	false	MEDIUM
camel.sink.endpoint.allowTemplateFromHeader	Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care.	false	false	MEDIUM
camel.sink.endpoint.configuration	Sets the Freemarker configuration to use	null	false	MEDIUM
camel.sink.endpoint.contentCache	Sets whether to use resource content cache or not	false	false	MEDIUM
camel.sink.endpoint.encoding	Sets the encoding to be used for loading the template file.	null	false	MEDIUM
camel.sink.endpoint.lazyStartProducer	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	false	MEDIUM
camel.sink.endpoint.templateUpdateDelay	Number of seconds the loaded template resource will remain in the cache.	null	false	MEDIUM
camel.sink.endpoint.basicPropertyBinding	Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	false	MEDIUM
camel.sink.endpoint.synchronous	Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).	false	false	MEDIUM
camel.component.freemarker.allowContextMapAll	Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API.	false	false	MEDIUM
camel.component.freemarker.allowTemplateFromHeader	Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care.	false	false	MEDIUM
camel.component.freemarker.lazyStartProducer	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	false	MEDIUM
camel.component.freemarker.basicPropertyBinding	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	false	LOW
camel.component.freemarker.configuration	To use an existing freemarker.template.Configuration instance as the configuration.	null	false	MEDIUM

Name

Description

Default

Required

Priority

camel.sink.path.resourceUri

Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod.

null

true

HIGH

camel.sink.endpoint.allowContextMapAll

Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API.

false

MEDIUM

camel.sink.endpoint.allowTemplateFromHeader

Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care.

false

MEDIUM

camel.sink.endpoint.configuration

Sets the Freemarker configuration to use

null

false

MEDIUM

camel.sink.endpoint.contentCache

Sets whether to use resource content cache or not

false

MEDIUM

camel.sink.endpoint.encoding

Sets the encoding to be used for loading the template file.

null

false

MEDIUM

camel.sink.endpoint.lazyStartProducer

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

MEDIUM

camel.sink.endpoint.templateUpdateDelay

Number of seconds the loaded template resource will remain in the cache.

null

false

MEDIUM

camel.sink.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.sink.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.component.freemarker.allowContextMapAll

false

MEDIUM

camel.component.freemarker.allowTemplateFromHeader

false

MEDIUM

camel.component.freemarker.lazyStartProducer

false

MEDIUM

camel.component.freemarker.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

LOW

camel.component.freemarker.configuration

To use an existing freemarker.template.Configuration instance as the configuration.

null

false

MEDIUM

The camel-freemarker sink connector has no converters out of the box.

The camel-freemarker sink connector has no transforms out of the box.

The camel-freemarker sink connector has no aggregation strategies out of the box.