org.keycloak.storage.ldap.mappers.membership.role

Class RoleLDAPStorageMapper

java.lang.Object

org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper

org.keycloak.storage.ldap.mappers.membership.role.RoleLDAPStorageMapper

All Implemented Interfaces:

CommonLDAPGroupMapper

public class RoleLDAPStorageMapper
extends AbstractLDAPStorageMapper
implements CommonLDAPGroupMapper

Map realm roles or roles of particular client to LDAP groups

Author:

Marek Posolda

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate

Field Summary

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

ldapProvider, mapperModel, realm

Constructor Summary

Constructors

Constructor and Description
RoleLDAPStorageMapper(ComponentModel mapperModel, LDAPStorageProvider ldapProvider, RealmModel realm, RoleLDAPStorageMapperFactory factory)

Method Summary

Modifier and Type	Method and Description
void	addRoleMappingInLDAP(String roleName, LDAPObject ldapUser)
void	beforeLDAPQuery(LDAPQuery query)
LDAPQuery	createLDAPGroupQuery()
LDAPObject	createLDAPRole(String roleName)
LDAPQuery	createRoleQuery()
void	deleteRoleMappingInLDAP(LDAPObject ldapUser, LDAPObject ldapRole)
CommonLDAPGroupMapperConfig	getConfig()
protected List<LDAPObject>	getLDAPRoleMappings(LDAPObject ldapUser)
protected RoleContainerModel	getTargetRoleContainer()
LDAPObject	loadLDAPRoleByName(String roleName)
void	onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, boolean isCreate)
void	onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser)
UserModel	proxy(LDAPObject ldapUser, UserModel delegate)
SynchronizationResult	syncDataFromFederationProviderToKeycloak()
SynchronizationResult	syncDataFromKeycloakToFederationProvider()

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

getGroupMembers, getLdapProvider, getRealm, onAuthenticationFailure, parseBooleanParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleLDAPStorageMapper

public RoleLDAPStorageMapper(ComponentModel mapperModel,
                             LDAPStorageProvider ldapProvider,
                             RealmModel realm,
                             RoleLDAPStorageMapperFactory factory)

Method Detail

createLDAPGroupQuery

public LDAPQuery createLDAPGroupQuery()

Specified by:

createLDAPGroupQuery in interface CommonLDAPGroupMapper

getConfig

public CommonLDAPGroupMapperConfig getConfig()

Specified by:

getConfig in interface CommonLDAPGroupMapper

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)

syncDataFromFederationProviderToKeycloak

public SynchronizationResult syncDataFromFederationProviderToKeycloak()

Overrides:

syncDataFromFederationProviderToKeycloak in class AbstractLDAPStorageMapper

See Also:

LDAPStorageMapper.syncDataFromFederationProviderToKeycloak(ComponentModel, LDAPStorageProvider, KeycloakSession, RealmModel)

syncDataFromKeycloakToFederationProvider

public SynchronizationResult syncDataFromKeycloakToFederationProvider()

Overrides:

syncDataFromKeycloakToFederationProvider in class AbstractLDAPStorageMapper

See Also:

LDAPStorageMapper.syncDataFromKeycloakToFederationProvider(ComponentModel, LDAPStorageProvider, KeycloakSession, RealmModel)

createRoleQuery

public LDAPQuery createRoleQuery()

getTargetRoleContainer

protected RoleContainerModel getTargetRoleContainer()

createLDAPRole

public LDAPObject createLDAPRole(String roleName)

addRoleMappingInLDAP

public void addRoleMappingInLDAP(String roleName,
                                 LDAPObject ldapUser)

deleteRoleMappingInLDAP

public void deleteRoleMappingInLDAP(LDAPObject ldapUser,
                                    LDAPObject ldapRole)

loadLDAPRoleByName

public LDAPObject loadLDAPRoleByName(String roleName)

getLDAPRoleMappings

protected List<LDAPObject> getLDAPRoleMappings(LDAPObject ldapUser)

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)