org.keycloak.storage.ldap.mappers

Interface LDAPStorageMapper

All Superinterfaces:

Provider

All Known Implementing Classes:

LDAPStorageMapperBridge

public interface LDAPStorageMapper
extends Provider

Author:

Marek Posolda

Method Summary

Modifier and Type	Method and Description
void	beforeLDAPQuery(ComponentModel mapperModel, LDAPQuery query) Called before LDAP Identity query for retrieve LDAP users was executed.
List<UserModel>	getGroupMembers(ComponentModel mapperModel, LDAPStorageProvider provider, RealmModel realm, GroupModel group, int firstResult, int maxResults) Return empty list if doesn't support storing of groups
boolean	onAuthenticationFailure(ComponentModel mapperModel, LDAPStorageProvider ldapProvider, LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm) Called when LDAP authentication of specified user fails.
void	onImportUserFromLDAP(ComponentModel mapperModel, LDAPStorageProvider ldapProvider, LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate) Called when importing user from LDAP to local keycloak DB.
void	onRegisterUserToLDAP(ComponentModel mapperModel, LDAPStorageProvider ldapProvider, LDAPObject ldapUser, UserModel localUser, RealmModel realm) Called when register new user to LDAP - just after user was created in Keycloak DB
UserModel	proxy(ComponentModel mapperModel, LDAPStorageProvider ldapProvider, LDAPObject ldapUser, UserModel delegate, RealmModel realm) Called when invoke proxy on LDAP federation provider
SynchronizationResult	syncDataFromFederationProviderToKeycloak(ComponentModel mapperModel, LDAPStorageProvider provider, KeycloakSession session, RealmModel realm) Sync data from federated storage to Keycloak.
SynchronizationResult	syncDataFromKeycloakToFederationProvider(ComponentModel mapperModel, LDAPStorageProvider provider, KeycloakSession session, RealmModel realm) Sync data from Keycloak back to federated storage

Methods inherited from interface org.keycloak.provider.Provider

close

Method Detail

syncDataFromFederationProviderToKeycloak

SynchronizationResult syncDataFromFederationProviderToKeycloak(ComponentModel mapperModel,
                                                               LDAPStorageProvider provider,
                                                               KeycloakSession session,
                                                               RealmModel realm)

Sync data from federated storage to Keycloak. It's useful just if mapper needs some data preloaded from federated storage (For example load roles from federated provider and sync them to Keycloak database) Applicable just if sync is supported

Parameters:

mapperModel -

provider -

session -

realm -

syncDataFromKeycloakToFederationProvider

SynchronizationResult syncDataFromKeycloakToFederationProvider(ComponentModel mapperModel,
                                                               LDAPStorageProvider provider,
                                                               KeycloakSession session,
                                                               RealmModel realm)

Sync data from Keycloak back to federated storage

Parameters:

mapperModel -

provider -

session -

realm -

getGroupMembers

List<UserModel> getGroupMembers(ComponentModel mapperModel,
                                LDAPStorageProvider provider,
                                RealmModel realm,
                                GroupModel group,
                                int firstResult,
                                int maxResults)

Return empty list if doesn't support storing of groups

onImportUserFromLDAP

void onImportUserFromLDAP(ComponentModel mapperModel,
                          LDAPStorageProvider ldapProvider,
                          LDAPObject ldapUser,
                          UserModel user,
                          RealmModel realm,
                          boolean isCreate)

Called when importing user from LDAP to local keycloak DB.

Parameters:

mapperModel -

ldapProvider -

ldapUser -

user -

realm -

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

void onRegisterUserToLDAP(ComponentModel mapperModel,
                          LDAPStorageProvider ldapProvider,
                          LDAPObject ldapUser,
                          UserModel localUser,
                          RealmModel realm)

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

Parameters:

mapperModel -

ldapProvider -

ldapUser -

localUser -

realm -

proxy

UserModel proxy(ComponentModel mapperModel,
                LDAPStorageProvider ldapProvider,
                LDAPObject ldapUser,
                UserModel delegate,
                RealmModel realm)

Called when invoke proxy on LDAP federation provider

Parameters:

mapperModel -

ldapProvider -

ldapUser -

delegate -

realm -

Returns:

beforeLDAPQuery

void beforeLDAPQuery(ComponentModel mapperModel,
                     LDAPQuery query)

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)

Parameters:

mapperModel -

query -

onAuthenticationFailure

boolean onAuthenticationFailure(ComponentModel mapperModel,
                                LDAPStorageProvider ldapProvider,
                                LDAPObject ldapUser,
                                UserModel user,
                                AuthenticationException ldapException,
                                RealmModel realm)

Called when LDAP authentication of specified user fails. If any mapper returns true from this method, AuthenticationException won't be rethrown!

Parameters:

mapperModel -

ldapProvider -

realm -

user -

ldapUser -

ldapException -

Returns:

true if mapper processed the AuthenticationException and did some actions based on that. In that case, AuthenticationException won't be rethrown!