org.keycloak.models.cache

Class DefaultCacheUserProvider

java.lang.Object

org.keycloak.models.cache.DefaultCacheUserProvider

All Implemented Interfaces:

CacheUserProvider, UserProvider, Provider

public class DefaultCacheUserProvider
extends Object
implements CacheUserProvider

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
protected UserCache	cache
protected boolean	clearAll
protected UserProvider	delegate
protected Map<String,UserModel>	managedUsers
protected Set<String>	realmInvalidations
protected KeycloakSession	session
protected boolean	setRollbackOnly
protected boolean	transactionActive
protected Map<String,String>	userInvalidations

Constructor Summary

Constructors

Constructor and Description
DefaultCacheUserProvider(UserCache cache, KeycloakSession session)

Method Summary

Methods

Modifier and Type	Method and Description
void	addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)
UserModel	addUser(RealmModel realm, String username)
UserModel	addUser(RealmModel realm, String id, String username, boolean addDefaultRoles)
void	close()
UserProvider	getDelegate()
Set<FederatedIdentityModel>	getFederatedIdentities(UserModel user, RealmModel realm)
FederatedIdentityModel	getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)
UserModel	getUserByEmail(String email, RealmModel realm)
UserModel	getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)
UserModel	getUserById(String id, RealmModel realm)
UserModel	getUserByUsername(String username, RealmModel realm)
List<UserModel>	getUsers(RealmModel realm)
List<UserModel>	getUsers(RealmModel realm, int firstResult, int maxResults)
int	getUsersCount(RealmModel realm)
boolean	isEnabled()
void	preRemove(RealmModel realm)
void	preRemove(RealmModel realm, RoleModel role)
void	preRemove(RealmModel realm, UserFederationProviderModel link)
void	registerUserInvalidation(RealmModel realm, String id)
boolean	removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)
boolean	removeUser(RealmModel realm, UserModel user)
protected void	runInvalidations()
List<UserModel>	searchForUser(String search, RealmModel realm)
List<UserModel>	searchForUser(String search, RealmModel realm, int firstResult, int maxResults)
List<UserModel>	searchForUserByAttributes(Map<String,String> attributes, RealmModel realm)
List<UserModel>	searchForUserByAttributes(Map<String,String> attributes, RealmModel realm, int firstResult, int maxResults)
void	setEnabled(boolean enabled)
void	updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)
CredentialValidationOutput	validCredentials(RealmModel realm, UserCredentialModel... input)
boolean	validCredentials(RealmModel realm, UserModel user, List<UserCredentialModel> input)
boolean	validCredentials(RealmModel realm, UserModel user, UserCredentialModel... input)

Methods inherited from class java.lang.Object

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

Field Detail

cache

protected UserCache cache

session

protected KeycloakSession session

delegate

protected UserProvider delegate

transactionActive

protected boolean transactionActive

setRollbackOnly

protected boolean setRollbackOnly

userInvalidations

protected Map<String,String> userInvalidations

realmInvalidations

protected Set<String> realmInvalidations

managedUsers

protected Map<String,UserModel> managedUsers

clearAll

protected boolean clearAll

Constructor Detail

DefaultCacheUserProvider

public DefaultCacheUserProvider(UserCache cache,
                        KeycloakSession session)

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface CacheUserProvider

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface CacheUserProvider

getDelegate

public UserProvider getDelegate()

Specified by:

getDelegate in interface CacheUserProvider

registerUserInvalidation

public void registerUserInvalidation(RealmModel realm,
                            String id)

Specified by:

registerUserInvalidation in interface CacheUserProvider

runInvalidations

protected void runInvalidations()

getUserById

public UserModel getUserById(String id,
                    RealmModel realm)

Specified by:

getUserById in interface UserProvider

getUserByUsername

public UserModel getUserByUsername(String username,
                          RealmModel realm)

Specified by:

getUserByUsername in interface UserProvider

getUserByEmail

public UserModel getUserByEmail(String email,
                       RealmModel realm)

Specified by:

getUserByEmail in interface UserProvider

close

public void close()

Specified by:

close in interface UserProvider

Specified by:

close in interface Provider

getUserByFederatedIdentity

public UserModel getUserByFederatedIdentity(FederatedIdentityModel socialLink,
                                   RealmModel realm)

Specified by:

getUserByFederatedIdentity in interface UserProvider

getUsers

public List<UserModel> getUsers(RealmModel realm)

Specified by:

getUsers in interface UserProvider

getUsersCount

public int getUsersCount(RealmModel realm)

Specified by:

getUsersCount in interface UserProvider

getUsers

public List<UserModel> getUsers(RealmModel realm,
                       int firstResult,
                       int maxResults)

Specified by:

getUsers in interface UserProvider

searchForUser

public List<UserModel> searchForUser(String search,
                            RealmModel realm)

Specified by:

searchForUser in interface UserProvider

searchForUser

public List<UserModel> searchForUser(String search,
                            RealmModel realm,
                            int firstResult,
                            int maxResults)

Specified by:

searchForUser in interface UserProvider

searchForUserByAttributes

public List<UserModel> searchForUserByAttributes(Map<String,String> attributes,
                                        RealmModel realm)

Specified by:

searchForUserByAttributes in interface UserProvider

searchForUserByAttributes

public List<UserModel> searchForUserByAttributes(Map<String,String> attributes,
                                        RealmModel realm,
                                        int firstResult,
                                        int maxResults)

Specified by:

searchForUserByAttributes in interface UserProvider

getFederatedIdentities

public Set<FederatedIdentityModel> getFederatedIdentities(UserModel user,
                                                 RealmModel realm)

Specified by:

getFederatedIdentities in interface UserProvider

getFederatedIdentity

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

Specified by:

getFederatedIdentity in interface UserProvider

addUser

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

Specified by:

addUser in interface UserProvider

addUser

public UserModel addUser(RealmModel realm,
                String username)

Specified by:

addUser in interface UserProvider

removeUser

public boolean removeUser(RealmModel realm,
                 UserModel user)

Specified by:

removeUser 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

validCredentials

public boolean validCredentials(RealmModel realm,
                       UserModel user,
                       List<UserCredentialModel> input)

Specified by:

validCredentials in interface UserProvider

validCredentials

public boolean validCredentials(RealmModel realm,
                       UserModel user,
                       UserCredentialModel... input)

Specified by:

validCredentials in interface UserProvider

validCredentials

public CredentialValidationOutput validCredentials(RealmModel realm,
                                          UserCredentialModel... input)

Specified by:

validCredentials in interface UserProvider

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,
             UserFederationProviderModel link)

Specified by:

preRemove in interface UserProvider