Package 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	Description
static DefaultClientSessionContext	fromClientSessionAndClientScopes(AuthenticatedClientSessionModel clientSession, Set<ClientScopeModel> requestedScopes, 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)
AuthorizationRequestContext	getAuthorizationRequestContext()
Set<String>	getClientScopeIds()
Stream<ClientScopeModel>	getClientScopesStream()	Returns client scopes as a stream.
AuthenticatedClientSessionModel	getClientSession()
Stream<ProtocolMapperModel>	getProtocolMappersStream()	Returns protocol mappers as a stream.
Stream<RoleModel>	getRolesStream()	Returns all roles including composite ones as a stream.
String	getScopeString()
String	getScopeString(boolean ignoreIncludeInTokenScope)
boolean	isOfflineTokenRequested()
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 Details

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)

fromClientSessionAndClientScopes

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

getClientSession

public AuthenticatedClientSessionModel getClientSession()

Specified by:

getClientSession in interface ClientSessionContext

getClientScopeIds

public Set<String> getClientScopeIds()

Specified by:

getClientScopeIds in interface ClientSessionContext

getClientScopesStream

public Stream<ClientScopeModel> getClientScopesStream()

Description copied from interface: ClientSessionContext

Returns client scopes as a stream.

Specified by:

getClientScopesStream in interface ClientSessionContext

Returns:

Stream of client scopes. Never returns null.

isOfflineTokenRequested

public boolean isOfflineTokenRequested()

Specified by:

isOfflineTokenRequested in interface ClientSessionContext

Returns:

true if offline token is requested

getRolesStream

public Stream<RoleModel> getRolesStream()

Description copied from interface: ClientSessionContext

Returns all roles including composite ones as a stream.

Specified by:

getRolesStream in interface ClientSessionContext

Returns:

Stream of RoleModel. Never returns null.

getProtocolMappersStream

public Stream<ProtocolMapperModel> getProtocolMappersStream()

Description copied from interface: ClientSessionContext

Returns protocol mappers as a stream.

Specified by:

getProtocolMappersStream in interface ClientSessionContext

Returns:

Stream of protocol mappers. Never returns null.

getScopeString

public String getScopeString()

Specified by:

getScopeString in interface ClientSessionContext

getScopeString

public String getScopeString(boolean ignoreIncludeInTokenScope)

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

getAuthorizationRequestContext

public AuthorizationRequestContext getAuthorizationRequestContext()

Specified by:

getAuthorizationRequestContext in interface ClientSessionContext