Package org.forgerock.openam.auth.node.api
@Supported
package org.forgerock.openam.auth.node.api
This package contains the API for writing authentication nodes.
-
ClassDescriptionAn abstract node implementation for nodes that result in a simple true-false outcome.Provides a static set of outcomes for decision nodes.A convenient base class for
AmPlugin
s that provide authentication nodes.Immutable container for the result of processing a node.Builder for theAction
.A representation of the external HTTP request in the current tree authentication context.A builder forExternalRequestContext
instances.A node is the core abstraction within an authentication tree.Annotation that describes the metadata of the node.Encapsulates all state that is provided by each node and passed between nodes on tree execution.Describes the outcomes for node instances.A model object for an outcome.This class represents all the constants that can be used as keys for storing values in the tree's shared state.Abstract node for nodes that always result in the same single outcome.Provides a static single outcome for nodes with a single outcome.Describes the outcomes for node instances that have static outcomes.Suspended text output callback extendsTextOutputCallback
to allow a custom message to be displayed to the user whilst informing the client that the current auth flow has been suspended.This handler interface allows authentication nodes to suspend authentication and send a unique ID out of band to the end-user.A representation of the context of the current tree authentication process.A TreeHook encapsulates some functionality that should be executed at the end of a tree, after authentication.Annotation that describes the metadata of the node.Meta data API to expose data concerning the evaluating tree, to nodes who care for that data.