MSV
Since Camel 1.1
Only producer is supported
The MSV component performs XML validation of the message body using the MSV Library and any of the supported XML schema languages, such as XML Schema or RelaxNG XML Syntax.
Maven users will need to add the following dependency to their pom.xml
for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-msv</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>Note that the Jing component also supports RelaxNG Compact Syntax
URI format
msv:someLocalOrRemoteResource[?options]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. For example
msv:org/foo/bar.rng
msv:file:../foo/bar.rng
msv:http://acme.com/cheese.rngYou can append query options to the URI in the following format,
?option=value&option=value&…
Options
The MSV component supports 4 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 |
basicPropertyBinding (advanced) |
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
boolean |
resourceResolverFactory (advanced) |
To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI |
ValidatorResourceResolverFactory |
|
schemaFactory (advanced) |
To use the javax.xml.validation.SchemaFactory. |
SchemaFactory |
The MSV endpoint is configured using URI syntax:
msv:resourceUri
with the following path and query parameters:
Path Parameters (1 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
resourceUri |
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 |
Query Parameters (12 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 |
basicPropertyBinding (advanced) |
Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
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 |
|
synchronous (advanced) |
Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |
false |
boolean |
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 |
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 RelaxNG XML Schema (which is supplied on the classpath).
Spring Boot Auto-Configuration
When using msv 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-msv-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>The component supports 5 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
camel.component.msv.basic-property-binding |
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
Boolean |
camel.component.msv.enabled |
Whether to enable auto configuration of the msv component. This is enabled by default. |
Boolean |
|
camel.component.msv.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.msv.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. |
String |
|
camel.component.msv.schema-factory |
To use the javax.xml.validation.SchemaFactory. The option is a javax.xml.validation.SchemaFactory type. |
String |