Chapter 52. Validator
Only producer is supported
The Validation component performs XML validation of the message body using the JAXP Validation API and based on any of the supported XML schema languages, which defaults to XML Schema
Note that the component also supports the following useful schema languages:
The MSV component also supports RelaxNG XML Syntax.
52.1. URI format
validator:someLocalOrRemoteResource
Where someLocalOrRemoteResource is some URL to a local resource on the classpath or a full URL to a remote resource or resource on the file system which contains the XSD to validate against. For example:
-
msv:org/foo/bar.xsd -
msv:file:../foo/bar.xsd -
msv:http://acme.com/cheese.xsd -
validator:com/mypackage/myschema.xsd
The Validation component is provided directly in the camel-core.
52.2. Configuring Options
Camel components are configured on two separate levels:
- component level
- endpoint level
52.2.1. Configuring Component Options
The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.
Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.
Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.
52.2.2. Configuring Endpoint Options
Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.
Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL as a type safe way of configuring endpoints.
A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.
The following two sections lists all the options, firstly for the component followed by the endpoint.
52.3. Component Options
The Validator component supports 3 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| lazyStartProducer (producer) | 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 | boolean |
| autowiredEnabled (advanced) | 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 | boolean |
| resourceResolverFactory (advanced) | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI. | ValidatorResourceResolverFactory |
52.4. Endpoint Options
The Validator endpoint is configured using URI syntax:
validator:resourceUri
with the following path and query parameters:
52.4.1. Path Parameters (1 parameters)
| Name | Description | Default | Type |
|---|---|---|---|
| resourceUri (producer) | Required 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. | String |
52.4.2. Query Parameters (10 parameters)
| Name | Description | Default | Type |
|---|---|---|---|
| failOnNullBody (producer) | Whether to fail if no body exists. | true | boolean |
| failOnNullHeader (producer) | Whether to fail if no header exists when validating against a header. | true | boolean |
| headerName (producer) | To validate against a header instead of the message body. | String | |
| lazyStartProducer (producer) | 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 | boolean |
| errorHandler (advanced) | To use a custom org.apache.camel.processor.validation.ValidatorErrorHandler. The default error handler captures the errors and throws an exception. | ValidatorErrorHandler | |
| resourceResolver (advanced) | To use a custom LSResourceResolver. Do not use together with resourceResolverFactory. | LSResourceResolver | |
| resourceResolverFactory (advanced) | 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. | ValidatorResourceResolverFactory | |
| schemaFactory (advanced) | To use a custom javax.xml.validation.SchemaFactory. | SchemaFactory | |
| schemaLanguage (advanced) | Configures the W3C XML Schema Namespace URI. | String | |
| useSharedSchema (advanced) | 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 | boolean |
52.5. Example
The following example shows how to configure a route from endpoint direct:start which then goes to one of two endpoints, either mock:valid or mock:invalid based on whether or not the XML matches the given schema (which is supplied on the classpath).
52.6. Advanced: JMX method clearCachedSchema
You can force that the cached schema in the validator endpoint is cleared and reread with the next process call with the JMX operation clearCachedSchema. You can also use this method to programmatically clear the cache. This method is available on the ValidatorEndpoint class.
52.7. Spring Boot Auto-Configuration
When using validator with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-validator-starter</artifactId> <version>3.14.5.redhat-00032</version> <!-- Use your Camel Spring Boot version --> </dependency>
The component supports 4 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| camel.component.validator.autowired-enabled | 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 | Boolean |
| camel.component.validator.enabled | Whether to enable auto configuration of the validator component. This is enabled by default. | Boolean | |
| camel.component.validator.lazy-start-producer | 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 | Boolean |
| camel.component.validator.resource-resolver-factory | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI. The option is a org.apache.camel.component.validator.ValidatorResourceResolverFactory type. | ValidatorResourceResolverFactory |
