org.keycloak.broker.oidc.mappers.UserAttributeMapper クラス

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

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

公開メンバ関数
List< ProviderConfigProperty >	getConfigProperties ()
String	getId ()
String []	getCompatibleProviders ()
String	getDisplayCategory ()
String	getDisplayType ()
void	preprocessFederatedIdentity (KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
void	updateBrokeredUser (KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
String	getHelpText ()
boolean	valueEquals (String desiredValue, Object value)

静的公開メンバ関数
static Object	getClaimValue (JsonWebToken token, String claim)
static Object	getClaimValue (IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
static Object	getClaimValue (BrokeredIdentityContext context, String claim)

静的公開変数類
static final String []	COMPATIBLE_PROVIDERS = {KeycloakOIDCIdentityProviderFactory.PROVIDER_ID, OIDCIdentityProviderFactory.PROVIDER_ID}
static final String	USER_ATTRIBUTE = "user.attribute"
static final String	EMAIL = "email"
static final String	FIRST_NAME = "firstName"
static final String	LAST_NAME = "lastName"
static final String	PROVIDER_ID = "oidc-user-attribute-idp-mapper"
static final String	CLAIM = "claim"
static final String	CLAIM_VALUE = "claim.value"

限定公開メンバ関数
boolean	hasClaimValue (IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)

静的関数
	[static initializer]

非公開メンバ関数
void	setIfNotEmpty (Consumer< String > consumer, List< String > values)
List< String >	toList (Object value)

静的非公開変数類
static final List< ProviderConfigProperty >	configProperties = new ArrayList<>()

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

[static initializer]()

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

inlinestaticpackage

getClaimValue() [1/3]

static Object org.keycloak.broker.oidc.mappers.AbstractClaimMapper.getClaimValue ( JsonWebToken  token, String  claim  )

inlinestaticinherited

                                                                         {
        List<String> split = OIDCAttributeMapperHelper.splitClaimPath(claim);
        Map<String, Object> jsonObject = token.getOtherClaims();
        final int length = split.size();
        int i = 0;
        for (String component : split) {
            i++;
            if (i == length) {
                return jsonObject.get(component);
            } else {
                Object val = jsonObject.get(component);
                if (!(val instanceof Map)) return null;
                jsonObject = (Map<String, Object>)val;
            }
        }
        return null;
    }

getClaimValue() [2/3]

static Object org.keycloak.broker.oidc.mappers.AbstractClaimMapper.getClaimValue ( IdentityProviderMapperModel  mapperModel, BrokeredIdentityContext  context  )

inlinestaticinherited

                                                                                                                 {
        String claim = mapperModel.getConfig().get(CLAIM);
        return getClaimValue(context, claim);
    }

getClaimValue() [3/3]

static Object org.keycloak.broker.oidc.mappers.AbstractClaimMapper.getClaimValue ( BrokeredIdentityContext  context, String  claim  )

inlinestaticinherited

                                                                                      {
        {  // search access token
            JsonWebToken token = (JsonWebToken)context.getContextData().get(KeycloakOIDCIdentityProvider.VALIDATED_ACCESS_TOKEN);
            if (token != null) {
                Object value = getClaimValue(token, claim);
                if (value != null) return value;
            }

        }
        {  // search ID Token
            JsonWebToken token = (JsonWebToken)context.getContextData().get(KeycloakOIDCIdentityProvider.VALIDATED_ID_TOKEN);
            if (token != null) {
                Object value = getClaimValue(token, claim);
                if (value != null) return value;
            }

        }
        {
            // Search the OIDC UserInfo claim set (if any)
            JsonNode profileJsonNode = (JsonNode) context.getContextData().get(OIDCIdentityProvider.USER_INFO);
            Object value = AbstractJsonUserAttributeMapper.getJsonValue(profileJsonNode, claim);
            if (value != null) return value;
        }
        return null;
    }

getCompatibleProviders()

String [] org.keycloak.broker.oidc.mappers.UserAttributeMapper.getCompatibleProviders ( )

inline

                                             {
        return COMPATIBLE_PROVIDERS;
    }

getConfigProperties()

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

inline

                                                              {
        return configProperties;
    }

getDisplayCategory()

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

inline

                                       {
        return "Attribute Importer";
    }

getDisplayType()

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

inline

                                   {
        return "Attribute Importer";
    }

getHelpText()

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

inline

                                {
        return "Import declared claim if it exists in ID, access token or the claim set returned by the user profile endpoint into the specified user property or attribute.";
    }

getId()

String org.keycloak.broker.oidc.mappers.UserAttributeMapper.getId ( )

inline

                          {
        return PROVIDER_ID;
    }

hasClaimValue()

boolean org.keycloak.broker.oidc.mappers.AbstractClaimMapper.hasClaimValue ( IdentityProviderMapperModel  mapperModel, BrokeredIdentityContext  context  )

inlineprotectedinherited

                                                                                                              {
        Object value = getClaimValue(mapperModel, context);
        String desiredValue = mapperModel.getConfig().get(CLAIM_VALUE);
        return valueEquals(desiredValue, value);
    }

preprocessFederatedIdentity()

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

inline

                                                                                                                                                                 {
        String attribute = mapperModel.getConfig().get(USER_ATTRIBUTE);
        if(StringUtil.isNullOrEmpty(attribute)){
            return;
        }
        Object value = getClaimValue(mapperModel, context);
        List<String> values = toList(value);

        if (EMAIL.equalsIgnoreCase(attribute)) {
            setIfNotEmpty(context::setEmail, values);
        } else if (FIRST_NAME.equalsIgnoreCase(attribute)) {
            setIfNotEmpty(context::setFirstName, values);
        } else if (LAST_NAME.equalsIgnoreCase(attribute)) {
            setIfNotEmpty(context::setLastName, values);
        } else {
            List<String> valuesToString = values.stream()
                    .filter(Objects::nonNull)
                    .map(Object::toString)
                    .collect(Collectors.toList());

            context.setUserAttribute(attribute, valuesToString);
        }
    }

setIfNotEmpty()

void org.keycloak.broker.oidc.mappers.UserAttributeMapper.setIfNotEmpty ( Consumer< String >  consumer, List< String >  values  )

inlineprivate

                                                                               {
        if (values != null && !values.isEmpty()) {
            consumer.accept(values.get(0));
        }
    }

toList()

List<String> org.keycloak.broker.oidc.mappers.UserAttributeMapper.toList ( Object  value )

inlineprivate

                                              {
        List<Object> values = (value instanceof List)
                ? (List) value
                : Collections.singletonList(value);
        return values.stream()
                .filter(Objects::nonNull)
                .map(Object::toString)
                .collect(Collectors.toList());
    }

updateBrokeredUser()

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

inline

                                                                                                                                                                        {
        String attribute = mapperModel.getConfig().get(USER_ATTRIBUTE);
        if(StringUtil.isNullOrEmpty(attribute)){
            return;
        }
        Object value = getClaimValue(mapperModel, context);
        List<String> values = toList(value);
        if (EMAIL.equalsIgnoreCase(attribute)) {
            setIfNotEmpty(user::setEmail, values);
        } else if (FIRST_NAME.equalsIgnoreCase(attribute)) {
            setIfNotEmpty(user::setFirstName, values);
        } else if (LAST_NAME.equalsIgnoreCase(attribute)) {
            setIfNotEmpty(user::setLastName, values);
        } else {
            List<String> current = user.getAttribute(attribute);
            if (!CollectionUtil.collectionEquals(values, current)) {
                user.setAttribute(attribute, values);
            } else if (values.isEmpty()) {
                user.removeAttribute(attribute);
            }
        }
    }

valueEquals()

boolean org.keycloak.broker.oidc.mappers.AbstractClaimMapper.valueEquals ( String  desiredValue, Object  value  )

inlineinherited

                                                                  {
        if (value instanceof String) {
            if (desiredValue.equals(value)) return true;
        } else if (value instanceof Double) {
            try {
                if (Double.valueOf(desiredValue).equals(value)) return true;
            } catch (Exception e) {

            }
        } else if (value instanceof Integer) {
            try {
                if (Integer.valueOf(desiredValue).equals(value)) return true;
            } catch (Exception e) {

            }
        } else if (value instanceof Boolean) {
            try {
                if (Boolean.valueOf(desiredValue).equals(value)) return true;
            } catch (Exception e) {

            }
        } else if (value instanceof List) {
            List list = (List)value;
            for (Object val : list) {
                if (valueEquals(desiredValue, val)) return true;
            }
        }
        return false;
    }

メンバ詳解

CLAIM

final String org.keycloak.broker.oidc.mappers.AbstractClaimMapper.CLAIM = "claim"

staticinherited

CLAIM_VALUE

final String org.keycloak.broker.oidc.mappers.AbstractClaimMapper.CLAIM_VALUE = "claim.value"

staticinherited

COMPATIBLE_PROVIDERS

final String [] org.keycloak.broker.oidc.mappers.UserAttributeMapper.COMPATIBLE_PROVIDERS = {KeycloakOIDCIdentityProviderFactory.PROVIDER_ID, OIDCIdentityProviderFactory.PROVIDER_ID}

static

configProperties

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

staticprivate

EMAIL

final String org.keycloak.broker.oidc.mappers.UserAttributeMapper.EMAIL = "email"

static

FIRST_NAME

final String org.keycloak.broker.oidc.mappers.UserAttributeMapper.FIRST_NAME = "firstName"

static

LAST_NAME

final String org.keycloak.broker.oidc.mappers.UserAttributeMapper.LAST_NAME = "lastName"

static

PROVIDER_ID

final String org.keycloak.broker.oidc.mappers.UserAttributeMapper.PROVIDER_ID = "oidc-user-attribute-idp-mapper"

static

USER_ATTRIBUTE

final String org.keycloak.broker.oidc.mappers.UserAttributeMapper.USER_ATTRIBUTE = "user.attribute"

static

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/broker/oidc/mappers/UserAttributeMapper.java