blob: 1299622981d694a7ec1a1e5e24434b84dbb89862 [file] [log] [blame]
// kafka-connector options: START
[[camel-jcr-kafka-connector-source]]
= camel-jcr-kafka-connector source configuration
When using camel-jcr-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-jcr-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-jcr source connector supports 19 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.host* | Name of the javax.jcr.Repository to lookup from the Camel registry to be used. | null | ConfigDef.Importance.HIGH
| *camel.source.path.base* | Get the base node when accessing the repository | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.deep* | When isDeep is true, events whose associated parent node is at absPath or within its subgraph are received. | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.event Types* | eventTypes (a combination of one or more event types encoded as a bit mask value such as javax.jcr.observation.Event.NODE_ADDED, javax.jcr.observation.Event.NODE_REMOVED, etc.). | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.nodeType Names* | When a comma separated nodeTypeName list string is set, only events whose associated parent node has one of the node types (or a subtype of one of the node types) in this list will be received. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.noLocal* | If noLocal is true, then events generated by the session through which the listener was registered are ignored. Otherwise, they are not ignored. | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.password* | Password for login | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.session LiveCheckInterval* | Interval in milliseconds to wait before each session live checking The default value is 60000 ms. | 60000L | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.session LiveCheckIntervalOnStart* | Interval in milliseconds to wait before the first session live checking. The default value is 3000 ms. | 3000L | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.username* | Username for login | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.uuids* | When a comma separated uuid list string is set, only events whose associated parent node has one of the identifiers in the comma separated uuid list will be received. | null | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.workspace Name* | The workspace to access. If it's not specified then the default one will be used | 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.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.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.jcr.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.jcr.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