Package org.keycloak.protocol.oidc.mappers

Class AbstractOIDCProtocolMapper

java.lang.Object

org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

All Implemented Interfaces:

org.keycloak.protocol.ProtocolMapper, org.keycloak.provider.ConfiguredProvider, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<org.keycloak.protocol.ProtocolMapper>

Direct Known Subclasses:

AbstractPairwiseSubMapper, AcrProtocolMapper, AddressMapper, AllowedWebOriginsProtocolMapper, AudienceProtocolMapper, AudienceResolveProtocolMapper, ClaimsParameterTokenMapper, ClaimsParameterWithValueIdTokenMapper, FullNameMapper, GroupMembershipMapper, HardcodedClaim, HardcodedRole, RoleNameMapper, ScriptBasedOIDCProtocolMapper, UserAttributeMapper, UserClientRoleMappingMapper, UserPropertyMapper, UserRealmRoleMappingMapper, UserSessionNoteMapper

public abstract class AbstractOIDCProtocolMapper
extends Object
implements org.keycloak.protocol.ProtocolMapper

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
static String	TOKEN_MAPPER_CATEGORY

Constructor Summary

Constructors

Constructor	Description
AbstractOIDCProtocolMapper()

Method Summary

Modifier and Type	Method	Description
void	close()
org.keycloak.protocol.ProtocolMapper	create(org.keycloak.models.KeycloakSession session)
String	getProtocol()
void	init(org.keycloak.Config.Scope config)
void	postInit(org.keycloak.models.KeycloakSessionFactory factory)
protected void	setClaim(org.keycloak.representations.AccessTokenResponse accessTokenResponse, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.KeycloakSession keycloakSession, org.keycloak.models.ClientSessionContext clientSessionCtx)	Intended to be overridden in ProtocolMapper implementations to add claims to an token.
protected void	setClaim(org.keycloak.representations.IDToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.UserSessionModel userSession)	Deprecated. override setClaim(IDToken, ProtocolMapperModel, UserSessionModel, KeycloakSession, ClientSessionContext) instead.
protected void	setClaim(org.keycloak.representations.IDToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.KeycloakSession keycloakSession, org.keycloak.models.ClientSessionContext clientSessionCtx)	Intended to be overridden in ProtocolMapper implementations to add claims to an token.
org.keycloak.representations.AccessToken	transformAccessToken(org.keycloak.representations.AccessToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.KeycloakSession session, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.ClientSessionContext clientSessionCtx)
org.keycloak.representations.AccessTokenResponse	transformAccessTokenResponse(org.keycloak.representations.AccessTokenResponse accessTokenResponse, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.KeycloakSession session, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.ClientSessionContext clientSessionCtx)
org.keycloak.representations.IDToken	transformIDToken(org.keycloak.representations.IDToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.KeycloakSession session, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.ClientSessionContext clientSessionCtx)
org.keycloak.representations.AccessToken	transformUserInfoToken(org.keycloak.representations.AccessToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.KeycloakSession session, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.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

getConfigMetadata, getId, order

Field Detail

TOKEN_MAPPER_CATEGORY

public static final String TOKEN_MAPPER_CATEGORY

See Also:

Constant Field Values

Constructor Detail

AbstractOIDCProtocolMapper

public AbstractOIDCProtocolMapper()

Method Detail

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface org.keycloak.protocol.ProtocolMapper

close

public void close()

Specified by:

close in interface org.keycloak.provider.Provider

Specified by:

close in interface org.keycloak.provider.ProviderFactory<org.keycloak.protocol.ProtocolMapper>

create

public final org.keycloak.protocol.ProtocolMapper create(org.keycloak.models.KeycloakSession session)

Specified by:

create in interface org.keycloak.provider.ProviderFactory<org.keycloak.protocol.ProtocolMapper>

init

public void init(org.keycloak.Config.Scope config)

Specified by:

init in interface org.keycloak.provider.ProviderFactory<org.keycloak.protocol.ProtocolMapper>

postInit

public void postInit(org.keycloak.models.KeycloakSessionFactory factory)

Specified by:

postInit in interface org.keycloak.provider.ProviderFactory<org.keycloak.protocol.ProtocolMapper>

transformUserInfoToken

public org.keycloak.representations.AccessToken transformUserInfoToken(org.keycloak.representations.AccessToken token,
                                                                       org.keycloak.models.ProtocolMapperModel mappingModel,
                                                                       org.keycloak.models.KeycloakSession session,
                                                                       org.keycloak.models.UserSessionModel userSession,
                                                                       org.keycloak.models.ClientSessionContext clientSessionCtx)

transformAccessToken

public org.keycloak.representations.AccessToken transformAccessToken(org.keycloak.representations.AccessToken token,
                                                                     org.keycloak.models.ProtocolMapperModel mappingModel,
                                                                     org.keycloak.models.KeycloakSession session,
                                                                     org.keycloak.models.UserSessionModel userSession,
                                                                     org.keycloak.models.ClientSessionContext clientSessionCtx)

transformIDToken

public org.keycloak.representations.IDToken transformIDToken(org.keycloak.representations.IDToken token,
                                                             org.keycloak.models.ProtocolMapperModel mappingModel,
                                                             org.keycloak.models.KeycloakSession session,
                                                             org.keycloak.models.UserSessionModel userSession,
                                                             org.keycloak.models.ClientSessionContext clientSessionCtx)

transformAccessTokenResponse

public org.keycloak.representations.AccessTokenResponse transformAccessTokenResponse(org.keycloak.representations.AccessTokenResponse accessTokenResponse,
                                                                                     org.keycloak.models.ProtocolMapperModel mappingModel,
                                                                                     org.keycloak.models.KeycloakSession session,
                                                                                     org.keycloak.models.UserSessionModel userSession,
                                                                                     org.keycloak.models.ClientSessionContext clientSessionCtx)

setClaim

@Deprecated
protected void setClaim(org.keycloak.representations.IDToken token,
                        org.keycloak.models.ProtocolMapperModel mappingModel,
                        org.keycloak.models.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(org.keycloak.representations.IDToken token,
                        org.keycloak.models.ProtocolMapperModel mappingModel,
                        org.keycloak.models.UserSessionModel userSession,
                        org.keycloak.models.KeycloakSession keycloakSession,
                        org.keycloak.models.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(org.keycloak.representations.AccessTokenResponse accessTokenResponse,
                        org.keycloak.models.ProtocolMapperModel mappingModel,
                        org.keycloak.models.UserSessionModel userSession,
                        org.keycloak.models.KeycloakSession keycloakSession,
                        org.keycloak.models.ClientSessionContext clientSessionCtx)

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

Parameters:

accessTokenResponse -

mappingModel -

userSession -

keycloakSession -

clientSessionCtx -