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

Class InputState

java.lang.Object
org.forgerock.openam.auth.node.api.InputState
@Supported public final class InputState extends Object
Describes a single shared state attribute consumed by a node.

  • Constructor Summary

    Constructors
    Constructor
    Description
    InputState(String name)
    Constructs a required InputState.
    InputState(String name, boolean required)
    Construct an InputState.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    name()
    Gets the attribute name of this input state.
    boolean
    required()
    Returns a boolean indicating whether this state is required by the consuming node in order to function.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • InputState

      @Supported public InputState(String name)
      Constructs a required InputState. The `required` attribute is set to true.
      Parameters:
      name - the attribute name of this state

    • InputState

      @Supported public InputState(String name, boolean required)
      Construct an InputState.
      Parameters:
      name - the attribute name of this state
      required - whether this state is required for the node to function.

  • Method Details

    • name

      @Supported public String name()
      Gets the attribute name of this input state.
      Returns:
      the attribute name of this state

    • required

      @Supported public boolean required()
      Returns a boolean indicating whether this state is required by the consuming node in order to function. If false the node must be able to handle the case where this input is missing.
      Returns:
      whether this state is required for the node to function.