org.mule.runtime.module.json.validation

Class JsonSchemaValidator

java.lang.Object

org.mule.runtime.module.json.validation.JsonSchemaValidator

public class JsonSchemaValidator
extends Object

Validates json payloads against json schemas compliant with drafts v3 and v4.

Instances are immutable and thread-safe. Correct way of instantiating this class is by invoking builder() to obtain a JsonSchemaValidator.Builder

Since:

3.6.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonSchemaValidator.Builder An implementation of the builder design pattern to create instances of JsonSchemaValidator.

Method Summary

Modifier and Type	Method and Description
static JsonSchemaValidator.Builder	builder() Returns a new JsonSchemaValidator.Builder
Event	validate(Event event, MuleContext muleContext) Parses the event's payload as a Json by the rules of DefaultJsonParser.asJsonNode(Object).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static JsonSchemaValidator.Builder builder()

Returns a new JsonSchemaValidator.Builder

Returns:

a JsonSchemaValidator.Builder

validate

public Event validate(Event event,
                      MuleContext muleContext)
               throws org.mule.runtime.api.exception.MuleException

Parses the event's payload as a Json by the rules of DefaultJsonParser.asJsonNode(Object). Then it validates it against the given schema.

If the validation fails, a JsonSchemaValidationException is thrown.

Notice that if the message payload is a Reader or InputStream then it will be consumed in order to perform the validation. As a result, the message payload will be changed to the String representation of the json.

Parameters:

event - the current Event

muleContext - the Mule node.

Throws:

org.mule.runtime.api.exception.MuleException