org.wikimedia.eventutilities.core.json

Class JsonSchemaLoader

java.lang.Object

org.wikimedia.eventutilities.core.json.JsonSchemaLoader

public class JsonSchemaLoader
extends Object

Uses a JsonLoader to fetch JSON schemas from URIs and cache them. Usage:

 JsonSchemaLoader schemaLoader = JsonSchemaLoader(schemaBaseURLs);
 JsonNode schema = schemaLoader.load("http://my.schemas.org/schemas/test/event/schema/0.0.2")
 

Constructor Summary

Constructors

Constructor and Description
JsonSchemaLoader(JsonLoader loader) Make a new JsonSchemaLoader using JsonLoader.

Method Summary

Modifier and Type	Method and Description
static JsonSchemaLoader	build(ResourceLoader resourceLoader) Creates a new JsonLoader using resourceLoader and uses that to create a new JsonSchemaLoader.
com.fasterxml.jackson.databind.JsonNode	cacheGet(URI schemaUri) Proxy method to get a schema by schemaUri directly from the local cache.
com.fasterxml.jackson.databind.JsonNode	cachePut(URI schemaUri, com.fasterxml.jackson.databind.JsonNode schema) Proxy method to put a schema by schemaUri directly in the local cache.
JsonLoader	getJsonLoader() Return the underlying JsonLoader.
boolean	isCached(URI schemaUri) Proxy method to see if the schemaUri is currently cached.
com.fasterxml.jackson.databind.JsonNode	load(URI schemaUri) Given a schemaUri, this will request the JSON or YAML content at that URI and parse it into a JsonNode.
com.fasterxml.jackson.databind.JsonNode	parse(String data) Parses the JSON or YAML string into a JsonNode.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonSchemaLoader

public JsonSchemaLoader(JsonLoader loader)

Make a new JsonSchemaLoader using JsonLoader.

Method Detail

build

public static JsonSchemaLoader build(ResourceLoader resourceLoader)

Creates a new JsonLoader using resourceLoader and uses that to create a new JsonSchemaLoader.

load

public com.fasterxml.jackson.databind.JsonNode load(URI schemaUri)
                                             throws JsonLoadingException

Given a schemaUri, this will request the JSON or YAML content at that URI and parse it into a JsonNode. $refs will be resolved. The compiled schema will be cached by schemaURI, and only looked up once per schemaURI.

Returns:

the jsonschema at schemaURI.

Throws:

JsonLoadingException

parse

public com.fasterxml.jackson.databind.JsonNode parse(String data)
                                              throws JsonLoadingException

Parses the JSON or YAML string into a JsonNode.

Parameters:

data - JSON or YAML string to parse into a JsonNode.

Throws:

JsonLoadingException

isCached

public boolean isCached(URI schemaUri)

Proxy method to see if the schemaUri is currently cached.

cacheGet

public com.fasterxml.jackson.databind.JsonNode cacheGet(URI schemaUri)

Proxy method to get a schema by schemaUri directly from the local cache.

cachePut

public com.fasterxml.jackson.databind.JsonNode cachePut(URI schemaUri,
                                                        com.fasterxml.jackson.databind.JsonNode schema)

Proxy method to put a schema by schemaUri directly in the local cache.

getJsonLoader

public JsonLoader getJsonLoader()

Return the underlying JsonLoader.