Package org.keycloak.models.jpa

Class JpaUserProvider

java.lang.Object

org.keycloak.models.jpa.JpaUserProvider

All Implemented Interfaces:

UserCredentialStore, UserProvider, Provider, UserBulkUpdateProvider, UserCountMethodsProvider, UserLookupProvider, UserQueryMethodsProvider, UserQueryProvider, UserRegistrationProvider

public class JpaUserProvider
extends Object
implements UserProvider, UserCredentialStore

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
protected jakarta.persistence.EntityManager	em

Constructor Summary

Constructors

Constructor	Description
JpaUserProvider(KeycloakSession session, jakarta.persistence.EntityManager em)

Method Summary

Modifier and Type	Method	Description
void	addConsent(RealmModel realm, String userId, UserConsentModel consent)
void	addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel identity)
UserModel	addUser(RealmModel realm, String username)
UserModel	addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)
void	close()
CredentialModel	createCredential(RealmModel realm, UserModel user, CredentialModel cred)
protected void	ensureEmailConstraint(List<UserEntity> users, RealmModel realm)
UserConsentModel	getConsentByClient(RealmModel realm, String userId, String clientId)
Stream<UserConsentModel>	getConsentsStream(RealmModel realm, String userId)
Stream<FederatedIdentityModel>	getFederatedIdentitiesStream(RealmModel realm, UserModel user)
FederatedIdentityModel	getFederatedIdentity(RealmModel realm, UserModel user, String identityProvider)
Stream<UserModel>	getGroupMembersStream(RealmModel realm, GroupModel group)
Stream<UserModel>	getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)
Stream<UserModel>	getGroupMembersStream(RealmModel realm, GroupModel group, String search, Boolean exact, Integer first, Integer max)
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)
CredentialModel	getStoredCredentialById(RealmModel realm, UserModel user, String id)
CredentialModel	getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type)
Stream<CredentialModel>	getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type)
Stream<CredentialModel>	getStoredCredentialsStream(RealmModel realm, UserModel user)
UserModel	getUserByEmail(RealmModel realm, String email)
UserModel	getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel identity)
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)
void	grantToAllUsers(RealmModel realm, RoleModel role)
boolean	moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId)
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)
protected void	removeConsentByClientStorageProvider(RealmModel realm, String providerId)
boolean	removeFederatedIdentity(RealmModel realm, UserModel user, String identityProvider)
void	removeImportedUsers(RealmModel realm, String storageProviderId)
boolean	removeStoredCredential(RealmModel realm, UserModel user, String id)
boolean	removeUser(RealmModel realm, UserModel user)
boolean	revokeConsentForClient(RealmModel realm, String userId, String clientId)
Stream<UserModel>	searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue)
Stream<UserModel>	searchForUserStream(RealmModel realm, String search, Integer firstResult, Integer maxResults)
Stream<UserModel>	searchForUserStream(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
void	setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore)
protected CredentialModel	toModel(CredentialEntity entity)
void	unlinkUsers(RealmModel realm, String storageProviderId)
void	updateConsent(RealmModel realm, String userId, UserConsentModel consent)
void	updateCredential(RealmModel realm, UserModel user, CredentialModel cred)
void	updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)

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.UserCountMethodsProvider

getUsersCount

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

getUserByCredential

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

searchForUserStream, searchForUserStream

Field Details

em

protected jakarta.persistence.EntityManager em

Constructor Details

JpaUserProvider

public JpaUserProvider(KeycloakSession session,
 jakarta.persistence.EntityManager em)

Method Details

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

removeUser

public boolean removeUser(RealmModel realm,
 UserModel user)

Specified by:

removeUser in interface UserRegistrationProvider

addFederatedIdentity

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

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

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

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

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

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

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

preRemove

public void preRemove(RealmModel realm,
 RoleModel role)

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

getGroupMembersStream

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

Specified by:

getGroupMembersStream in interface UserQueryMethodsProvider

getRoleMembersStream

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

Specified by:

getRoleMembersStream in interface UserQueryMethodsProvider

preRemove

public void preRemove(RealmModel realm,
 GroupModel group)

Specified by:

preRemove in interface UserProvider

getUserById

public UserModel getUserById(RealmModel realm,
 String id)

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

close

public void close()

Specified by:

close in interface Provider

getUserByFederatedIdentity

public UserModel getUserByFederatedIdentity(RealmModel realm,
 FederatedIdentityModel identity)

Specified by:

getUserByFederatedIdentity in interface UserProvider

getServiceAccount

public UserModel getServiceAccount(ClientModel client)

Specified by:

getServiceAccount in interface UserProvider

getUsersCount

public int getUsersCount(RealmModel realm,
 boolean includeServiceAccount)

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

getGroupMembersStream

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

Specified by:

getGroupMembersStream in interface UserQueryMethodsProvider

getGroupMembersStream

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

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

searchForUserStream

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

Specified by:

searchForUserStream in interface UserQueryMethodsProvider

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

getFederatedIdentitiesStream

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

Specified by:

getFederatedIdentitiesStream in interface UserProvider

getFederatedIdentity

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

Specified by:

getFederatedIdentity in interface UserProvider

preRemove

public void preRemove(RealmModel realm,
 ComponentModel component)

Specified by:

preRemove in interface UserProvider

removeConsentByClientStorageProvider

protected void removeConsentByClientStorageProvider(RealmModel realm,
 String providerId)

updateCredential

public void updateCredential(RealmModel realm,
 UserModel user,
 CredentialModel cred)

Specified by:

updateCredential in interface UserCredentialStore

createCredential

public CredentialModel createCredential(RealmModel realm,
 UserModel user,
 CredentialModel cred)

Specified by:

createCredential in interface UserCredentialStore

removeStoredCredential

public boolean removeStoredCredential(RealmModel realm,
 UserModel user,
 String id)

Specified by:

removeStoredCredential in interface UserCredentialStore

getStoredCredentialById

public CredentialModel getStoredCredentialById(RealmModel realm,
 UserModel user,
 String id)

Specified by:

getStoredCredentialById in interface UserCredentialStore

toModel

protected CredentialModel toModel(CredentialEntity entity)

getStoredCredentialsStream

public Stream<CredentialModel> getStoredCredentialsStream(RealmModel realm,
 UserModel user)

Specified by:

getStoredCredentialsStream in interface UserCredentialStore

getStoredCredentialsByTypeStream

public Stream<CredentialModel> getStoredCredentialsByTypeStream(RealmModel realm,
 UserModel user,
 String type)

Specified by:

getStoredCredentialsByTypeStream in interface UserCredentialStore

getStoredCredentialByNameAndType

public CredentialModel getStoredCredentialByNameAndType(RealmModel realm,
 UserModel user,
 String name,
 String type)

Specified by:

getStoredCredentialByNameAndType in interface UserCredentialStore

moveCredentialTo

public boolean moveCredentialTo(RealmModel realm,
 UserModel user,
 String id,
 String newPreviousCredentialId)

Specified by:

moveCredentialTo in interface UserCredentialStore

ensureEmailConstraint

protected void ensureEmailConstraint(List<UserEntity> users,
 RealmModel realm)