blob: bf973fe8419c2d48705d25afb7cdd8e0f544c86b [file] [log] [blame]
// kafka-connector options: START
[[camel-atomix-queue-kafka-connector-source]]
= camel-atomix-queue-kafka-connector source configuration
When using camel-atomix-queue-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-atomix-queue-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-atomix-queue source connector supports 24 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.resourceName* | The distributed resource name | null | HIGH
| *camel.source.endpoint.atomix* | The Atomix instance to use | null | MEDIUM
| *camel.source.endpoint.configurationUri* | The Atomix configuration uri. | null | MEDIUM
| *camel.source.endpoint.defaultAction* | The default action. One of: [ADD] [OFFER] [PEEK] [POLL] [CLEAR] [CONTAINS] [IS_EMPTY] [REMOVE] [SIZE] | "ADD" | MEDIUM
| *camel.source.endpoint.nodes* | The address of the nodes composing the cluster. | null | MEDIUM
| *camel.source.endpoint.resultHeader* | The header that wil carry the result. | null | MEDIUM
| *camel.source.endpoint.transportClassName* | The class name (fqn) of the Atomix transport | "io.atomix.catalyst.transport.netty.NettyTransport" | 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.defaultResourceConfig* | The cluster wide default resource configuration. | null | MEDIUM
| *camel.source.endpoint.defaultResourceOptions* | The local default resource options. | null | MEDIUM
| *camel.source.endpoint.ephemeral* | Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. | false | MEDIUM
| *camel.source.endpoint.readConsistency* | The read consistency level. One of: [ATOMIC] [ATOMIC_LEASE] [SEQUENTIAL] [LOCAL] | null | MEDIUM
| *camel.source.endpoint.resourceConfigs* | Cluster wide resources configuration. | null | MEDIUM
| *camel.source.endpoint.resourceOptions* | Local resources configurations | null | 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.atomix-queue.atomix* | The shared AtomixClient instance | null | MEDIUM
| *camel.component.atomix-queue.configuration* | The shared component configuration | null | MEDIUM
| *camel.component.atomix-queue.configurationUri* | The path to the AtomixClient configuration | null | MEDIUM
| *camel.component.atomix-queue.nodes* | The nodes the AtomixClient should connect to | null | MEDIUM
| *camel.component.atomix-queue.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.atomix-queue.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
|===
// kafka-connector options: END