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

Interface StaticOutcomeProvider

All Superinterfaces:

OutcomeProvider

All Known Implementing Classes:

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

@SupportedAll
public interface StaticOutcomeProvider
extends OutcomeProvider

Describes the outcomes for node instances that have static outcomes.

Nested Class Summary

Nested classes/interfaces inherited from interface org.forgerock.openam.auth.node.api.OutcomeProvider

OutcomeProvider.Outcome

Method Summary

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

Method Detail

getOutcomes

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

Description copied from interface: OutcomeProvider

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

Specified by:

getOutcomes in interface OutcomeProvider

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.

getOutcomes

List<OutcomeProvider.Outcome> getOutcomes(PreferredLocales locales)

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

Parameters:

locales - The locales for the localised description.

Returns:

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