org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig クラス

org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig の継承関係図

org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig 連携図

公開メンバ関数
	RoleMapperConfig (ComponentModel mapperModel)
String	getRolesDn ()
String	getLDAPGroupsDn ()
String	getRoleNameLdapAttribute ()
String	getLDAPGroupNameLdapAttribute ()
Collection< String >	getRoleObjectClasses (LDAPStorageProvider ldapProvider)
String	getCustomLdapFilter ()
boolean	isRealmRolesMapping ()
String	getClientId ()
String	getUserRolesRetrieveStrategy ()
String	getMembershipLdapAttribute ()
MembershipType	getMembershipTypeLdapAttribute ()
String	getMembershipUserLdapAttribute (LDAPConfig ldapConfig)
String	getMemberOfLdapAttribute ()
LDAPGroupMapperMode	getMode ()

静的公開変数類
static final String	ROLES_DN = "roles.dn"
static final String	ROLE_NAME_LDAP_ATTRIBUTE = "role.name.ldap.attribute"
static final String	ROLE_OBJECT_CLASSES = "role.object.classes"
static final String	USE_REALM_ROLES_MAPPING = "use.realm.roles.mapping"
static final String	CLIENT_ID = "client.id"
static final String	ROLES_LDAP_FILTER = "roles.ldap.filter"
static final String	LOAD_ROLES_BY_MEMBER_ATTRIBUTE = "LOAD_ROLES_BY_MEMBER_ATTRIBUTE"
static final String	GET_ROLES_FROM_USER_MEMBEROF_ATTRIBUTE = "GET_ROLES_FROM_USER_MEMBEROF_ATTRIBUTE"
static final String	LOAD_ROLES_BY_MEMBER_ATTRIBUTE_RECURSIVELY = "LOAD_ROLES_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

構築子と解体子

RoleMapperConfig()

org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.RoleMapperConfig ( ComponentModel  mapperModel )

inline

                                                        {
        super(mapperModel);
    }

関数詳解

getClientId()

String org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.getClientId ( )

inline

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

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.role.RoleMapperConfig.getCustomLdapFilter ( )

inline

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

getLDAPGroupNameLdapAttribute()

String org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.getLDAPGroupNameLdapAttribute ( )

inline

                                                  {
        return getRoleNameLdapAttribute();
    }

getLDAPGroupsDn()

String org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.getLDAPGroupsDn ( )

inline

                                    {
        return getRolesDn();
    }

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());
    }

getRoleNameLdapAttribute()

String org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.getRoleNameLdapAttribute ( )

inline

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

getRoleObjectClasses()

Collection<String> org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.getRoleObjectClasses ( LDAPStorageProvider  ldapProvider )

inline

                                                                                     {
        String objectClasses = mapperModel.getConfig().getFirst(ROLE_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);
    }

getRolesDn()

String org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.getRolesDn ( )

inline

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

getUserRolesRetrieveStrategy()

String org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.getUserRolesRetrieveStrategy ( )

inline

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

isRealmRolesMapping()

boolean org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.isRealmRolesMapping ( )

inline

                                         {
        String realmRolesMapping = mapperModel.getConfig().getFirst(USE_REALM_ROLES_MAPPING);
        return realmRolesMapping==null || Boolean.parseBoolean(realmRolesMapping);
    }

メンバ詳解

CLIENT_ID

final String org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.CLIENT_ID = "client.id"

static

GET_ROLES_FROM_USER_MEMBEROF_ATTRIBUTE

final String org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.GET_ROLES_FROM_USER_MEMBEROF_ATTRIBUTE = "GET_ROLES_FROM_USER_MEMBEROF_ATTRIBUTE"

static

LOAD_ROLES_BY_MEMBER_ATTRIBUTE

final String org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.LOAD_ROLES_BY_MEMBER_ATTRIBUTE = "LOAD_ROLES_BY_MEMBER_ATTRIBUTE"

static

LOAD_ROLES_BY_MEMBER_ATTRIBUTE_RECURSIVELY

final String org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.LOAD_ROLES_BY_MEMBER_ATTRIBUTE_RECURSIVELY = "LOAD_ROLES_BY_MEMBER_ATTRIBUTE_RECURSIVELY"

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

ROLE_NAME_LDAP_ATTRIBUTE

final String org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.ROLE_NAME_LDAP_ATTRIBUTE = "role.name.ldap.attribute"

static

ROLE_OBJECT_CLASSES

final String org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.ROLE_OBJECT_CLASSES = "role.object.classes"

static

ROLES_DN

final String org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.ROLES_DN = "roles.dn"

static

ROLES_LDAP_FILTER

final String org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.ROLES_LDAP_FILTER = "roles.ldap.filter"

static

USE_REALM_ROLES_MAPPING

final String org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig.USE_REALM_ROLES_MAPPING = "use.realm.roles.mapping"

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/role/RoleMapperConfig.java