org.keycloak.federation.ldap.mappers

Class UserAttributeLDAPFederationMapper

java.lang.Object

org.keycloak.federation.ldap.mappers.AbstractLDAPFederationMapper

org.keycloak.federation.ldap.mappers.UserAttributeLDAPFederationMapper

All Implemented Interfaces:

LDAPFederationMapper, UserFederationMapper, Provider

public class UserAttributeLDAPFederationMapper
extends AbstractLDAPFederationMapper

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALWAYS_READ_VALUE_FROM_LDAP
static String	IS_MANDATORY_IN_LDAP
static String	LDAP_ATTRIBUTE
static String	READ_ONLY
static String	USER_MODEL_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
UserAttributeLDAPFederationMapper()

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 void	checkDuplicateEmail(String userModelAttrName, String email, RealmModel realm, KeycloakSession session, UserModel user)
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
protected void	setPropertyOnUserModel(Property<Object> userModelProperty, UserModel user, String ldapAttrValue)

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

USER_MODEL_ATTRIBUTE

public static final String USER_MODEL_ATTRIBUTE

See Also:

Constant Field Values

LDAP_ATTRIBUTE

public static final String LDAP_ATTRIBUTE

See Also:

Constant Field Values

READ_ONLY

public static final String READ_ONLY

See Also:

Constant Field Values

ALWAYS_READ_VALUE_FROM_LDAP

public static final String ALWAYS_READ_VALUE_FROM_LDAP

See Also:

Constant Field Values

IS_MANDATORY_IN_LDAP

public static final String IS_MANDATORY_IN_LDAP

See Also:

Constant Field Values

Constructor Detail

UserAttributeLDAPFederationMapper

public UserAttributeLDAPFederationMapper()

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

checkDuplicateEmail

protected void checkDuplicateEmail(String userModelAttrName,
                       String email,
                       RealmModel realm,
                       KeycloakSession session,
                       UserModel user)

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)

setPropertyOnUserModel

protected void setPropertyOnUserModel(Property<Object> userModelProperty,
                          UserModel user,
                          String ldapAttrValue)