Package org.forgerock.selfservice.core

Interface ProcessContext

  • public interface ProcessContext
    Process context represents the current state of the workflow.
    Since:
    0.2.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean containsState​(String jsonPointer)
      Determines whether state defined by the json pointer exists.
      org.forgerock.json.JsonValue getInput()
      Gets the input provided by the client.
      org.forgerock.json.resource.Request getRequest()
      Gets the original request.
      org.forgerock.services.context.Context getRequestContext()
      Gets the request context.
      String getStageTag()
      Gets the current stage tag defined by the previously invoked stage.
      org.forgerock.json.JsonValue getState​(String jsonPointer)
      Allows retrieval of state persisted throughout the flow.
      void putState​(String jsonPointer, Object value)
      Puts a value into the state referenced by the json pointer.
      void putSuccessAddition​(String jsonPointer, Object value)
      Puts a value into the additions referenced by the json pointer.

    • Method Detail

      • getRequestContext

        org.forgerock.services.context.Context getRequestContext()
        Gets the request context.
        Returns:
        the request context

      • getRequest

        org.forgerock.json.resource.Request getRequest()
        Gets the original request.
        Returns:
        the request

      • getStageTag

        String getStageTag()
        Gets the current stage tag defined by the previously invoked stage.
        Returns:
        the stage tag

      • getInput

        org.forgerock.json.JsonValue getInput()
        Gets the input provided by the client. Empty json object represents no input.
        Returns:
        the input

      • containsState

        boolean containsState​(String jsonPointer)
        Determines whether state defined by the json pointer exists.
        Parameters:
        jsonPointer - json pointer to the state
        Returns:
        whether of the a value exists

      • getState

        org.forgerock.json.JsonValue getState​(String jsonPointer)
        Allows retrieval of state persisted throughout the flow.
        Parameters:
        jsonPointer - json pointer to the state
        Returns:
        the corresponding value

      • putState

        void putState​(String jsonPointer,
              Object value)
        Puts a value into the state referenced by the json pointer.
        Parameters:
        jsonPointer - json pointer to where the state should be added
        value - the value to be added

      • putSuccessAddition

        void putSuccessAddition​(String jsonPointer,
                        Object value)
        Puts a value into the additions referenced by the json pointer.

        Additions are included in the response of successfully completing a flow.

        Parameters:
        jsonPointer - json point to additions value
        value - the corresponding value