Package org.keycloak.services

Class DefaultKeycloakContext

java.lang.Object

org.keycloak.services.DefaultKeycloakContext

All Implemented Interfaces:

KeycloakContext

public abstract class DefaultKeycloakContext
extends Object
implements KeycloakContext

Author:

Stian Thorgersen

Field Summary

Fields

Modifier and Type	Field	Description
protected KeycloakSession	session

Constructor Summary

Constructors

Constructor	Description
DefaultKeycloakContext(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
protected ClientConnection	createClientConnection()
protected abstract HttpRequest	createHttpRequest()
protected abstract HttpResponse	createHttpResponse()
AuthenticationSessionModel	getAuthenticationSession()	Get current AuthenticationSessionModel, can be null out of the AuthenticationSession context.
URI	getAuthServerUrl()
Token	getBearerToken()	Returns a Token representing the bearer token used to authenticate and authorize the current request.
ClientModel	getClient()
ClientConnection	getConnection()
String	getContextPath()
HttpRequest	getHttpRequest()
HttpResponse	getHttpResponse()
OrganizationModel	getOrganization()
RealmModel	getRealm()
jakarta.ws.rs.core.HttpHeaders	getRequestHeaders()	Deprecated. Use getHttpRequest() to obtain the request headers.
protected KeycloakSession	getSession()
KeycloakUriInfo	getUri()	Returns the URI assuming it is a frontend request.
KeycloakUriInfo	getUri(UrlType type)	Returns the URI.
UserModel	getUser()	Returns the UserModel bound to this context.
UserSessionModel	getUserSession()
Locale	resolveLocale(UserModel user)
Locale	resolveLocale(UserModel user, Theme.Type themeType)
void	setAuthenticationSession(AuthenticationSessionModel authenticationSession)
void	setBearerToken(Token token)
void	setClient(ClientModel client)
void	setConnection(ClientConnection clientConnection)
void	setHttpRequest(HttpRequest httpRequest)
void	setHttpResponse(HttpResponse httpResponse)
void	setOrganization(OrganizationModel organization)
void	setRealm(RealmModel realm)
void	setUserSession(UserSessionModel userSession)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.models.KeycloakContext

getContextObject

Field Details

session

protected KeycloakSession session

Constructor Details

DefaultKeycloakContext

public DefaultKeycloakContext(KeycloakSession session)

Method Details

getAuthServerUrl

public URI getAuthServerUrl()

Specified by:

getAuthServerUrl in interface KeycloakContext

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface KeycloakContext

getUri

public KeycloakUriInfo getUri(UrlType type)

Description copied from interface: KeycloakContext

Returns the URI. If a frontend request (from user-agent) @frontendRequest should be set to true. If a backend request (request from a client) should be set to false. Depending on the configure hostname provider it may return a hard-coded base URL for frontend request (for example https://auth.mycompany.com) and use the request URL for backend requests. Frontend URI should also be used for realm issuer fields in tokens.

Specified by:

getUri in interface KeycloakContext

Parameters:

type - the type of the request

Returns:

getUri

public KeycloakUriInfo getUri()

Description copied from interface: KeycloakContext

Returns the URI assuming it is a frontend request. To resolve URI for a backend request use KeycloakContext.getUri(UrlType)

Specified by:

getUri in interface KeycloakContext

Returns:

getRequestHeaders

@Deprecated
public jakarta.ws.rs.core.HttpHeaders getRequestHeaders()

Deprecated.

Use getHttpRequest() to obtain the request headers.

Specified by:

getRequestHeaders in interface KeycloakContext

Returns:

getRealm

public RealmModel getRealm()

Specified by:

getRealm in interface KeycloakContext

setRealm

public void setRealm(RealmModel realm)

Specified by:

setRealm in interface KeycloakContext

getClient

public ClientModel getClient()

Specified by:

getClient in interface KeycloakContext

setClient

public void setClient(ClientModel client)

Specified by:

setClient in interface KeycloakContext

getOrganization

public OrganizationModel getOrganization()

Specified by:

getOrganization in interface KeycloakContext

setOrganization

public void setOrganization(OrganizationModel organization)

Specified by:

setOrganization in interface KeycloakContext

getConnection

public ClientConnection getConnection()

Specified by:

getConnection in interface KeycloakContext

resolveLocale

public Locale resolveLocale(UserModel user)

Specified by:

resolveLocale in interface KeycloakContext

resolveLocale

public Locale resolveLocale(UserModel user,
 Theme.Type themeType)

Specified by:

resolveLocale in interface KeycloakContext

getAuthenticationSession

public AuthenticationSessionModel getAuthenticationSession()

Description copied from interface: KeycloakContext

Get current AuthenticationSessionModel, can be null out of the AuthenticationSession context.

Specified by:

getAuthenticationSession in interface KeycloakContext

Returns:

current AuthenticationSessionModel or null

setAuthenticationSession

public void setAuthenticationSession(AuthenticationSessionModel authenticationSession)

Specified by:

setAuthenticationSession in interface KeycloakContext

getHttpRequest

public HttpRequest getHttpRequest()

Specified by:

getHttpRequest in interface KeycloakContext

getHttpResponse

public HttpResponse getHttpResponse()

Specified by:

getHttpResponse in interface KeycloakContext

createClientConnection

protected ClientConnection createClientConnection()

createHttpRequest

protected abstract HttpRequest createHttpRequest()

createHttpResponse

protected abstract HttpResponse createHttpResponse()

getSession

protected KeycloakSession getSession()

setConnection

public void setConnection(ClientConnection clientConnection)

Specified by:

setConnection in interface KeycloakContext

setHttpRequest

public void setHttpRequest(HttpRequest httpRequest)

Specified by:

setHttpRequest in interface KeycloakContext

setHttpResponse

public void setHttpResponse(HttpResponse httpResponse)

Specified by:

setHttpResponse in interface KeycloakContext

getUserSession

public UserSessionModel getUserSession()

Specified by:

getUserSession in interface KeycloakContext

setUserSession

public void setUserSession(UserSessionModel userSession)

Specified by:

setUserSession in interface KeycloakContext

setBearerToken

public void setBearerToken(Token token)

Specified by:

setBearerToken in interface KeycloakContext

getBearerToken

public Token getBearerToken()

Description copied from interface: KeycloakContext

Returns a Token representing the bearer token used to authenticate and authorize the current request.

Specified by:

getBearerToken in interface KeycloakContext

Returns:

the bearer token

getUser

public UserModel getUser()

Description copied from interface: KeycloakContext

Returns the UserModel bound to this context. The user is first resolved from the KeycloakContext.getBearerToken() set to this context, if any. Otherwise, it will be resolved from the KeycloakContext.getUserSession() set to this context, if any.

Specified by:

getUser in interface KeycloakContext

Returns:

the UserModel bound to this context.