org.keycloak.social.paypal.PayPalUserAttributeMapper クラス

org.keycloak.social.paypal.PayPalUserAttributeMapper の継承関係図

org.keycloak.social.paypal.PayPalUserAttributeMapper 連携図

公開メンバ関数
String []	getCompatibleProviders ()
String	getId ()
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)
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 []	cp = new String[] { PayPalIdentityProviderFactory.PROVIDER_ID }

詳解

User attribute mapper.

著者

Petter Lysne (petterlysne at hotmail dot com)

関数詳解

[static initializer]()

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

inlinestaticpackageinherited

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.social.paypal.PayPalUserAttributeMapper.getCompatibleProviders ( )

inline

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

                                                 {
                return cp;
        }

getConfigProperties()

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

inlineinherited

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

                                                                  {
                return configProperties;
        }

getDisplayCategory()

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

inlineinherited

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

                                           {
                return "Attribute Importer";
        }

getDisplayType()

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

inlineinherited

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

                                       {
                return "Attribute Importer";
        }

getHelpText()

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

inlineinherited

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.social.paypal.PayPalUserAttributeMapper.getId ( )

inline

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

                              {
                return "paypal-user-attribute-mapper";
        }

getJsonValue() [1/2]

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

inlinestaticprotectedinherited

                                                                                                                       {

                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  )

