public class GroupLDAPStorageMapper extends AbstractLDAPStorageMapper implements CommonLDAPGroupMapper
Modifier and Type | Class and Description |
---|---|
class |
GroupLDAPStorageMapper.LDAPGroupMappingsUserDelegate |
ldapProvider, mapperModel, session
Constructor and Description |
---|
GroupLDAPStorageMapper(ComponentModel mapperModel,
LDAPStorageProvider ldapProvider,
GroupLDAPStorageMapperFactory factory) |
Modifier and Type | Method and Description |
---|---|
void |
addGroupMappingInLDAP(RealmModel realm,
GroupModel kcGroup,
LDAPObject ldapUser) |
void |
beforeLDAPQuery(LDAPQuery query)
Called before LDAP Identity query for retrieve LDAP users was executed.
|
LDAPQuery |
createGroupQuery(boolean includeMemberAttribute) |
protected GroupModel |
createKcGroup(RealmModel realm,
String ldapGroupName,
GroupModel parentGroup)
Creates a new KC group from given LDAP group name in given KC parent group or the groups path.
|
LDAPObject |
createLDAPGroup(String groupName,
Map<String,Set<String>> additionalAttributes) |
LDAPQuery |
createLDAPGroupQuery() |
void |
deleteGroupMappingInLDAP(LDAPObject ldapUser,
LDAPObject ldapGroup) |
protected GroupModel |
findKcGroupByLDAPGroup(RealmModel realm,
LDAPObject ldapGroup) |
protected GroupModel |
findKcGroupOrSyncFromLDAP(RealmModel realm,
LDAPObject ldapGroup,
UserModel user) |
protected List<GroupModel> |
getAllKcGroups(RealmModel realm)
Provides a list of all KC groups (with their sub groups) from groups path configured by the "Groups Path" configuration property.
|
protected List<LDAPObject> |
getAllLDAPGroups(boolean includeMemberAttribute) |
CommonLDAPGroupMapperConfig |
getConfig() |
List<UserModel> |
getGroupMembers(RealmModel realm,
GroupModel kcGroup,
int firstResult,
int maxResults)
Return empty list if doesn't support storing of groups
|
protected String |
getKcGroupPathFromLDAPGroupName(String ldapGroupName)
Translates given LDAP group name into a KC group within the groups path.
|
protected GroupModel |
getKcGroupsPathGroup(RealmModel realm)
Provides KC group defined as groups path or null (top-level group) if corresponding group is not available.
|
protected Collection<GroupModel> |
getKcSubGroups(RealmModel realm,
GroupModel parentGroup)
Provides a list of all KC sub groups from given parent group or from groups path.
|
protected List<LDAPObject> |
getLDAPGroupMappings(LDAPObject ldapUser) |
protected Set<LDAPDn> |
getLDAPSubgroups(LDAPObject ldapGroup) |
protected String |
getMembershipUserLdapAttribute() |
LDAPObject |
loadLDAPGroupByName(String groupName) |
void |
onImportUserFromLDAP(LDAPObject ldapUser,
UserModel user,
RealmModel realm,
boolean isCreate)
Called when importing user from LDAP to local keycloak DB.
|
void |
onRegisterUserToLDAP(LDAPObject ldapUser,
UserModel localUser,
RealmModel realm)
Called when register new user to LDAP - just after user was created in Keycloak DB
|
UserModel |
proxy(LDAPObject ldapUser,
UserModel delegate,
RealmModel realm)
Called when invoke proxy on LDAP federation provider
|
SynchronizationResult |
syncDataFromFederationProviderToKeycloak(RealmModel realm)
Sync data from federated storage to Keycloak.
|
SynchronizationResult |
syncDataFromKeycloakToFederationProvider(RealmModel realm)
Sync data from Keycloak back to federated storage
|
LDAPObject |
updateLDAPGroup(LDAPObject ldapObject) |
close, getLdapProvider, onAuthenticationFailure, parseBooleanParameter
public GroupLDAPStorageMapper(ComponentModel mapperModel, LDAPStorageProvider ldapProvider, GroupLDAPStorageMapperFactory factory)
public LDAPQuery createLDAPGroupQuery()
createLDAPGroupQuery
in interface CommonLDAPGroupMapper
public CommonLDAPGroupMapperConfig getConfig()
getConfig
in interface CommonLDAPGroupMapper
public LDAPQuery createGroupQuery(boolean includeMemberAttribute)
public LDAPObject createLDAPGroup(String groupName, Map<String,Set<String>> additionalAttributes)
public LDAPObject loadLDAPGroupByName(String groupName)
public LDAPObject updateLDAPGroup(LDAPObject ldapObject)
protected Set<LDAPDn> getLDAPSubgroups(LDAPObject ldapGroup)
public SynchronizationResult syncDataFromFederationProviderToKeycloak(RealmModel realm)
LDAPStorageMapper
syncDataFromFederationProviderToKeycloak
in interface LDAPStorageMapper
syncDataFromFederationProviderToKeycloak
in class AbstractLDAPStorageMapper
protected GroupModel findKcGroupByLDAPGroup(RealmModel realm, LDAPObject ldapGroup)
protected GroupModel findKcGroupOrSyncFromLDAP(RealmModel realm, LDAPObject ldapGroup, UserModel user)
protected List<LDAPObject> getAllLDAPGroups(boolean includeMemberAttribute)
public SynchronizationResult syncDataFromKeycloakToFederationProvider(RealmModel realm)
LDAPStorageMapper
syncDataFromKeycloakToFederationProvider
in interface LDAPStorageMapper
syncDataFromKeycloakToFederationProvider
in class AbstractLDAPStorageMapper
public List<UserModel> getGroupMembers(RealmModel realm, GroupModel kcGroup, int firstResult, int maxResults)
LDAPStorageMapper
getGroupMembers
in interface LDAPStorageMapper
getGroupMembers
in class AbstractLDAPStorageMapper
public void addGroupMappingInLDAP(RealmModel realm, GroupModel kcGroup, LDAPObject ldapUser)
public void deleteGroupMappingInLDAP(LDAPObject ldapUser, LDAPObject ldapGroup)
protected List<LDAPObject> getLDAPGroupMappings(LDAPObject ldapUser)
public void beforeLDAPQuery(LDAPQuery query)
LDAPStorageMapper
beforeLDAPQuery
in interface LDAPStorageMapper
public UserModel proxy(LDAPObject ldapUser, UserModel delegate, RealmModel realm)
LDAPStorageMapper
proxy
in interface LDAPStorageMapper
public void onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser, RealmModel realm)
LDAPStorageMapper
onRegisterUserToLDAP
in interface LDAPStorageMapper
public void onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)
LDAPStorageMapper
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 LDAPprotected String getMembershipUserLdapAttribute()
protected String getKcGroupPathFromLDAPGroupName(String ldapGroupName)
protected GroupModel getKcGroupsPathGroup(RealmModel realm)
protected GroupModel createKcGroup(RealmModel realm, String ldapGroupName, GroupModel parentGroup)
protected Collection<GroupModel> getKcSubGroups(RealmModel realm, GroupModel parentGroup)
protected List<GroupModel> getAllKcGroups(RealmModel realm)
Copyright © 2020 JBoss by Red Hat. All rights reserved.