blob: 8639361980ddb24af9277e9fcfe726173de83af8 [file] [log] [blame]
// kafka-connector options: START
[[camel-infinispan-kafka-connector-source]]
= camel-infinispan-kafka-connector source configuration
When using camel-infinispan-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-infinispan-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-infinispan 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.cacheName* | The cache to use | null | ConfigDef.Importance.HIGH
| *camel.source.endpoint.hosts* | Specifies the host of the cache on Infinispan instance | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.query Builder* | Specifies the query builder. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.bridge ErrorHandler* | 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 | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.clustered Listener* | If true, the listener will be installed for the entire cluster | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.command* | The operation to perform. | "PUT" | ConfigDef.Importance.LOW
| *camel.source.endpoint.custom Listener* | Returns the custom listener in use, if provided | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.event Types* | Specifies the set of event types to register by the consumer. Multiple event can be separated by comma. The possible event types are: CACHE_ENTRY_ACTIVATED, CACHE_ENTRY_PASSIVATED, CACHE_ENTRY_VISITED, CACHE_ENTRY_LOADED, CACHE_ENTRY_EVICTED, CACHE_ENTRY_CREATED, CACHE_ENTRY_REMOVED, CACHE_ENTRY_MODIFIED, TRANSACTION_COMPLETED, TRANSACTION_REGISTERED, CACHE_ENTRY_INVALIDATED, DATA_REHASHED, TOPOLOGY_CHANGED, PARTITION_STATUS_CHANGED | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.sync* | If true, the consumer will receive notifications synchronously | true | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.exception Handler* | 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 | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.exchange Pattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.cache Container* | Specifies the cache Container to connect | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.cache ContainerConfiguration* | The CacheContainer configuration. Uses if the cacheContainer is not defined. Must be the following types: org.infinispan.client.hotrod.configuration.Configuration - for remote cache interaction configuration; org.infinispan.configuration.cache.Configuration - for embedded cache interaction configuration; | null | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.configuration Properties* | Implementation specific properties for the CacheManager | null | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.configuration Uri* | An implementation specific URI for the CacheManager | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.flags* | A comma separated list of Flag to be applied by default on each cache invocation, not applicable to remote caches. | null | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.remapping Function* | Set a specific remappingFunction to use in a compute operation | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.result Header* | Store the operation result in a header instead of the message body. By default, resultHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If resultHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved. This value can be overridden by an in message header named: CamelInfinispanOperationResultHeader | null | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM
| * camel.component.infinispan.cache Container* | Default Cache container | null | ConfigDef.Importance.MEDIUM
| * camel.component.infinispan.configuration* | Default configuration | null | ConfigDef.Importance.MEDIUM
| * camel.component.infinispan.bridge ErrorHandler* | 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 | ConfigDef.Importance.MEDIUM
| * camel.component.infinispan.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
|===
// kafka-connector options: END