Package org.keycloak.models.cache.infinispan

Class UserCacheSession

java.lang.Object

org.keycloak.models.cache.infinispan.UserCacheSession

All Implemented Interfaces:

UserCache, UserCache.Streams, UserProvider, UserProvider.Streams, Provider, OnCreateComponent, OnUpdateComponent, UserBulkUpdateProvider, UserLookupProvider, UserLookupProvider.Streams, UserQueryProvider, UserQueryProvider.Streams, UserRegistrationProvider

public class UserCacheSession
extends Object
implements UserCache.Streams, OnCreateComponent, OnUpdateComponent

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.cache.UserCache

UserCache.Streams

Nested classes/interfaces inherited from interface org.keycloak.storage.user.UserLookupProvider

UserLookupProvider.Streams

Nested classes/interfaces inherited from interface org.keycloak.models.UserProvider

UserProvider.Streams

Nested classes/interfaces inherited from interface org.keycloak.storage.user.UserQueryProvider

UserQueryProvider.Streams

Field Summary

Fields

Modifier and Type	Field	Description
protected UserCacheManager	cache
protected UserProvider	delegate
protected Set<InvalidationEvent>	invalidationEvents
protected Set<String>	invalidations
protected static org.jboss.logging.Logger	logger
protected Map<String,UserModel>	managedUsers
protected Set<String>	realmInvalidations
protected KeycloakSession	session
protected boolean	setRollbackOnly
protected long	startupRevision
protected boolean	transactionActive

Constructor Summary

Constructors

Constructor	Description
UserCacheSession(UserCacheManager cache, 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)
UserModel	addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)
protected UserModel	cacheUser(RealmModel realm, UserModel delegate, Long revision)
void	clear()
void	close()
void	evict(RealmModel realm)
void	evict(RealmModel realm, UserModel user)
UserModel	findServiceAccount(ClientModel client)
protected void	fullyInvalidateUser(RealmModel realm, UserModel user)
UserConsentModel	getConsentByClient(RealmModel realm, String userId, String clientId)
Stream<UserConsentModel>	getConsentsStream(RealmModel realm, String userId)
UserProvider	getDelegate()
Stream<FederatedIdentityModel>	getFederatedIdentitiesStream(RealmModel realm, UserModel user)
FederatedIdentityModel	getFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)
Stream<UserModel>	getGroupMembersStream(RealmModel realm, GroupModel group)
Stream<UserModel>	getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)
int	getNotBeforeOfUser(RealmModel realm, UserModel user)
Stream<UserModel>	getRoleMembersStream(RealmModel realm, RoleModel role)
Stream<UserModel>	getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
UserModel	getServiceAccount(ClientModel client)
protected UserModel	getUserAdapter(RealmModel realm, String userId, Long loaded, UserModel delegate)
CredentialValidationOutput	getUserByCredential(RealmModel realm, CredentialInput input)
UserModel	getUserByEmail(RealmModel realm, String email)
UserModel	getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink)
UserModel	getUserById(RealmModel realm, String id)
UserModel	getUserByUsername(RealmModel realm, String username)
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)
Stream<UserModel>	getUsersStream(RealmModel realm)
Stream<UserModel>	getUsersStream(RealmModel realm, boolean includeServiceAccounts)
Stream<UserModel>	getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults)
Stream<UserModel>	getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults, boolean includeServiceAccounts)
void	grantToAllUsers(RealmModel realm, RoleModel role)
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)
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)
void	registerUserInvalidation(RealmModel realm, CachedUser user)
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)
protected void	runInvalidations()
Stream<UserModel>	searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue)
Stream<UserModel>	searchForUserStream(RealmModel realm, String search)
Stream<UserModel>	searchForUserStream(RealmModel realm, String search, Integer firstResult, Integer maxResults)
Stream<UserModel>	searchForUserStream(RealmModel realm, Map<String,String> attributes)
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)
protected UserModel	validateCache(RealmModel realm, CachedUser cached)

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.UserLookupProvider.Streams

getUserByEmail, getUserById, getUserByUsername

Methods inherited from interface org.keycloak.models.UserProvider.Streams

