Page Comparison

The Validate mediator validates XML messages against a specified schema. You can specify an XPath to extract and validate a specific part of the message. Otherwise, the mediator validates the first child of the SOAP body of the current message.

Syntax

<validate [source="xpath"]>
   <property name="validation-feature-id" value="true|false"/>*
   <schema key="string"/>+
   <on-fail>
      mediator+
   </on-fail>
</validate>

Configuration

The mediator configuration can be divided into the following sections.

Schema keys defined for Validate Mediator

This section is used to specify the key to access the main schema based on which validation is carried out, as well as to specify the XML which needs to be validated. The parameters available in this section are as follows.

Features Defined for Validator Mediator

This section is used to specify which features of the Validate mediator should be enabled and which should be disabled. The parameters available in this section are as follows.

Resources of the Validate Mediator

A resource in the Validate mediator configuration enables you to import a schema referenced within another schema. In order to access such a schema via a resource, the parent schema should be saved as a resource in the Registry. The parameters available in this section are as follows.

Examples

Example 1 - Basic configuration

In this example, the required schema for validating messages going through the validate mediator is given as a registry key, schema\sample.xsd. No source attribute is specified, and therefore the schema will be used to validate the first child of the SOAP body. The mediation logic to follow if the validation fails is defined within the on-fail element. In this example, the Fault Mediator  creates a SOAP fault to be sent back to the party which sent the message.

<validate cache-schema="true">
    <schema key="schema\sample.xsd"/>
         <on-fail>
                <makefault>
                    <code value="tns:Receiver"
                            xmlns:tns="http://www.w3.org/2003/05/soap-envelope"/>
                    <reason value="Invalid Request!!!"/>
                </makefault>
                <property name="RESPONSE" value="true"/>
                <header name="To" expression="get-property('ReplyTo')"/>
         </on-fail>
</validate>

Example 2 - Validate mediator with resources

In this example, the following schema named 08MockServiceSchema is saved in the Registry. This schema is located in MockDataTypes.xsd. A reference is made within this schema to another schema named  08SOAPFaults which is located in SOAPFaults.xsd.

<xsd:import namespace= "http://samples.synapse.com/08MockServiceSchema" schemalocation= "MockDataTypes.xsd">
	<xsd:import namespace= "http://samples.synapse.com/08SOAPFaults" schemalocation= "../Common/SOAPFaults.xsd">
</xsd:import>

The Validate mediator can be configured as follows.

<validate cache-schema="true">
	<schema key="MockDataTypes.xsd"/>
	<resource location="../Common/SOAPFaults.xsd" key="conf:custom/schema/SOAPFaults.xsd"/>
	<on-fail>
		<log level="custom">
			<property name="validation failed" value="Validation failed ###"/>
			<property name="error_msg" expression="$ctx:ERROR_MESSAGE"/>
		</log>
	</on-fail>
</validate>

The schema used by the validate mediator is MockDataTypes.xsd. In addition, a resource is used to import the 08 SOAPFaults schema which is referred in the 08MockServiceSchema schema. Note that the value ../Common/SOAPFaults.xsd which is specified as the location for the schema to be imported is the same as the location specified for 08 SOAPFaults schema in the 08MockServiceSchema configuration.

The on-fail sequence of this Validate mediator includes a Log mediator which is added as a child to the Validate mediator. This log mediator uses two properties to generate the error message Validation failed ### when the validation of a message against the schemas specified fails.

The Validate mediator validates JSON messages against a specified JSON schema. You can specify a JSONPath to extract and validate a specific part of the message. Otherwise, the mediator validates the complete content of the current message.

Syntax

<validate [source="xpath"]>
   <schema key="string"/>+
   <on-fail>
      mediator+
   </on-fail>
</validate>

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "getQuote": {
      "type": "object",
      "properties": {
        "request": {
          "type": "object",
          "properties": {
            "symbol": {
              "type": "string"
            }
          },
          "required": [
            "symbol"
          ]
        }
      },
      "required": [
        "request"
      ]
    }
  },
  "required": [
    "getQuote"
  ]
}

<validate cache-schema="true">
    <schema key="conf:/schema/StockQuoteSchema.json"/>
    <on-fail>
        <payloadFactory media-type="json">
            <format>{"Error":"$1"}</format>
            <args>
                <arg evaluator="xml" expression="$ctx:ERROR_MESSAGE"/>
            </args>
        </payloadFactory>
        <property name="HTTP_SC" value="500" scope="axis2"/>
        <respond/>
    </on-fail>
</validate>

{
   "getQuote": {
      "request": {
         "symbol": "WSO2"
      }
   }
}

<validate cache-schema="true" source="json-eval($.msg)">
    <schema key="conf:/schema/StockQuoteSchema.json"/>
    <on-fail>
        <payloadFactory media-type="json">
            <format>{"Error":$1"}</format>
            <args>
                <arg evaluator="xml" expression="$ctx:ERROR_MESSAGE"/>
            </args>
        </payloadFactory>
        <property name="HTTP_SC" value="500" scope="axis2"/>
        <respond/>
    </on-fail>
</validate>

{
   "msg": {
      "getQuote": {
         "request": {
            "symbol": "WSO2"
         }
      }
   }
}