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

Constructor	Description
UserStorageManager(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
void	addConsent(RealmModel realm, String userId, UserConsentModel consent)
void	addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)
UserModel	addUser(RealmModel realm, String username)	UserRegistrationProvider methods implementations start here
UserModel	addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)	UserStorageProvider methods implementation end here UserProvider methods implementations start here -> no StorageProviders involved
void	close()	UserProvider methods implementations end here
List<AttributeMetadata>	decorateUserProfile(String providerId, UserProfileMetadata metadata)
protected void	deleteInvalidUser(RealmModel realm, UserModel user)
UserConsentModel	getConsentByClient(RealmModel realm, String userId, String clientInternalId)
Stream<UserConsentModel>	getConsentsStream(RealmModel realm, String userId)
Stream<FederatedIdentityModel>	getFederatedIdentitiesStream(RealmModel realm, UserModel user)
FederatedIdentityModel	getFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)
Stream<UserModel>	getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)	UserLookupProvider methods implementations end here UserQueryProvider methods implementation start here
Stream<UserModel>	getGroupMembersStream(RealmModel realm, GroupModel group, String search, Boolean exact, Integer firstResult, Integer maxResults)
int	getNotBeforeOfUser(RealmModel realm, UserModel user)
Stream<UserModel>	getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
UserModel	getServiceAccount(ClientModel client)
CredentialValidationOutput	getUserByCredential(RealmModel realm, CredentialInput input)
UserModel	getUserByEmail(RealmModel realm, String email)
UserModel	getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink)
UserModel	getUserById(RealmModel realm, String id)	UserRegistrationProvider methods implementations end here UserLookupProvider methods implementations start here
UserModel	getUserByUsername(RealmModel realm, String username)
int	getUsersCount(RealmModel realm)
int	getUsersCount(RealmModel realm, boolean includeServiceAccount)
int	getUsersCount(RealmModel realm, String search)
int	getUsersCount(RealmModel realm, String search, Set<String> groupIds)
int	getUsersCount(RealmModel realm, Map<String,String> params)
int	getUsersCount(RealmModel realm, Map<String,String> params, Set<String> groupIds)
int	getUsersCount(RealmModel realm, Set<String> groupIds)
void	grantToAllUsers(RealmModel realm, RoleModel role)	UserQueryProvider methods implementation end here UserBulkUpdateProvider methods implementation start here
protected Stream<UserModel>	importValidation(RealmModel realm, Stream<UserModel> users)
protected UserModel	importValidation(RealmModel realm, UserModel user)	Allows a UserStorageProvider to proxy and/or synchronize an imported user.
protected UserProvider	localStorage()
void	onCache(RealmModel realm, CachedUserModel user, UserModel delegate)
void	onCreate(KeycloakSession session, RealmModel realm, ComponentModel model)
void	onUpdate(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel)
void	preRemove(ClientScopeModel clientScope)
void	preRemove(ProtocolMapperModel protocolMapper)
void	preRemove(RealmModel realm)	UserBulkUpdateProvider methods implementation end here UserStorageProvider methods implementations start here -> no StorageProviders involved
void	preRemove(RealmModel realm, ComponentModel component)
void	preRemove(RealmModel realm, ClientModel client)
void	preRemove(RealmModel realm, GroupModel group)
void	preRemove(RealmModel realm, IdentityProviderModel provider)
void	preRemove(RealmModel realm, RoleModel role)
protected Stream<UserModel>	query(org.keycloak.storage.UserStorageManager.PaginatedQuery pagedQuery, RealmModel realm, Integer firstResult, Integer maxResults)
protected Stream<UserModel>	query(org.keycloak.storage.UserStorageManager.PaginatedQuery pagedQuery, org.keycloak.storage.UserStorageManager.CountQuery countQuery, RealmModel realm, Integer firstResult, Integer maxResults)
boolean	removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)
void	removeImportedUsers(RealmModel realm, String storageProviderId)
boolean	removeUser(RealmModel realm, UserModel user)
boolean	revokeConsentForClient(RealmModel realm, String userId, String clientInternalId)
Stream<UserModel>	searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue)
Stream<UserModel>	searchForUserStream(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
void	setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore)
void	unlinkUsers(RealmModel realm, String storageProviderId)
void	updateConsent(RealmModel realm, String userId, UserConsentModel consent)
void	updateFederatedIdentity(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, mapEnabledStorageProvidersWithTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.storage.user.UserQueryMethodsProvider

getGroupMembersStream, getRoleMembersStream, searchForUserStream, searchForUserStream, searchForUserStream

Constructor Details

UserStorageManager

public UserStorageManager(KeycloakSession session)

Method Details

localStorage

protected UserProvider localStorage()

importValidation

protected UserModel importValidation(RealmModel realm,
 UserModel user)

Allows a UserStorageProvider to proxy and/or synchronize an imported user.

Parameters:

realm -

user -

Returns:

getUserByCredential

public CredentialValidationOutput getUserByCredential(RealmModel realm,
 CredentialInput input)

Specified by:

getUserByCredential in interface UserLookupProvider

deleteInvalidUser

protected void deleteInvalidUser(RealmModel realm,
 UserModel user)

importValidation

protected Stream<UserModel> importValidation(RealmModel realm,
 Stream<UserModel> users)

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

public UserModel addUser(RealmModel realm,
 String username)

UserRegistrationProvider methods implementations start here

Specified by:

addUser in interface UserRegistrationProvider

removeUser

public boolean removeUser(RealmModel realm,
 UserModel user)

Specified by:

removeUser in interface UserRegistrationProvider

getUserById

public UserModel getUserById(RealmModel realm,
 String id)

UserRegistrationProvider methods implementations end here UserLookupProvider methods implementations start here

Specified by:

getUserById in interface UserLookupProvider

getUserByUsername

public UserModel getUserByUsername(RealmModel realm,
 String username)

Specified by:

getUserByUsername in interface UserLookupProvider

getUserByEmail

public UserModel getUserByEmail(RealmModel realm,
 String email)

Specified by:

getUserByEmail in interface UserLookupProvider

getGroupMembersStream

public Stream<UserModel> getGroupMembersStream(RealmModel realm,
 GroupModel group,
 Integer firstResult,
 Integer maxResults)

UserLookupProvider methods implementations end here UserQueryProvider methods implementation start here

Specified by:

getGroupMembersStream in interface UserQueryMethodsProvider

getGroupMembersStream

public Stream<UserModel> getGroupMembersStream(RealmModel realm,
 GroupModel group,
 String search,
 Boolean exact,
 Integer firstResult,
 Integer maxResults)

Specified by:

getGroupMembersStream in interface UserQueryMethodsProvider

getRoleMembersStream

public Stream<UserModel> getRoleMembersStream(RealmModel realm,
 RoleModel role,
 Integer firstResult,
 Integer maxResults)

Specified by:

getRoleMembersStream in interface UserQueryMethodsProvider

getUsersCount

public int getUsersCount(RealmModel realm,
 boolean includeServiceAccount)

Specified by:

getUsersCount in interface UserCountMethodsProvider

getUsersCount

public int getUsersCount(RealmModel realm)

Specified by:

getUsersCount in interface UserCountMethodsProvider

getUsersCount

public int getUsersCount(RealmModel realm,
 Set<String> groupIds)

Specified by:

getUsersCount in interface UserCountMethodsProvider

getUsersCount

public int getUsersCount(RealmModel realm,
 String search)

Specified by:

getUsersCount in interface UserCountMethodsProvider

getUsersCount

public int getUsersCount(RealmModel realm,
 String search,
 Set<String> groupIds)

Specified by:

getUsersCount in interface UserCountMethodsProvider

getUsersCount

public int getUsersCount(RealmModel realm,
 Map<String,String> params)

Specified by:

getUsersCount in interface UserCountMethodsProvider

getUsersCount

public int getUsersCount(RealmModel realm,
 Map<String,String> params,
 Set<String> groupIds)

Specified by:

getUsersCount in interface UserCountMethodsProvider

searchForUserStream

public Stream<UserModel> searchForUserStream(RealmModel realm,
 Map<String,String> attributes,
 Integer firstResult,
 Integer maxResults)

Specified by:

searchForUserStream in interface UserQueryMethodsProvider

searchForUserByUserAttributeStream

public Stream<UserModel> searchForUserByUserAttributeStream(RealmModel realm,
 String attrName,
 String attrValue)

Specified by:

searchForUserByUserAttributeStream in interface UserQueryMethodsProvider

grantToAllUsers

public void grantToAllUsers(RealmModel realm,
 RoleModel role)

UserQueryProvider methods implementation end here UserBulkUpdateProvider methods implementation start here

Specified by:

grantToAllUsers in interface UserBulkUpdateProvider

preRemove

public void preRemove(RealmModel realm)

UserBulkUpdateProvider methods implementation end here UserStorageProvider methods implementations start here -> no StorageProviders involved

Specified by:

preRemove in interface UserProvider

preRemove

public void preRemove(RealmModel realm,
 GroupModel group)

Specified by:

preRemove in interface UserProvider

preRemove

public void preRemove(RealmModel realm,
 RoleModel role)

Specified by:

preRemove in interface UserProvider

addUser

public UserModel addUser(RealmModel realm,
 String id,
 String username,
 boolean addDefaultRoles,
 boolean addDefaultRequiredActions)

UserStorageProvider methods implementation end here UserProvider methods implementations start here -> no StorageProviders involved

Specified by:

addUser in interface UserProvider

addFederatedIdentity

public void addFederatedIdentity(RealmModel realm,
 UserModel user,
 FederatedIdentityModel socialLink)

Specified by:

addFederatedIdentity in interface UserProvider

updateFederatedIdentity

public void updateFederatedIdentity(RealmModel realm,
 UserModel federatedUser,
 FederatedIdentityModel federatedIdentityModel)

Specified by:

updateFederatedIdentity in interface UserProvider

removeFederatedIdentity

public boolean removeFederatedIdentity(RealmModel realm,
 UserModel user,
 String socialProvider)

Specified by:

removeFederatedIdentity in interface UserProvider

preRemove

public void preRemove(RealmModel realm,
 IdentityProviderModel provider)

Specified by:

preRemove in interface UserProvider

addConsent

public void addConsent(RealmModel realm,
 String userId,
 UserConsentModel consent)

Specified by:

addConsent in interface UserProvider

getConsentByClient

public UserConsentModel getConsentByClient(RealmModel realm,
 String userId,
 String clientInternalId)

Specified by:

getConsentByClient in interface UserProvider

getConsentsStream

public Stream<UserConsentModel> getConsentsStream(RealmModel realm,
 String userId)

Specified by:

getConsentsStream in interface UserProvider

updateConsent

public void updateConsent(RealmModel realm,
 String userId,
 UserConsentModel consent)

Specified by:

updateConsent in interface UserProvider

revokeConsentForClient

public boolean revokeConsentForClient(RealmModel realm,
 String userId,
 String clientInternalId)

Specified by:

revokeConsentForClient in interface UserProvider

setNotBeforeForUser

public void setNotBeforeForUser(RealmModel realm,
 UserModel user,
 int notBefore)

Specified by:

setNotBeforeForUser in interface UserProvider

getNotBeforeOfUser

public int getNotBeforeOfUser(RealmModel realm,
 UserModel user)

Specified by:

getNotBeforeOfUser in interface UserProvider

getUserByFederatedIdentity

public UserModel getUserByFederatedIdentity(RealmModel realm,
 FederatedIdentityModel socialLink)

Specified by:

getUserByFederatedIdentity in interface UserProvider

getServiceAccount

public UserModel getServiceAccount(ClientModel client)

Specified by:

getServiceAccount in interface UserProvider

getFederatedIdentitiesStream

public Stream<FederatedIdentityModel> getFederatedIdentitiesStream(RealmModel realm,
 UserModel user)

Specified by:

getFederatedIdentitiesStream in interface UserProvider

getFederatedIdentity

public FederatedIdentityModel getFederatedIdentity(RealmModel realm,
 UserModel user,
 String socialProvider)

Specified by:

getFederatedIdentity in interface UserProvider

preRemove

public void preRemove(RealmModel realm,
 ClientModel client)

Specified by:

preRemove in interface UserProvider

preRemove

public void preRemove(ProtocolMapperModel protocolMapper)

Specified by:

preRemove in interface UserProvider

preRemove

public void preRemove(ClientScopeModel clientScope)

Specified by:

preRemove in interface UserProvider

preRemove

public void preRemove(RealmModel realm,
 ComponentModel component)

Specified by:

preRemove in interface UserProvider

removeImportedUsers

public void removeImportedUsers(RealmModel realm,
 String storageProviderId)

Specified by:

removeImportedUsers in interface UserProvider

unlinkUsers

public void unlinkUsers(RealmModel realm,
 String storageProviderId)

Specified by:

unlinkUsers in interface UserProvider

close

public void close()

UserProvider methods implementations end here

Specified by:

close in interface Provider

onCreate

public void onCreate(KeycloakSession session,
 RealmModel realm,
 ComponentModel model)

Specified by:

onCreate in interface OnCreateComponent

onUpdate

public void onUpdate(KeycloakSession session,
 RealmModel realm,
 ComponentModel oldModel,
 ComponentModel newModel)

Specified by:

onUpdate in interface OnUpdateComponent

onCache

public void onCache(RealmModel realm,
 CachedUserModel user,
 UserModel delegate)

Specified by:

onCache in interface OnUserCache

decorateUserProfile

public List<AttributeMetadata> decorateUserProfile(String providerId,
 UserProfileMetadata metadata)

Specified by:

decorateUserProfile in interface UserProfileDecorator