org.eel.kitchen.jsonschema.uri

Class URIManager

java.lang.Object

org.eel.kitchen.jsonschema.uri.URIManager

public class URIManager
extends Object

Class to fetch JSON documents

This uses a map of URIDownloader instances to fetch the contents of a URI as an InputStream, then tries and turns this content into JSON using an ObjectMapper.

Normally, you will never use this class directly.

See Also:

SchemaRegistry, JsonLoader

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,URIDownloader>	downloaders Map of downloaders (schemes as keys, URIDownloader instances as values)
private static ObjectMapper	mapper Our object mapper
private Map<URI,URI>	URIRedirections Map for URI redirections

Constructor Summary

Constructors

Constructor and Description
URIManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRedirection(String from, String to) Add a URI rediction
JsonNode	getContent(URI uri) Get the content at a given URI as a JsonNode
void	registerScheme(String scheme, URIDownloader downloader) Register a new downloader for a given URI scheme
void	unregisterScheme(String scheme) Unregister a downloader for a given scheme

Methods inherited from class java.lang.Object

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

Field Detail

mapper

private static final ObjectMapper mapper

Our object mapper

Note that it uses DeserializationFeature.USE_BIG_DECIMAL_FOR_FLOATS to deserialize, for accuracy reasons.

See Also:

NumericKeywordValidator

downloaders

private final Map<String,URIDownloader> downloaders

Map of downloaders (schemes as keys, URIDownloader instances as values)

URIRedirections

private final Map<URI,URI> URIRedirections

Map for URI redirections

This map will be used if you wish for an absolute URI to be redirected to another URI of your choice, which must also be absolute.

Note that this map requires URIs to be exact. Currently, you cannot, for example, redirect a whole namespace this way.

Constructor Detail

URIManager

public URIManager()

Method Detail

registerScheme

public void registerScheme(String scheme,
                  URIDownloader downloader)

Register a new downloader for a given URI scheme

Parameters:

scheme - the scheme

downloader - the URIDownloader instance

Throws:

NullPointerException - scheme is null

IllegalArgumentException - scheme is empty, or is already registered

unregisterScheme

public void unregisterScheme(String scheme)

Unregister a downloader for a given scheme

Parameters:

scheme - the scheme

Throws:

NullPointerException - scheme is null

addRedirection

public void addRedirection(String from,
                  String to)

Add a URI rediction

The typical use case for this is if you have a local copy of a schema whose id is normally unreachable. You can transform all references to this schema's URI to another URI which is reachable by your application.

Note that the given strings will be considered as JSON References, and that both arguments must be valid absolute JSON References. For the recall, there is more to it than URIs being absolute: their fragment part must also be empty or null.

Parameters:

from - the original URI

to - an URI which is reachable

Throws:

IllegalArgumentException - either of from or to are invalid URIs, or are not absolute JSON References

getContent

public JsonNode getContent(URI uri)
                    throws JsonSchemaException

Get the content at a given URI as a JsonNode

Parameters:

uri - the URI

Returns:

the content

Throws:

JsonSchemaException - scheme is not registered, failed to get content, or content is not JSON