Uses of Class
org.forgerock.am.trees.model.TreeState

Packages that use TreeState

Package	Description
org.forgerock.am.trees.api	Provides classes for accessing trees components.
org.forgerock.am.trees.model	Contains classes that represent the model of the authentication trees.

Uses of TreeState in org.forgerock.am.trees.api

Methods in org.forgerock.am.trees.api with parameters of type TreeState

Modifier and Type	Method	Description
TreeResult	TreeExecutor.process(Realm realm, Tree tree, TreeState previousState, List<? extends Callback> callbacks, boolean resumedFromSuspended, ExternalRequestContext request)	Process an authentication tree until either: A node requests input from the user. The tree completes with a success or failure.

Uses of TreeState in org.forgerock.am.trees.model

Fields in org.forgerock.am.trees.model declared as TreeState

Modifier and Type	Field	Description
final TreeState	TreeResult.treeState	The state of the tree after processing.

Methods in org.forgerock.am.trees.model that return TreeState

Modifier and Type	Method	Description
TreeState	TreeState.Builder.build()	Builds the TreeState object with the provided properties.
static TreeState	TreeState.createInitial(Realm realm, Integer targetAuthLevel, Map<String,Object> initialData, int maxTreeDuration)	Creates a tree state that represents start of authentication tree.
static TreeState	TreeState.fromJson(JsonValue json, long maxSessionTime)	Returns a TreeState object from the JsonValue.

Methods in org.forgerock.am.trees.model with parameters of type TreeState

Modifier and Type	Method	Description
TreeState.Builder	TreeState.Builder.withIdentifiedIdentityFrom(TreeState previousState, Action action)	Sets the identified identity from the provided action if present, or the previous tree state otherwise.
TreeState.Builder	TreeState.Builder.withMaxTreeDurationFrom(TreeState previousState, Action action)	Sets the maximum duration of the tree from the provided action if present, or the previous tree state otherwise.
TreeState.Builder	TreeState.Builder.withSessionHooksFrom(TreeState previousState, Action action)	Sets the session hooks from the previous state, followed by those from the provided action.
TreeState.Builder	TreeState.Builder.withSessionPropertiesFrom(TreeState previousState, Action action)	Sets the combined session properties from the provided action and previous state.
TreeState.Builder	TreeState.Builder.withSharedStateFrom(TreeState previousState, Action action)	Sets the shared state from the provided action if present, or the previous tree state otherwise.
TreeState.Builder	TreeState.Builder.withTransientStateFrom(TreeState previousState, Action action)	Sets the transient state from the provided action if present, or the previous tree state otherwise.
TreeState.Builder	TreeState.Builder.withUniversalIdFrom(TreeState previousState, Action action)	Sets the universal ID from the provided action if present, or the previous tree state otherwise.
TreeState.Builder	TreeState.Builder.withWebhooksFrom(TreeState previousState, Action action)	Sets the webhooks from the previous state, followed by those from the provided action.

Constructors in org.forgerock.am.trees.model with parameters of type TreeState

Modifier	Constructor	Description
	TreeResult(TreeState treeState, Outcome outcome)	Constructs a new TreeResult.
	TreeResult(TreeState treeState, Outcome outcome, Map<String,Object> returnProperties, List<Callback> callbacks)	Constructs a new TreeResult.
	TreeResult(TreeState treeState, Outcome outcome, Map<String,Object> returnProperties, List<Callback> callbacks, SuspensionHandler suspensionHandler, Duration suspensionDuration, NodeProcessException cause)	Constructs a new TreeResult.