org.keycloak.storage.ldap.mappers

Class LDAPStorageMapperBridge

java.lang.Object

org.keycloak.storage.ldap.mappers.LDAPStorageMapperBridge

All Implemented Interfaces:

Provider, LDAPStorageMapper

public class LDAPStorageMapperBridge
extends Object
implements LDAPStorageMapper

Sufficient if mapper implementation is stateless and doesn't need to "close" any state

Author:

Marek Posolda

Constructor Summary

Constructors

Constructor and Description
LDAPStorageMapperBridge(AbstractLDAPStorageMapperFactory factory)

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.
void	close()
List<UserModel>	getGroupMembers(ComponentModel mapperModel, LDAPStorageProvider ldapProvider, 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 federationProvider, KeycloakSession session, RealmModel realm) Sync data from federated storage to Keycloak.
SynchronizationResult	syncDataFromKeycloakToFederationProvider(ComponentModel mapperModel, LDAPStorageProvider federationProvider, KeycloakSession session, RealmModel realm) Sync data from Keycloak back to federated storage

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPStorageMapperBridge

public LDAPStorageMapperBridge(AbstractLDAPStorageMapperFactory factory)

Method Detail

syncDataFromFederationProviderToKeycloak

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

Description copied from interface: LDAPStorageMapper

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

Specified by:

syncDataFromFederationProviderToKeycloak in interface LDAPStorageMapper

syncDataFromKeycloakToFederationProvider

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

Description copied from interface: LDAPStorageMapper

Sync data from Keycloak back to federated storage

Specified by:

syncDataFromKeycloakToFederationProvider in interface LDAPStorageMapper

onImportUserFromLDAP

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

Description copied from interface: LDAPStorageMapper

Called when importing user from LDAP to local keycloak DB.

Specified by:

onImportUserFromLDAP in interface LDAPStorageMapper

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(ComponentModel mapperModel,
                                 LDAPStorageProvider ldapProvider,
                                 LDAPObject ldapUser,
                                 UserModel localUser,
                                 RealmModel realm)

Description copied from interface: LDAPStorageMapper

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

Specified by:

onRegisterUserToLDAP in interface LDAPStorageMapper

proxy

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

Description copied from interface: LDAPStorageMapper

Called when invoke proxy on LDAP federation provider

Specified by:

proxy in interface LDAPStorageMapper

Returns:

beforeLDAPQuery

public void beforeLDAPQuery(ComponentModel mapperModel,
                            LDAPQuery query)

Description copied from interface: LDAPStorageMapper

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)

Specified by:

beforeLDAPQuery in interface LDAPStorageMapper

getGroupMembers

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

Description copied from interface: LDAPStorageMapper

Return empty list if doesn't support storing of groups

Specified by:

getGroupMembers in interface LDAPStorageMapper

onAuthenticationFailure

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

Description copied from interface: LDAPStorageMapper

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

Specified by:

onAuthenticationFailure in interface LDAPStorageMapper

Returns:

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

close

public void close()

Specified by:

close in interface Provider