org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper の継承関係図

org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper 連携図

公開メンバ関数
List< ProviderConfigProperty >	getConfigProperties ()

String	getDisplayCategory ()

String	getDisplayType ()

String	getHelpText ()

void	preprocessFederatedIdentity (KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)

void	updateBrokeredUser (KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)

void	close ()

IdentityProviderMapper	create (KeycloakSession session)

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

void	init (Config.Scope config)

void	postInit (KeycloakSessionFactory factory)

void	importNewUser (KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)

String []	getCompatibleProviders ()

String	getId ()

default int	order ()

静的公開メンバ関数
static void	storeUserProfileForMapper (BrokeredIdentityContext user, JsonNode profile, String provider)

static Object	getJsonValue (JsonNode baseNode, String fieldPath)

静的公開変数類
static final String	CONF_JSON_FIELD = "jsonField"

static final String	CONF_USER_ATTRIBUTE = "userAttribute"

static final String	CONTEXT_JSON_NODE = OIDCIdentityProvider.USER_INFO

static final String	ANY_PROVIDER = "*"

静的限定公開メンバ関数
static Object	getJsonValue (IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)

静的限定公開変数類
static final Logger	logger = Logger.getLogger(AbstractJsonUserAttributeMapper.class)

static final Logger	LOGGER_DUMP_USER_PROFILE = Logger.getLogger("org.keycloak.social.user_profile_dump")

静的関数
	[static initializer]

静的非公開変数類
static final String	JSON_PATH_DELIMITER = "."

static final List< ProviderConfigProperty >	configProperties = new ArrayList<ProviderConfigProperty>()

詳解

Abstract class for Social Provider mappers which allow mapping of JSON user profile field into Keycloak user attribute. Concrete mapper classes with own ID and provider mapping must be implemented for each social provider who uses JsonNode user profile.

著者: Vlastimil Elias (velias at redhat dot com)

関数詳解

◆ [static initializer]()

org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper.[static initializer] ( )

inlinestaticpackage

◆ close()

void org.keycloak.broker.provider.AbstractIdentityProviderMapper.close ( )

inlineinherited

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

                         {
 
     }

◆ create()

IdentityProviderMapper org.keycloak.broker.provider.AbstractIdentityProviderMapper.create ( KeycloakSession session )

inlineinherited

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

                                                                   {
         return null;
     }

◆ getCompatibleProviders()

String [] org.keycloak.broker.provider.IdentityProviderMapper.getCompatibleProviders ( )

inherited

org.keycloak.broker.oidc.mappers.ClaimToRoleMapper, org.keycloak.broker.oidc.mappers.UserAttributeMapper, org.keycloak.broker.provider.HardcodedAttributeMapper, org.keycloak.broker.provider.HardcodedUserSessionAttributeMapper, org.keycloak.broker.oidc.mappers.ExternalKeycloakRoleToRoleMapper, org.keycloak.broker.provider.HardcodedRoleMapper, org.keycloak.broker.oidc.mappers.UsernameTemplateMapperで実装されています。

◆ getConfigProperties()

List<ProviderConfigProperty> org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper.getConfigProperties ( )

inline

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

                                                                   {
                 return configProperties;
         }

◆ getDisplayCategory()

String org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper.getDisplayCategory ( )

inline

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

                                            {
                 return "Attribute Importer";
         }

◆ getDisplayType()

String org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper.getDisplayType ( )

inline

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

                                        {
                 return "Attribute Importer";
         }

◆ getHelpText()

String org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper.getHelpText ( )

inline

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

                                     {
                 return "Import user profile information if it exists in Social provider JSON data into the specified user attribute.";
         }

◆ getId()

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

inherited

◆ getJsonValue() [1/2]

static Object org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper.getJsonValue	(	IdentityProviderMapperModel	mapperModel,
		BrokeredIdentityContext	context
	)

inlinestaticprotected

                                                                                                                        {
 
                 String jsonField = mapperModel.getConfig().get(CONF_JSON_FIELD);
                 if (jsonField == null || jsonField.trim().isEmpty()) {
                         logger.warnf("JSON field path is not configured for mapper %s", mapperModel.getName());
                         return null;
                 }
                 jsonField = jsonField.trim();
 
                 if (jsonField.startsWith(JSON_PATH_DELIMITER) || jsonField.endsWith(JSON_PATH_DELIMITER) || jsonField.startsWith("[")) {
                         logger.warnf("JSON field path is invalid %s", jsonField);
                         return null;
                 }
 
                 JsonNode profileJsonNode = (JsonNode) context.getContextData().get(CONTEXT_JSON_NODE);
 
                 Object value = getJsonValue(profileJsonNode, jsonField);
 
                 if (value == null) {
                         logger.debugf("User profile JSON value '%s' is not available.", jsonField);
                 }
 
                 return value;
         }

