org.forgerock.openam.auth.node.api

Interface Node

All Known Implementing Classes:

AbstractDecisionNode, SingleOutcomeNode

public interface Node

A node is the core abstraction within an authentication tree. Trees are made up of nodes, which may modify the shared state and/or request input from the user via callbacks.

A node *must* not store any state in memory and should instead use the shared state mechanism for this.

Nodes are instantiated using dependency injection and can therefore use an @Inject-annotated constructor.

All concrete implementations of this class should be annotated with Node.Metadata.

Since:

AM 5.5.0

Method Summary

Modifier and Type	Method and Description
default JsonValue	getAuditEntryDetail() Supply the additional detail to be logged with this node's completion event.
Action	process(TreeContext context) Performs processing on the given shared state, which holds all the data gathered by nodes that have already executed as part of this authentication session in the tree.

Method Detail

process

Action process(TreeContext context)
        throws NodeProcessException

Performs processing on the given shared state, which holds all the data gathered by nodes that have already executed as part of this authentication session in the tree.

This method is invoked when the node is reached in the tree.

Parameters:

context - The context of the tree authentication.

Returns:

The next action to perform. Must not be null.

Throws:

NodeProcessException - If there was a problem processing that could not be resolved to a single outcome.

getAuditEntryDetail

default JsonValue getAuditEntryDetail()

Supply the additional detail to be logged with this node's completion event. Subclasses can override this method to add more specific detail.

Returns:

The audit entry detail.