org.forgerock.json.ref

Class JsonReferenceTransformer

java.lang.Object

org.forgerock.json.ref.JsonReferenceTransformer

Direct Known Subclasses:

JacksonReferenceTransformer

public class JsonReferenceTransformer
extends Object

Simple JSON reference transformer that can resolve fragment URI references. Classes can extend this class to resolve other types of URIs.

Note: The current implementation of this class has no checks for cyclic references. This can lead to scenarios of infinite recursion and throwing of a StackOverflowError. Plans for mitigating this are in place and will be implemented within this class.

Field Summary

Fields

Modifier and Type	Field and Description
protected URI	base The URI of the referring document or directory where it is located.
protected JsonValue	root The root value of the referring document.

Constructor Summary

Constructors

Constructor and Description
JsonReferenceTransformer(URI base, JsonValue root) Constructs a new 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.
void	transform(JsonValue value)

Methods inherited from class java.lang.Object

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

Field Detail

base

protected URI base

The URI of the referring document or directory where it is located.

root

protected JsonValue root

The root value of the referring document.

Constructor Detail

JsonReferenceTransformer

public JsonReferenceTransformer(URI base,
                                JsonValue root)
                         throws JsonReferenceException

Constructs a new JSON reference transformer.

If base is null then only absolute URI references or fragment-only references can be resolved; an attempt to resolve a relative reference URI will throw a JsonReferenceException.

The purpose of root is to allow fragment identifier references within the same document without the need to resolve it via an absolute URI. If root is null, then fragment identifier references are constructed from base, if specified.

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)

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.

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

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.

Parameters:

uri - the URI to resolve.

Returns:

the JSON value that the URI resolves to.

Throws:

JsonException - if the URI could not be resolved.

transform

public void transform(JsonValue value)
               throws JsonException

Throws:

JsonException