@Supported

Package org.forgerock.openam.auth.node.api

This package contains the API for writing authentication nodes.

Interface Summary

Interface	Description
Node	A node is the core abstraction within an authentication tree.
OutcomeProvider	Describes the outcomes for node instances.
StaticOutcomeProvider	Describes the outcomes for node instances that have static outcomes.
SuspensionHandler	This handler interface allows authentication nodes to suspend authentication and send a unique ID out of band to the end-user.
TreeHook	A TreeHook encapsulates some functionality that should be executed at the end of a tree, after authentication.
TreeMetaData	Meta data API to expose data concerning the evaluating tree, to nodes who care for that data.

Class Summary

Class	Description
AbstractDecisionNode	An abstract node implementation for nodes that result in a simple true-false outcome.
AbstractDecisionNode.OutcomeProvider	Provides a static set of outcomes for decision nodes.
AbstractNodeAmPlugin	A convenient base class for AmPlugins that provide authentication nodes.
Action	Immutable container for the result of processing a node.
Action.ActionBuilder	Builder for the Action.
ExternalRequestContext	A representation of the external HTTP request in the current tree authentication context.
ExternalRequestContext.Builder	A builder for ExternalRequestContext instances.
NodeState	Encapsulates all state that is provided by each node and passed between nodes on tree execution.
OutcomeProvider.Outcome	A model object for an outcome.
SharedStateConstants	This class represents all the constants that can be used as keys for storing values in the tree's shared state.
SingleOutcomeNode	Abstract node for nodes that always result in the same single outcome.
SingleOutcomeNode.OutcomeProvider	Provides a static single outcome for nodes with a single outcome.
SuspendedTextOutputCallback	Suspended text output callback extends TextOutputCallback to allow a custom message to be displayed to the user whilst informing the client that the current auth flow has been suspended.
TreeContext	A representation of the context of the current tree authentication process.

Exception Summary

Exception	Description
NodeProcessException	An Exception to indicate that there was a problem processing a Node that could not be resolved to a Action.

Annotation Types Summary

Annotation Type	Description
Node.Metadata	Annotation that describes the metadata of the node.
TreeHook.Metadata	Annotation that describes the metadata of the node.