blob: 2f8c466bf966cf4808d25c51f122b36319d68f09 [file] [log] [blame]
// kafka-connector options: START
[[camel-atmos-kafka-connector-source]]
= camel-atmos-kafka-connector source configuration
When using camel-atmos-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-atmos-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-atmos source connector supports 21 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.name* | Atmos name | null | MEDIUM
| *camel.source.path.operation* | Operation to perform One of: [put] [del] [search] [get] [move] | null | HIGH
| *camel.source.endpoint.localPath* | Local path to put files | null | MEDIUM
| *camel.source.endpoint.newRemotePath* | New path on Atmos when moving files | null | MEDIUM
| *camel.source.endpoint.query* | Search query on Atmos | null | MEDIUM
| *camel.source.endpoint.remotePath* | Where to put files on Atmos | 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.source.endpoint.uri* | Atomos server uri | null | MEDIUM
| *camel.source.endpoint.fullTokenId* | Atmos client fullTokenId | null | MEDIUM
| *camel.source.endpoint.secretKey* | The secret key to pass to the Atmos client (should be base64 encoded) | null | MEDIUM
| *camel.source.endpoint.sslValidation* | Atmos SSL validation | false | MEDIUM
| *camel.component.atmos.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.atmos.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.component.atmos.uri* | The URI of the server for the Atmos client to connect to | null | MEDIUM
| *camel.component.atmos.fullTokenId* | The token id to pass to the Atmos client | null | MEDIUM
| *camel.component.atmos.secretKey* | The secret key to pass to the Atmos client (should be base64 encoded) | null | MEDIUM
| *camel.component.atmos.sslValidation* | Whether the Atmos client should perform SSL validation | false | MEDIUM
|===
// kafka-connector options: END