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

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

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

公開メンバ関数
String	getDisplayCategory ()
String	getDisplayType ()
String	getHelpText ()
List< ProviderConfigProperty >	getConfigProperties ()
String	getId ()
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 boolean	useFullPath (ProtocolMapperModel mappingModel)
static ProtocolMapperModel	create (String name, String samlAttributeName, String nameFormat, String friendlyName, boolean singleAttribute)

静的公開変数類
static final String	PROVIDER_ID = "saml-group-membership-mapper"
static final String	SINGLE_GROUP_ATTRIBUTE = "single"

静的関数
	[static initializer]

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

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

[static initializer]()

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

inlinestaticpackage

close()

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

inlineinherited

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

                        {

    }

create() [1/2]

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

inlineinherited

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

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

create() [2/2]

static ProtocolMapperModel org.keycloak.protocol.saml.mappers.GroupMembershipMapper.create ( String  name, String  samlAttributeName, String  nameFormat, String  friendlyName, boolean  singleAttribute  )

inlinestatic

                                                                                                                                                     {
        ProtocolMapperModel mapper = new ProtocolMapperModel();
        mapper.setName(name);
        mapper.setProtocolMapper(PROVIDER_ID);
        mapper.setProtocol(SamlProtocol.LOGIN_PROTOCOL);
        Map<String, String> config = new HashMap<String, String>();
        config.put(AttributeStatementHelper.SAML_ATTRIBUTE_NAME, samlAttributeName);
        if (friendlyName != null) {
            config.put(AttributeStatementHelper.FRIENDLY_NAME, friendlyName);
        }
        if (nameFormat != null) {
            config.put(AttributeStatementHelper.SAML_ATTRIBUTE_NAMEFORMAT, nameFormat);
        }
        config.put(SINGLE_GROUP_ATTRIBUTE, Boolean.toString(singleAttribute));
        mapper.setConfig(config);

        return mapper;
    }

getConfigProperties()

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

inline

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

                                                              {
        return configProperties;
    }

getDisplayCategory()

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

inline

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

                                       {
        return "Group Mapper";
    }

getDisplayType()

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

inline

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

                                   {
        return "Group list";
    }

getHelpText()

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

inline

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

                                {
        return "Group names are stored in an attribute value.  There is either one attribute with multiple attribute values, or an attribute per group name depending on how you configure it.  You can also specify the attribute name i.e. 'member' or 'memberOf' being examples.";
    }

getId()

String org.keycloak.protocol.saml.mappers.GroupMembershipMapper.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.GroupMembershipMapper.transformAttributeStatement ( AttributeStatementType  attributeStatement, ProtocolMapperModel  mappingModel, KeycloakSession  session, UserSessionModel  userSession, AuthenticatedClientSessionModel  clientSession  )

inline

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

                                                                                                                                                                                                                               {
        String single = mappingModel.getConfig().get(SINGLE_GROUP_ATTRIBUTE);
        boolean singleAttribute = Boolean.parseBoolean(single);

        boolean fullPath = useFullPath(mappingModel);
        AttributeType singleAttributeType = null;
        for (GroupModel group : userSession.getUser().getGroups()) {
            String groupName;
            if (fullPath) {
                groupName = ModelToRepresentation.buildGroupPath(group);
            } else {
                groupName = group.getName();
            }
            AttributeType attributeType = null;
            if (singleAttribute) {
                if (singleAttributeType == null) {
                    singleAttributeType = AttributeStatementHelper.createAttributeType(mappingModel);
                    attributeStatement.addAttribute(new AttributeStatementType.ASTChoiceType(singleAttributeType));
                }
                attributeType = singleAttributeType;
            } else {
                attributeType = AttributeStatementHelper.createAttributeType(mappingModel);
                attributeStatement.addAttribute(new AttributeStatementType.ASTChoiceType(attributeType));
            }
            attributeType.addAttributeValue(groupName);
        }
    }

useFullPath()

static boolean org.keycloak.protocol.saml.mappers.GroupMembershipMapper.useFullPath ( ProtocolMapperModel  mappingModel )

inlinestatic

                                                                        {
        return "true".equals(mappingModel.getConfig().get("full.path"));
    }

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.GroupMembershipMapper.configProperties = new ArrayList<ProviderConfigProperty>()

staticprivate

PROVIDER_ID

final String org.keycloak.protocol.saml.mappers.GroupMembershipMapper.PROVIDER_ID = "saml-group-membership-mapper"

static

SINGLE_GROUP_ATTRIBUTE

final String org.keycloak.protocol.saml.mappers.GroupMembershipMapper.SINGLE_GROUP_ATTRIBUTE = "single"

static

---

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

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