Table of Contents
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
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.rng
You can append query options to the URI in the following format,
?option=value&option=value&…
The MSV component supports 2 options which are listed below.
{% raw %}
| Name | Java Type | Description |
|---|---|---|
schemaFactory |
| To use the javax.xml.validation.SchemaFactory. |
resourceResolverFactory |
| To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI |
{% endraw %}
The MSV component supports 12 endpoint options which are listed below:
{% raw %}
| Name | Group | Default | Java Type | Description |
|---|---|---|---|---|
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. | |
failOnNullBody | producer |
|
| Whether to fail if no body exists. |
failOnNullHeader | producer |
|
| Whether to fail if no header exists when validating against a header. |
headerName | producer |
| To validate against a header instead of the message body. | |
errorHandler | advanced |
| To use a custom org.apache.camel.processor.validation.ValidatorErrorHandler. The default error handler captures the errors and throws an exception. | |
resourceResolver | advanced |
| To use a custom LSResourceResolver. Do not use together with resourceResolverFactory | |
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. | |
schemaFactory | advanced |
| To use a custom javax.xml.validation.SchemaFactory | |
schemaLanguage | advanced |
| Configures the W3C XML Schema Namespace URI. | |
synchronous | advanced |
|
| Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |
useDom | advanced |
|
| Whether DOMSource/DOMResult or SaxSource/SaxResult should be used by the validator. |
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. |
{% endraw %}
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).