org.forgerock.openam.auth.node.api

Class TreeContext

java.lang.Object

org.forgerock.openam.auth.node.api.TreeContext

public final class TreeContext
extends Object

A representation of the context of the current tree authentication process.

Constructor Summary

Constructors

Constructor and Description
TreeContext(JsonValue sharedState, ExternalRequestContext request, List<? extends Callback> callbacks) Construct a tree context for the current state.
TreeContext(JsonValue sharedState, ExternalRequestContext request, List<? extends Callback> callbacks, Optional<String> universalId) Construct a tree context for the current state.
TreeContext(JsonValue sharedState, JsonValue transientState, ExternalRequestContext request, List<? extends Callback> callbacks) Construct a tree context for the current state.
TreeContext(JsonValue sharedState, JsonValue transientState, ExternalRequestContext request, List<? extends Callback> callbacks, Optional<String> universalId) Construct a tree context for the current state.

Method Summary

Modifier and Type	Method and Description
List<? extends Callback>	getAllCallbacks() Gets all the callbacks sent in the request.
boolean	hasCallbacks() Check if any callbacks have been submitted in this authenticate request.

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeContext

public TreeContext(JsonValue sharedState,
                   ExternalRequestContext request,
                   List<? extends Callback> callbacks)

Construct a tree context for the current state.

Parameters:

sharedState - The shared state.

request - The request associated with the current authentication request.

callbacks - The callbacks received in the current authentication request.

TreeContext

public TreeContext(JsonValue sharedState,
                   ExternalRequestContext request,
                   List<? extends Callback> callbacks,
                   Optional<String> universalId)

Construct a tree context for the current state.

Parameters:

sharedState - The shared state.

request - The request associated with the current authentication request.

callbacks - The callbacks received in the current authentication request.

universalId - The universal id of the identity object.

TreeContext

public TreeContext(JsonValue sharedState,
                   JsonValue transientState,
                   ExternalRequestContext request,
                   List<? extends Callback> callbacks)

Construct a tree context for the current state.

Parameters:

sharedState - The shared state.

transientState - The transient state.

request - The request associated with the current authentication request.

callbacks - The callbacks received in the current authentication request.

TreeContext

public TreeContext(JsonValue sharedState,
                   JsonValue transientState,
                   ExternalRequestContext request,
                   List<? extends Callback> callbacks,
                   Optional<String> universalId)

Construct a tree context for the current state.

Parameters:

sharedState - The shared state.

transientState - The transient state.

request - The request associated with the current authentication request.

callbacks - The callbacks received in the current authentication request.

universalId - The universal id of the identity object.

Method Detail

getAllCallbacks

public List<? extends Callback> getAllCallbacks()

Gets all the callbacks sent in the request.

Use TreeContext.getCallback(Class) in preference to this method.

Returns:

An unmodifiable list of callbacks.

hasCallbacks

public boolean hasCallbacks()

Check if any callbacks have been submitted in this authenticate request.

Returns:

true if there are callbacks available.