org.keycloak.federation.ldap.mappers

Class FullNameLDAPFederationMapper

java.lang.Object

org.keycloak.federation.ldap.mappers.AbstractLDAPFederationMapper

org.keycloak.federation.ldap.mappers.FullNameLDAPFederationMapper

All Implemented Interfaces:

LDAPFederationMapper, UserFederationMapper, Provider

public class FullNameLDAPFederationMapper
extends AbstractLDAPFederationMapper

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

Constructor Summary

Constructors

Constructor and Description
FullNameLDAPFederationMapper()

Method Summary

Methods

Modifier and Type	Method and Description
void	beforeLDAPQuery(UserFederationMapperModel mapperModel, LDAPQuery query) Called before LDAP Identity query for retrieve LDAP users was executed.
protected String	getFullName(String firstName, String lastName)
protected String	getLdapFullNameAttrName(UserFederationMapperModel mapperModel)
void	onImportUserFromLDAP(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) Called when importing user from LDAP to local keycloak DB.
void	onRegisterUserToLDAP(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel localUser, RealmModel realm) Called when register new user to LDAP - just after user was created in Keycloak DB
UserModel	proxy(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel delegate, RealmModel realm) Called when invoke proxy on LDAP federation provider

Methods inherited from class org.keycloak.federation.ldap.mappers.AbstractLDAPFederationMapper

close, parseBooleanParameter

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

Constructor Detail

FullNameLDAPFederationMapper

public FullNameLDAPFederationMapper()

Method Detail

onImportUserFromLDAP

public void onImportUserFromLDAP(UserFederationMapperModel mapperModel,
                        LDAPFederationProvider ldapProvider,
                        LDAPObject ldapUser,
                        UserModel user,
                        RealmModel realm,
                        boolean isCreate)

Description copied from interface: LDAPFederationMapper

Called when importing user from LDAP to local keycloak DB.

isCreate - true if we importing new user from LDAP. False if user already exists in Keycloak, but we are upgrading (syncing) it from LDAP

onRegisterUserToLDAP

public void onRegisterUserToLDAP(UserFederationMapperModel mapperModel,
                        LDAPFederationProvider ldapProvider,
                        LDAPObject ldapUser,
                        UserModel localUser,
                        RealmModel realm)

Description copied from interface: LDAPFederationMapper

Called when register new user to LDAP - just after user was created in Keycloak DB

proxy

public UserModel proxy(UserFederationMapperModel mapperModel,
              LDAPFederationProvider ldapProvider,
              LDAPObject ldapUser,
              UserModel delegate,
              RealmModel realm)

Description copied from interface: LDAPFederationMapper

Called when invoke proxy on LDAP federation provider

Returns:

beforeLDAPQuery

public void beforeLDAPQuery(UserFederationMapperModel mapperModel,
                   LDAPQuery query)

Description copied from interface: LDAPFederationMapper

Called before LDAP Identity query for retrieve LDAP users was executed. It allows to change query somehow (add returning attributes from LDAP, change conditions etc)

getLdapFullNameAttrName

protected String getLdapFullNameAttrName(UserFederationMapperModel mapperModel)

getFullName

protected String getFullName(String firstName,
                 String lastName)