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()	Mark this action as cancelled.
void	challenge(jakarta.ws.rs.core.Response response)	Send a challenge Response back to user
void	failure(String errorMessage)	Abort the authentication with an error, optionally with an erroMessage.
LoginFormsProvider	form()	Create a Freemarker form builder that presets the user, action URI, and a generated access code
String	generateCode()	Generates access code and updates clientsession timestamp Access codes must be included in form action callbacks as a query parameter.
String	getAction()
URI	getActionUrl()	Get the action URL for the required action.
URI	getActionUrl(String code)	Get the action URL for the required action.
AuthenticationSessionModel	getAuthenticationSession()
jakarta.ws.rs.core.Response	getChallenge()	If challenge has been sent this returns the JAX-RS Response
RequiredActionConfigModel	getConfig()	The configuration of the current required action.
ClientConnection	getConnection()
String	getErrorMessage()
EventBuilder	getEvent()	Current event builder being used
RequiredActionFactory	getFactory()
HttpRequest	getHttpRequest()
RealmModel	getRealm()
KeycloakSession	getSession()
RequiredActionContext.Status	getStatus()
jakarta.ws.rs.core.UriInfo	getUriInfo()
UserModel	getUser()	Current user
void	ignore()	Ignore this required action and go onto the next, or complete the flow.
void	success()	Mark this required action as successful.

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()

Description copied from interface: RequiredActionContext

The configuration of the current required action. Returns null if the current required action is not configurable.

Specified by:

getConfig in interface RequiredActionContext

Returns:

getFactory

public RequiredActionFactory getFactory()

getEvent

public EventBuilder getEvent()

Description copied from interface: RequiredActionContext

Current event builder being used

Specified by:

getEvent in interface RequiredActionContext

Returns:

getUser

public UserModel getUser()

Description copied from interface: RequiredActionContext

Current user

Specified by:

getUser in interface RequiredActionContext

Returns:

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)

Description copied from interface: RequiredActionContext

Send a challenge Response back to user

Specified by:

challenge in interface RequiredActionContext

failure

public void failure(String errorMessage)

Description copied from interface: RequiredActionContext

Abort the authentication with an error, optionally with an erroMessage.

Specified by:

failure in interface RequiredActionContext

success

public void success()

Description copied from interface: RequiredActionContext

Mark this required action as successful. The required action will be removed from the UserModel

Specified by:

success in interface RequiredActionContext

cancel

public void cancel()

Description copied from interface: RequiredActionContext

Mark this action as cancelled. Can be only used in AIA

Specified by:

cancel in interface RequiredActionContext

ignore

public void ignore()

Description copied from interface: RequiredActionContext

Ignore this required action and go onto the next, or complete the flow.

Specified by:

ignore in interface RequiredActionContext

getAction

public String getAction()

Specified by:

getAction in interface RequiredActionContext

getActionUrl

public URI getActionUrl(String code)

Description copied from interface: RequiredActionContext

Get the action URL for the required action.

Specified by:

getActionUrl in interface RequiredActionContext

Parameters:

code - client sessino access code

Returns:

generateCode

public String generateCode()

Description copied from interface: RequiredActionContext

Generates access code and updates clientsession timestamp Access codes must be included in form action callbacks as a query parameter.

Specified by:

generateCode in interface RequiredActionContext

Returns:

getActionUrl

public URI getActionUrl()

Description copied from interface: RequiredActionContext

Get the action URL for the required action. This auto-generates the access code.

Specified by:

getActionUrl in interface RequiredActionContext

Returns:

form

public LoginFormsProvider form()

Description copied from interface: RequiredActionContext

Create a Freemarker form builder that presets the user, action URI, and a generated access code

Specified by:

form in interface RequiredActionContext

Returns:

getChallenge

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

Description copied from interface: RequiredActionContext

If challenge has been sent this returns the JAX-RS Response

Specified by:

getChallenge in interface RequiredActionContext

Returns: