org.wikimedia.eventutilities.core.event

Class EventSchemaLoader

java.lang.Object

org.wikimedia.eventutilities.core.event.EventSchemaLoader

Direct Known Subclasses:

EventLoggingSchemaLoader

public class EventSchemaLoader
extends Object

Class to load and cache JSONSchema JsonNodes from relative schema URIs and event data. Usage:

 EventSchemaLoader schemaLoader = EventSchemaLoader.builder()
  .setJsonSchemaLoader(ResourceLoader.asURLs(Arrays.asList(
      "file:///path/to/schemas1",
      "http://schema.repo.org/path/to/schemas"
  )))
  .build();

 // Load the JSONSchema at file:///path/to/schemas/test/event/0.0.2
 schemaLoader.getEventSchema("/test/event/0.0.2");

 // Load the JsonNode or JSON String event's JSONSchema at /$schema
 schemaLoader.getEventSchema(event);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventSchemaLoader.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	LATEST_FILE_NAME When looking up latest schema versions, this will be used instead of a semver string.
protected com.fasterxml.jackson.core.JsonPointer	schemaFieldPointer Field in an event from which to extract the schema URI.
protected JsonSchemaLoader	schemaLoader JsonSchemaLoader used to load schemas from URIs.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EventSchemaLoader(JsonSchemaLoader loader, com.fasterxml.jackson.core.JsonPointer schemaFieldPointer) Constructs a EventSchemaLoader that prefixes URIs with baseURI and extracts schema URIs from the schemaField in events.

Method Summary

Modifier and Type	Method and Description
static EventSchemaLoader.Builder	builder()
URI	extractSchemaUri(com.fasterxml.jackson.databind.JsonNode event) Extracts the value at schemaFieldPointer from the event as a URI.
com.github.fge.jsonschema.main.JsonSchema	getEventJsonSchema(com.fasterxml.jackson.databind.JsonNode event) Given a JSON event, get its schema URI, and load and return schema for the event as a JsonSchema (suited for validation).
com.github.fge.jsonschema.main.JsonSchema	getEventJsonSchema(String eventString) Given a JSON event, get its schema URI, and load and return schema for the event as a JsonSchema (suited for validation).
com.fasterxml.jackson.databind.JsonNode	getEventSchema(com.fasterxml.jackson.databind.JsonNode event) Given an event object, this extracts its schema URI at schemaField (prefixed with baseURI) and returns the schema there.
com.fasterxml.jackson.databind.JsonNode	getEventSchema(String eventString) Given a JSON event string, get its schema URI, and load and return schema for the event.
JsonLoader	getJsonLoader()
com.github.fge.jsonschema.main.JsonSchema	getJsonSchema(com.fasterxml.jackson.databind.JsonNode schema) Given a json schema parsed as a JsonNode materialize JsonSchema suited for validation.
com.fasterxml.jackson.databind.JsonNode	getLatestEventSchema(com.fasterxml.jackson.databind.JsonNode event) Given an event object, this extracts its schema URI at schemaField (prefixed with baseURI) and resolves it to the latest schema URI and returns the schema there.
com.fasterxml.jackson.databind.JsonNode	getLatestEventSchema(String eventString) Given a JSON event string, get its schema URI, and load and return latest schema for the event.
com.fasterxml.jackson.databind.JsonNode	getLatestSchema(URI schemaUri) Get a 'latest' JsonSchema given a schema URI looking in all baseUris.
URI	getLatestSchemaUri(com.fasterxml.jackson.databind.JsonNode event) Extracts the event's schema URI and converts it to a latest schema URI.
URI	getLatestSchemaUri(URI schemaUri) Converts the given schemaUri to a 'latest' schema URI.
String	getLatestVersionFileName()
ResourceLoader	getResourceLoader()
com.fasterxml.jackson.databind.JsonNode	getSchema(URI schemaUri) Get a JsonSchema at schemaUri looking in all baseUris.
URI	latestSchemaURI(String title) Builds the URI to the latest schema using this title.
com.fasterxml.jackson.databind.JsonNode	load(URI schemaUri) Returns the content at schemaURI as a JsonNode JSONSchema.
URI	schemaUri(String title, String version) Builds the URI to the schema using this title and this version.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LATEST_FILE_NAME

protected static final String LATEST_FILE_NAME

When looking up latest schema versions, this will be used instead of a semver string.

See Also:

Constant Field Values

schemaFieldPointer

protected final com.fasterxml.jackson.core.JsonPointer schemaFieldPointer

Field in an event from which to extract the schema URI.

schemaLoader

protected final JsonSchemaLoader schemaLoader

