Package org.forgerock.api.util

Class ReferenceResolver

java.lang.Object

org.forgerock.api.util.ReferenceResolver

public class ReferenceResolver
extends Object

Helper that registers one or more ApiDescription instances and provides a means to resolve References.

Constructor Summary

Constructors

Constructor	Description
ReferenceResolver(ApiDescription local)	Creates a reference-resolver and defines the one ApiDescription that can be used for local (non-namespaced) reference lookups.

Method Summary

Modifier and Type	Method	Description
Schema	getDefinition(Reference reference)	Gets a Definitions Schema by JSON reference.
ApiError	getError(Reference reference)	Gets and Errors ApiError by JSON reference.
Resource	getService(Reference reference)	Get a Services Resource by JSON reference.
ReferenceResolver	register(ApiDescription apiDescription)	Registers an external ApiDescription, for Reference lookup, and must not have previously been registered.
ReferenceResolver	registerAll(ApiDescription... apiDescriptions)	Registers external ApiDescriptions, for Reference lookup, and each must not have previously been registered.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceResolver

public ReferenceResolver(ApiDescription local)

Creates a reference-resolver and defines the one ApiDescription that can be used for local (non-namespaced) reference lookups.

Parameters:

local - ApiDescription to use for local (non-namespaced) reference lookups

Method Detail

register

public ReferenceResolver register(ApiDescription apiDescription)

Registers an external ApiDescription, for Reference lookup, and must not have previously been registered.

Parameters:

apiDescription - ApiDescription to register, which has not previously been registered

Returns:

self

registerAll

public ReferenceResolver registerAll(ApiDescription... apiDescriptions)

Registers external ApiDescriptions, for Reference lookup, and each must not have previously been registered.

Parameters:

apiDescriptions - List of ApiDescriptions to register, which have not previously been registered

Returns:

self

getDefinition

public Schema getDefinition(Reference reference)

Gets a Definitions Schema by JSON reference.

Parameters:

reference - JSON reference

Returns:

Schema or null if not found

getError

public ApiError getError(Reference reference)

Gets and Errors ApiError by JSON reference.

Parameters:

reference - JSON reference

Returns:

ApiError or null if not found

getService

public Resource getService(Reference reference)

Get a Services Resource by JSON reference.

Parameters:

reference - JSON reference

Returns:

Resource or null if not found