org.forgerock.openam.auth.node.api

Class Action

java.lang.Object

org.forgerock.openam.auth.node.api.Action

public final class Action
extends Object

Immutable container for the result of processing a node.

Since:

AM 5.5.0

Method Summary

Modifier and Type	Method and Description
static Action.ActionBuilder	goTo(String outcome) Move on to the next node in the tree that is connected to the given outcome.
static Action.ActionBuilder	send(Callback... callbacks) Send the given callbacks to the user for them to interact with.
static Action.ActionBuilder	send(List<? extends Callback> callbacks) Send the given callbacks to the user for them to interact with.
boolean	sendingCallbacks() Returns true if the action is a request for input.

Methods inherited from class java.lang.Object

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

Method Detail

goTo

public static Action.ActionBuilder goTo(String outcome)

Move on to the next node in the tree that is connected to the given outcome.

Parameters:

outcome - the outcome.

Returns:

an action builder to provide additional details.

send

public static Action.ActionBuilder send(List<? extends Callback> callbacks)

Send the given callbacks to the user for them to interact with.

Parameters:

callbacks - a non-empty list of callbacks.

Returns:

an action builder to provide additional details.

send

public static Action.ActionBuilder send(Callback... callbacks)

Send the given callbacks to the user for them to interact with.

Parameters:

callbacks - a non-empty list of callbacks.

Returns:

an action builder to provide additional details.

sendingCallbacks

public boolean sendingCallbacks()

Returns true if the action is a request for input.

Returns:

true if the action need to request for input, false otherwise.