Chapter 232. MSV Component
Available as of Camel version 1.1
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
232.1. 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.rng
You can append query options to the URI in the following format, ?option=value&option=value&…
232.2. Options
The MSV component supports 3 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| schemaFactory (advanced) | To use the javax.xml.validation.SchemaFactory. | SchemaFactory | |
| resourceResolverFactory (advanced) | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI | ValidatorResource ResolverFactory | |
| resolveProperty Placeholders (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |
The MSV endpoint is configured using URI syntax:
msv:resourceUri
with the following path and query parameters:
232.2.1. 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 |
232.2.2. Query Parameters (11 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 | |
| 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. | ValidatorResource ResolverFactory | |
| 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 |
| useDom (advanced) | Whether DOMSource/DOMResult or SaxSource/SaxResult should be used by the validator. | 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 |
232.3. Spring Boot Auto-Configuration
The component supports 4 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| camel.component.msv.enabled | Enable msv component | true | Boolean |
| camel.component.msv.resolve-property-placeholders | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | 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 |
232.4. 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).
232.5. See Also
- Configuring Camel
- Component
- Endpoint
- Getting Started
