org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig クラス

org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig の継承関係図

org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig 連携図

公開メンバ関数
	GroupMapperConfig (ComponentModel mapperModel)
String	getGroupsDn ()
String	getLDAPGroupsDn ()
String	getGroupNameLdapAttribute ()
String	getLDAPGroupNameLdapAttribute ()
boolean	isPreserveGroupsInheritance ()
boolean	isIgnoreMissingGroups ()
Collection< String >	getGroupObjectClasses (LDAPStorageProvider ldapProvider)
Collection< String >	getGroupAttributes ()
String	getCustomLdapFilter ()
boolean	isDropNonExistingGroupsDuringSync ()
String	getUserGroupsRetrieveStrategy ()
String	getMembershipLdapAttribute ()
MembershipType	getMembershipTypeLdapAttribute ()
String	getMembershipUserLdapAttribute (LDAPConfig ldapConfig)
String	getMemberOfLdapAttribute ()
LDAPGroupMapperMode	getMode ()

静的公開変数類
static final String	GROUPS_DN = "groups.dn"
static final String	GROUP_NAME_LDAP_ATTRIBUTE = "group.name.ldap.attribute"
static final String	GROUP_OBJECT_CLASSES = "group.object.classes"
static final String	PRESERVE_GROUP_INHERITANCE = "preserve.group.inheritance"
static final String	IGNORE_MISSING_GROUPS = "ignore.missing.groups"
static final String	GROUPS_LDAP_FILTER = "groups.ldap.filter"
static final String	MAPPED_GROUP_ATTRIBUTES = "mapped.group.attributes"
static final String	DROP_NON_EXISTING_GROUPS_DURING_SYNC = "drop.non.existing.groups.during.sync"
static final String	LOAD_GROUPS_BY_MEMBER_ATTRIBUTE = "LOAD_GROUPS_BY_MEMBER_ATTRIBUTE"
static final String	GET_GROUPS_FROM_USER_MEMBEROF_ATTRIBUTE = "GET_GROUPS_FROM_USER_MEMBEROF_ATTRIBUTE"
static final String	LOAD_GROUPS_BY_MEMBER_ATTRIBUTE_RECURSIVELY = "LOAD_GROUPS_BY_MEMBER_ATTRIBUTE_RECURSIVELY"
static final String	MEMBERSHIP_LDAP_ATTRIBUTE = "membership.ldap.attribute"
static final String	MEMBERSHIP_ATTRIBUTE_TYPE = "membership.attribute.type"
static final String	MEMBERSHIP_USER_LDAP_ATTRIBUTE = "membership.user.ldap.attribute"
static final String	MODE = "mode"
static final String	USER_ROLES_RETRIEVE_STRATEGY = "user.roles.retrieve.strategy"
static final String	MEMBEROF_LDAP_ATTRIBUTE = "memberof.ldap.attribute"

限定公開メンバ関数
Set< String >	getConfigValues (String str)

限定公開変数類
final ComponentModel	mapperModel

詳解

著者

Marek Posolda

構築子と解体子

GroupMapperConfig()

org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.GroupMapperConfig ( ComponentModel  mapperModel )

inline

                                                         {
        super(mapperModel);
    }

関数詳解

getConfigValues()

Set<String> org.keycloak.storage.ldap.mappers.membership.CommonLDAPGroupMapperConfig.getConfigValues ( String  str )

inlineprotectedinherited

                                                      {
        String[] objClasses = str.split(",");
        Set<String> trimmed = new HashSet<>();
        for (String objectClass : objClasses) {
            objectClass = objectClass.trim();
            if (objectClass.length() > 0) {
                trimmed.add(objectClass);
            }
        }
        return trimmed;
    }

getCustomLdapFilter()

String org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.getCustomLdapFilter ( )

inline

                                        {
        return mapperModel.getConfig().getFirst(GROUPS_LDAP_FILTER);
    }

getGroupAttributes()

Collection<String> org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.getGroupAttributes ( )

inline

                                                   {
        String groupAttrs = mapperModel.getConfig().getFirst(MAPPED_GROUP_ATTRIBUTES);
        return (groupAttrs == null) ? Collections.<String>emptySet() : getConfigValues(groupAttrs);
    }

getGroupNameLdapAttribute()

String org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.getGroupNameLdapAttribute ( )

