camel-avro-kafka-connector source configuration

When using camel-avro-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-avro-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this Source connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.avro.CamelAvroSourceConnector

The camel-avro source connector supports 23 options, which are listed below.

Name	Description	Default	Required	Priority
camel.source.path.transport	Transport to use, can be either http or netty One of: [http] [netty]	null	true	HIGH
camel.source.path.port	Port number to use	null	true	HIGH
camel.source.path.host	Hostname to use	null	true	HIGH
camel.source.path.messageName	The name of the message to send.	null	false	MEDIUM
camel.source.endpoint.protocol	Avro protocol to use	null	false	MEDIUM
camel.source.endpoint.protocolClassName	Avro protocol to use defined by the FQN class name	null	false	MEDIUM
camel.source.endpoint.protocolLocation	Avro protocol location	null	false	MEDIUM
camel.source.endpoint.reflectionProtocol	If protocol object provided is reflection protocol. Should be used only with protocol parameter because for protocolClassName protocol type will be auto detected	false	false	MEDIUM
camel.source.endpoint.singleParameter	If true, consumer parameter won’t be wrapped into array. Will fail if protocol specifies more then 1 parameter for the message	false	false	MEDIUM
camel.source.endpoint.uriAuthority	Authority to use (username and password)	null	false	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	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	false	MEDIUM
camel.source.endpoint.exchangePattern	Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]	null	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	false	MEDIUM
camel.component.avro.protocol	Avro protocol to use	null	false	MEDIUM
camel.component.avro.protocolClassName	Avro protocol to use defined by the FQN class name	null	false	MEDIUM
camel.component.avro.protocolLocation	Avro protocol location	null	false	MEDIUM
camel.component.avro.reflectionProtocol	If protocol object provided is reflection protocol. Should be used only with protocol parameter because for protocolClassName protocol type will be auto detected	false	false	MEDIUM
camel.component.avro.singleParameter	If true, consumer parameter won’t be wrapped into array. Will fail if protocol specifies more then 1 parameter for the message	false	false	MEDIUM
camel.component.avro.uriAuthority	Authority to use (username and password)	null	false	MEDIUM
camel.component.avro.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	false	MEDIUM
camel.component.avro.autowiredEnabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	false	MEDIUM
camel.component.avro.configuration	To use a shared AvroConfiguration to configure options once	null	false	MEDIUM

Name

Description

Default

Required

Priority

camel.source.path.transport

Transport to use, can be either http or netty One of: [http] [netty]

null

true

HIGH

camel.source.path.port

Port number to use

null

true

HIGH

camel.source.path.host

Hostname to use

null

true

HIGH

camel.source.path.messageName

The name of the message to send.

null

false

MEDIUM

camel.source.endpoint.protocol

Avro protocol to use

null

false

MEDIUM

camel.source.endpoint.protocolClassName

Avro protocol to use defined by the FQN class name

null

false

MEDIUM

camel.source.endpoint.protocolLocation

Avro protocol location

null

false

MEDIUM

camel.source.endpoint.reflectionProtocol

If protocol object provided is reflection protocol. Should be used only with protocol parameter because for protocolClassName protocol type will be auto detected

false

MEDIUM

camel.source.endpoint.singleParameter

If true, consumer parameter won’t be wrapped into array. Will fail if protocol specifies more then 1 parameter for the message

false

MEDIUM

camel.source.endpoint.uriAuthority

Authority to use (username and password)

null

false

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

false

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]

null

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.component.avro.protocol

Avro protocol to use

null

false

MEDIUM

camel.component.avro.protocolClassName

Avro protocol to use defined by the FQN class name

null

false

MEDIUM

camel.component.avro.protocolLocation

Avro protocol location

null

false

MEDIUM

camel.component.avro.reflectionProtocol

If protocol object provided is reflection protocol. Should be used only with protocol parameter because for protocolClassName protocol type will be auto detected

false

MEDIUM

camel.component.avro.singleParameter

If true, consumer parameter won’t be wrapped into array. Will fail if protocol specifies more then 1 parameter for the message

false

MEDIUM

camel.component.avro.uriAuthority

Authority to use (username and password)

null

false

MEDIUM

camel.component.avro.bridgeErrorHandler

false

MEDIUM

camel.component.avro.autowiredEnabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

false

MEDIUM

camel.component.avro.configuration

To use a shared AvroConfiguration to configure options once

null

false

MEDIUM

The camel-avro source connector has no converters out of the box.

The camel-avro source connector has no transforms out of the box.

The camel-avro source connector has no aggregation strategies out of the box.