Package org.keycloak.protocol.oidc.mappers

Class AbstractOIDCProtocolMapper

java.lang.Object

org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

All Implemented Interfaces:

ProtocolMapper, ConfiguredProvider, Provider, ProviderFactory<ProtocolMapper>

Direct Known Subclasses:

AbstractPairwiseSubMapper, AbstractUserRoleMappingMapper, AcrProtocolMapper, AddressMapper, AllowedWebOriginsProtocolMapper, AmrProtocolMapper, AudienceProtocolMapper, AudienceResolveProtocolMapper, ClaimsParameterTokenMapper, ClaimsParameterWithValueIdTokenMapper, FullNameMapper, GroupMembershipMapper, HardcodedClaim, HardcodedRole, OrganizationMembershipMapper, RoleNameMapper, ScriptBasedOIDCProtocolMapper, SessionStateMapper, SubMapper, UserAttributeMapper, UserPropertyMapper, UserSessionNoteMapper

public abstract class AbstractOIDCProtocolMapper
extends Object
implements ProtocolMapper

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TOKEN_MAPPER_CATEGORY

Constructor Summary

Constructors

Constructor	Description
AbstractOIDCProtocolMapper()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
final ProtocolMapper	create(KeycloakSession session)
ProtocolMapperModel	getEffectiveModel(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel)	Get effective configuration of protocol mapper.
String	getProtocol()
static boolean	getShouldUseLightweightToken(KeycloakSession session)
void	init(Config.Scope config)	Only called once when the factory is first created.
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized
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)	Deprecated. override setClaim(IDToken, ProtocolMapperModel, UserSessionModel, KeycloakSession, ClientSessionContext) instead.
protected void	setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)	Intended to be overridden in ProtocolMapper implementations to add claims to an token.
AccessToken	transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessTokenResponse	transformAccessTokenResponse(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
IDToken	transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	transformIntrospectionToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	transformUserInfoToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)

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, getConfigProperties, getHelpText

Methods inherited from interface org.keycloak.protocol.ProtocolMapper

getDisplayCategory, getDisplayType, getPriority, validateConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, getId, order

Field Details

TOKEN_MAPPER_CATEGORY

public static final String TOKEN_MAPPER_CATEGORY

See Also:

• Constant Field Values

Constructor Details

AbstractOIDCProtocolMapper

public AbstractOIDCProtocolMapper()

Method Details

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface ProtocolMapper

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<ProtocolMapper>

create

public final ProtocolMapper create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<ProtocolMapper>

init

public void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created.

Specified by:

init in interface ProviderFactory<ProtocolMapper>

postInit

public void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<ProtocolMapper>

transformUserInfoToken

public AccessToken transformUserInfoToken(AccessToken token,
 ProtocolMapperModel mappingModel,
 KeycloakSession session,
 UserSessionModel userSession,
 ClientSessionContext clientSessionCtx)

getShouldUseLightweightToken

public static boolean getShouldUseLightweightToken(KeycloakSession session)

transformAccessToken

public AccessToken transformAccessToken(AccessToken token,
 ProtocolMapperModel mappingModel,
 KeycloakSession session,
 UserSessionModel userSession,
 ClientSessionContext clientSessionCtx)

transformIDToken

public IDToken transformIDToken(IDToken token,
 ProtocolMapperModel mappingModel,
 KeycloakSession session,
 UserSessionModel userSession,
 ClientSessionContext clientSessionCtx)

transformAccessTokenResponse

public AccessTokenResponse transformAccessTokenResponse(AccessTokenResponse accessTokenResponse,
 ProtocolMapperModel mappingModel,
 KeycloakSession session,
 UserSessionModel userSession,
 ClientSessionContext clientSessionCtx)

transformIntrospectionToken

public AccessToken transformIntrospectionToken(AccessToken token,
 ProtocolMapperModel mappingModel,
 KeycloakSession session,
 UserSessionModel userSession,
 ClientSessionContext clientSessionCtx)

setClaim

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

Deprecated.

override setClaim(IDToken, ProtocolMapperModel, UserSessionModel, KeycloakSession, ClientSessionContext) instead.

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

Parameters:

token -

mappingModel -

userSession -

setClaim

protected void setClaim(IDToken token,
 ProtocolMapperModel mappingModel,
 UserSessionModel userSession,
 KeycloakSession keycloakSession,
 ClientSessionContext clientSessionCtx)

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

Parameters:

token -

mappingModel -

userSession -

keycloakSession -

clientSessionCtx -

setClaim

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.

Parameters:

accessTokenResponse -

mappingModel -

userSession -

keycloakSession -

clientSessionCtx -

getEffectiveModel

public ProtocolMapperModel getEffectiveModel(KeycloakSession session,
 RealmModel realm,
 ProtocolMapperModel protocolMapperModel)

Description copied from interface: ProtocolMapper

Get effective configuration of protocol mapper. Effective configuration takes "default values" of the options into consideration and hence it is the configuration, which would be actually used when processing this protocolMapper during issuing tokens/assertions. So for instance, when configuration option "introspection.token.claim" is unset in the protocolMapperModel, but default value of this option is supposed to be "true", then effective config returned by this method will contain "introspection.token.claim" config option with value "true" . If the "introspection.token.claim" is set, then the default value is typically ignored in the effective configuration, but this can depend on the implementation of particular protocol mapper.

Specified by:

getEffectiveModel in interface ProtocolMapper