Package com.pingidentity.sdk.api.authn.model

Class AuthnState<ModelType>

java.lang.Object
com.pingidentity.sdk.api.authn.model.AuthnState<ModelType>
Type Parameters:
ModelType - The type for the model associated with the state (or Void if no model is associated with the state).
All Implemented Interfaces:
WithStateAttributeSupport
public class AuthnState<ModelType> extends Object implements WithStateAttributeSupport
The API model representing the current state of a flow in the Authentication API.
Since:
9.3

  • Constructor Details

    • AuthnState

      public AuthnState(String id, String url)
      Create an instance with the specified parameters.
      Parameters:
      id - The ID of the flow the state is associated with.
      url - The absolute URL of the flow the state is associated with.

  • Method Details

    • getId

      public String getId()
      Get the ID of the flow the state belongs to.

    • setId

      public void setId(String id)
      Set the ID of the flow the state belongs to.

    • getStatus

      public String getStatus()
      Get the status for the state.

    • setStatus

      public void setStatus(String status)
      Set the status for the state.

    • getPluginTypeId

      public String getPluginTypeId()
      Get the type ID for the API-capable plugin that is currently active.

    • setPluginTypeId

      public void setPluginTypeId(String pluginTypeId)
      Set the type ID for the API-capable plugin that is currently active.

    • getModel

      public ModelType getModel()
      Get the model associated with the state, if one exists.

    • setModel

      public void setModel(ModelType model)
      Set the model associated with the state.

    • getActions

      public List<AuthnAction> getActions()
      Get the actions available for the current state.

    • addAction

      public void addAction(AuthnAction action)
      Add an action to the available actions.

    • removeAction

      public void removeAction(String id)
      Remove an action from the available actions.
      Parameters:
      id - The ID of the action to remove.

    • clearActions

      public void clearActions()
      Clear the list of available actions.

    • getLinks

      public Map<String,HalLink> getLinks()
      Get the HAL links associated with the state. These include links for each of the available actions, as well as a "self" link.

    • getUrl

      public String getUrl()
      Get the absolute URL of the flow the state is associated with.

    • getRequestContext

      public RequestContext getRequestContext()
      Get the request context containing parameters made available for authentication API responses.
      Since:
      11.0

    • setRequestContext

      public void setRequestContext(RequestContext requestContext)
      Set the request context that is made available to authentication API responses.
      Since:
      11.0

    • getState

      public String getState()
      Get the cookieless state value.
      Specified by:
      getState in interface WithStateAttributeSupport
      Returns:
      the cookieless state value
      Since:
      12.1

    • setState

      public void setState(String state)
      Set the cookieless state value.
      Specified by:
      setState in interface WithStateAttributeSupport
      Parameters:
      state - the cookieless state value
      Since:
      12.1