getConsents, getFederatedIdentities, getFederatedIdentity, getUserByFederatedIdentity, getUsers, getUsers

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

getRoleMembers, getRoleMembers, getUsersCount

Methods inherited from interface org.keycloak.storage.user.UserQueryProvider.Streams

getGroupMembers, getGroupMembers, getUsers, getUsers, getUsersCount, getUsersCount, getUsersCount, getUsersCount, searchForUser, searchForUser, searchForUser, searchForUser, searchForUserByUserAttribute

Field Detail

logger

protected static final org.jboss.logging.Logger logger

cache

protected UserCacheManager cache

session

protected KeycloakSession session

delegate

protected UserProvider delegate

transactionActive

protected boolean transactionActive

setRollbackOnly

protected boolean setRollbackOnly

startupRevision

protected final long startupRevision

invalidations

protected Set<String> invalidations

realmInvalidations

protected Set<String> realmInvalidations

invalidationEvents

protected Set<InvalidationEvent> invalidationEvents

managedUsers

protected Map<String,UserModel> managedUsers

Constructor Detail

UserCacheSession

public UserCacheSession(UserCacheManager cache,
                        KeycloakSession session)

Method Detail

clear

public void clear()

Specified by:

clear in interface UserCache

getDelegate

public UserProvider getDelegate()

registerUserInvalidation

public void registerUserInvalidation(RealmModel realm,
                                     CachedUser user)

evict

public void evict(RealmModel realm,
                  UserModel user)

Specified by:

evict in interface UserCache

evict

public void evict(RealmModel realm)

Specified by:

evict in interface UserCache

runInvalidations

protected void runInvalidations()

getUserById

public UserModel getUserById(RealmModel realm,
                             String id)

Specified by:

getUserById in interface UserLookupProvider

Specified by:

getUserById in interface UserLookupProvider.Streams

getUserByUsername

public UserModel getUserByUsername(RealmModel realm,
                                   String username)

Specified by:

getUserByUsername in interface UserLookupProvider

Specified by:

getUserByUsername in interface UserLookupProvider.Streams

getUserAdapter

protected UserModel getUserAdapter(RealmModel realm,
                                   String userId,
                                   Long loaded,
                                   UserModel delegate)

validateCache

protected UserModel validateCache(RealmModel realm,
                                  CachedUser cached)

cacheUser

protected UserModel cacheUser(RealmModel realm,
                              UserModel delegate,
                              Long revision)

getUserByEmail

public UserModel getUserByEmail(RealmModel realm,
                                String email)

Specified by:

getUserByEmail in interface UserLookupProvider

Specified by:

getUserByEmail in interface UserLookupProvider.Streams

close

public void close()

Specified by:

close in interface Provider

Specified by:

close in interface UserProvider

getUserByFederatedIdentity

public UserModel getUserByFederatedIdentity(RealmModel realm,
                                            FederatedIdentityModel socialLink)

Specified by:

getUserByFederatedIdentity in interface UserProvider

Specified by:

getUserByFederatedIdentity in interface UserProvider.Streams

getGroupMembersStream

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

Specified by:

getGroupMembersStream in interface UserQueryProvider

Specified by:

getGroupMembersStream in interface UserQueryProvider.Streams

getGroupMembersStream

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

Specified by:

getGroupMembersStream in interface UserQueryProvider

Specified by:

getGroupMembersStream in interface UserQueryProvider.Streams

getRoleMembersStream

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

Specified by:

getRoleMembersStream in interface UserQueryProvider

getRoleMembersStream

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

Specified by:

getRoleMembersStream in interface UserQueryProvider

getServiceAccount

public UserModel getServiceAccount(ClientModel client)

Specified by:

getServiceAccount in interface UserProvider

findServiceAccount

public UserModel findServiceAccount(ClientModel client)

getUsersStream

public Stream<UserModel> getUsersStream(RealmModel realm,
                                        boolean includeServiceAccounts)

Specified by:

getUsersStream in interface UserProvider

Specified by:

getUsersStream in interface UserProvider.Streams

getUserByCredential

public CredentialValidationOutput getUserByCredential(RealmModel realm,
                                                      CredentialInput input)

Specified by:

getUserByCredential in interface UserLookupProvider

getUsersCount

