org.keycloak.protocol.saml.mappers.UserPropertyAttributeStatementMapper クラス

org.keycloak.protocol.saml.mappers.UserPropertyAttributeStatementMapper の継承関係図

org.keycloak.protocol.saml.mappers.UserPropertyAttributeStatementMapper 連携図

公開メンバ関数
List< ProviderConfigProperty >	getConfigProperties ()
String	getId ()
String	getDisplayType ()
String	getDisplayCategory ()
String	getHelpText ()
void	transformAttributeStatement (AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
String	getProtocol ()
void	close ()
final ProtocolMapper	create (KeycloakSession session)
void	init (Config.Scope config)
void	postInit (KeycloakSessionFactory factory)
default void	validateConfig (KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel) throws ProtocolMapperConfigException
default int	order ()

静的公開メンバ関数
static ProtocolMapperModel	createAttributeMapper (String name, String userAttribute, String samlAttributeName, String nameFormat, String friendlyName, boolean consentRequired, String consentText)

静的公開変数類
static final String	PROVIDER_ID = "saml-user-property-mapper"

静的関数
	[static initializer]

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

詳解

Mappings UserModel property (the property name of a getter method) to an AttributeStatement.

著者

Bill Burke

バージョン

Revision

1

関数詳解

[static initializer]()

org.keycloak.protocol.saml.mappers.UserPropertyAttributeStatementMapper.[static initializer] ( )

inlinestaticpackage

close()

void org.keycloak.protocol.saml.mappers.AbstractSAMLProtocolMapper.close ( )

inlineinherited

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

                        {

    }

create()

final ProtocolMapper org.keycloak.protocol.saml.mappers.AbstractSAMLProtocolMapper.create ( KeycloakSession  session )

inlineinherited

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

                                                                {
        throw new RuntimeException("UNSUPPORTED METHOD");
    }

createAttributeMapper()

static ProtocolMapperModel org.keycloak.protocol.saml.mappers.UserPropertyAttributeStatementMapper.createAttributeMapper ( String  name, String  userAttribute, String  samlAttributeName, String  nameFormat, String  friendlyName, boolean  consentRequired, String  consentText  )

inlinestatic

                                                                                                         {
        String mapperId = PROVIDER_ID;
        return AttributeStatementHelper.createAttributeMapper(name, userAttribute, samlAttributeName, nameFormat, friendlyName,
                mapperId);

    }

getConfigProperties()

List<ProviderConfigProperty> org.keycloak.protocol.saml.mappers.UserPropertyAttributeStatementMapper.getConfigProperties ( )

inline

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

                                                              {
        return configProperties;
    }

getDisplayCategory()

String org.keycloak.protocol.saml.mappers.UserPropertyAttributeStatementMapper.getDisplayCategory ( )

inline

org.keycloak.protocol.ProtocolMapperを実装しています。

                                       {
        return AttributeStatementHelper.ATTRIBUTE_STATEMENT_CATEGORY;
    }

getDisplayType()

String org.keycloak.protocol.saml.mappers.UserPropertyAttributeStatementMapper.getDisplayType ( )

inline

org.keycloak.protocol.ProtocolMapperを実装しています。

                                   {
        return "User Property";
    }

getHelpText()

String org.keycloak.protocol.saml.mappers.UserPropertyAttributeStatementMapper.getHelpText ( )

inline

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

                                {
        return "Map a built in user property (email, firstName, lastName) to a SAML attribute type.";
    }

getId()

String org.keycloak.protocol.saml.mappers.UserPropertyAttributeStatementMapper.getId ( )

inline

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

                          {
        return PROVIDER_ID;
    }

getProtocol()

String org.keycloak.protocol.saml.mappers.AbstractSAMLProtocolMapper.getProtocol ( )

inlineinherited

org.keycloak.protocol.ProtocolMapperを実装しています。

                                {
        return SamlProtocol.LOGIN_PROTOCOL;
    }

init()

void org.keycloak.protocol.saml.mappers.AbstractSAMLProtocolMapper.init ( Config.Scope  config )

inlineinherited

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

                                          {
    }

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.protocol.saml.mappers.AbstractSAMLProtocolMapper.postInit ( KeycloakSessionFactory  factory )

inlineinherited

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

                                                         {

    }

transformAttributeStatement()

void org.keycloak.protocol.saml.mappers.UserPropertyAttributeStatementMapper.transformAttributeStatement ( AttributeStatementType  attributeStatement, ProtocolMapperModel  mappingModel, KeycloakSession  session, UserSessionModel  userSession, AuthenticatedClientSessionModel  clientSession  )

inline

org.keycloak.protocol.saml.mappers.SAMLAttributeStatementMapperを実装しています。

                                                                                                                                                                                                                               {
        UserModel user = userSession.getUser();
        String propertyName = mappingModel.getConfig().get(ProtocolMapperUtils.USER_ATTRIBUTE);

        if (propertyName == null || propertyName.trim().isEmpty()) return;

        String propertyValue = ProtocolMapperUtils.getUserModelValue(user, propertyName);

        if (propertyValue == null) return;

        AttributeStatementHelper.addAttribute(attributeStatement, mappingModel, propertyValue);
    }

validateConfig()

default void org.keycloak.protocol.ProtocolMapper.validateConfig ( KeycloakSession  session, RealmModel  realm, ProtocolMapperContainerModel  client, ProtocolMapperModel  mapperModel  ) throws ProtocolMapperConfigException

inlineinherited

Called when instance of mapperModel is created/updated for this protocolMapper through admin endpoint

引数

session
realm
client	client or clientTemplate
mapperModel

例外

ProtocolMapperConfigException

if configuration provided in mapperModel is not valid

org.keycloak.protocol.saml.mappers.ScriptBasedMapper, org.keycloak.protocol.oidc.mappers.ScriptBasedOIDCProtocolMapper, org.keycloak.protocol.oidc.mappers.AbstractPairwiseSubMapperで実装されています。

                                                                                                                                                                                      {
    };

メンバ詳解

configProperties

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

staticprivate

PROVIDER_ID

final String org.keycloak.protocol.saml.mappers.UserPropertyAttributeStatementMapper.PROVIDER_ID = "saml-user-property-mapper"

static

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/protocol/saml/mappers/UserPropertyAttributeStatementMapper.java