blob: b5f1bc33e723ce1b7b754ae605268178c5718b72 [file] [log] [blame]
// kafka-connector options: START
[[camel-vertx-kafka-connector-source]]
= camel-vertx-kafka-connector source configuration
When using camel-vertx-kafka-connector as source 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-vertx-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-vertx source connector supports 15 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.address* | Sets the event bus address used to communicate | null | HIGH
| *camel.source.endpoint.pubSub* | Whether to use publish/subscribe instead of point to point when sending to a vertx endpoint. | null | MEDIUM
| *camel.source.endpoint.bridgeErrorHandler* | 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 | MEDIUM
| *camel.source.endpoint.exceptionHandler* | 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. | null | MEDIUM
| *camel.source.endpoint.exchangePattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | MEDIUM
| *camel.source.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
| *camel.component.vertx.host* | Hostname for creating an embedded clustered EventBus | null | MEDIUM
| *camel.component.vertx.port* | Port for creating an embedded clustered EventBus | null | MEDIUM
| *camel.component.vertx.timeout* | Timeout in seconds to wait for clustered Vertx EventBus to be ready. The default value is 60. | 60 | MEDIUM
| *camel.component.vertx.vertx* | To use the given vertx EventBus instead of creating a new embedded EventBus | null | MEDIUM
| *camel.component.vertx.vertxOptions* | Options to use for creating vertx | null | MEDIUM
| *camel.component.vertx.bridgeErrorHandler* | 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 | MEDIUM
| *camel.component.vertx.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.component.vertx.vertxFactory* | To use a custom VertxFactory implementation | null | MEDIUM
|===
// kafka-connector options: END