Package org.forgerock.am.trees.api

Interface TreeExecutor

public interface TreeExecutor

Interface for processing a tree.

Method Summary

Modifier and Type	Method	Description
TreeResult	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.

Method Details

process

TreeResult 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.

The tree is defined as complete when the processing reaches either the Outcome.TREE_NODE_SUCCESS_ID or Outcome.TREE_NODE_FAILURE_ID node.

Parameters:

realm - The realm the tree is in.

tree - The tree to process

previousState - A tree state that was previously returned by this method.

callbacks - Completed callbacks that have been submitted by the user. May be null.

resumedFromSuspended - Optional that, when a SuspendedAuthSession is present, indicates a flow that is to be suspended.

request - The request associated with the current authentication request.

Returns:

The result of processing the tree.