camel-validator-kafka-connector sink configuration

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

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

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

connector.class=org.apache.camel.kafkaconnector.validator.CamelValidatorSinkConnector

The camel-validator sink connector supports 16 options, which are listed below.

Name	Description	Default	Required	Priority
camel.sink.path.resourceUri	URL to a local resource on the classpath, or a reference to lookup a bean in the Registry, or a full URL to a remote resource or resource on the file system which contains the XSD to validate against.	null	true	HIGH
camel.sink.endpoint.failOnNullBody	Whether to fail if no body exists.	true	false	MEDIUM
camel.sink.endpoint.failOnNullHeader	Whether to fail if no header exists when validating against a header.	true	false	MEDIUM
camel.sink.endpoint.headerName	To validate against a header instead of the message body.	null	false	MEDIUM
camel.sink.endpoint.lazyStartProducer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	false	MEDIUM
camel.sink.endpoint.basicPropertyBinding	Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	false	MEDIUM
camel.sink.endpoint.errorHandler	To use a custom org.apache.camel.processor.validation.ValidatorErrorHandler. The default error handler captures the errors and throws an exception.	null	false	MEDIUM
camel.sink.endpoint.resourceResolver	To use a custom LSResourceResolver. Do not use together with resourceResolverFactory	null	false	MEDIUM
camel.sink.endpoint.resourceResolverFactory	To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI. The default resource resolver factory resturns a resource resolver which can read files from the class path and file system. Do not use together with resourceResolver.	null	false	MEDIUM
camel.sink.endpoint.schemaFactory	To use a custom javax.xml.validation.SchemaFactory	null	false	MEDIUM
camel.sink.endpoint.schemaLanguage	Configures the W3C XML Schema Namespace URI.	"http://www.w3.org/2001/XMLSchema"	false	MEDIUM
camel.sink.endpoint.synchronous	Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).	false	false	MEDIUM
camel.sink.endpoint.useSharedSchema	Whether the Schema instance should be shared or not. This option is introduced to work around a JDK 1.6.x bug. Xerces should not have this issue.	true	false	MEDIUM
camel.component.validator.lazyStartProducer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	false	MEDIUM
camel.component.validator.basicPropertyBinding	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	false	LOW
camel.component.validator.resourceResolverFactory	To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI	null	false	MEDIUM

Name

Description

Default

Required

Priority

camel.sink.path.resourceUri

URL to a local resource on the classpath, or a reference to lookup a bean in the Registry, or a full URL to a remote resource or resource on the file system which contains the XSD to validate against.

null

true

HIGH

camel.sink.endpoint.failOnNullBody

Whether to fail if no body exists.

true

false

MEDIUM

camel.sink.endpoint.failOnNullHeader

Whether to fail if no header exists when validating against a header.

true

false

MEDIUM

camel.sink.endpoint.headerName

To validate against a header instead of the message body.

null

false

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.sink.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.sink.endpoint.errorHandler

To use a custom org.apache.camel.processor.validation.ValidatorErrorHandler. The default error handler captures the errors and throws an exception.

null

false

MEDIUM

camel.sink.endpoint.resourceResolver

To use a custom LSResourceResolver. Do not use together with resourceResolverFactory

null

false

MEDIUM

camel.sink.endpoint.resourceResolverFactory

To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI. The default resource resolver factory resturns a resource resolver which can read files from the class path and file system. Do not use together with resourceResolver.

null

false

MEDIUM

camel.sink.endpoint.schemaFactory

To use a custom javax.xml.validation.SchemaFactory

null

false

MEDIUM

camel.sink.endpoint.schemaLanguage

Configures the W3C XML Schema Namespace URI.

"http://www.w3.org/2001/XMLSchema"

false

MEDIUM

camel.sink.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.sink.endpoint.useSharedSchema

Whether the Schema instance should be shared or not. This option is introduced to work around a JDK 1.6.x bug. Xerces should not have this issue.

true

false

MEDIUM

camel.component.validator.lazyStartProducer

false

MEDIUM

camel.component.validator.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

LOW

camel.component.validator.resourceResolverFactory

To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI

null

false

MEDIUM

The camel-validator sink connector has no converters out of the box.

The camel-validator sink connector has no transforms out of the box.

The camel-validator sink connector has no aggregation strategies out of the box.