Package org.keycloak.protocol.oidc.mappers

Class UserSessionNoteMapper

java.lang.Object

org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

org.keycloak.protocol.oidc.mappers.UserSessionNoteMapper

All Implemented Interfaces:

OIDCAccessTokenMapper, OIDCAccessTokenResponseMapper, OIDCIDTokenMapper, TokenIntrospectionTokenMapper, UserInfoTokenMapper, ProtocolMapper, ConfiguredProvider, Provider, ProviderFactory<ProtocolMapper>

public class UserSessionNoteMapper
extends AbstractOIDCProtocolMapper
implements OIDCAccessTokenMapper, OIDCIDTokenMapper, OIDCAccessTokenResponseMapper, UserInfoTokenMapper, TokenIntrospectionTokenMapper

Mappings UserSessionModel.note to an ID Token claim.

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_ID

Fields inherited from class org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

TOKEN_MAPPER_CATEGORY

Constructor Summary

Constructors

Constructor	Description
UserSessionNoteMapper()

Method Summary

Modifier and Type	Method	Description
static ProtocolMapperModel	createClaimMapper(String name, String userSessionNote, String tokenClaimName, String jsonType, boolean accessToken, boolean idToken, boolean introspectionEndpoint)
static ProtocolMapperModel	createClaimMapper(String name, String userSessionNote, String tokenClaimName, String jsonType, boolean accessToken, boolean idToken, boolean userInfo, boolean introspectionEndpoint)
static ProtocolMapperModel	createUserSessionNoteMapper(UserSessionNoteDescriptor userSessionNoteDescriptor)	For session notes defined using a UserSessionNoteDescriptor enum
List<ProviderConfigProperty>	getConfigProperties()
String	getDisplayCategory()
String	getDisplayType()
String	getHelpText()
String	getId()
protected void	setClaim(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)	Intended to be overridden in ProtocolMapper implementations to add claims to an token.
protected void	setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)	Intended to be overridden in ProtocolMapper implementations to add claims to an token.

Methods inherited from class org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

close, create, getEffectiveModel, getProtocol, getShouldUseLightweightToken, init, postInit, setClaim, transformAccessToken, transformAccessTokenResponse, transformIDToken, transformIntrospectionToken, transformUserInfoToken

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.protocol.oidc.mappers.OIDCAccessTokenMapper

transformAccessToken

Methods inherited from interface org.keycloak.protocol.oidc.mappers.OIDCAccessTokenResponseMapper

transformAccessTokenResponse

Methods inherited from interface org.keycloak.protocol.oidc.mappers.OIDCIDTokenMapper

transformIDToken

Methods inherited from interface org.keycloak.protocol.ProtocolMapper

getPriority, validateConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Methods inherited from interface org.keycloak.protocol.oidc.mappers.TokenIntrospectionTokenMapper

transformIntrospectionToken

Methods inherited from interface org.keycloak.protocol.oidc.mappers.UserInfoTokenMapper

transformUserInfoToken

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

Constructor Details

UserSessionNoteMapper

public UserSessionNoteMapper()

Method Details

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

getId

public String getId()

Specified by:

getId in interface ProviderFactory<ProtocolMapper>

getDisplayType

public String getDisplayType()

Specified by:

getDisplayType in interface ProtocolMapper

getDisplayCategory

public String getDisplayCategory()

Specified by:

getDisplayCategory in interface ProtocolMapper

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

setClaim

protected void setClaim(IDToken token,
 ProtocolMapperModel mappingModel,
 UserSessionModel userSession)

Description copied from class: AbstractOIDCProtocolMapper

Intended to be overridden in ProtocolMapper implementations to add claims to an token.

Overrides:

setClaim in class AbstractOIDCProtocolMapper

setClaim

protected void setClaim(AccessTokenResponse accessTokenResponse,
 ProtocolMapperModel mappingModel,
 UserSessionModel userSession,
 KeycloakSession keycloakSession,
 ClientSessionContext clientSessionCtx)

Description copied from class: AbstractOIDCProtocolMapper

Intended to be overridden in ProtocolMapper implementations to add claims to an token.

Overrides:

setClaim in class AbstractOIDCProtocolMapper

createClaimMapper

public static ProtocolMapperModel createClaimMapper(String name,
 String userSessionNote,
 String tokenClaimName,
 String jsonType,
 boolean accessToken,
 boolean idToken,
 boolean introspectionEndpoint)

createClaimMapper

public static ProtocolMapperModel createClaimMapper(String name,
 String userSessionNote,
 String tokenClaimName,
 String jsonType,
 boolean accessToken,
 boolean idToken,
 boolean userInfo,
 boolean introspectionEndpoint)

createUserSessionNoteMapper

public static ProtocolMapperModel createUserSessionNoteMapper(UserSessionNoteDescriptor userSessionNoteDescriptor)

For session notes defined using a UserSessionNoteDescriptor enum

Parameters:

userSessionNoteDescriptor - User session note descriptor for which to create a protocol mapper model.