JsonSchemaLoader used to load schemas from URIs.

Constructor Detail

EventSchemaLoader

protected EventSchemaLoader(JsonSchemaLoader loader,
                            com.fasterxml.jackson.core.JsonPointer schemaFieldPointer)

Constructs a EventSchemaLoader that prefixes URIs with baseURI and extracts schema URIs from the schemaField in events. This is protected; use EventSchemaLoader.Builder.

Method Detail

builder

public static EventSchemaLoader.Builder builder()

load

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

Returns the content at schemaURI as a JsonNode JSONSchema.

Returns:

the jsonschema at schemaURI.

Throws:

JsonLoadingException

extractSchemaUri

public URI extractSchemaUri(com.fasterxml.jackson.databind.JsonNode event)

Extracts the value at schemaFieldPointer from the event as a URI.

getLatestSchemaUri

public URI getLatestSchemaUri(URI schemaUri)

Converts the given schemaUri to a 'latest' schema URI. E.g. "/my/schema/1.0.0" returns "/my/schema/latest".

latestSchemaURI

public URI latestSchemaURI(String title)

Builds the URI to the latest schema using this title. E.g. "my/schema" returns "/my/schema/latest".

schemaUri

public URI schemaUri(String title,
                     String version)

Builds the URI to the schema using this title and this version. E.g. "my/schema", "1.1.0" returns "/my/schema/1.1.0".

getLatestSchemaUri

public URI getLatestSchemaUri(com.fasterxml.jackson.databind.JsonNode event)

Extracts the event's schema URI and converts it to a latest schema URI.

Returns:

'latest' version of this event's schema URI

getSchema

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

Get a JsonSchema at schemaUri looking in all baseUris.

Throws:

JsonLoadingException

getLatestSchema

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

Get a 'latest' JsonSchema given a schema URI looking in all baseUris.

Throws:

JsonLoadingException

getEventSchema

public com.fasterxml.jackson.databind.JsonNode getEventSchema(com.fasterxml.jackson.databind.JsonNode event)
                                                       throws JsonLoadingException

Given an event object, this extracts its schema URI at schemaField (prefixed with baseURI) and returns the schema there.

Throws:

JsonLoadingException

getEventSchema

public com.fasterxml.jackson.databind.JsonNode getEventSchema(String eventString)
                                                       throws JsonLoadingException

Given a JSON event string, get its schema URI, and load and return schema for the event.

Throws:

JsonLoadingException

getEventJsonSchema

public com.github.fge.jsonschema.main.JsonSchema getEventJsonSchema(String eventString)
                                                             throws com.github.fge.jsonschema.core.exceptions.ProcessingException,
                                                                    JsonLoadingException

Given a JSON event, get its schema URI, and load and return schema for the event as a JsonSchema (suited for validation).

Throws:

com.github.fge.jsonschema.core.exceptions.ProcessingException

JsonLoadingException

getEventJsonSchema

public com.github.fge.jsonschema.main.JsonSchema getEventJsonSchema(com.fasterxml.jackson.databind.JsonNode event)
                                                             throws com.github.fge.jsonschema.core.exceptions.ProcessingException,
                                                                    JsonLoadingException

Given a JSON event, get its schema URI, and load and return schema for the event as a JsonSchema (suited for validation).

Throws:

com.github.fge.jsonschema.core.exceptions.ProcessingException

JsonLoadingException

getJsonSchema

public com.github.fge.jsonschema.main.JsonSchema getJsonSchema(com.fasterxml.jackson.databind.JsonNode schema)
                                                        throws com.github.fge.jsonschema.core.exceptions.ProcessingException

Given a json schema parsed as a JsonNode materialize JsonSchema suited for validation.

Throws:

com.github.fge.jsonschema.core.exceptions.ProcessingException

getLatestEventSchema

public com.fasterxml.jackson.databind.JsonNode getLatestEventSchema(com.fasterxml.jackson.databind.JsonNode event)
                                                             throws JsonLoadingException

Given an event object, this extracts its schema URI at schemaField (prefixed with baseURI) and resolves it to the latest schema URI and returns the schema there.

Throws:

JsonLoadingException

getLatestEventSchema

public com.fasterxml.jackson.databind.JsonNode getLatestEventSchema(String eventString)
                                                             throws JsonLoadingException

Given a JSON event string, get its schema URI, and load and return latest schema for the event.

Throws:

JsonLoadingException

getJsonLoader

public JsonLoader getJsonLoader()

getResourceLoader

public ResourceLoader getResourceLoader()

getLatestVersionFileName

public String getLatestVersionFileName()

toString

public String toString()

Overrides:

toString in class Object