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

Enum Class MembershipType

java.lang.Object

java.lang.Enum<MembershipType>

org.keycloak.storage.ldap.mappers.membership.MembershipType

All Implemented Interfaces:

Serializable, Comparable<MembershipType>, Constable

public enum MembershipType
extends Enum<MembershipType>

Author:

Marek Posolda

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DN	Used if LDAP role has it's members declared in form of their full DN.
UID	Used if LDAP role has it's members declared in form of pure user uids.

Method Summary

Modifier and Type	Method	Description
abstract List<UserModel>	getGroupMembers(RealmModel realm, CommonLDAPGroupMapper groupMapper, LDAPObject ldapGroup, int firstResult, int maxResults)
abstract Set<LDAPDn>	getLDAPSubgroups(CommonLDAPGroupMapper groupMapper, LDAPObject ldapGroup)
static MembershipType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MembershipType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DN

public static final MembershipType DN

Used if LDAP role has it's members declared in form of their full DN. For example ( "member: uid=john,ou=users,dc=example,dc=com" )

UID

public static final MembershipType UID

Used if LDAP role has it's members declared in form of pure user uids. For example ( "memberUid: john" )

Method Details

values

public static MembershipType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MembershipType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getLDAPSubgroups

public abstract Set<LDAPDn> getLDAPSubgroups(CommonLDAPGroupMapper groupMapper,
 LDAPObject ldapGroup)

getGroupMembers

public abstract List<UserModel> getGroupMembers(RealmModel realm,
 CommonLDAPGroupMapper groupMapper,
 LDAPObject ldapGroup,
 int firstResult,
 int maxResults)