blob: b1a9c678dbc1161539d2c63b82714fc600eed43a [file] [log] [blame]
// kafka-connector options: START
[[camel-direct-vm-kafka-connector-sink]]
= camel-direct-vm-kafka-connector sink configuration
When using camel-direct-vm-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-direct-vm-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-direct-vm sink connector supports 15 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.name* | Name of direct-vm endpoint | null | HIGH
| *camel.sink.endpoint.block* | 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 | MEDIUM
| *camel.sink.endpoint.failIfNoConsumers* | Whether the producer should fail by throwing an exception, when sending to a Direct-VM endpoint with no active consumers. | 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.timeout* | The timeout value to use if block is enabled. | 30000L | MEDIUM
| *camel.sink.endpoint.headerFilterStrategy* | Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response). Default value: none. | null | 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.propagateProperties* | Whether to propagate or not properties from the producer side to the consumer side, and vice versa. Default value: true. | true | 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.direct-vm.block* | 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 | MEDIUM
| *camel.component.direct-vm.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.component.direct-vm.timeout* | The timeout value to use if block is enabled. | 30000L | MEDIUM
| *camel.component.direct-vm.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.component.direct-vm.headerFilterStrategy* | Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response). Default value: none. | null | MEDIUM
| *camel.component.direct-vm.propagateProperties* | Whether to propagate or not properties from the producer side to the consumer side, and vice versa. Default value: true. | true | MEDIUM
|===
// kafka-connector options: END