org.mule.module.json.validation

Class JsonSchemaValidator.Builder

java.lang.Object

org.mule.module.json.validation.JsonSchemaValidator.Builder

Enclosing class:

JsonSchemaValidator

public static final class JsonSchemaValidator.Builder
extends Object

An implementation of the builder design pattern to create instances of JsonSchemaValidator. This builder can be safely reused, returning a different instance each time build() is invoked. It is mandatory to invoke setSchemaLocation(String) with a valid value before attempting to build() an instance

Since:

3.6.0

Method Summary

Modifier and Type	Method and Description
JsonSchemaValidator.Builder	addSchemaRedirect(String from, String to) Allows to redirect any given URI in the Schema (or even the schema location itself) to any other specific URI.
JsonSchemaValidator.Builder	addSchemaRedirects(Map<String,String> redirects) Allows adding many redirects following the same rules as addSchemaRedirect(String, String)
JsonSchemaValidator	build() Builds a new instance per the given configuration.
JsonSchemaValidator.Builder	setDereferencing(JsonSchemaDereferencing dereferencing) Sets the dereferencing mode to be used.
JsonSchemaValidator.Builder	setSchemaLocation(String schemaLocation) A location in which the json schema is present.

Methods inherited from class java.lang.Object

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

Method Detail

setSchemaLocation

public JsonSchemaValidator.Builder setSchemaLocation(String schemaLocation)

A location in which the json schema is present. It allows both local and external resources. For example, all of the following are valid:

schemas/schema.json

/schemas/schema.json

resource:/schemas/schema.json

http://mule.org/schemas/schema.json

Parameters:

schemaLocation - the location of the schema to validate against

Returns:

this builder

Throws:

IllegalArgumentException - if schemaLocation is blank or null

setDereferencing

public JsonSchemaValidator.Builder setDereferencing(JsonSchemaDereferencing dereferencing)

Sets the dereferencing mode to be used. If not invoked, then it defaults to JsonSchemaDereferencing.CANONICAL

Parameters:

dereferencing - a dereferencing mode

Returns:

this builder

Throws:

IllegalArgumentException - if dereferencing is null

addSchemaRedirect

public JsonSchemaValidator.Builder addSchemaRedirect(String from,
                                                     String to)

Allows to redirect any given URI in the Schema (or even the schema location itself) to any other specific URI. The most common use case for this feature is to map external namespace URIs without the need to a local resource

Parameters:

from - the location to redirect. Accepts the same formats as setSchemaLocation(String)

to - the location to redirect to. Accepts the same formats as setSchemaLocation(String)

Returns:

this builder

Throws:

IllegalArgumentException - if from or to are blank or null

addSchemaRedirects

public JsonSchemaValidator.Builder addSchemaRedirects(Map<String,String> redirects)

Allows adding many redirects following the same rules as addSchemaRedirect(String, String)

Parameters:

redirects - a Map with redirections

Returns:

this builder

Throws:

IllegalArgumentException - if redirects is null

build

public JsonSchemaValidator build()

Builds a new instance per the given configuration. This method can be safely invoked many times, returning a different instance each.

Returns:

a JsonSchemaValidator

Throws:

IllegalStateException - if setSchemaLocation(String) was not invoked