org.keycloak.federation.ldap.idm.store.ldap

Class LDAPIdentityStore

java.lang.Object

org.keycloak.federation.ldap.idm.store.ldap.LDAPIdentityStore

All Implemented Interfaces:

IdentityStore

public class LDAPIdentityStore
extends Object
implements IdentityStore

An IdentityStore implementation backed by an LDAP directory

Author:

Shane Bryzak, Anil Saldhana, Pedro Silva

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_ATTRIBUTE_VALUE

Constructor Summary

Constructors

Constructor and Description
LDAPIdentityStore(LDAPIdentityStoreConfiguration config)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(AttributedType attributedType) Persists the specified IdentityType
protected void	addToParentAsMember(AttributedType attributedType)
<V extends IdentityType> int	countQueryResults(IdentityQuery<V> identityQuery)
protected <V extends IdentityType> StringBuilder	createIdentityTypeSearchFilter(IdentityQuery<V> identityQuery, LDAPMappingConfiguration ldapEntryConfig)
IdentityQueryBuilder	createQueryBuilder()
protected BasicAttributes	extractAttributes(AttributedType attributedType, boolean isCreate)
<V extends IdentityType> List<V>	fetchQueryResults(IdentityQuery<V> identityQuery)
String	getBindingDN(AttributedType attributedType, boolean appendBaseDN)
LDAPIdentityStoreConfiguration	getConfig() Returns the configuration for this IdentityStore instance
protected String	getEntryIdentifier(AttributedType attributedType)
LDAPUser	getUser(String username)
static boolean	isNullOrEmpty(String str)
void	remove(AttributedType attributedType) Removes the specified IdentityType
void	update(AttributedType attributedType) Updates the specified IdentityType
void	updatePassword(LDAPUser user, String password) Updates the specified credential value.
boolean	validatePassword(LDAPUser user, String password) Validates the specified credentials.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ATTRIBUTE_VALUE

public static final String EMPTY_ATTRIBUTE_VALUE

See Also:

Constant Field Values

Constructor Detail

LDAPIdentityStore

public LDAPIdentityStore(LDAPIdentityStoreConfiguration config)

Method Detail

getConfig

public LDAPIdentityStoreConfiguration getConfig()

Description copied from interface: IdentityStore

Returns the configuration for this IdentityStore instance

Specified by:

getConfig in interface IdentityStore

Returns:

add

public void add(AttributedType attributedType)

Description copied from interface: IdentityStore

Persists the specified IdentityType

Specified by:

add in interface IdentityStore

update

public void update(AttributedType attributedType)

Description copied from interface: IdentityStore

Updates the specified IdentityType

Specified by:

update in interface IdentityStore

remove

public void remove(AttributedType attributedType)

Description copied from interface: IdentityStore

Removes the specified IdentityType

Specified by:

remove in interface IdentityStore

fetchQueryResults

public <V extends IdentityType> List<V> fetchQueryResults(IdentityQuery<V> identityQuery)

Specified by:

fetchQueryResults in interface IdentityStore

countQueryResults

public <V extends IdentityType> int countQueryResults(IdentityQuery<V> identityQuery)

Specified by:

countQueryResults in interface IdentityStore

createQueryBuilder

public IdentityQueryBuilder createQueryBuilder()

validatePassword

public boolean validatePassword(LDAPUser user,
                       String password)

Description copied from interface: IdentityStore

Validates the specified credentials.

Specified by:

validatePassword in interface IdentityStore

Parameters:

user - Keycloak user

password - Ldap password

updatePassword

public void updatePassword(LDAPUser user,
                  String password)

Description copied from interface: IdentityStore

Updates the specified credential value.

Specified by:

updatePassword in interface IdentityStore

Parameters:

user - Keycloak user

password - Ldap password

getUser

public LDAPUser getUser(String username)

createIdentityTypeSearchFilter

protected <V extends IdentityType> StringBuilder createIdentityTypeSearchFilter(IdentityQuery<V> identityQuery,
                                                                    LDAPMappingConfiguration ldapEntryConfig)

extractAttributes

protected BasicAttributes extractAttributes(AttributedType attributedType,
                                boolean isCreate)

isNullOrEmpty

public static boolean isNullOrEmpty(String str)

getBindingDN

public String getBindingDN(AttributedType attributedType,
                  boolean appendBaseDN)

addToParentAsMember

protected void addToParentAsMember(AttributedType attributedType)

getEntryIdentifier

protected String getEntryIdentifier(AttributedType attributedType)