org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper の継承関係図

org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper 連携図

公開メンバ関数
String	getProtocol ()

void	close ()

final ProtocolMapper	create (KeycloakSession session)

void	init (Config.Scope config)

void	postInit (KeycloakSessionFactory factory)

AccessToken	transformUserInfoToken (AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)

AccessToken	transformAccessToken (AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)

IDToken	transformIDToken (IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)

String	getDisplayCategory ()

String	getDisplayType ()

default void	validateConfig (KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel) throws ProtocolMapperConfigException

String	getId ()

default int	order ()

String	getHelpText ()

List< ProviderConfigProperty >	getConfigProperties ()

静的公開変数類
static final String	TOKEN_MAPPER_CATEGORY = "Token mapper"

限定公開メンバ関数
void	setClaim (IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)

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

詳解

著者: Bill Burke

バージョン

Revision: 1

関数詳解

◆ close()

void org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.close ( )

inline

org.keycloak.provider.Providerを実装しています。

                         {
 
     }

◆ create()

final ProtocolMapper org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.create ( KeycloakSession session )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                                 {
         throw new RuntimeException("UNSUPPORTED METHOD");
     }

◆ getConfigProperties()

List<ProviderConfigProperty> org.keycloak.provider.ConfiguredProvider.getConfigProperties ( )

inherited

◆ getDisplayCategory()

String org.keycloak.protocol.ProtocolMapper.getDisplayCategory ( )

inherited

◆ getDisplayType()

String org.keycloak.protocol.ProtocolMapper.getDisplayType ( )

inherited

◆ getHelpText()

String org.keycloak.provider.ConfiguredProvider.getHelpText ( )

inherited

◆ getId()

String org.keycloak.provider.ProviderFactory< T extends Provider >.getId ( )

inherited

◆ getProtocol()

String org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.getProtocol ( )

inline

org.keycloak.protocol.ProtocolMapperを実装しています。

                                 {
         return OIDCLoginProtocol.LOGIN_PROTOCOL;
     }

◆ init()

void org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.init ( Config.Scope config )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

55 {

56 }

◆ order()

default int org.keycloak.provider.ProviderFactory< T extends Provider >.order ( )

inlineinherited

org.keycloak.protocol.docker.DockerAuthV2ProtocolFactory, org.keycloak.urls.HostnameProviderFactory, org.keycloak.protocol.oidc.ext.OIDCExtProviderFactoryで実装されています。

                         {
         return 0;
     }

◆ postInit()

void org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.postInit ( KeycloakSessionFactory factory )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                          {
 
     }

◆ setClaim() [1/2]

void org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.setClaim	(	IDToken	token,
		ProtocolMapperModel	mappingModel,
		UserSessionModel	userSession
	)

inlineprotected

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

引数

token
mappingModel
userSession

非推奨:: override setClaim(IDToken, ProtocolMapperModel, UserSessionModel, KeycloakSession) instead.

105 {

106 }

◆ setClaim() [2/2]

void org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.setClaim	(	IDToken	token,
		ProtocolMapperModel	mappingModel,
		UserSessionModel	userSession,
		KeycloakSession	keycloakSession
	)

inlineprotected

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

引数

token
mappingModel
userSession
keycloakSession

                                                                                                                                             {
         // we delegate to the old #setClaim(...) method for backwards compatibility
         setClaim(token, mappingModel, userSession);
     }

◆ transformAccessToken()

AccessToken org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.transformAccessToken	(	AccessToken	token,
		ProtocolMapperModel	mappingModel,
		KeycloakSession	session,
		UserSessionModel	userSession,
		AuthenticatedClientSessionModel	clientSession
	)

inline

                                                                                                                          {
 
         if (!OIDCAttributeMapperHelper.includeInAccessToken(mappingModel)){
             return token;
         }
 
         setClaim(token, mappingModel, userSession, session);
         return token;
     }

◆ transformIDToken()

IDToken org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.transformIDToken	(	IDToken	token,
		ProtocolMapperModel	mappingModel,
		KeycloakSession	session,
		UserSessionModel	userSession,
		AuthenticatedClientSessionModel	clientSession
	)

inline

                                                                                                                  {
 
         if (!OIDCAttributeMapperHelper.includeInIDToken(mappingModel)){
             return token;
         }
 
         setClaim(token, mappingModel, userSession, session);
         return token;
     }

◆ transformUserInfoToken()

AccessToken org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.transformUserInfoToken	(	AccessToken	token,
		ProtocolMapperModel	mappingModel,
		KeycloakSession	session,
		UserSessionModel	userSession,
		AuthenticatedClientSessionModel	clientSession
	)

inline

                                                                                                                            {
 
         if (!OIDCAttributeMapperHelper.includeInUserInfo(mappingModel)) {
             return token;
         }
 
         setClaim(token, mappingModel, userSession, session);
         return token;
     }

◆ validateConfig()

default void org.keycloak.protocol.ProtocolMapper.validateConfig	(	KeycloakSession	session,
		RealmModel	realm,
		ProtocolMapperContainerModel	client,
		ProtocolMapperModel	mapperModel
	)		throws ProtocolMapperConfigException

inlineinherited

Called when instance of mapperModel is created/updated for this protocolMapper through admin endpoint

引数

session
realm
client	client or clientTemplate
mapperModel

例外

ProtocolMapperConfigException if configuration provided in mapperModel is not valid

org.keycloak.protocol.saml.mappers.ScriptBasedMapper, org.keycloak.protocol.oidc.mappers.ScriptBasedOIDCProtocolMapper, org.keycloak.protocol.oidc.mappers.AbstractPairwiseSubMapperで実装されています。

46 {

47 };

メンバ詳解

◆ TOKEN_MAPPER_CATEGORY

final String org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.TOKEN_MAPPER_CATEGORY = "Token mapper"

static

このクラス詳解は次のファイルから抽出されました:

D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/protocol/oidc/mappers/AbstractOIDCProtocolMapper.java

公開メンバ関数

静的公開変数類

限定公開メンバ関数

詳解

関数詳解

◆ close()

◆ create()

◆ getConfigProperties()

◆ getDisplayCategory()

◆ getDisplayType()

◆ getHelpText()

◆ getId()

◆ getProtocol()

◆ init()

◆ order()

◆ postInit()

◆ setClaim() [1/2]

◆ setClaim() [2/2]

◆ transformAccessToken()

◆ transformIDToken()

◆ transformUserInfoToken()

◆ validateConfig()

メンバ詳解

◆ TOKEN_MAPPER_CATEGORY