◆ getJsonValue() [2/2]

static Object org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper.getJsonValue	(	JsonNode	baseNode,
		String	fieldPath
	)

inlinestatic

                                                                                {
                 logger.debug("Going to process JsonNode path " + fieldPath + " on data " + baseNode);
                 if (baseNode != null) {
 
                         int idx = fieldPath.indexOf(JSON_PATH_DELIMITER);
 
                         String currentFieldName = fieldPath;
                         if (idx > 0) {
                                 currentFieldName = fieldPath.substring(0, idx).trim();
                                 if (currentFieldName.isEmpty()) {
                                         logger.debug("JSON path is invalid " + fieldPath);
                                         return null;
                                 }
                         }
 
                         String currentNodeName = currentFieldName;
                         int arrayIndex = -1;
                         if (currentFieldName.endsWith("]")) {
                                 int bi = currentFieldName.indexOf("[");
                                 if (bi == -1) {
                                         logger.debug("Invalid array index construct in " + currentFieldName);
                                         return null;
                                 }
                                 try {
                                 String is = currentFieldName.substring(bi+1, currentFieldName.length() - 1).trim();
                                         arrayIndex = Integer.parseInt(is);
                                 } catch (Exception e) {
                                         logger.debug("Invalid array index construct in " + currentFieldName);
                                         return null;
                                 }
                                 currentNodeName = currentFieldName.substring(0,bi).trim();
                         }
 
                         JsonNode currentNode = baseNode.get(currentNodeName);
                         if (arrayIndex > -1 && currentNode.isArray()) {
                                 logger.debug("Going to take array node at index " + arrayIndex);
                                 currentNode = currentNode.get(arrayIndex);
                         }
 
                         if (currentNode == null) {
                                 logger.debug("JsonNode not found for name " + currentFieldName);
                                 return null;
                         }
 
                         if (idx < 0) {
                                 if (currentNode.isArray()) {
                                         List<String> values = new ArrayList<>();
                                         for (JsonNode childNode : currentNode) {
                                                 if (childNode.isTextual()) {
                                                         values.add(childNode.textValue());
                                                 } else {
                                                         logger.warn("JsonNode in array is not text value " + childNode);
                                                 }
                                         }
                                         if (values.isEmpty()) {
                                                 return null;
                                         }
                                         return arrayIndex == idx? values : null;
                                 }
                                 if (!currentNode.isValueNode() || currentNode.isNull()) {
                                         logger.debug("JsonNode is not value node for name " + currentFieldName);
                                         return null;
                                 }
                                 String ret = currentNode.asText();
                                 if (ret != null && !ret.trim().isEmpty())
                                         return ret.trim();
                         } else {
                                 return getJsonValue(currentNode, fieldPath.substring(idx + 1));
                         }
                 }
                 return null;
         }

◆ importNewUser()

void org.keycloak.broker.provider.AbstractIdentityProviderMapper.importNewUser	(	KeycloakSession	session,
		RealmModel	realm,
		UserModel	user,
		IdentityProviderMapperModel	mapperModel,
		BrokeredIdentityContext	context
	)

inlineinherited

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

                                                                                                                                                                    {
 
     }

◆ init() [1/2]

void org.keycloak.provider.ProviderFactory< T extends Provider >.init ( Config.Scope config )

inherited

Only called once when the factory is first created. This config is pulled from keycloak_server.json

引数

config

◆ init() [2/2]

void org.keycloak.broker.provider.AbstractIdentityProviderMapper.init ( org.keycloak.Config.Scope config )

inlineinherited

                                                        {
 
     }

◆ order()

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

inlineinherited

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

                         {
         return 0;
     }

◆ postInit()

void org.keycloak.broker.provider.AbstractIdentityProviderMapper.postInit ( KeycloakSessionFactory factory )

inlineinherited

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

                                                          {
 
     }

◆ preprocessFederatedIdentity()

void org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper.preprocessFederatedIdentity	(	KeycloakSession	session,
		RealmModel	realm,
		IdentityProviderMapperModel	mapperModel,
		BrokeredIdentityContext	context
	)

