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

org.keycloak.broker.saml.mappers.UsernameTemplateMapper 連携図

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

String	getId ()

String []	getCompatibleProviders ()

String	getDisplayCategory ()

String	getDisplayType ()

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

void	preprocessFederatedIdentity (KeycloakSession session, RealmModel realm, 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	TEMPLATE = "template"

static final String	PROVIDER_ID = "saml-username-idp-mapper"

static final String	ANY_PROVIDER = "*"

静的関数
	[static initializer]

静的変数
static Pattern	substitution = Pattern.compile("\\$\\{([^}]+)\\}")

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

詳解

著者: Bill Burke

バージョン

Revision: 1

関数詳解

◆ [static initializer]()

org.keycloak.broker.saml.mappers.UsernameTemplateMapper.[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.saml.mappers.UsernameTemplateMapper.getCompatibleProviders ( )

inline

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

                                              {
         return COMPATIBLE_PROVIDERS;
     }

◆ getConfigProperties()

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

inline

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

                                                               {
         return configProperties;
     }

◆ getDisplayCategory()

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

inline

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

                                        {
         return "Preprocessor";
     }

◆ getDisplayType()

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

inline

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

                                    {
         return "Username Template Importer";
     }

◆ getHelpText()

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

inline

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

                                 {
         return "Format the username to import.";
     }

◆ getId()

String org.keycloak.broker.saml.mappers.UsernameTemplateMapper.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.UsernameTemplateMapper.preprocessFederatedIdentity	(	KeycloakSession	session,
		RealmModel	realm,
		IdentityProviderMapperModel	mapperModel,
		BrokeredIdentityContext	context
	)

inline

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

                                                                                                                                                                  {
         AssertionType assertion = (AssertionType)context.getContextData().get(SAMLEndpoint.SAML_ASSERTION);
         String template = mapperModel.getConfig().get(TEMPLATE);
         Matcher m = substitution.matcher(template);
         StringBuffer sb = new StringBuffer();
         while (m.find()) {
             String variable = m.group(1);
             if (variable.equals("ALIAS")) {
                 m.appendReplacement(sb, context.getIdpConfig().getAlias());
             } else if (variable.equals("UUID")) {
                 m.appendReplacement(sb, KeycloakModelUtils.generateId());
             } else if (variable.equals("NAMEID")) {
                 SubjectType subject = assertion.getSubject();
                 SubjectType.STSubType subType = subject.getSubType();
                 NameIDType subjectNameID = (NameIDType) subType.getBaseID();
                 m.appendReplacement(sb, subjectNameID.getValue());
             } else if (variable.startsWith("ATTRIBUTE.")) {
                 String name = variable.substring("ATTRIBUTE.".length());
                 String value = "";
                 for (AttributeStatementType statement : assertion.getAttributeStatements()) {
                     for (AttributeStatementType.ASTChoiceType choice : statement.getAttributes()) {
                         AttributeType attr = choice.getAttribute();
                         if (name.equals(attr.getName()) || name.equals(attr.getFriendlyName())) {
                             List<Object> attributeValue = attr.getAttributeValue();
                             if (attributeValue != null && !attributeValue.isEmpty()) {
                                 value = attributeValue.get(0).toString();
                             }
                             break;
                         }
                     }
                 }
                 m.appendReplacement(sb, value);
             } else {
                 m.appendReplacement(sb, m.group(1));
             }
 
         }
         m.appendTail(sb);
         context.setModelUsername(sb.toString());
 
     }

◆ updateBrokeredUser()

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

inline

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

                                                                                                                                                                         {
 
     }

メンバ詳解

◆ ANY_PROVIDER

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

staticinherited

◆ COMPATIBLE_PROVIDERS

final String [] org.keycloak.broker.saml.mappers.UsernameTemplateMapper.COMPATIBLE_PROVIDERS = {SAMLIdentityProviderFactory.PROVIDER_ID}

static

◆ configProperties

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

staticprivate

◆ PROVIDER_ID

final String org.keycloak.broker.saml.mappers.UsernameTemplateMapper.PROVIDER_ID = "saml-username-idp-mapper"

static

◆ substitution

Pattern org.keycloak.broker.saml.mappers.UsernameTemplateMapper.substitution = Pattern.compile("\\$\\{([^}]+)\\}")

staticpackage

◆ TEMPLATE

final String org.keycloak.broker.saml.mappers.UsernameTemplateMapper.TEMPLATE = "template"

static

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

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

公開メンバ関数

静的公開変数類

静的関数

静的変数

静的非公開変数類

詳解

関数詳解

◆ [static initializer]()

◆ close()

◆ create()

◆ getCompatibleProviders()

◆ getConfigProperties()

◆ getDisplayCategory()

◆ getDisplayType()

◆ getHelpText()

◆ getId()

◆ importNewUser()

◆ init() [1/2]

◆ init() [2/2]

◆ order()

◆ postInit()

◆ preprocessFederatedIdentity()

◆ updateBrokeredUser()

メンバ詳解

◆ ANY_PROVIDER

◆ COMPATIBLE_PROVIDERS

◆ configProperties

◆ PROVIDER_ID

◆ substitution

◆ TEMPLATE