blob: d0e9a7105a59b2cd7325f5deed8bac1e63f3a125 [file] [log] [blame]
// kafka-connector options: START
[[camel-thrift-kafka-connector-source]]
= camel-thrift-kafka-connector source configuration
When using camel-thrift-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-thrift-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-thrift source connector supports 18 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.host* | The Thrift server host name. This is localhost or 0.0.0.0 (if not defined) when being a consumer or remote server host name when using producer. | null | ConfigDef.Importance.MEDIUM
| *camel.source.path.port* | The Thrift server port | null | ConfigDef.Importance.HIGH
| *camel.source.path.service* | Fully qualified service name from the thrift descriptor file (package dot service definition name) | null | ConfigDef.Importance.HIGH
| * camel.source.endpoint.compression Type* | Protocol compression mechanism type One of: [NONE] [ZLIB] | "NONE" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.exchange Protocol* | Exchange protocol serialization type One of: [BINARY] [JSON] [SJSON] [COMPACT] | "BINARY" | 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.client Timeout* | Client timeout for consumers | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.maxPool Size* | The Thrift server consumer max thread pool size | 10 | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.poolSize* | The Thrift server consumer initial thread pool size | 1 | 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.source.endpoint.negotiation Type* | Security negotiation type One of: [PLAINTEXT] [SSL] [SASL] | "PLAINTEXT" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.ssl Parameters* | Configuration parameters for SSL/TLS security negotiation | null | ConfigDef.Importance.MEDIUM
| *camel.component.thrift.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.thrift.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
| *camel.component.thrift.use GlobalSslContextParameters* | Determine if the thrift component is using global SSL context parameters | false | ConfigDef.Importance.MEDIUM
|===
// kafka-connector options: END