Interface RequiredActionContext

  • All Known Implementing Classes:
    RequiredActionContextResult

    public interface RequiredActionContext
    Interface that encapsulates current information about the current requred action
    Version:
    $Revision: 1 $
    Author:
    Bill Burke
    • Method Detail

      • getActionUrl

        URI getActionUrl​(String code)
        Get the action URL for the required action.
        Parameters:
        code - client sessino access code
        Returns:
      • getActionUrl

        URI getActionUrl()
        Get the action URL for the required action. This auto-generates the access code.
        Returns:
      • getActionUrl

        URI getActionUrl​(boolean authSessionIdParam)
        Get the action URL for the required action. This auto-generates the access code.
        Parameters:
        authSessionIdParam - if true, will embed session id as query param. Useful for clients that don't support cookies (i.e. console)
        Returns:
      • form

        LoginFormsProvider form()
        Create a Freemarker form builder that presets the user, action URI, and a generated access code
        Returns:
      • getChallenge

        javax.ws.rs.core.Response getChallenge()
        If challenge has been sent this returns the JAX-RS Response
        Returns:
      • getEvent

        EventBuilder getEvent()
        Current event builder being used
        Returns:
      • getUser

        UserModel getUser()
        Current user
        Returns:
      • getUriInfo

        javax.ws.rs.core.UriInfo getUriInfo()
      • getHttpRequest

        org.jboss.resteasy.spi.HttpRequest getHttpRequest()
      • generateCode

        String generateCode()
        Generates access code and updates clientsession timestamp Access codes must be included in form action callbacks as a query parameter.
        Returns:
      • challenge

        void challenge​(javax.ws.rs.core.Response response)
        Send a challenge Response back to user
        Parameters:
        response -
      • failure

        void failure()
        Abort the authentication with an error
      • success

        void success()
        Mark this required action as successful. The required action will be removed from the UserModel
      • ignore

        void ignore()
        Ignore this required action and go onto the next, or complete the flow.