Package org.keycloak.authentication

Class AuthenticationProcessor.Result

java.lang.Object

org.keycloak.authentication.AuthenticationProcessor.Result

All Implemented Interfaces:

AbstractAuthenticationFlowContext, AuthenticationFlowContext, ClientAuthenticationFlowContext

Enclosing class:

AuthenticationProcessor

public class AuthenticationProcessor.Result
extends Object
implements AuthenticationFlowContext, ClientAuthenticationFlowContext

Method Summary

Modifier and Type	Method	Description
void	attachUserSession(UserSessionModel userSession)
void	attempted()
void	cancelLogin()
void	challenge(jakarta.ws.rs.core.Response challenge)
void	clearUser()
void	failure(AuthenticationFlowError error)
void	failure(AuthenticationFlowError error, jakarta.ws.rs.core.Response challenge)
void	failure(AuthenticationFlowError error, jakarta.ws.rs.core.Response challenge, String eventDetails, String userErrorMessage)
void	failureChallenge(AuthenticationFlowError error, jakarta.ws.rs.core.Response challenge)
void	forceChallenge(jakarta.ws.rs.core.Response challenge)
void	fork()
void	forkWithErrorMessage(FormMessage message)
void	forkWithSuccessMessage(FormMessage message)
LoginFormsProvider	form()
String	generateAccessCode()
URI	getActionTokenUrl(String tokenString)
URI	getActionUrl(String code)
List<AuthenticationSelectionOption>	getAuthenticationSelections()
AuthenticationSessionModel	getAuthenticationSession()
Authenticator	getAuthenticator()
AuthenticatorConfigModel	getAuthenticatorConfig()
AuthenticationExecutionModel.Requirement	getCategoryRequirementFromCurrentFlow(String authenticatorCategory)
jakarta.ws.rs.core.Response	getChallenge()
ClientModel	getClient()
Map<String,String>	getClientAuthAttributes()
ClientAuthenticator	getClientAuthenticator()
ClientConnection	getConnection()
AuthenticationFlowError	getError()
FormMessage	getErrorMessage()
EventBuilder	getEvent()
String	getEventDetails()
AuthenticationExecutionModel	getExecution()
String	getFlowPath()
FormMessage	getForwardedErrorMessage()
FormMessage	getForwardedInfoMessage()
FormMessage	getForwardedSuccessMessage()
HttpRequest	getHttpRequest()
BruteForceProtector	getProtector()
RealmModel	getRealm()
URI	getRefreshExecutionUrl()
URI	getRefreshUrl(boolean authSessionIdParam)
KeycloakSession	getSession()
FlowStatus	getStatus()
FormMessage	getSuccessMessage()
AuthenticationFlowModel	getTopLevelFlow()
jakarta.ws.rs.core.UriInfo	getUriInfo()
UserModel	getUser()
String	getUserErrorMessage()
EventBuilder	newEvent()
void	resetFlow()
void	resetFlow(Runnable afterResetListener)
void	setAuthenticationSelections(List<AuthenticationSelectionOption> authenticationSelections)
void	setClient(ClientModel client)
void	setForwardedInfoMessage(String message, Object... parameters)
void	setUser(UserModel user)
void	success()
void	success(String credentialType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

newEvent

public EventBuilder newEvent()

Specified by:

newEvent in interface AbstractAuthenticationFlowContext

getCategoryRequirementFromCurrentFlow

public AuthenticationExecutionModel.Requirement getCategoryRequirementFromCurrentFlow(String authenticatorCategory)

Specified by:

getCategoryRequirementFromCurrentFlow in interface AbstractAuthenticationFlowContext

getExecution

public AuthenticationExecutionModel getExecution()

Specified by:

getExecution in interface AbstractAuthenticationFlowContext

getTopLevelFlow

public AuthenticationFlowModel getTopLevelFlow()

Specified by:

getTopLevelFlow in interface AbstractAuthenticationFlowContext

getAuthenticatorConfig

public AuthenticatorConfigModel getAuthenticatorConfig()

Specified by:

getAuthenticatorConfig in interface AbstractAuthenticationFlowContext

getAuthenticator

public Authenticator getAuthenticator()

getStatus

public FlowStatus getStatus()

Specified by:

getStatus in interface AbstractAuthenticationFlowContext

getClientAuthenticator

public ClientAuthenticator getClientAuthenticator()

success

public void success()

Specified by:

success in interface AbstractAuthenticationFlowContext

success

public void success(String credentialType)

Specified by:

success in interface AbstractAuthenticationFlowContext

failure

public void failure(AuthenticationFlowError error)

Specified by:

failure in interface AbstractAuthenticationFlowContext

challenge

public void challenge(jakarta.ws.rs.core.Response challenge)

Specified by:

challenge in interface AbstractAuthenticationFlowContext

forceChallenge

public void forceChallenge(jakarta.ws.rs.core.Response challenge)

Specified by:

forceChallenge in interface AbstractAuthenticationFlowContext

failureChallenge

public void failureChallenge(AuthenticationFlowError error,
 jakarta.ws.rs.core.Response challenge)

Specified by:

failureChallenge in interface AbstractAuthenticationFlowContext

failure

public void failure(AuthenticationFlowError error,
 jakarta.ws.rs.core.Response challenge)

Specified by:

failure in interface AbstractAuthenticationFlowContext

failure

public void failure(AuthenticationFlowError error,
 jakarta.ws.rs.core.Response challenge,
 String eventDetails,
 String userErrorMessage)

Specified by:

failure in interface AbstractAuthenticationFlowContext

attempted

public void attempted()

Specified by:

attempted in interface AbstractAuthenticationFlowContext

getUser

public UserModel getUser()

Specified by:

getUser in interface AuthenticationFlowContext

setUser

public void setUser(UserModel user)

Specified by:

setUser in interface AuthenticationFlowContext

getAuthenticationSelections

public List<AuthenticationSelectionOption> getAuthenticationSelections()

Specified by:

getAuthenticationSelections in interface AuthenticationFlowContext

setAuthenticationSelections

public void setAuthenticationSelections(List<AuthenticationSelectionOption> authenticationSelections)

Specified by:

setAuthenticationSelections in interface AuthenticationFlowContext

clearUser

public void clearUser()

Specified by:

clearUser in interface AuthenticationFlowContext

getRealm

public RealmModel getRealm()

Specified by:

getRealm in interface AbstractAuthenticationFlowContext

getClient

public ClientModel getClient()

Specified by:

getClient in interface ClientAuthenticationFlowContext

setClient

public void setClient(ClientModel client)

Specified by:

setClient in interface ClientAuthenticationFlowContext

getClientAuthAttributes

public Map<String,String> getClientAuthAttributes()

Specified by:

getClientAuthAttributes in interface ClientAuthenticationFlowContext

getAuthenticationSession

public AuthenticationSessionModel getAuthenticationSession()

Specified by:

getAuthenticationSession in interface AuthenticationFlowContext

getFlowPath

public String getFlowPath()

Specified by:

getFlowPath in interface AuthenticationFlowContext

getConnection

public ClientConnection getConnection()

Specified by:

getConnection in interface AbstractAuthenticationFlowContext

getUriInfo

public jakarta.ws.rs.core.UriInfo getUriInfo()

Specified by:

getUriInfo in interface AbstractAuthenticationFlowContext

getSession

public KeycloakSession getSession()

Specified by:

getSession in interface AbstractAuthenticationFlowContext

getHttpRequest

public HttpRequest getHttpRequest()

Specified by:

getHttpRequest in interface AbstractAuthenticationFlowContext

attachUserSession

public void attachUserSession(UserSessionModel userSession)

Specified by:

attachUserSession in interface AuthenticationFlowContext

getProtector

public BruteForceProtector getProtector()

Specified by:

getProtector in interface AbstractAuthenticationFlowContext

getEvent

public EventBuilder getEvent()

Specified by:

getEvent in interface AbstractAuthenticationFlowContext

getForwardedErrorMessage

public FormMessage getForwardedErrorMessage()

Specified by:

getForwardedErrorMessage in interface AbstractAuthenticationFlowContext

generateAccessCode

public String generateAccessCode()

Specified by:

generateAccessCode in interface AbstractAuthenticationFlowContext

getChallenge

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

getError

public AuthenticationFlowError getError()

Specified by:

getError in interface AbstractAuthenticationFlowContext

form

public LoginFormsProvider form()

Specified by:

form in interface AuthenticationFlowContext

getActionUrl

public URI getActionUrl(String code)

Specified by:

getActionUrl in interface AuthenticationFlowContext

getActionTokenUrl

public URI getActionTokenUrl(String tokenString)

Specified by:

getActionTokenUrl in interface AuthenticationFlowContext

getRefreshExecutionUrl

public URI getRefreshExecutionUrl()

Specified by:

getRefreshExecutionUrl in interface AuthenticationFlowContext

getRefreshUrl

public URI getRefreshUrl(boolean authSessionIdParam)

Specified by:

getRefreshUrl in interface AuthenticationFlowContext

cancelLogin

public void cancelLogin()

Specified by:

cancelLogin in interface AuthenticationFlowContext

resetFlow

public void resetFlow()

Specified by:

resetFlow in interface AuthenticationFlowContext

resetFlow

public void resetFlow(Runnable afterResetListener)

Specified by:

resetFlow in interface AuthenticationFlowContext

fork

public void fork()

Specified by:

fork in interface AuthenticationFlowContext

forkWithSuccessMessage

public void forkWithSuccessMessage(FormMessage message)

Specified by:

forkWithSuccessMessage in interface AuthenticationFlowContext

forkWithErrorMessage

public void forkWithErrorMessage(FormMessage message)

Specified by:

forkWithErrorMessage in interface AuthenticationFlowContext

getForwardedSuccessMessage

public FormMessage getForwardedSuccessMessage()

Specified by:

getForwardedSuccessMessage in interface AbstractAuthenticationFlowContext

setForwardedInfoMessage

public void setForwardedInfoMessage(String message,
 Object... parameters)

Specified by:

setForwardedInfoMessage in interface AbstractAuthenticationFlowContext

getForwardedInfoMessage

public FormMessage getForwardedInfoMessage()

Specified by:

getForwardedInfoMessage in interface AbstractAuthenticationFlowContext

getErrorMessage

public FormMessage getErrorMessage()

getSuccessMessage

public FormMessage getSuccessMessage()

getEventDetails

public String getEventDetails()

Specified by:

getEventDetails in interface AbstractAuthenticationFlowContext

getUserErrorMessage

public String getUserErrorMessage()

Specified by:

getUserErrorMessage in interface AbstractAuthenticationFlowContext