Package org.keycloak.authentication

Class RequiredActionContextResult

java.lang.Object

org.keycloak.authentication.RequiredActionContextResult

All Implemented Interfaces:

RequiredActionContext

public class RequiredActionContextResult
extends Object
implements RequiredActionContext

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

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

RequiredActionContext.KcActionStatus, RequiredActionContext.Status

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthenticationSessionModel	authenticationSession
protected jakarta.ws.rs.core.Response	challenge
protected RequiredActionConfigModel	config
protected String	errorMessage
protected EventBuilder	eventBuilder
protected RequiredActionFactory	factory
protected HttpRequest	httpRequest
protected RealmModel	realm
protected KeycloakSession	session
protected RequiredActionContext.Status	status
protected UserModel	user

Constructor Summary

Constructors

Constructor	Description
RequiredActionContextResult(AuthenticationSessionModel authSession, RealmModel realm, EventBuilder eventBuilder, KeycloakSession session, HttpRequest httpRequest, UserModel user, RequiredActionFactory factory)

Method Summary

Modifier and Type	Method	Description
void	cancel()
void	challenge(jakarta.ws.rs.core.Response response)
void	failure(String errorMessage)
LoginFormsProvider	form()
String	generateCode()
String	getAction()
URI	getActionUrl()
URI	getActionUrl(String code)
AuthenticationSessionModel	getAuthenticationSession()
jakarta.ws.rs.core.Response	getChallenge()
RequiredActionConfigModel	getConfig()
ClientConnection	getConnection()
String	getErrorMessage()
EventBuilder	getEvent()
RequiredActionFactory	getFactory()
HttpRequest	getHttpRequest()
RealmModel	getRealm()
KeycloakSession	getSession()
RequiredActionContext.Status	getStatus()
jakarta.ws.rs.core.UriInfo	getUriInfo()
UserModel	getUser()
void	ignore()
void	success()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.authentication.RequiredActionContext

failure

Field Details

authenticationSession

protected AuthenticationSessionModel authenticationSession

realm

protected RealmModel realm

eventBuilder

protected EventBuilder eventBuilder

session

protected KeycloakSession session

status

protected RequiredActionContext.Status status

errorMessage

protected String errorMessage

challenge

protected jakarta.ws.rs.core.Response challenge

httpRequest

protected HttpRequest httpRequest

user

protected UserModel user

factory

protected RequiredActionFactory factory

config

protected RequiredActionConfigModel config

Constructor Details

RequiredActionContextResult

public RequiredActionContextResult(AuthenticationSessionModel authSession,
 RealmModel realm,
 EventBuilder eventBuilder,
 KeycloakSession session,
 HttpRequest httpRequest,
 UserModel user,
 RequiredActionFactory factory)

Method Details

getConfig

public RequiredActionConfigModel getConfig()

Specified by:

getConfig in interface RequiredActionContext

getFactory

public RequiredActionFactory getFactory()

getEvent

public EventBuilder getEvent()

Specified by:

getEvent in interface RequiredActionContext

getUser

public UserModel getUser()

Specified by:

getUser in interface RequiredActionContext

getRealm

public RealmModel getRealm()

Specified by:

getRealm in interface RequiredActionContext

getAuthenticationSession

public AuthenticationSessionModel getAuthenticationSession()

Specified by:

getAuthenticationSession in interface RequiredActionContext

getConnection

public ClientConnection getConnection()

Specified by:

getConnection in interface RequiredActionContext

getUriInfo

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

Specified by:

getUriInfo in interface RequiredActionContext

getSession

public KeycloakSession getSession()

Specified by:

getSession in interface RequiredActionContext

getHttpRequest

public HttpRequest getHttpRequest()

Specified by:

getHttpRequest in interface RequiredActionContext

getStatus

public RequiredActionContext.Status getStatus()

Specified by:

getStatus in interface RequiredActionContext

getErrorMessage

public String getErrorMessage()

Specified by:

getErrorMessage in interface RequiredActionContext

challenge

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

Specified by:

challenge in interface RequiredActionContext

failure

public void failure(String errorMessage)

Specified by:

failure in interface RequiredActionContext

success

public void success()

Specified by:

success in interface RequiredActionContext

cancel

public void cancel()

Specified by:

cancel in interface RequiredActionContext

ignore

public void ignore()

Specified by:

ignore in interface RequiredActionContext

getAction

public String getAction()

Specified by:

getAction in interface RequiredActionContext

getActionUrl

public URI getActionUrl(String code)

Specified by:

getActionUrl in interface RequiredActionContext

generateCode

public String generateCode()

Specified by:

generateCode in interface RequiredActionContext

getActionUrl

public URI getActionUrl()

Specified by:

getActionUrl in interface RequiredActionContext

form

public LoginFormsProvider form()

Specified by:

form in interface RequiredActionContext

getChallenge

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

Specified by:

getChallenge in interface RequiredActionContext