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
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
Field Summary
-
Constructor Summary
ConstructorDescriptionJpaUserProvider
(KeycloakSession session, jakarta.persistence.EntityManager em) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addConsent
(RealmModel realm, String userId, UserConsentModel consent) void
addFederatedIdentity
(RealmModel realm, UserModel user, FederatedIdentityModel identity) addUser
(RealmModel realm, String username) addUser
(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) void
close()
createCredential
(RealmModel realm, UserModel user, CredentialModel cred) protected void
ensureEmailConstraint
(List<UserEntity> users, RealmModel realm) getConsentByClient
(RealmModel realm, String userId, String clientId) getConsentsStream
(RealmModel realm, String userId) getFederatedIdentitiesStream
(RealmModel realm, UserModel user) getFederatedIdentity
(RealmModel realm, UserModel user, String identityProvider) getGroupMembersStream
(RealmModel realm, GroupModel group) getGroupMembersStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) int
getNotBeforeOfUser
(RealmModel realm, UserModel user) getRoleMembersStream
(RealmModel realm, RoleModel role) getRoleMembersStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) getServiceAccount
(ClientModel client) getStoredCredentialById
(RealmModel realm, UserModel user, String id) getStoredCredentialByNameAndType
(RealmModel realm, UserModel user, String name, String type) getStoredCredentialsByTypeStream
(RealmModel realm, UserModel user, String type) getStoredCredentialsStream
(RealmModel realm, UserModel user) getUserByEmail
(RealmModel realm, String email) getUserByFederatedIdentity
(RealmModel realm, FederatedIdentityModel identity) getUserById
(RealmModel realm, String id) 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) searchForUserByUserAttributeStream
(RealmModel realm, String attrName, String attrValue) searchForUserStream
(RealmModel realm, String search, Integer firstResult, Integer maxResults) 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
-
-
Method Details
-
addUser
public UserModel addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) - Specified by:
addUser
in interfaceUserProvider
-
addUser
- Specified by:
addUser
in interfaceUserRegistrationProvider
-
removeUser
- Specified by:
removeUser
in interfaceUserRegistrationProvider
-
addFederatedIdentity
- Specified by:
addFederatedIdentity
in interfaceUserProvider
-
updateFederatedIdentity
public void updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) - Specified by:
updateFederatedIdentity
in interfaceUserProvider
-
removeFederatedIdentity
- Specified by:
removeFederatedIdentity
in interfaceUserProvider
-
preRemove
- Specified by:
preRemove
in interfaceUserProvider
-
addConsent
- Specified by:
addConsent
in interfaceUserProvider
-
getConsentByClient
- Specified by:
getConsentByClient
in interfaceUserProvider
-
getConsentsStream
- Specified by:
getConsentsStream
in interfaceUserProvider
-
updateConsent
- Specified by:
updateConsent
in interfaceUserProvider
-
revokeConsentForClient
- Specified by:
revokeConsentForClient
in interfaceUserProvider
-
setNotBeforeForUser
- Specified by:
setNotBeforeForUser
in interfaceUserProvider
-
getNotBeforeOfUser
- Specified by:
getNotBeforeOfUser
in interfaceUserProvider
-
grantToAllUsers
- Specified by:
grantToAllUsers
in interfaceUserBulkUpdateProvider
-
preRemove
- Specified by:
preRemove
in interfaceUserProvider
-
removeImportedUsers
- Specified by:
removeImportedUsers
in interfaceUserProvider
-
unlinkUsers
- Specified by:
unlinkUsers
in interfaceUserProvider
-
preRemove
- Specified by:
preRemove
in interfaceUserProvider
-
preRemove
- Specified by:
preRemove
in interfaceUserProvider
-
preRemove
- Specified by:
preRemove
in interfaceUserProvider
-
preRemove
- Specified by:
preRemove
in interfaceUserProvider
-
getGroupMembersStream
- Specified by:
getGroupMembersStream
in interfaceUserQueryMethodsProvider
-
getRoleMembersStream
- Specified by:
getRoleMembersStream
in interfaceUserQueryMethodsProvider
-
preRemove
- Specified by:
preRemove
in interfaceUserProvider
-
getUserById
- Specified by:
getUserById
in interfaceUserLookupProvider
-
getUserByUsername
- Specified by:
getUserByUsername
in interfaceUserLookupProvider
-
getUserByEmail
- Specified by:
getUserByEmail
in interfaceUserLookupProvider
-
close
public void close() -
getUserByFederatedIdentity
- Specified by:
getUserByFederatedIdentity
in interfaceUserProvider
-
getServiceAccount
- Specified by:
getServiceAccount
in interfaceUserProvider
-
getUsersCount
- Specified by:
getUsersCount
in interfaceUserCountMethodsProvider
-
getUsersCount
- Specified by:
getUsersCount
in interfaceUserCountMethodsProvider
-
getUsersCount
- Specified by:
getUsersCount
in interfaceUserCountMethodsProvider
-
getUsersCount
- Specified by:
getUsersCount
in interfaceUserCountMethodsProvider
-
getUsersCount
- Specified by:
getUsersCount
in interfaceUserCountMethodsProvider
-
getUsersCount
- Specified by:
getUsersCount
in interfaceUserCountMethodsProvider
-
getGroupMembersStream
public Stream<UserModel> getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) - Specified by:
getGroupMembersStream
in interfaceUserQueryMethodsProvider
-
getRoleMembersStream
public Stream<UserModel> getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) - Specified by:
getRoleMembersStream
in interfaceUserQueryMethodsProvider
-
searchForUserStream
public Stream<UserModel> searchForUserStream(RealmModel realm, String search, Integer firstResult, Integer maxResults) - Specified by:
searchForUserStream
in interfaceUserQueryMethodsProvider
-
searchForUserStream
public Stream<UserModel> searchForUserStream(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) - Specified by:
searchForUserStream
in interfaceUserQueryMethodsProvider
-
searchForUserByUserAttributeStream
public Stream<UserModel> searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue) - Specified by:
searchForUserByUserAttributeStream
in interfaceUserQueryMethodsProvider
-
getFederatedIdentitiesStream
public Stream<FederatedIdentityModel> getFederatedIdentitiesStream(RealmModel realm, UserModel user) - Specified by:
getFederatedIdentitiesStream
in interfaceUserProvider
-
getFederatedIdentity
public FederatedIdentityModel getFederatedIdentity(RealmModel realm, UserModel user, String identityProvider) - Specified by:
getFederatedIdentity
in interfaceUserProvider
-
preRemove
- Specified by:
preRemove
in interfaceUserProvider
-
removeConsentByClientStorageProvider
-
updateCredential
- Specified by:
updateCredential
in interfaceUserCredentialStore
-
createCredential
- Specified by:
createCredential
in interfaceUserCredentialStore
-
removeStoredCredential
- Specified by:
removeStoredCredential
in interfaceUserCredentialStore
-
getStoredCredentialById
- Specified by:
getStoredCredentialById
in interfaceUserCredentialStore
-
toModel
-
getStoredCredentialsStream
- Specified by:
getStoredCredentialsStream
in interfaceUserCredentialStore
-
getStoredCredentialsByTypeStream
public Stream<CredentialModel> getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type) - Specified by:
getStoredCredentialsByTypeStream
in interfaceUserCredentialStore
-
getStoredCredentialByNameAndType
public CredentialModel getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type) - Specified by:
getStoredCredentialByNameAndType
in interfaceUserCredentialStore
-
moveCredentialTo
public boolean moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId) - Specified by:
moveCredentialTo
in interfaceUserCredentialStore
-
ensureEmailConstraint
-