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

org.keycloak.broker.saml.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 ()

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 final String []	COMPATIBLE_PROVIDERS = {SAMLIdentityProviderFactory.PROVIDER_ID}

static final String	ATTRIBUTE_NAME = "attribute.name"

static final String	ATTRIBUTE_FRIENDLY_NAME = "attribute.friendly.name"

static final String	USER_ATTRIBUTE = "user.attribute"

static final String	PROVIDER_ID = "saml-user-attribute-idp-mapper"

static final String	ANY_PROVIDER = "*"

静的関数
	[static initializer]

非公開メンバ関数
String	getAttributeNameFromMapperModel (IdentityProviderMapperModel mapperModel)

void	setIfNotEmpty (Consumer< String > consumer, List< String > values)

Predicate< AttributeStatementType.ASTChoiceType >	elementWith (String attributeName)

List< String >	findAttributeValuesInContext (String attributeName, BrokeredIdentityContext context)

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

static final String	EMAIL = "email"

static final String	FIRST_NAME = "firstName"

static final String	LAST_NAME = "lastName"

詳解

著者: Bill Burke

バージョン

Revision: 1

関数詳解

◆ [static initializer]()

org.keycloak.broker.saml.mappers.UserAttributeMapper.[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;
     }

◆ elementWith()

Predicate<AttributeStatementType.ASTChoiceType> org.keycloak.broker.saml.mappers.UserAttributeMapper.elementWith ( String attributeName )

inlineprivate

                                                                                               {
         return attributeType -> {
             AttributeType attribute = attributeType.getAttribute();
             return Objects.equals(attribute.getName(), attributeName)
                     || Objects.equals(attribute.getFriendlyName(), attributeName);
         };
     }

◆ findAttributeValuesInContext()

List<String> org.keycloak.broker.saml.mappers.UserAttributeMapper.findAttributeValuesInContext	(	String	attributeName,
		BrokeredIdentityContext	context
	)

inlineprivate

                                                                                                              {
         AssertionType assertion = (AssertionType) context.getContextData().get(SAMLEndpoint.SAML_ASSERTION);
 
         return assertion.getAttributeStatements().stream()
                 .flatMap(statement -> statement.getAttributes().stream())
                 .filter(elementWith(attributeName))
                 .flatMap(attributeType -> attributeType.getAttribute().getAttributeValue().stream())
                 .filter(Objects::nonNull)
                 .map(Object::toString)
                 .collect(Collectors.toList());
     }

◆ getAttributeNameFromMapperModel()

String org.keycloak.broker.saml.mappers.UserAttributeMapper.getAttributeNameFromMapperModel ( IdentityProviderMapperModel mapperModel )

inlineprivate

                                                                                             {
         String attributeName = mapperModel.getConfig().get(ATTRIBUTE_NAME);
         if (attributeName == null) {
             attributeName = mapperModel.getConfig().get(ATTRIBUTE_FRIENDLY_NAME);
         }
         return attributeName;
     }

◆ getCompatibleProviders()

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

inline

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

                                              {
         return COMPATIBLE_PROVIDERS;
     }

◆ getConfigProperties()

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

inline

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

                                                               {
         return configProperties;
     }

◆ getDisplayCategory()

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

inline

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

                                        {
         return "Attribute Importer";
     }

◆ getDisplayType()

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

inline

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

                                    {
         return "Attribute Importer";
     }

◆ getHelpText()

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

inline

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

                                 {
         return "Import declared saml attribute if it exists in assertion into the specified user property or attribute.";
     }

◆ getId()

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

inline

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

                           {
         return PROVIDER_ID;
     }

◆ 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.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.saml.mappers.UserAttributeMapper.preprocessFederatedIdentity	(	KeycloakSession	session,
		RealmModel	realm,
		IdentityProviderMapperModel	mapperModel,
		BrokeredIdentityContext	context
	)

inline

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

                                                                                                                                                                  {
         String attribute = mapperModel.getConfig().get(USER_ATTRIBUTE);
         if (StringUtil.isNullOrEmpty(attribute)) {
             return;
         }
         String attributeName = getAttributeNameFromMapperModel(mapperModel);
 
         List<String> attributeValuesInContext = findAttributeValuesInContext(attributeName, context);
         if (!attributeValuesInContext.isEmpty()) {
             if (attribute.equalsIgnoreCase(EMAIL)) {
                 setIfNotEmpty(context::setEmail, attributeValuesInContext);
             } else if (attribute.equalsIgnoreCase(FIRST_NAME)) {
                 setIfNotEmpty(context::setFirstName, attributeValuesInContext);
             } else if (attribute.equalsIgnoreCase(LAST_NAME)) {
                 setIfNotEmpty(context::setLastName, attributeValuesInContext);
             } else {
                 context.setUserAttribute(attribute, attributeValuesInContext);
             }
         }
     }

◆ setIfNotEmpty()

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

inlineprivate

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

◆ updateBrokeredUser()

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

inline

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

                                                                                                                                                                         {
         String attribute = mapperModel.getConfig().get(USER_ATTRIBUTE);
         if (StringUtil.isNullOrEmpty(attribute)) {
             return;
         }
         String attributeName = getAttributeNameFromMapperModel(mapperModel);
         List<String> attributeValuesInContext = findAttributeValuesInContext(attributeName, context);
         if (attribute.equalsIgnoreCase(EMAIL)) {
             setIfNotEmpty(user::setEmail, attributeValuesInContext);
         } else if (attribute.equalsIgnoreCase(FIRST_NAME)) {
             setIfNotEmpty(user::setFirstName, attributeValuesInContext);
         } else if (attribute.equalsIgnoreCase(LAST_NAME)) {
             setIfNotEmpty(user::setLastName, attributeValuesInContext);
         } else {
             List<String> currentAttributeValues = user.getAttributes().get(attribute);
             if (attributeValuesInContext == null) {
                 // attribute no longer sent by brokered idp, remove it
                 user.removeAttribute(attribute);
             } else if (currentAttributeValues == null) {
                 // new attribute sent by brokered idp, add it
                 user.setAttribute(attribute, attributeValuesInContext);
             } else if (!CollectionUtil.collectionEquals(attributeValuesInContext, currentAttributeValues)) {
                 // attribute sent by brokered idp has different values as before, update it
                 user.setAttribute(attribute, attributeValuesInContext);
             }
             // attribute allready set
         }
     }

static

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

D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/broker/saml/mappers/UserAttributeMapper.java

公開メンバ関数

静的公開変数類

静的関数

非公開メンバ関数

静的非公開変数類

詳解

関数詳解

◆ [static initializer]()

◆ close()

◆ create()

◆ elementWith()

◆ findAttributeValuesInContext()

◆ getAttributeNameFromMapperModel()

◆ getCompatibleProviders()

◆ getConfigProperties()

◆ getDisplayCategory()

◆ getDisplayType()

◆ getHelpText()

◆ getId()

◆ importNewUser()

◆ init() [1/2]

◆ init() [2/2]

◆ order()

◆ postInit()

◆ preprocessFederatedIdentity()

◆ setIfNotEmpty()

◆ updateBrokeredUser()

メンバ詳解

◆ ANY_PROVIDER

◆ ATTRIBUTE_FRIENDLY_NAME

◆ ATTRIBUTE_NAME

◆ COMPATIBLE_PROVIDERS

◆ configProperties

◆ EMAIL

◆ FIRST_NAME

◆ LAST_NAME

◆ PROVIDER_ID

◆ USER_ATTRIBUTE