Package org.keycloak.storage
Class UserStorageManager
java.lang.Object
org.keycloak.storage.AbstractStorageManager<UserStorageProvider,UserStorageProviderModel>
org.keycloak.storage.UserStorageManager
- All Implemented Interfaces:
OnUserCache,UserProvider,Provider,OnCreateComponent,OnUpdateComponent,UserBulkUpdateProvider,UserCountMethodsProvider,UserLookupProvider,UserQueryMethodsProvider,UserQueryProvider,UserRegistrationProvider,UserProfileDecorator
public class UserStorageManager
extends AbstractStorageManager<UserStorageProvider,UserStorageProviderModel>
implements UserProvider, OnUserCache, OnCreateComponent, OnUpdateComponent, UserProfileDecorator
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
Field Summary
Fields inherited from class org.keycloak.storage.AbstractStorageManager
session -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddConsent(RealmModel realm, String userId, UserConsentModel consent) voidaddFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink) addUser(RealmModel realm, String username) UserRegistrationProvidermethods implementations start hereaddUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) UserStorageProvidermethods implementation end hereUserProvidermethods implementations start here -> no StorageProviders involvedvoidclose()UserProvidermethods implementations end heredecorateUserProfile(String providerId, UserProfileMetadata metadata) protected voiddeleteInvalidUser(RealmModel realm, UserModel user) getConsentByClient(RealmModel realm, String userId, String clientInternalId) getConsentsStream(RealmModel realm, String userId) getFederatedIdentitiesStream(RealmModel realm, UserModel user) getFederatedIdentity(RealmModel realm, UserModel user, String socialProvider) getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) UserLookupProvidermethods implementations end hereUserQueryProvidermethods implementation start heregetGroupMembersStream(RealmModel realm, GroupModel group, String search, Boolean exact, Integer firstResult, Integer maxResults) intgetNotBeforeOfUser(RealmModel realm, UserModel user) getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) getServiceAccount(ClientModel client) getUserByCredential(RealmModel realm, CredentialInput input) getUserByEmail(RealmModel realm, String email) getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink) getUserById(RealmModel realm, String id) UserRegistrationProvidermethods implementations end hereUserLookupProvidermethods implementations start heregetUserByUsername(RealmModel realm, String username) intgetUsersCount(RealmModel realm) intgetUsersCount(RealmModel realm, boolean includeServiceAccount) intgetUsersCount(RealmModel realm, String search) intgetUsersCount(RealmModel realm, String search, Set<String> groupIds) intgetUsersCount(RealmModel realm, Map<String, String> params) intgetUsersCount(RealmModel realm, Map<String, String> params, Set<String> groupIds) intgetUsersCount(RealmModel realm, Set<String> groupIds) voidgrantToAllUsers(RealmModel realm, RoleModel role) UserQueryProvidermethods implementation end hereUserBulkUpdateProvidermethods implementation start hereimportValidation(RealmModel realm, Stream<UserModel> users) protected UserModelimportValidation(RealmModel realm, UserModel user) Allows a UserStorageProvider to proxy and/or synchronize an imported user.protected UserProvidervoidonCache(RealmModel realm, CachedUserModel user, UserModel delegate) voidonCreate(KeycloakSession session, RealmModel realm, ComponentModel model) voidonUpdate(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) voidpreRemove(ClientScopeModel clientScope) voidpreRemove(ProtocolMapperModel protocolMapper) voidpreRemove(RealmModel realm) UserBulkUpdateProvidermethods implementation end hereUserStorageProvidermethods implementations start here -> no StorageProviders involvedvoidpreRemove(RealmModel realm, ComponentModel component) voidpreRemove(RealmModel realm, ClientModel client) voidpreRemove(RealmModel realm, GroupModel group) voidpreRemove(RealmModel realm, IdentityProviderModel provider) voidpreRemove(RealmModel realm, RoleModel role) query(org.keycloak.storage.UserStorageManager.PaginatedQuery pagedQuery, RealmModel realm, Integer firstResult, Integer maxResults) query(org.keycloak.storage.UserStorageManager.PaginatedQuery pagedQuery, org.keycloak.storage.UserStorageManager.CountQuery countQuery, RealmModel realm, Integer firstResult, Integer maxResults) booleanremoveFederatedIdentity(RealmModel realm, UserModel user, String socialProvider) voidremoveImportedUsers(RealmModel realm, String storageProviderId) booleanremoveUser(RealmModel realm, UserModel user) booleanrevokeConsentForClient(RealmModel realm, String userId, String clientInternalId) searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue) searchForUserStream(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) voidsetNotBeforeForUser(RealmModel realm, UserModel user, int notBefore) voidunlinkUsers(RealmModel realm, String storageProviderId) voidupdateConsent(RealmModel realm, String userId, UserConsentModel consent) voidupdateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) Methods inherited from class org.keycloak.storage.AbstractStorageManager
consumeEnabledStorageProvidersWithTimeout, flatMapEnabledStorageProvidersWithTimeout, getEnabledStorageProviders, getStorageProviderFactory, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderModel, getStorageProviderModels, getStorageProviderTimeout, mapEnabledStorageProvidersWithTimeoutMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.keycloak.storage.user.UserQueryMethodsProvider
getGroupMembersStream, getRoleMembersStream, searchForUserStream, searchForUserStream, searchForUserStream
-
Constructor Details
-
UserStorageManager
-
-
Method Details
-
localStorage
-
importValidation
Allows a UserStorageProvider to proxy and/or synchronize an imported user.- Parameters:
realm-user-- Returns:
-
getUserByCredential
- Specified by:
getUserByCredentialin interfaceUserLookupProvider
-
deleteInvalidUser
-
importValidation
-
query
protected Stream<UserModel> query(org.keycloak.storage.UserStorageManager.PaginatedQuery pagedQuery, RealmModel realm, Integer firstResult, Integer maxResults) -
query
protected Stream<UserModel> query(org.keycloak.storage.UserStorageManager.PaginatedQuery pagedQuery, org.keycloak.storage.UserStorageManager.CountQuery countQuery, RealmModel realm, Integer firstResult, Integer maxResults) -
addUser
UserRegistrationProvidermethods implementations start here- Specified by:
addUserin interfaceUserRegistrationProvider
-
removeUser
- Specified by:
removeUserin interfaceUserRegistrationProvider
-
getUserById
UserRegistrationProvidermethods implementations end hereUserLookupProvidermethods implementations start here- Specified by:
getUserByIdin interfaceUserLookupProvider
-
getUserByUsername
- Specified by:
getUserByUsernamein interfaceUserLookupProvider
-
getUserByEmail
- Specified by:
getUserByEmailin interfaceUserLookupProvider
-
getGroupMembersStream
public Stream<UserModel> getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) UserLookupProvidermethods implementations end hereUserQueryProvidermethods implementation start here- Specified by:
getGroupMembersStreamin interfaceUserQueryMethodsProvider
-
getGroupMembersStream
public Stream<UserModel> getGroupMembersStream(RealmModel realm, GroupModel group, String search, Boolean exact, Integer firstResult, Integer maxResults) - Specified by:
getGroupMembersStreamin interfaceUserQueryMethodsProvider
-
getRoleMembersStream
public Stream<UserModel> getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) - Specified by:
getRoleMembersStreamin interfaceUserQueryMethodsProvider
-
getUsersCount
- Specified by:
getUsersCountin interfaceUserCountMethodsProvider
-
getUsersCount
- Specified by:
getUsersCountin interfaceUserCountMethodsProvider
-
getUsersCount
- Specified by:
getUsersCountin interfaceUserCountMethodsProvider
-
getUsersCount
- Specified by:
getUsersCountin interfaceUserCountMethodsProvider
-
getUsersCount
- Specified by:
getUsersCountin interfaceUserCountMethodsProvider
-
getUsersCount
- Specified by:
getUsersCountin interfaceUserCountMethodsProvider
-
getUsersCount
- Specified by:
getUsersCountin interfaceUserCountMethodsProvider
-
searchForUserStream
public Stream<UserModel> searchForUserStream(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) - Specified by:
searchForUserStreamin interfaceUserQueryMethodsProvider
-
searchForUserByUserAttributeStream
public Stream<UserModel> searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue) - Specified by:
searchForUserByUserAttributeStreamin interfaceUserQueryMethodsProvider
-
grantToAllUsers
UserQueryProvidermethods implementation end hereUserBulkUpdateProvidermethods implementation start here- Specified by:
grantToAllUsersin interfaceUserBulkUpdateProvider
-
preRemove
UserBulkUpdateProvidermethods implementation end hereUserStorageProvidermethods implementations start here -> no StorageProviders involved- Specified by:
preRemovein interfaceUserProvider
-
preRemove
- Specified by:
preRemovein interfaceUserProvider
-
preRemove
- Specified by:
preRemovein interfaceUserProvider
-
addUser
public UserModel addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) UserStorageProvidermethods implementation end hereUserProvidermethods implementations start here -> no StorageProviders involved- Specified by:
addUserin interfaceUserProvider
-
addFederatedIdentity
public void addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink) - Specified by:
addFederatedIdentityin interfaceUserProvider
-
updateFederatedIdentity
public void updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) - Specified by:
updateFederatedIdentityin interfaceUserProvider
-
removeFederatedIdentity
- Specified by:
removeFederatedIdentityin interfaceUserProvider
-
preRemove
- Specified by:
preRemovein interfaceUserProvider
-
addConsent
- Specified by:
addConsentin interfaceUserProvider
-
getConsentByClient
public UserConsentModel getConsentByClient(RealmModel realm, String userId, String clientInternalId) - Specified by:
getConsentByClientin interfaceUserProvider
-
getConsentsStream
- Specified by:
getConsentsStreamin interfaceUserProvider
-
updateConsent
- Specified by:
updateConsentin interfaceUserProvider
-
revokeConsentForClient
- Specified by:
revokeConsentForClientin interfaceUserProvider
-
setNotBeforeForUser
- Specified by:
setNotBeforeForUserin interfaceUserProvider
-
getNotBeforeOfUser
- Specified by:
getNotBeforeOfUserin interfaceUserProvider
-
getUserByFederatedIdentity
- Specified by:
getUserByFederatedIdentityin interfaceUserProvider
-
getServiceAccount
- Specified by:
getServiceAccountin interfaceUserProvider
-
getFederatedIdentitiesStream
public Stream<FederatedIdentityModel> getFederatedIdentitiesStream(RealmModel realm, UserModel user) - Specified by:
getFederatedIdentitiesStreamin interfaceUserProvider
-
getFederatedIdentity
public FederatedIdentityModel getFederatedIdentity(RealmModel realm, UserModel user, String socialProvider) - Specified by:
getFederatedIdentityin interfaceUserProvider
-
preRemove
- Specified by:
preRemovein interfaceUserProvider
-
preRemove
- Specified by:
preRemovein interfaceUserProvider
-
preRemove
- Specified by:
preRemovein interfaceUserProvider
-
preRemove
- Specified by:
preRemovein interfaceUserProvider
-
removeImportedUsers
- Specified by:
removeImportedUsersin interfaceUserProvider
-
unlinkUsers
- Specified by:
unlinkUsersin interfaceUserProvider
-
close
public void close()UserProvidermethods implementations end here -
onCreate
- Specified by:
onCreatein interfaceOnCreateComponent
-
onUpdate
public void onUpdate(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) - Specified by:
onUpdatein interfaceOnUpdateComponent
-
onCache
- Specified by:
onCachein interfaceOnUserCache
-
decorateUserProfile
- Specified by:
decorateUserProfilein interfaceUserProfileDecorator
-