inline

                                              {
        String rolesRdnAttr = mapperModel.getConfig().getFirst(GROUP_NAME_LDAP_ATTRIBUTE);
        return rolesRdnAttr!=null ? rolesRdnAttr : LDAPConstants.CN;
    }

getGroupObjectClasses()

Collection<String> org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.getGroupObjectClasses ( LDAPStorageProvider  ldapProvider )

inline

                                                                                      {
        String objectClasses = mapperModel.getConfig().getFirst(GROUP_OBJECT_CLASSES);
        if (objectClasses == null) {
            // For Active directory, the default is 'group' . For other servers 'groupOfNames'
            objectClasses = ldapProvider.getLdapIdentityStore().getConfig().isActiveDirectory() ? LDAPConstants.GROUP : LDAPConstants.GROUP_OF_NAMES;
        }

        return getConfigValues(objectClasses);
    }

getGroupsDn()

String org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.getGroupsDn ( )

inline

                                {
        String groupsDn = mapperModel.getConfig().getFirst(GROUPS_DN);
        if (groupsDn == null) {
            throw new ModelException("Groups DN is null! Check your configuration");
        }
        return groupsDn;
    }

getLDAPGroupNameLdapAttribute()

String org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.getLDAPGroupNameLdapAttribute ( )

inline

                                                  {
        return getGroupNameLdapAttribute();
    }

getLDAPGroupsDn()

String org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.getLDAPGroupsDn ( )

inline

                                    {
        return getGroupsDn();
    }

getMemberOfLdapAttribute()

String org.keycloak.storage.ldap.mappers.membership.CommonLDAPGroupMapperConfig.getMemberOfLdapAttribute ( )

inlineinherited

                                             {
        String memberOfLdapAttrName = mapperModel.getConfig().getFirst(MEMBEROF_LDAP_ATTRIBUTE);
        return memberOfLdapAttrName!=null ? memberOfLdapAttrName : LDAPConstants.MEMBER_OF;
    }

getMembershipLdapAttribute()

String org.keycloak.storage.ldap.mappers.membership.CommonLDAPGroupMapperConfig.getMembershipLdapAttribute ( )

inlineinherited

                                               {
        String membershipAttrName = mapperModel.getConfig().getFirst(MEMBERSHIP_LDAP_ATTRIBUTE);
        return membershipAttrName!=null ? membershipAttrName : LDAPConstants.MEMBER;
    }

getMembershipTypeLdapAttribute()

MembershipType org.keycloak.storage.ldap.mappers.membership.CommonLDAPGroupMapperConfig.getMembershipTypeLdapAttribute ( )

inlineinherited

                                                           {
        String membershipType = mapperModel.getConfig().getFirst(MEMBERSHIP_ATTRIBUTE_TYPE);
        return (membershipType!=null && !membershipType.isEmpty()) ? Enum.valueOf(MembershipType.class, membershipType) : MembershipType.DN;
    }

getMembershipUserLdapAttribute()

String org.keycloak.storage.ldap.mappers.membership.CommonLDAPGroupMapperConfig.getMembershipUserLdapAttribute ( LDAPConfig  ldapConfig )

inlineinherited

                                                                        {
        String membershipUserAttrName = mapperModel.getConfig().getFirst(MEMBERSHIP_USER_LDAP_ATTRIBUTE);
        return membershipUserAttrName!=null ? membershipUserAttrName : ldapConfig.getUsernameLdapAttribute();
    }

getMode()

LDAPGroupMapperMode org.keycloak.storage.ldap.mappers.membership.CommonLDAPGroupMapperConfig.getMode ( )

inlineinherited

                                         {
        String modeString = mapperModel.getConfig().getFirst(MODE);
        if (modeString == null || modeString.isEmpty()) {
            throw new ModelException("Mode is missing! Check your configuration");
        }

        return Enum.valueOf(LDAPGroupMapperMode.class, modeString.toUpperCase());
    }

getUserGroupsRetrieveStrategy()

String org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.getUserGroupsRetrieveStrategy ( )

inline

                                                  {
        String strategyString = mapperModel.getConfig().getFirst(USER_ROLES_RETRIEVE_STRATEGY);
        return strategyString!=null ? strategyString : LOAD_GROUPS_BY_MEMBER_ATTRIBUTE;
    }

isDropNonExistingGroupsDuringSync()

boolean org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.isDropNonExistingGroupsDuringSync ( )

