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

Interface OutcomeProvider

All Known Subinterfaces:

StaticOutcomeProvider

All Known Implementing Classes:

AbstractDecisionNode.OutcomeProvider, IotAuthenticationNode.AuthenticationOutcomeProvider, IotRegistrationNode.RegistrationOutcomeProvider, SingleOutcomeNode.OutcomeProvider

@SupportedAll
public interface OutcomeProvider

Describes the outcomes for node instances.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	OutcomeProvider.Outcome	A model object for an outcome.

Method Summary

Modifier and Type	Method	Description
List<OutcomeProvider.Outcome>	getOutcomes(PreferredLocales locales, JsonValue nodeAttributes)	Returns a ordered list of possible node outcomes with localised display names.

Method Details

getOutcomes

List<OutcomeProvider.Outcome> getOutcomes(PreferredLocales locales,
 JsonValue nodeAttributes)
                                   throws NodeProcessException

Returns a ordered list of possible node outcomes with localised display names.

Parameters:

locales - The locales for the localised description.

nodeAttributes - Unvalidated node attributes submitted in the request.

Returns:

A non-null list of outcomes. May be empty.

Throws:

NodeProcessException - If outcomes could not be determined.