Package org.keycloak.authentication

Class AuthenticationProcessor.Result

  • All Implemented Interfaces:
    org.keycloak.authentication.AbstractAuthenticationFlowContext, org.keycloak.authentication.AuthenticationFlowContext, org.keycloak.authentication.ClientAuthenticationFlowContext
    Enclosing class:
    AuthenticationProcessor
    public class AuthenticationProcessor.Result
extends Object
implements org.keycloak.authentication.AuthenticationFlowContext, org.keycloak.authentication.ClientAuthenticationFlowContext

    • Method Detail

      • newEvent

        public org.keycloak.events.EventBuilder newEvent()
        Specified by:
        newEvent in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • getCategoryRequirementFromCurrentFlow

        public org.keycloak.models.AuthenticationExecutionModel.Requirement getCategoryRequirementFromCurrentFlow​(String authenticatorCategory)
        Specified by:
        getCategoryRequirementFromCurrentFlow in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • getExecution

        public org.keycloak.models.AuthenticationExecutionModel getExecution()
        Specified by:
        getExecution in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • getAuthenticatorConfig

        public org.keycloak.models.AuthenticatorConfigModel getAuthenticatorConfig()
        Specified by:
        getAuthenticatorConfig in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • getAuthenticator

        public org.keycloak.authentication.Authenticator getAuthenticator()

      • getStatus

        public org.keycloak.authentication.FlowStatus getStatus()
        Specified by:
        getStatus in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • getClientAuthenticator

        public org.keycloak.authentication.ClientAuthenticator getClientAuthenticator()

      • success

        public void success()
        Specified by:
        success in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • failure

        public void failure​(org.keycloak.authentication.AuthenticationFlowError error)
        Specified by:
        failure in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • challenge

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

      • forceChallenge

        public void forceChallenge​(javax.ws.rs.core.Response challenge)
        Specified by:
        forceChallenge in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • failureChallenge

        public void failureChallenge​(org.keycloak.authentication.AuthenticationFlowError error,
                             javax.ws.rs.core.Response challenge)
        Specified by:
        failureChallenge in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • failure

        public void failure​(org.keycloak.authentication.AuthenticationFlowError error,
                    javax.ws.rs.core.Response challenge)
        Specified by:
        failure in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • failure

        public void failure​(org.keycloak.authentication.AuthenticationFlowError error,
                    javax.ws.rs.core.Response challenge,
                    String eventDetails,
                    String userErrorMessage)
        Specified by:
        failure in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • attempted

        public void attempted()
        Specified by:
        attempted in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • getUser

        public org.keycloak.models.UserModel getUser()
        Specified by:
        getUser in interface org.keycloak.authentication.AuthenticationFlowContext

      • setUser

        public void setUser​(org.keycloak.models.UserModel user)
        Specified by:
        setUser in interface org.keycloak.authentication.AuthenticationFlowContext

      • getAuthenticationSelections

        public List<org.keycloak.authentication.AuthenticationSelectionOption> getAuthenticationSelections()
        Specified by:
        getAuthenticationSelections in interface org.keycloak.authentication.AuthenticationFlowContext

      • setAuthenticationSelections

        public void setAuthenticationSelections​(List<org.keycloak.authentication.AuthenticationSelectionOption> authenticationSelections)
        Specified by:
        setAuthenticationSelections in interface org.keycloak.authentication.AuthenticationFlowContext

      • clearUser

        public void clearUser()
        Specified by:
        clearUser in interface org.keycloak.authentication.AuthenticationFlowContext

      • getRealm

        public org.keycloak.models.RealmModel getRealm()
        Specified by:
        getRealm in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • getClient

        public org.keycloak.models.ClientModel getClient()
        Specified by:
        getClient in interface org.keycloak.authentication.ClientAuthenticationFlowContext

      • setClient

        public void setClient​(org.keycloak.models.ClientModel client)
        Specified by:
        setClient in interface org.keycloak.authentication.ClientAuthenticationFlowContext

      • getClientAuthAttributes

        public Map<String,​String> getClientAuthAttributes()
        Specified by:
        getClientAuthAttributes in interface org.keycloak.authentication.ClientAuthenticationFlowContext

      • getAuthenticationSession

        public org.keycloak.sessions.AuthenticationSessionModel getAuthenticationSession()
        Specified by:
        getAuthenticationSession in interface org.keycloak.authentication.AuthenticationFlowContext

      • getFlowPath

        public String getFlowPath()
        Specified by:
        getFlowPath in interface org.keycloak.authentication.AuthenticationFlowContext

      • getConnection

        public org.keycloak.common.ClientConnection getConnection()
        Specified by:
        getConnection in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • getUriInfo

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

      • getSession

        public org.keycloak.models.KeycloakSession getSession()
        Specified by:
        getSession in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • getHttpRequest

        public org.jboss.resteasy.spi.HttpRequest getHttpRequest()
        Specified by:
        getHttpRequest in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • attachUserSession

        public void attachUserSession​(org.keycloak.models.UserSessionModel userSession)
        Specified by:
        attachUserSession in interface org.keycloak.authentication.AuthenticationFlowContext

      • getProtector

        public org.keycloak.services.managers.BruteForceProtector getProtector()
        Specified by:
        getProtector in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • getEvent

        public org.keycloak.events.EventBuilder getEvent()
        Specified by:
        getEvent in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • getForwardedErrorMessage

        public org.keycloak.models.utils.FormMessage getForwardedErrorMessage()
        Specified by:
        getForwardedErrorMessage in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • generateAccessCode

        public String generateAccessCode()
        Specified by:
        generateAccessCode in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • getChallenge

        public javax.ws.rs.core.Response getChallenge()

      • getError

        public org.keycloak.authentication.AuthenticationFlowError getError()
        Specified by:
        getError in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • form

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

      • getActionUrl

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

      • getActionTokenUrl

        public URI getActionTokenUrl​(String tokenString)
        Specified by:
        getActionTokenUrl in interface org.keycloak.authentication.AuthenticationFlowContext

      • getActionUrl

        public URI getActionUrl​(String code,
                        boolean authSessionIdParam)
        Specified by:
        getActionUrl in interface org.keycloak.authentication.AuthenticationFlowContext

      • getRefreshExecutionUrl

        public URI getRefreshExecutionUrl()
        Specified by:
        getRefreshExecutionUrl in interface org.keycloak.authentication.AuthenticationFlowContext

      • getRefreshUrl

        public URI getRefreshUrl​(boolean authSessionIdParam)
        Specified by:
        getRefreshUrl in interface org.keycloak.authentication.AuthenticationFlowContext

      • cancelLogin

        public void cancelLogin()
        Specified by:
        cancelLogin in interface org.keycloak.authentication.AuthenticationFlowContext

      • resetFlow

        public void resetFlow()
        Specified by:
        resetFlow in interface org.keycloak.authentication.AuthenticationFlowContext

      • resetFlow

        public void resetFlow​(Runnable afterResetListener)
        Specified by:
        resetFlow in interface org.keycloak.authentication.AuthenticationFlowContext

      • fork

        public void fork()
        Specified by:
        fork in interface org.keycloak.authentication.AuthenticationFlowContext

      • forkWithSuccessMessage

        public void forkWithSuccessMessage​(org.keycloak.models.utils.FormMessage message)
        Specified by:
        forkWithSuccessMessage in interface org.keycloak.authentication.AuthenticationFlowContext

      • forkWithErrorMessage

        public void forkWithErrorMessage​(org.keycloak.models.utils.FormMessage message)
        Specified by:
        forkWithErrorMessage in interface org.keycloak.authentication.AuthenticationFlowContext

      • getForwardedSuccessMessage

        public org.keycloak.models.utils.FormMessage getForwardedSuccessMessage()
        Specified by:
        getForwardedSuccessMessage in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • setForwardedInfoMessage

        public void setForwardedInfoMessage​(String message,
                                    Object... parameters)
        Specified by:
        setForwardedInfoMessage in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • getForwardedInfoMessage

        public org.keycloak.models.utils.FormMessage getForwardedInfoMessage()
        Specified by:
        getForwardedInfoMessage in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • getErrorMessage

        public org.keycloak.models.utils.FormMessage getErrorMessage()

      • getSuccessMessage

        public org.keycloak.models.utils.FormMessage getSuccessMessage()

      • getEventDetails

        public String getEventDetails()
        Specified by:
        getEventDetails in interface org.keycloak.authentication.AbstractAuthenticationFlowContext

      • getUserErrorMessage

        public String getUserErrorMessage()
        Specified by:
        getUserErrorMessage in interface org.keycloak.authentication.AbstractAuthenticationFlowContext