inline

                                                       {
        return AbstractLDAPStorageMapper.parseBooleanParameter(mapperModel, DROP_NON_EXISTING_GROUPS_DURING_SYNC);
    }

isIgnoreMissingGroups()

boolean org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.isIgnoreMissingGroups ( )

inline

                                           {
        return AbstractLDAPStorageMapper.parseBooleanParameter(mapperModel, IGNORE_MISSING_GROUPS);
    }

isPreserveGroupsInheritance()

boolean org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.isPreserveGroupsInheritance ( )

inline

                                                 {
        return AbstractLDAPStorageMapper.parseBooleanParameter(mapperModel, PRESERVE_GROUP_INHERITANCE);
    }

メンバ詳解

DROP_NON_EXISTING_GROUPS_DURING_SYNC

final String org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.DROP_NON_EXISTING_GROUPS_DURING_SYNC = "drop.non.existing.groups.during.sync"

static

GET_GROUPS_FROM_USER_MEMBEROF_ATTRIBUTE

final String org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.GET_GROUPS_FROM_USER_MEMBEROF_ATTRIBUTE = "GET_GROUPS_FROM_USER_MEMBEROF_ATTRIBUTE"

static

GROUP_NAME_LDAP_ATTRIBUTE

final String org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.GROUP_NAME_LDAP_ATTRIBUTE = "group.name.ldap.attribute"

static

GROUP_OBJECT_CLASSES

final String org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.GROUP_OBJECT_CLASSES = "group.object.classes"

static

GROUPS_DN

final String org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.GROUPS_DN = "groups.dn"

static

GROUPS_LDAP_FILTER

final String org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.GROUPS_LDAP_FILTER = "groups.ldap.filter"

static

IGNORE_MISSING_GROUPS

final String org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.IGNORE_MISSING_GROUPS = "ignore.missing.groups"

static

LOAD_GROUPS_BY_MEMBER_ATTRIBUTE

final String org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.LOAD_GROUPS_BY_MEMBER_ATTRIBUTE = "LOAD_GROUPS_BY_MEMBER_ATTRIBUTE"

static

LOAD_GROUPS_BY_MEMBER_ATTRIBUTE_RECURSIVELY

final String org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.LOAD_GROUPS_BY_MEMBER_ATTRIBUTE_RECURSIVELY = "LOAD_GROUPS_BY_MEMBER_ATTRIBUTE_RECURSIVELY"

static

MAPPED_GROUP_ATTRIBUTES

final String org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.MAPPED_GROUP_ATTRIBUTES = "mapped.group.attributes"

static

mapperModel

final ComponentModel org.keycloak.storage.ldap.mappers.membership.CommonLDAPGroupMapperConfig.mapperModel

protectedinherited

MEMBEROF_LDAP_ATTRIBUTE

final String org.keycloak.storage.ldap.mappers.membership.CommonLDAPGroupMapperConfig.MEMBEROF_LDAP_ATTRIBUTE = "memberof.ldap.attribute"

staticinherited

MEMBERSHIP_ATTRIBUTE_TYPE

final String org.keycloak.storage.ldap.mappers.membership.CommonLDAPGroupMapperConfig.MEMBERSHIP_ATTRIBUTE_TYPE = "membership.attribute.type"

staticinherited

MEMBERSHIP_LDAP_ATTRIBUTE

final String org.keycloak.storage.ldap.mappers.membership.CommonLDAPGroupMapperConfig.MEMBERSHIP_LDAP_ATTRIBUTE = "membership.ldap.attribute"

staticinherited

MEMBERSHIP_USER_LDAP_ATTRIBUTE

final String org.keycloak.storage.ldap.mappers.membership.CommonLDAPGroupMapperConfig.MEMBERSHIP_USER_LDAP_ATTRIBUTE = "membership.user.ldap.attribute"

staticinherited

MODE

final String org.keycloak.storage.ldap.mappers.membership.CommonLDAPGroupMapperConfig.MODE = "mode"

staticinherited

PRESERVE_GROUP_INHERITANCE

final String org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig.PRESERVE_GROUP_INHERITANCE = "preserve.group.inheritance"

static

USER_ROLES_RETRIEVE_STRATEGY

final String org.keycloak.storage.ldap.mappers.membership.CommonLDAPGroupMapperConfig.USER_ROLES_RETRIEVE_STRATEGY = "user.roles.retrieve.strategy"

staticinherited

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/storage/ldap/mappers/membership/group/GroupMapperConfig.java