inline

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

                                                                                                                                                                      {
                 String attribute = mapperModel.getConfig().get(CONF_USER_ATTRIBUTE);
                 if (attribute == null || attribute.trim().isEmpty()) {
                         logger.warnf("Attribute is not configured for mapper %s", mapperModel.getName());
                         return;
                 }
                 attribute = attribute.trim();
 
                 Object value = getJsonValue(mapperModel, context);
                 if (value != null) {
                         if (value instanceof List) {
                                 context.setUserAttribute(attribute, (List<String>) value);
                         } else {
                                 context.setUserAttribute(attribute, value.toString());
                         }
                 }
         }

◆ storeUserProfileForMapper()

static void org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper.storeUserProfileForMapper	(	BrokeredIdentityContext	user,
		JsonNode	profile,
		String	provider
	)

inlinestatic

Store used profile JsonNode into user context for later use by this mapper. Profile data are dumped into special logger if enabled also to allow investigation of the structure.

引数

user	context to store profile data into
profile	to store into context
provider	identification of social provider to be used in log dump

参照: preprocessFederatedIdentity(KeycloakSession, RealmModel, IdentityProviderMapperModel, BrokeredIdentityContext); BrokeredIdentityContext::getContextData()

                                                                                                                       {
                 user.getContextData().put(AbstractJsonUserAttributeMapper.CONTEXT_JSON_NODE, profile);
                 if (LOGGER_DUMP_USER_PROFILE.isDebugEnabled())
                         LOGGER_DUMP_USER_PROFILE.debug("User Profile JSON Data for provider "+provider+": " + profile);
         }

◆ updateBrokeredUser()

void org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper.updateBrokeredUser	(	KeycloakSession	session,
		RealmModel	realm,
		UserModel	user,
		IdentityProviderMapperModel	mapperModel,
		BrokeredIdentityContext	context
	)

inline

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

                                                                                                                                                                             {
                 // we do not update user profile from social provider
         }

メンバ詳解

◆ ANY_PROVIDER

final String org.keycloak.broker.provider.IdentityProviderMapper.ANY_PROVIDER = "*"

staticinherited

◆ CONF_JSON_FIELD

final String org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper.CONF_JSON_FIELD = "jsonField"

static

Config param where name of mapping source JSON User Profile field is stored.

◆ CONF_USER_ATTRIBUTE

final String org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper.CONF_USER_ATTRIBUTE = "userAttribute"

static

Config param where name of mapping target USer attribute is stored.

◆ configProperties

final List<ProviderConfigProperty> org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper.configProperties = new ArrayList<ProviderConfigProperty>()

staticprivate

◆ CONTEXT_JSON_NODE

final String org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper.CONTEXT_JSON_NODE = OIDCIdentityProvider.USER_INFO

static

Key in BrokeredIdentityContext#getContextData() where JsonNode with user profile is stored.

◆ JSON_PATH_DELIMITER

final String org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper.JSON_PATH_DELIMITER = "."

staticprivate

◆ logger

final Logger org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper.logger = Logger.getLogger(AbstractJsonUserAttributeMapper.class)

staticprotected

◆ LOGGER_DUMP_USER_PROFILE

final Logger org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper.LOGGER_DUMP_USER_PROFILE = Logger.getLogger("org.keycloak.social.user_profile_dump")

staticprotected

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

D:/AppData/doxygen/keycloak/oidc-service/src/main/java/org/keycloak/broker/oidc/mappers/AbstractJsonUserAttributeMapper.java

公開メンバ関数

静的公開メンバ関数

静的公開変数類

静的限定公開メンバ関数

静的限定公開変数類

静的関数

静的非公開変数類

詳解

関数詳解

◆ [static initializer]()

◆ close()

◆ create()

◆ getCompatibleProviders()

◆ getConfigProperties()

◆ getDisplayCategory()

◆ getDisplayType()

◆ getHelpText()

◆ getId()

◆ getJsonValue() [1/2]

◆ getJsonValue() [2/2]

◆ importNewUser()

◆ init() [1/2]

◆ init() [2/2]

◆ order()

◆ postInit()

◆ preprocessFederatedIdentity()

◆ storeUserProfileForMapper()

◆ updateBrokeredUser()

メンバ詳解

◆ ANY_PROVIDER

◆ CONF_JSON_FIELD

◆ CONF_USER_ATTRIBUTE

◆ configProperties

◆ CONTEXT_JSON_NODE

◆ JSON_PATH_DELIMITER

◆ logger

◆ LOGGER_DUMP_USER_PROFILE