org.keycloak.services.util

Class DefaultClientSessionContext

java.lang.Object

org.keycloak.services.util.DefaultClientSessionContext

All Implemented Interfaces:

ClientSessionContext

public class DefaultClientSessionContext
extends Object
implements ClientSessionContext

Not thread safe. It's per-request object

Author:

Marek Posolda

Method Summary

Modifier and Type	Method and Description
static DefaultClientSessionContext	fromClientSessionAndClientScopeIds(AuthenticatedClientSessionModel clientSession, Set<String> clientScopeIds, KeycloakSession session)
static DefaultClientSessionContext	fromClientSessionAndClientScopes(AuthenticatedClientSessionModel clientSession, Set<ClientScopeModel> clientScopes, KeycloakSession session)
static DefaultClientSessionContext	fromClientSessionAndScopeParameter(AuthenticatedClientSessionModel clientSession, String scopeParam, KeycloakSession session)
static DefaultClientSessionContext	fromClientSessionScopeParameter(AuthenticatedClientSessionModel clientSession, KeycloakSession session) Useful if we want to "re-compute" client scopes based on the scope parameter
<T> T	getAttribute(String name, Class<T> clazz)
Set<String>	getClientScopeIds()
Set<ClientScopeModel>	getClientScopes()
AuthenticatedClientSessionModel	getClientSession()
Set<ProtocolMapperModel>	getProtocolMappers()
Set<RoleModel>	getRoles()
String	getScopeString()
void	setAttribute(String name, Object value)

Methods inherited from class java.lang.Object

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

Method Detail

fromClientSessionScopeParameter

public static DefaultClientSessionContext fromClientSessionScopeParameter(AuthenticatedClientSessionModel clientSession,
                                                                          KeycloakSession session)

Useful if we want to "re-compute" client scopes based on the scope parameter

fromClientSessionAndScopeParameter

public static DefaultClientSessionContext fromClientSessionAndScopeParameter(AuthenticatedClientSessionModel clientSession,
                                                                             String scopeParam,
                                                                             KeycloakSession session)

fromClientSessionAndClientScopeIds

public static DefaultClientSessionContext fromClientSessionAndClientScopeIds(AuthenticatedClientSessionModel clientSession,
                                                                             Set<String> clientScopeIds,
                                                                             KeycloakSession session)

fromClientSessionAndClientScopes

public static DefaultClientSessionContext fromClientSessionAndClientScopes(AuthenticatedClientSessionModel clientSession,
                                                                           Set<ClientScopeModel> clientScopes,
                                                                           KeycloakSession session)

getClientSession

public AuthenticatedClientSessionModel getClientSession()

Specified by:

getClientSession in interface ClientSessionContext

getClientScopeIds

public Set<String> getClientScopeIds()

Specified by:

getClientScopeIds in interface ClientSessionContext

getClientScopes

public Set<ClientScopeModel> getClientScopes()

Specified by:

getClientScopes in interface ClientSessionContext

getRoles

public Set<RoleModel> getRoles()

Specified by:

getRoles in interface ClientSessionContext

Returns:

expanded roles (composite roles already applied)

getProtocolMappers

public Set<ProtocolMapperModel> getProtocolMappers()

Specified by:

getProtocolMappers in interface ClientSessionContext

getScopeString

public String getScopeString()

Specified by:

getScopeString in interface ClientSessionContext

setAttribute

public void setAttribute(String name,
                         Object value)

Specified by:

setAttribute in interface ClientSessionContext

getAttribute

public <T> T getAttribute(String name,
                          Class<T> clazz)

Specified by:

getAttribute in interface ClientSessionContext