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

Class OutputState

java.lang.Object

org.forgerock.openam.auth.node.api.OutputState

@Supported
public final class OutputState
extends Object

Describes one shared state attribute produced by a node.

Constructor Summary

Constructors

Constructor	Description
OutputState(String name)	Construct an OutputState with a name and default outcomes.
OutputState(String name, Map<String,Boolean> outcomes)	Construct an OutputState with a name and map of outcomes.

Method Summary

Modifier and Type	Method	Description
String	name()	Get the attribute (property) name of this state.
Map<String,Boolean>	outcomes()	Gets the map of node outcome names and whether the output property is guaranteed to be provided for that outcome.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OutputState

@Supported
public OutputState(String name)

Construct an OutputState with a name and default outcomes. The default wildcard for outcome indicates that the output will be provided for all outcomes.

Parameters:

name - the name of the output state

OutputState

@Supported
public OutputState(String name,
 Map<String,Boolean> outcomes)

Construct an OutputState with a name and map of outcomes.

Parameters:

name - the name of the output state

outcomes - the outcomes for this state

Method Details

name

@Supported
public String name()

Get the attribute (property) name of this state.

Returns:

The attribute (property) name of this state

outcomes

@Supported
public Map<String,Boolean> outcomes()

Gets the map of node outcome names and whether the output property is guaranteed to be provided for that outcome.

A wildcard * may be used to represent all outcomes.

Returns:

The map of node outcomes