Class RequiredActionContextResult

  • All Implemented Interfaces:
    org.keycloak.authentication.RequiredActionContext

    public class RequiredActionContextResult
    extends Object
    implements org.keycloak.authentication.RequiredActionContext
    Version:
    $Revision: 1 $
    Author:
    Bill Burke
    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.keycloak.authentication.RequiredActionContext

        org.keycloak.authentication.RequiredActionContext.KcActionStatus, org.keycloak.authentication.RequiredActionContext.Status
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.keycloak.sessions.AuthenticationSessionModel authenticationSession  
      protected javax.ws.rs.core.Response challenge  
      protected org.keycloak.events.EventBuilder eventBuilder  
      protected org.keycloak.authentication.RequiredActionFactory factory  
      protected org.keycloak.http.HttpRequest httpRequest  
      protected org.keycloak.models.RealmModel realm  
      protected org.keycloak.models.KeycloakSession session  
      protected org.keycloak.authentication.RequiredActionContext.Status status  
      protected org.keycloak.models.UserModel user  
    • Constructor Summary

      Constructors 
      Constructor Description
      RequiredActionContextResult​(org.keycloak.sessions.AuthenticationSessionModel authSession, org.keycloak.models.RealmModel realm, org.keycloak.events.EventBuilder eventBuilder, org.keycloak.models.KeycloakSession session, org.keycloak.http.HttpRequest httpRequest, org.keycloak.models.UserModel user, org.keycloak.authentication.RequiredActionFactory factory)  
    • Field Detail

      • authenticationSession

        protected org.keycloak.sessions.AuthenticationSessionModel authenticationSession
      • realm

        protected org.keycloak.models.RealmModel realm
      • eventBuilder

        protected org.keycloak.events.EventBuilder eventBuilder
      • session

        protected org.keycloak.models.KeycloakSession session
      • status

        protected org.keycloak.authentication.RequiredActionContext.Status status
      • challenge

        protected javax.ws.rs.core.Response challenge
      • httpRequest

        protected org.keycloak.http.HttpRequest httpRequest
      • user

        protected org.keycloak.models.UserModel user
      • factory

        protected org.keycloak.authentication.RequiredActionFactory factory
    • Constructor Detail

      • RequiredActionContextResult

        public RequiredActionContextResult​(org.keycloak.sessions.AuthenticationSessionModel authSession,
                                           org.keycloak.models.RealmModel realm,
                                           org.keycloak.events.EventBuilder eventBuilder,
                                           org.keycloak.models.KeycloakSession session,
                                           org.keycloak.http.HttpRequest httpRequest,
                                           org.keycloak.models.UserModel user,
                                           org.keycloak.authentication.RequiredActionFactory factory)
    • Method Detail

      • getFactory

        public org.keycloak.authentication.RequiredActionFactory getFactory()
      • getEvent

        public org.keycloak.events.EventBuilder getEvent()
        Specified by:
        getEvent in interface org.keycloak.authentication.RequiredActionContext
      • getUser

        public org.keycloak.models.UserModel getUser()
        Specified by:
        getUser in interface org.keycloak.authentication.RequiredActionContext
      • getRealm

        public org.keycloak.models.RealmModel getRealm()
        Specified by:
        getRealm in interface org.keycloak.authentication.RequiredActionContext
      • getAuthenticationSession

        public org.keycloak.sessions.AuthenticationSessionModel getAuthenticationSession()
        Specified by:
        getAuthenticationSession in interface org.keycloak.authentication.RequiredActionContext
      • getConnection

        public org.keycloak.common.ClientConnection getConnection()
        Specified by:
        getConnection in interface org.keycloak.authentication.RequiredActionContext
      • getUriInfo

        public javax.ws.rs.core.UriInfo getUriInfo()
        Specified by:
        getUriInfo in interface org.keycloak.authentication.RequiredActionContext
      • getSession

        public org.keycloak.models.KeycloakSession getSession()
        Specified by:
        getSession in interface org.keycloak.authentication.RequiredActionContext
      • getHttpRequest

        public org.keycloak.http.HttpRequest getHttpRequest()
        Specified by:
        getHttpRequest in interface org.keycloak.authentication.RequiredActionContext
      • getStatus

        public org.keycloak.authentication.RequiredActionContext.Status getStatus()
        Specified by:
        getStatus in interface org.keycloak.authentication.RequiredActionContext
      • challenge

        public void challenge​(javax.ws.rs.core.Response response)
        Specified by:
        challenge in interface org.keycloak.authentication.RequiredActionContext
      • failure

        public void failure()
        Specified by:
        failure in interface org.keycloak.authentication.RequiredActionContext
      • success

        public void success()
        Specified by:
        success in interface org.keycloak.authentication.RequiredActionContext
      • ignore

        public void ignore()
        Specified by:
        ignore in interface org.keycloak.authentication.RequiredActionContext
      • getActionUrl

        public URI getActionUrl​(String code)
        Specified by:
        getActionUrl in interface org.keycloak.authentication.RequiredActionContext
      • generateCode

        public String generateCode()
        Specified by:
        generateCode in interface org.keycloak.authentication.RequiredActionContext
      • getActionUrl

        public URI getActionUrl()
        Specified by:
        getActionUrl in interface org.keycloak.authentication.RequiredActionContext
      • form

        public org.keycloak.forms.login.LoginFormsProvider form()
        Specified by:
        form in interface org.keycloak.authentication.RequiredActionContext
      • getChallenge

        public javax.ws.rs.core.Response getChallenge()
        Specified by:
        getChallenge in interface org.keycloak.authentication.RequiredActionContext