org.keycloak.storage.ldap.mappers

Class FullNameLDAPStorageMapper

java.lang.Object

org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper

org.keycloak.storage.ldap.mappers.FullNameLDAPStorageMapper

public class FullNameLDAPStorageMapper
extends AbstractLDAPStorageMapper

Mapper useful for the LDAP deployments when some attribute (usually CN) is mapped to full name of user

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field and Description
static String	LDAP_FULL_NAME_ATTRIBUTE
static String	READ_ONLY
static String	WRITE_ONLY

Fields inherited from class org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper

ldapProvider, mapperModel, realm

Constructor Summary

Constructors

Constructor and Description
FullNameLDAPStorageMapper(ComponentModel mapperModel, LDAPStorageProvider ldapProvider, RealmModel realm)

Method Summary

Modifier and Type	Method and Description
void	beforeLDAPQuery(LDAPQuery query)
protected String	getFullName(String firstName, String lastName)
protected String	getLdapFullNameAttrName()
void	onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, boolean isCreate)
void	onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser)
UserModel	proxy(LDAPObject ldapUser, UserModel delegate)

Methods inherited from class org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper

getGroupMembers, getLdapProvider, getRealm, onAuthenticationFailure, parseBooleanParameter, syncDataFromFederationProviderToKeycloak, syncDataFromKeycloakToFederationProvider

Methods inherited from class java.lang.Object

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

Field Detail

LDAP_FULL_NAME_ATTRIBUTE

public static final String LDAP_FULL_NAME_ATTRIBUTE

See Also:

Constant Field Values

READ_ONLY

public static final String READ_ONLY

See Also:

Constant Field Values

WRITE_ONLY

public static final String WRITE_ONLY

See Also:

Constant Field Values

Constructor Detail

FullNameLDAPStorageMapper

public FullNameLDAPStorageMapper(ComponentModel mapperModel,
                                 LDAPStorageProvider ldapProvider,
                                 RealmModel realm)

Method Detail

onImportUserFromLDAP

public void onImportUserFromLDAP(LDAPObject ldapUser,
                                 UserModel user,
                                 boolean isCreate)

Specified by:

onImportUserFromLDAP in class AbstractLDAPStorageMapper

See Also:

LDAPStorageMapper.onImportUserFromLDAP(ComponentModel, LDAPStorageProvider, LDAPObject, UserModel, RealmModel, boolean)

onRegisterUserToLDAP

public void onRegisterUserToLDAP(LDAPObject ldapUser,
                                 UserModel localUser)

Specified by:

onRegisterUserToLDAP in class AbstractLDAPStorageMapper

See Also:

LDAPStorageMapper.onRegisterUserToLDAP(ComponentModel, LDAPStorageProvider, LDAPObject, UserModel, RealmModel)

proxy

public UserModel proxy(LDAPObject ldapUser,
                       UserModel delegate)

Specified by:

proxy in class AbstractLDAPStorageMapper

See Also:

LDAPStorageMapper.proxy(ComponentModel, LDAPStorageProvider, LDAPObject, UserModel, RealmModel)

beforeLDAPQuery

public void beforeLDAPQuery(LDAPQuery query)

Specified by:

beforeLDAPQuery in class AbstractLDAPStorageMapper

See Also:

LDAPStorageMapper.beforeLDAPQuery(ComponentModel, LDAPQuery)

getLdapFullNameAttrName

protected String getLdapFullNameAttrName()

getFullName

protected String getFullName(String firstName,
                             String lastName)