blob: 91d8a524dfa8cc459f922d3129ec32af2a4d9496 [file] [log] [blame]
// kafka-connector options: START
[[camel-json-validator-kafka-connector-sink]]
= camel-json-validator-kafka-connector sink configuration
When using camel-json-validator-kafka-connector as sink 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-json-validator-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-json-validator sink connector supports 12 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.resourceUri* | Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod. | null | HIGH
| *camel.sink.endpoint.contentCache* | Sets whether to use resource content cache or not | false | MEDIUM
| *camel.sink.endpoint.failOnNullBody* | Whether to fail if no body exists. | true | MEDIUM
| *camel.sink.endpoint.failOnNullHeader* | Whether to fail if no header exists when validating against a header. | true | MEDIUM
| *camel.sink.endpoint.headerName* | To validate against a header instead of the message body. | null | 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 ValidatorErrorHandler. The default error handler captures the errors and throws an exception. | null | MEDIUM
| *camel.sink.endpoint.schemaLoader* | To use a custom schema loader allowing for adding custom format validation. The default implementation will create a schema loader with draft v4 support. | null | 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.component.json-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 | MEDIUM
| *camel.component.json-validator.basicProperty Binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
|===
// kafka-connector options: END