inlinestaticinherited

                                                                               {
                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

org.keycloak.storage.ldap.LDAPStorageProviderFactory, org.keycloak.protocol.saml.EntityDescriptorDescriptionConverter, org.keycloak.authentication.authenticators.x509.AbstractX509ClientCertificateAuthenticatorFactory, org.keycloak.authentication.forms.RegistrationUserCreation, org.keycloak.authentication.authenticators.resetcred.ResetCredentialEmail, org.keycloak.authentication.forms.RegistrationRecaptcha, org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser, org.keycloak.authentication.forms.RegistrationProfile, org.keycloak.authentication.forms.RegistrationPassword, org.keycloak.cluster.infinispan.InfinispanClusterProviderFactory, org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation, org.keycloak.protocol.saml.installation.SamlIDPDescriptorClientInstallation, org.keycloak.authentication.requiredactions.UpdateProfile, org.keycloak.authentication.requiredactions.UpdatePassword, org.keycloak.protocol.oidc.installation.KeycloakOIDCClientInstallation, org.keycloak.protocol.saml.mappers.RoleNameMapper, org.keycloak.connections.httpclient.DefaultHttpClientFactory, org.keycloak.protocol.saml.installation.ModAuthMellonClientInstallation, org.keycloak.federation.kerberos.KerberosFederationProviderFactory, org.keycloak.authentication.requiredactions.VerifyEmail, org.keycloak.authentication.requiredactions.UpdateTotp, org.keycloak.connections.jpa.updater.liquibase.conn.DefaultLiquibaseConnectionProvider, org.keycloak.protocol.oidc.installation.KeycloakOIDCJbossSubsystemClientInstallation, org.keycloak.connections.jpa.DefaultJpaConnectionProviderFactory, org.keycloak.protocol.saml.installation.SamlSPDescriptorClientInstallation, org.keycloak.policy.BlacklistPasswordPolicyProviderFactory, org.keycloak.authentication.forms.RegistrationPage, org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticatorFactory, org.keycloak.authentication.authenticators.browser.IdentityProviderAuthenticatorFactory, org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator, org.keycloak.connections.infinispan.DefaultInfinispanConnectionProviderFactory, org.keycloak.protocol.saml.installation.KeycloakSamlSubsystemInstallation, org.keycloak.keys.infinispan.InfinispanPublicKeyStorageProviderFactory, org.keycloak.theme.ClasspathThemeProviderFactory, org.keycloak.models.cache.infinispan.InfinispanUserCacheProviderFactory, org.keycloak.models.cache.infinispan.InfinispanCacheRealmProviderFactory, org.keycloak.executors.DefaultExecutorsProviderFactory, org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticatorFactory, org.keycloak.protocol.saml.SamlProtocolFactory, org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory, org.keycloak.protocol.docker.DockerAuthenticatorFactory, org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >, org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >, org.keycloak.authentication.authenticators.directgrant.AbstractDirectGrantAuthenticator, org.keycloak.authentication.authenticators.browser.OTPFormAuthenticatorFactory, org.keycloak.authentication.authenticators.browser.UsernamePasswordFormFactory, org.keycloak.exportimport.KeycloakClientDescriptionConverter, org.keycloak.authentication.authenticators.browser.SpnegoAuthenticatorFactory, org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper, org.keycloak.authentication.authenticators.browser.CookieAuthenticatorFactory, org.keycloak.authentication.requiredactions.TermsAndConditions, org.keycloak.events.email.EmailEventListenerProviderFactory, org.keycloak.authentication.authenticators.broker.IdpReviewProfileAuthenticatorFactory, org.keycloak.protocol.saml.mappers.AbstractSAMLProtocolMapper, org.keycloak.models.session.DisabledUserSessionPersisterProvider, org.keycloak.services.x509.DefaultClientCertificateLookupFactory, org.keycloak.authentication.authenticators.broker.IdpCreateUserIfUniqueAuthenticatorFactory, org.keycloak.authentication.authenticators.cli.CliUsernamePasswordAuthenticatorFactory, org.keycloak.authentication.authenticators.client.AbstractClientAuthenticator, org.keycloak.theme.JarThemeProviderFactory, org.keycloak.authentication.authenticators.challenge.BasicAuthAuthenticatorFactory, org.keycloak.authentication.authenticators.challenge.BasicAuthOTPAuthenticatorFactory, org.keycloak.authentication.authenticators.challenge.NoCookieFlowRedirectAuthenticatorFactory, org.keycloak.connections.jpa.updater.liquibase.lock.LiquibaseDBLockProviderFactory, org.keycloak.models.sessions.infinispan.InfinispanActionTokenStoreProviderFactory, org.keycloak.timer.basic.BasicTimerProviderFactory, org.keycloak.truststore.FileTruststoreProviderFactory, org.keycloak.authentication.authenticators.console.ConsoleUsernamePasswordAuthenticatorFactory, org.keycloak.events.log.JBossLoggingEventListenerProviderFactory, org.keycloak.protocol.oidc.OIDCClientDescriptionConverterFactory, org.keycloak.authentication.authenticators.broker.IdpConfirmLinkAuthenticatorFactory, org.keycloak.authentication.authenticators.broker.IdpEmailVerificationAuthenticatorFactory, org.keycloak.exportimport.singlefile.SingleFileImportProviderFactory, org.keycloak.services.x509.AbstractClientCertificateFromHttpHeadersLookupFactory, org.keycloak.theme.ClasspathThemeResourceProviderFactory, org.keycloak.exportimport.dir.DirExportProviderFactory, org.keycloak.exportimport.singlefile.SingleFileExportProviderFactory, org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory, org.keycloak.policy.HistoryPasswordPolicyProviderFactory, org.keycloak.protocol.docker.mapper.DockerAuthV2ProtocolMapper, org.keycloak.authentication.authenticators.broker.IdpAutoLinkAuthenticatorFactory, org.keycloak.models.jpa.session.JpaUserSessionPersisterProviderFactory, org.keycloak.policy.DigitsPasswordPolicyProviderFactory, org.keycloak.policy.LengthPasswordPolicyProviderFactory, org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory, org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory, org.keycloak.scripting.DefaultScriptingProviderFactory, org.keycloak.credential.hash.Pbkdf2PasswordHashProviderFactory, org.keycloak.events.jpa.JpaEventStoreProviderFactory, org.keycloak.exportimport.dir.DirImportProviderFactory, org.keycloak.transaction.JBossJtaTransactionManagerLookup, org.keycloak.email.freemarker.FreeMarkerEmailTemplateProviderFactory, org.keycloak.forms.account.freemarker.FreeMarkerAccountProviderFactory, org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProviderFactory, org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory, org.keycloak.storage.jpa.JpaUserFederatedStorageProviderFactory, org.keycloak.keys.KeyProviderFactory< T extends KeyProvider >, org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory, org.keycloak.protocol.oidc.OIDCWellKnownProviderFactory, org.keycloak.protocol.saml.clientregistration.EntityDescriptorClientRegistrationProviderFactory, org.keycloak.services.clientregistration.oidc.OIDCClientRegistrationProviderFactory, org.keycloak.theme.ExtendingThemeManagerFactory, org.keycloak.theme.FolderThemeProviderFactory, org.keycloak.credential.CredentialProviderFactory< T extends CredentialProvider >, org.keycloak.services.clientregistration.policy.AbstractClientRegistrationPolicyFactory, org.keycloak.connections.jpa.updater.liquibase.LiquibaseJpaUpdaterProviderFactory, org.keycloak.policy.LowerCasePasswordPolicyProviderFactory, org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory, org.keycloak.policy.UpperCasePasswordPolicyProviderFactory, org.keycloak.protocol.oidc.AccessTokenIntrospectionProviderFactory, org.keycloak.provider.wildfly.ModuleThemeProviderFactory, org.keycloak.services.managers.DefaultBruteForceProtectorFactory, org.keycloak.services.migration.DefaultMigrationProviderFactory, org.keycloak.models.jpa.JpaRealmProviderFactory, org.keycloak.models.jpa.JpaUserCredentialStoreFactory, org.keycloak.models.jpa.JpaUserProviderFactory, org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider, org.keycloak.email.DefaultEmailSenderProviderFactory, org.keycloak.policy.DefaultPasswordPolicyManagerProviderFactory, org.keycloak.protocol.AbstractLoginProtocolFactory, org.keycloak.services.clientregistration.AdapterInstallationClientRegistrationProviderFactory, org.keycloak.services.clientregistration.DefaultClientRegistrationProviderFactory, org.keycloak.locale.DefaultLocaleSelectorProviderFactory, org.keycloak.urls.HostnameProviderFactory, org.keycloak.credential.hash.Pbkdf2Sha256PasswordHashProviderFactory, org.keycloak.credential.hash.Pbkdf2Sha512PasswordHashProviderFactory, org.keycloak.crypto.SignatureProviderFactory, org.keycloak.protocol.docker.installation.DockerRegistryConfigFileInstallationProvider, org.keycloak.protocol.docker.installation.DockerVariableOverrideInstallationProvider, org.keycloak.url.FixedHostnameProviderFactory, org.keycloak.theme.DefaultThemeSelectorProviderFactory, org.keycloak.protocol.oidc.ext.OIDCExtProviderFactory (計132項目)で実装されています。

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.protocol.docker.DockerAuthV2ProtocolFactory, 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  )

inlineinherited

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  )

inlinestaticinherited

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  )

inlineinherited

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"

staticinherited

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"

staticinherited

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

CONTEXT_JSON_NODE

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

staticinherited

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

cp

final String [] org.keycloak.social.paypal.PayPalUserAttributeMapper.cp = new String[] { PayPalIdentityProviderFactory.PROVIDER_ID }

staticprivate

logger

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

staticprotectedinherited

LOGGER_DUMP_USER_PROFILE

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

staticprotectedinherited

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/social/paypal/PayPalUserAttributeMapper.java