ServiceMix Validation
The ServiceMix Validation component provides schema validation of documents using JAXP 1.3 and XMLSchema or RelaxNG.
Availability
Note that this component is only available in releases >= 3.3.
Installation
Installing the servicemix-validation component can be done in several ways:
- drop the installer zip in an hotdeploy directory monitored by ServiceMix
- using ant tasks
Note that when using ant tasks, the component is not started, you will have to start it manually using ant tasks or a console.
Creation
You can use Maven to create a service unit.
mvn archetype:create \ -DarchetypeGroupId=org.apache.servicemix.tooling \ -DarchetypeArtifactId=servicemix-validation-service-unit \ -DgroupId=com.mycompany.myproduct \ -DartifactId=mycomponent.artifact
or simply use the smx-arch tool from ServiceMix's bin folder.
Endpoints
<validation:endpoint service="test:myAddressValidationService" endpoint="addressValidationEndpoint" schemaResource="classpath:address.xsd" handlingErrorMethod="FAULT_FLOW" />
Message Exchange Pattern
The endpoint can handle all MEPs.
The following table shows the additional configuration possibilities of the endpoint.
endpoint attributes
Name |
Type |
Description |
Default |
---|---|---|---|
schema |
Class |
javax.xml.validation.Schema |
null |
schemaLanguage |
String |
the schema language |
http://www.w3.org/2001/XMLSchema![]() |
schemaSource |
Class |
javax.xml.transform.Source |
null |
schemaResource |
String |
path to schema resource |
null |
handlingErrorMethod |
String |
the error handling mode |
FAULT_JBI |
errorHandlerFactory |
Class |
org.apache.servicemix.validation.handler.MessageAwareErrorHandlerFactory |
CountingErrorHandlerFactory |
For all xbean file endpoint configuration take a look at Xml schemas
The schemaResource
The schema resource can be defined in different ways:
script="classpath:mySchema.xsd" OR script="file:///home/lhein/mySchema.xsd"
The errorHandlerFactory
You can specify your own error handling factory which will be used to create an error handler for the validation.
All factories have to implement the interface org.apache.servicemix.validation.handler.MessageAwareErrorHandlerFactory. This interface
describes only one method:
This method createMessageAwareErrorHandler() creates the error handler for validating the xml.
The MessageAwareErrorHandler is also a interface defining the methods needed for call back while validating a xml:
You can the configure your endpoint to use your factory and handler instead the standard ones.
Example:
<validation:endpoint service="test:service3" endpoint="endpoint" schemaResource="classpath:schema.xsd" handlingErrorMethod="FAULT_FLOW"> <property name="errorHandlerFactory"> <bean class="org.apache.servicemix.validation.handler.MessageAggregatingErrorHandlerFactory"> <property name="rootPath" value="Fault/payload/messages"/> <property name="namespace" value="http://www.servicemix.org/fault"/> <property name="includeStackTraces" value="false"/> </bean> </property> </validation:endpoint>
Available factories / handlers
CountingErrorHandlerFactory / CountingErrorHandler
This one is just counting warnings, errors and fatal errors. Depending on the set handlingErrorMethod it will throw an exception or deliver a fault string containing a xml like this:
<result> <warning>10</warning> <error>2</error> <fatal>0</fatal> </result>
As you can see this factory / handler is just counting problems in the xml and delivers the result back.
MessageAggregatingErrorHandlerFactory / MessageAggregatingErrorHandler
This one captures messages from the validator and delivers them to the caller like this:
<rootPath xmlns="namespace"> <warning><![CDATA[ warning message ]]></warning> <error><![CDATA[ error message ]]></error> <fatalError><![CDATA[ fatal error message ]]></fatalError> </rootPath>
handlingErrorMethod
There are 2 modes existing:
- FAULT_JBI - this is the default. A jbi exception is thrown on validation errors (depending on used MEP)
- FAULT_FLOW - the validation result will be sent in out / fault message (depending on used MEP)