Package org.keycloak.storage.ldap.mappers.membership.group

Class GroupMapperConfig

java.lang.Object

org.keycloak.storage.ldap.mappers.membership.CommonLDAPGroupMapperConfig

org.keycloak.storage.ldap.mappers.membership.group.GroupMapperConfig

public class GroupMapperConfig
extends CommonLDAPGroupMapperConfig

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_LDAP_GROUPS_PATH
static final String	DROP_NON_EXISTING_GROUPS_DURING_SYNC
static final String	GET_GROUPS_FROM_USER_MEMBEROF_ATTRIBUTE
static final String	GROUP_NAME_LDAP_ATTRIBUTE
static final String	GROUP_OBJECT_CLASSES
static final String	GROUPS_DN
static final String	GROUPS_LDAP_FILTER
static final String	IGNORE_MISSING_GROUPS
static final String	LDAP_GROUPS_PATH
static final String	LOAD_GROUPS_BY_MEMBER_ATTRIBUTE
static final String	LOAD_GROUPS_BY_MEMBER_ATTRIBUTE_RECURSIVELY
static final String	MAPPED_GROUP_ATTRIBUTES
static final String	PRESERVE_GROUP_INHERITANCE

Fields inherited from class org.keycloak.storage.ldap.mappers.membership.CommonLDAPGroupMapperConfig

mapperModel, MEMBEROF_LDAP_ATTRIBUTE, MEMBERSHIP_ATTRIBUTE_TYPE, MEMBERSHIP_LDAP_ATTRIBUTE, MEMBERSHIP_USER_LDAP_ATTRIBUTE, MODE, USER_ROLES_RETRIEVE_STRATEGY

Constructor Summary

Constructors

Constructor	Description
GroupMapperConfig(ComponentModel mapperModel)

Method Summary

Modifier and Type	Method	Description
String	getCustomLdapFilter()
Collection<String>	getGroupAttributes()
String	getGroupNameLdapAttribute()
Collection<String>	getGroupObjectClasses(LDAPStorageProvider ldapProvider)
String	getGroupsDn()
String	getGroupsPath()
String	getGroupsPathWithTrailingSlash()
String	getLDAPGroupNameLdapAttribute()
String	getLDAPGroupsDn()
String	getUserGroupsRetrieveStrategy()
boolean	isDropNonExistingGroupsDuringSync()
boolean	isIgnoreMissingGroups()
boolean	isPreserveGroupsInheritance()
boolean	isTopLevelGroupsPath()

Methods inherited from class org.keycloak.storage.ldap.mappers.membership.CommonLDAPGroupMapperConfig

getConfigValues, getMemberOfLdapAttribute, getMembershipLdapAttribute, getMembershipTypeLdapAttribute, getMembershipUserLdapAttribute, getMode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

GROUPS_DN

public static final String GROUPS_DN

See Also:

• Constant Field Values

GROUP_NAME_LDAP_ATTRIBUTE

public static final String GROUP_NAME_LDAP_ATTRIBUTE

See Also:

• Constant Field Values

GROUP_OBJECT_CLASSES

public static final String GROUP_OBJECT_CLASSES

See Also:

• Constant Field Values

PRESERVE_GROUP_INHERITANCE

public static final String PRESERVE_GROUP_INHERITANCE

See Also:

• Constant Field Values

IGNORE_MISSING_GROUPS

public static final String IGNORE_MISSING_GROUPS

See Also:

• Constant Field Values

GROUPS_LDAP_FILTER

public static final String GROUPS_LDAP_FILTER

See Also:

• Constant Field Values

MAPPED_GROUP_ATTRIBUTES

public static final String MAPPED_GROUP_ATTRIBUTES

See Also:

• Constant Field Values

DROP_NON_EXISTING_GROUPS_DURING_SYNC

public static final String DROP_NON_EXISTING_GROUPS_DURING_SYNC

See Also:

• Constant Field Values

LOAD_GROUPS_BY_MEMBER_ATTRIBUTE

public static final String LOAD_GROUPS_BY_MEMBER_ATTRIBUTE

See Also:

• Constant Field Values

GET_GROUPS_FROM_USER_MEMBEROF_ATTRIBUTE

public static final String GET_GROUPS_FROM_USER_MEMBEROF_ATTRIBUTE

See Also:

• Constant Field Values

LOAD_GROUPS_BY_MEMBER_ATTRIBUTE_RECURSIVELY

public static final String LOAD_GROUPS_BY_MEMBER_ATTRIBUTE_RECURSIVELY

See Also:

• Constant Field Values

LDAP_GROUPS_PATH

public static final String LDAP_GROUPS_PATH

See Also:

• Constant Field Values

DEFAULT_LDAP_GROUPS_PATH

public static final String DEFAULT_LDAP_GROUPS_PATH

See Also:

• Constant Field Values

Constructor Details

GroupMapperConfig

public GroupMapperConfig(ComponentModel mapperModel)

Method Details

getGroupsDn

public String getGroupsDn()

getLDAPGroupsDn

public String getLDAPGroupsDn()

Specified by:

getLDAPGroupsDn in class CommonLDAPGroupMapperConfig

getGroupNameLdapAttribute

public String getGroupNameLdapAttribute()

getLDAPGroupNameLdapAttribute

public String getLDAPGroupNameLdapAttribute()

Specified by:

getLDAPGroupNameLdapAttribute in class CommonLDAPGroupMapperConfig

isPreserveGroupsInheritance

public boolean isPreserveGroupsInheritance()

isIgnoreMissingGroups

public boolean isIgnoreMissingGroups()

getGroupObjectClasses

public Collection<String> getGroupObjectClasses(LDAPStorageProvider ldapProvider)

getGroupAttributes

public Collection<String> getGroupAttributes()

getCustomLdapFilter

public String getCustomLdapFilter()

isDropNonExistingGroupsDuringSync

public boolean isDropNonExistingGroupsDuringSync()

getUserGroupsRetrieveStrategy

public String getUserGroupsRetrieveStrategy()

getGroupsPath

public String getGroupsPath()

getGroupsPathWithTrailingSlash

public String getGroupsPathWithTrailingSlash()

isTopLevelGroupsPath

public boolean isTopLevelGroupsPath()