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

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

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

公開メンバ関数
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)

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

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

静的関数
	[static initializer]

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

詳解

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

著者

Bill Burke

バージョン

Revision

1

関数詳解

[static initializer]()

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

inlinestaticpackage

close()

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

inlineinherited

                        {

    }

create()

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

inlineinherited

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

createAttributeMapper()

static ProtocolMapperModel org.keycloak.protocol.saml.mappers.UserAttributeStatementMapper.createAttributeMapper ( String  name, String  userAttribute, String  samlAttributeName, String  nameFormat, String  friendlyName  )

inlinestatic

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

    }

getConfigProperties()

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

inline

                                                              {
        return configProperties;
    }

getDisplayCategory()

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

inline

                                       {
        return AttributeStatementHelper.ATTRIBUTE_STATEMENT_CATEGORY;
    }

getDisplayType()

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

inline

                                   {
        return "User Attribute";
    }

getHelpText()

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

inline

                                {
        return "Map a custom user attribute to a to a SAML attribute.";
    }

getId()

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

inline

                          {
        return PROVIDER_ID;
    }

getProtocol()

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

inlineinherited

                                {
        return SamlProtocol.LOGIN_PROTOCOL;
    }

init()

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

inlineinherited

                                          {
    }

postInit()

void org.keycloak.protocol.saml.mappers.AbstractSAMLProtocolMapper.postInit ( KeycloakSessionFactory  factory )

inlineinherited

                                                         {

    }

transformAttributeStatement()

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

inline

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

                                                                                                                                                                                                                               {
        UserModel user = userSession.getUser();
        String attributeName = mappingModel.getConfig().get(ProtocolMapperUtils.USER_ATTRIBUTE);
        List<String> attributeValues = KeycloakModelUtils.resolveAttribute(user, attributeName);
        if (attributeValues.isEmpty()) return;
        AttributeStatementHelper.addAttributes(attributeStatement, mappingModel, attributeValues);
    }

メンバ詳解

configProperties

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

staticprivate

PROVIDER_ID

final String org.keycloak.protocol.saml.mappers.UserAttributeStatementMapper.PROVIDER_ID = "saml-user-attribute-mapper"

static

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/protocol/saml/mappers/UserAttributeStatementMapper.java