org.forgerock.json.ref.jackson

Class JacksonReferenceTransformer

java.lang.Object

org.forgerock.json.ref.JsonReferenceTransformer

org.forgerock.json.ref.jackson.JacksonReferenceTransformer

public class JacksonReferenceTransformer
extends JsonReferenceTransformer

Resolves JSON reference values using the Jackson JSON processor, converting from JSON representations to standard Java objects. This transformer applies its transformation for http(s) and file URL schemes, or associated relative URIs. Any other URIs are ignored.

Field Summary

Fields inherited from class org.forgerock.json.ref.JsonReferenceTransformer

base, root

Constructor Summary

Constructors

Constructor and Description
JacksonReferenceTransformer(URI base, JsonValue root) Constructs a new Jackson JSON reference transformer.

Method Summary

Modifier and Type	Method and Description
protected boolean	isResolvable(URI uri) Returns true if the specified URI can be resolved by this transformer.
protected JsonValue	resolve(URI uri) Resolves the specified URI into a JSON value.

Methods inherited from class org.forgerock.json.ref.JsonReferenceTransformer

transform

Methods inherited from class java.lang.Object

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

Constructor Detail

JacksonReferenceTransformer

public JacksonReferenceTransformer(URI base,
                                   JsonValue root)
                            throws JsonReferenceException

Constructs a new Jackson JSON reference transformer.

Parameters:

base - the base URI of the referring document.

root - the root value of the referring document.

Throws:

JsonReferenceException - if base is not null and is not an absolute URI.

Method Detail

isResolvable

protected boolean isResolvable(URI uri)

Description copied from class: JsonReferenceTransformer

Returns true if the specified URI can be resolved by this transformer.

The default implementation returns false. This method is intended to be overridden by subclasses that can resolve particular types of URIs.

Overrides:

isResolvable in class JsonReferenceTransformer

Parameters:

uri - the URI to test to determine if it can be resolved.

Returns:

true if the specified URI can be resolved by this transformer.

resolve

protected JsonValue resolve(URI uri)
                     throws JsonException

Description copied from class: JsonReferenceTransformer

Resolves the specified URI into a JSON value. The URI is guaranteed to not contain a fragment identifier.

The default implementation throws a JsonException. This method is intended to be overridden by subclasses that can resolve particular types of URIs.

Overrides:

resolve in class JsonReferenceTransformer

Parameters:

uri - the URI to resolve.

Returns:

the JSON value that the URI resolves to.

Throws:

JsonException - if the URI could not be resolved.