public int getUsersCount(RealmModel realm,
                         boolean includeServiceAccount)

Specified by:

getUsersCount in interface UserQueryProvider

getUsersCount

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

Specified by:

getUsersCount in interface UserQueryProvider

getUsersCount

public int getUsersCount(RealmModel realm,
                         String search)

Specified by:

getUsersCount in interface UserQueryProvider

Specified by:

getUsersCount in interface UserQueryProvider.Streams

getUsersCount

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

Specified by:

getUsersCount in interface UserQueryProvider

Specified by:

getUsersCount in interface UserQueryProvider.Streams

getUsersCount

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

Specified by:

getUsersCount in interface UserQueryProvider

Specified by:

getUsersCount in interface UserQueryProvider.Streams

getUsersCount

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

Specified by:

getUsersCount in interface UserQueryProvider

Specified by:

getUsersCount in interface UserQueryProvider.Streams

getUsersStream

public Stream<UserModel> getUsersStream(RealmModel realm,
                                        Integer firstResult,
                                        Integer maxResults,
                                        boolean includeServiceAccounts)

Specified by:

getUsersStream in interface UserProvider

Specified by:

getUsersStream in interface UserProvider.Streams

getUsersStream

public Stream<UserModel> getUsersStream(RealmModel realm)

Specified by:

getUsersStream in interface UserQueryProvider

Specified by:

getUsersStream in interface UserQueryProvider.Streams

getUsersStream

public Stream<UserModel> getUsersStream(RealmModel realm,
                                        Integer firstResult,
                                        Integer maxResults)

Specified by:

getUsersStream in interface UserQueryProvider

Specified by:

getUsersStream in interface UserQueryProvider.Streams

searchForUserStream

public Stream<UserModel> searchForUserStream(RealmModel realm,
                                             String search)

Specified by:

searchForUserStream in interface UserQueryProvider

Specified by:

searchForUserStream in interface UserQueryProvider.Streams

searchForUserStream

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

Specified by:

searchForUserStream in interface UserQueryProvider

Specified by:

searchForUserStream in interface UserQueryProvider.Streams

searchForUserStream

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

Specified by:

searchForUserStream in interface UserQueryProvider

Specified by:

searchForUserStream in interface UserQueryProvider.Streams

searchForUserStream

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

Specified by:

searchForUserStream in interface UserQueryProvider

Specified by:

searchForUserStream in interface UserQueryProvider.Streams

searchForUserByUserAttributeStream

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

Specified by:

searchForUserByUserAttributeStream in interface UserQueryProvider

Specified by:

searchForUserByUserAttributeStream in interface UserQueryProvider.Streams

getFederatedIdentitiesStream

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

Specified by:

getFederatedIdentitiesStream in interface UserProvider

Specified by:

getFederatedIdentitiesStream in interface UserProvider.Streams

getFederatedIdentity

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

Specified by:

getFederatedIdentity in interface UserProvider

Specified by:

getFederatedIdentity in interface UserProvider.Streams

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

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 clientId)

Specified by:

getConsentByClient in interface UserProvider

getConsentsStream

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

Specified by:

getConsentsStream in interface UserProvider

Specified by:

getConsentsStream in interface UserProvider.Streams

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

addUser

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

Specified by:

addUser in interface UserProvider

addUser

public UserModel addUser(RealmModel realm,
                         String username)

Specified by:

addUser in interface UserRegistrationProvider

fullyInvalidateUser

protected void fullyInvalidateUser(RealmModel realm,
                                   UserModel user)

removeUser

public boolean removeUser(RealmModel realm,
                          UserModel user)

Specified by:

removeUser in interface UserRegistrationProvider

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

grantToAllUsers

public void grantToAllUsers(RealmModel realm,
                            RoleModel role)

Specified by:

grantToAllUsers in interface UserBulkUpdateProvider

preRemove

public void preRemove(RealmModel realm)

Specified by:

preRemove in interface UserProvider

preRemove

public void preRemove(RealmModel realm,
                      RoleModel role)

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,
                      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

onUpdate

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

Specified by:

onUpdate in interface OnUpdateComponent

onCreate

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

Specified by:

onCreate in interface OnCreateComponent