public class JpaUserProvider extends Object implements UserProvider, UserCredentialStore
Modifier and Type | Field and Description |
---|---|
protected javax.persistence.EntityManager |
em |
Constructor and Description |
---|
JpaUserProvider(KeycloakSession session,
javax.persistence.EntityManager em) |
Modifier and Type | Method and Description |
---|---|
void |
addConsent(RealmModel realm,
String userId,
UserConsentModel consent) |
void |
addFederatedIdentity(RealmModel realm,
UserModel user,
FederatedIdentityModel identity) |
UserModel |
addUser(RealmModel realm,
String username)
All storage providers that implement this interface will be looped through.
|
UserModel |
addUser(RealmModel realm,
String id,
String username,
boolean addDefaultRoles,
boolean addDefaultRequiredActions)
only used for local storage
|
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) |
List<UserConsentModel> |
getConsents(RealmModel realm,
String userId) |
Set<FederatedIdentityModel> |
getFederatedIdentities(UserModel user,
RealmModel realm) |
FederatedIdentityModel |
getFederatedIdentity(UserModel user,
String identityProvider,
RealmModel realm) |
List<UserModel> |
getGroupMembers(RealmModel realm,
GroupModel group)
Get users that belong to a specific group.
|
List<UserModel> |
getGroupMembers(RealmModel realm,
GroupModel group,
int firstResult,
int maxResults)
Get users that belong to a specific group.
|
int |
getNotBeforeOfUser(RealmModel realm,
UserModel user) |
List<UserModel> |
getRoleMembers(RealmModel realm,
RoleModel role)
Get users that belong to a specific role.
|
List<UserModel> |
getRoleMembers(RealmModel realm,
RoleModel role,
int firstResult,
int maxResults)
Search for users that have a specific role with a specific roleId.
|
UserModel |
getServiceAccount(ClientModel client) |
CredentialModel |
getStoredCredentialById(RealmModel realm,
UserModel user,
String id) |
CredentialModel |
getStoredCredentialByNameAndType(RealmModel realm,
UserModel user,
String name,
String type) |
List<CredentialModel> |
getStoredCredentials(RealmModel realm,
UserModel user) |
List<CredentialModel> |
getStoredCredentialsByType(RealmModel realm,
UserModel user,
String type) |
UserModel |
getUserByEmail(String email,
RealmModel realm) |
UserModel |
getUserByFederatedIdentity(FederatedIdentityModel identity,
RealmModel realm) |
UserModel |
getUserById(String id,
RealmModel realm) |
UserModel |
getUserByUsername(String username,
RealmModel realm) |
List<UserModel> |
getUsers(RealmModel realm) |
List<UserModel> |
getUsers(RealmModel realm,
boolean includeServiceAccounts) |
List<UserModel> |
getUsers(RealmModel realm,
int firstResult,
int maxResults) |
List<UserModel> |
getUsers(RealmModel realm,
int firstResult,
int maxResults,
boolean includeServiceAccounts) |
int |
getUsersCount(Map<String,String> params,
RealmModel realm)
Returns the number of users that match the given filter parameters.
|
int |
getUsersCount(Map<String,String> params,
RealmModel realm,
Set<String> groupIds)
Returns the number of users that match the given filter parameters and is in
at least one of the given groups.
|
int |
getUsersCount(RealmModel realm)
Returns the number of users, without consider any service account.
|
int |
getUsersCount(RealmModel realm,
boolean includeServiceAccount)
Returns the number of users.
|
int |
getUsersCount(RealmModel realm,
Set<String> groupIds)
Returns the number of users that are in at least one of the groups
given.
|
int |
getUsersCount(String search,
RealmModel realm)
Returns the number of users that match the given criteria.
|
int |
getUsersCount(String search,
RealmModel realm,
Set<String> groupIds)
Returns the number of users that match the given criteria and are in
at least one of the groups given.
|
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,
ClientModel client) |
void |
preRemove(RealmModel realm,
ComponentModel component) |
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)
Removes any imported users from a specific User Storage Provider.
|
boolean |
removeStoredCredential(RealmModel realm,
UserModel user,
String id) |
boolean |
removeUser(RealmModel realm,
UserModel user)
Called if user originated from this provider.
|
boolean |
revokeConsentForClient(RealmModel realm,
String userId,
String clientId) |
List<UserModel> |
searchForUser(Map<String,String> attributes,
RealmModel realm)
Search for user by parameter.
|
List<UserModel> |
searchForUser(Map<String,String> attributes,
RealmModel realm,
int firstResult,
int maxResults)
Search for user by parameter.
|
List<UserModel> |
searchForUser(String search,
RealmModel realm)
Search for users with username, email or first + last name that is like search string.
|
List<UserModel> |
searchForUser(String search,
RealmModel realm,
int firstResult,
int maxResults)
Search for users with username, email or first + last name that is like search string.
|
List<UserModel> |
searchForUserByUserAttribute(String attrName,
String attrValue,
RealmModel realm)
Search for users that have a specific attribute with a specific value.
|
void |
setNotBeforeForUser(RealmModel realm,
UserModel user,
int notBefore) |
protected CredentialModel |
toModel(CredentialEntity entity) |
void |
unlinkUsers(RealmModel realm,
String storageProviderId)
Set federation link to null to imported users of a specific User Storage Provider
|
void |
updateConsent(RealmModel realm,
String userId,
UserConsentModel consent) |
void |
updateCredential(RealmModel realm,
UserModel user,
CredentialModel cred) |
void |
updateFederatedIdentity(RealmModel realm,
UserModel federatedUser,
FederatedIdentityModel federatedIdentityModel) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
countUsersInGroups
public JpaUserProvider(KeycloakSession session, javax.persistence.EntityManager em)
public UserModel addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)
UserProvider
addUser
in interface UserProvider
public UserModel addUser(RealmModel realm, String username)
UserRegistrationProvider
addUser
in interface UserRegistrationProvider
public boolean removeUser(RealmModel realm, UserModel user)
UserRegistrationProvider
removeUser
in interface UserRegistrationProvider
public void addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel identity)
addFederatedIdentity
in interface UserProvider
public void updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)
updateFederatedIdentity
in interface UserProvider
public boolean removeFederatedIdentity(RealmModel realm, UserModel user, String identityProvider)
removeFederatedIdentity
in interface UserProvider
public void preRemove(RealmModel realm, IdentityProviderModel provider)
preRemove
in interface UserProvider
public void addConsent(RealmModel realm, String userId, UserConsentModel consent)
addConsent
in interface UserProvider
public UserConsentModel getConsentByClient(RealmModel realm, String userId, String clientId)
getConsentByClient
in interface UserProvider
public List<UserConsentModel> getConsents(RealmModel realm, String userId)
getConsents
in interface UserProvider
public void updateConsent(RealmModel realm, String userId, UserConsentModel consent)
updateConsent
in interface UserProvider
public boolean revokeConsentForClient(RealmModel realm, String userId, String clientId)
revokeConsentForClient
in interface UserProvider
public void setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore)
setNotBeforeForUser
in interface UserProvider
public int getNotBeforeOfUser(RealmModel realm, UserModel user)
getNotBeforeOfUser
in interface UserProvider
public void grantToAllUsers(RealmModel realm, RoleModel role)
grantToAllUsers
in interface UserBulkUpdateProvider
public void preRemove(RealmModel realm)
preRemove
in interface UserProvider
public void removeImportedUsers(RealmModel realm, String storageProviderId)
UserProvider
removeImportedUsers
in interface UserProvider
public void unlinkUsers(RealmModel realm, String storageProviderId)
UserProvider
unlinkUsers
in interface UserProvider
public void preRemove(RealmModel realm, RoleModel role)
preRemove
in interface UserProvider
public void preRemove(RealmModel realm, ClientModel client)
preRemove
in interface UserProvider
public void preRemove(ProtocolMapperModel protocolMapper)
preRemove
in interface UserProvider
public void preRemove(ClientScopeModel clientScope)
preRemove
in interface UserProvider
public List<UserModel> getGroupMembers(RealmModel realm, GroupModel group)
UserQueryProvider
getGroupMembers
in interface UserQueryProvider
UserFederatedStorageProvider
public List<UserModel> getRoleMembers(RealmModel realm, RoleModel role)
UserQueryProvider
getRoleMembers
in interface UserQueryProvider
public void preRemove(RealmModel realm, GroupModel group)
preRemove
in interface UserProvider
public UserModel getUserById(String id, RealmModel realm)
getUserById
in interface UserLookupProvider
public UserModel getUserByUsername(String username, RealmModel realm)
getUserByUsername
in interface UserLookupProvider
public UserModel getUserByEmail(String email, RealmModel realm)
getUserByEmail
in interface UserLookupProvider
public void close()
close
in interface UserProvider
close
in interface Provider
public UserModel getUserByFederatedIdentity(FederatedIdentityModel identity, RealmModel realm)
getUserByFederatedIdentity
in interface UserProvider
public UserModel getServiceAccount(ClientModel client)
getServiceAccount
in interface UserProvider
public List<UserModel> getUsers(RealmModel realm, boolean includeServiceAccounts)
getUsers
in interface UserProvider
public int getUsersCount(RealmModel realm, boolean includeServiceAccount)
UserQueryProvider
getUsersCount
in interface UserQueryProvider
realm
- the realmincludeServiceAccount
- if true, the number of users will also include service accounts. Otherwise, only the number of users.public int getUsersCount(RealmModel realm)
UserQueryProvider
getUsersCount
in interface UserQueryProvider
realm
- the realmpublic int getUsersCount(RealmModel realm, Set<String> groupIds)
UserQueryProvider
getUsersCount
in interface UserQueryProvider
realm
- the realmgroupIds
- set of groups id to check forpublic int getUsersCount(String search, RealmModel realm)
UserQueryProvider
getUsersCount
in interface UserQueryProvider
search
- search criteriarealm
- the realmpublic int getUsersCount(String search, RealmModel realm, Set<String> groupIds)
UserQueryProvider
getUsersCount
in interface UserQueryProvider
search
- search criteriarealm
- the realmgroupIds
- set of groups to check forpublic int getUsersCount(Map<String,String> params, RealmModel realm)
UserQueryProvider
getUsersCount
in interface UserQueryProvider
params
- filter parametersrealm
- the realmpublic int getUsersCount(Map<String,String> params, RealmModel realm, Set<String> groupIds)
UserQueryProvider
getUsersCount
in interface UserQueryProvider
params
- filter parametersrealm
- the realmgroupIds
- set if groups to check forpublic List<UserModel> getUsers(RealmModel realm)
getUsers
in interface UserQueryProvider
public List<UserModel> getUsers(RealmModel realm, int firstResult, int maxResults)
getUsers
in interface UserQueryProvider
public List<UserModel> getUsers(RealmModel realm, int firstResult, int maxResults, boolean includeServiceAccounts)
getUsers
in interface UserProvider
public List<UserModel> getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)
UserQueryProvider
getGroupMembers
in interface UserQueryProvider
UserFederatedStorageProvider
public List<UserModel> getRoleMembers(RealmModel realm, RoleModel role, int firstResult, int maxResults)
UserQueryProvider
getRoleMembers
in interface UserQueryProvider
public List<UserModel> searchForUser(String search, RealmModel realm)
UserQueryProvider
searchForUser
in interface UserQueryProvider
public List<UserModel> searchForUser(String search, RealmModel realm, int firstResult, int maxResults)
UserQueryProvider
searchForUser
in interface UserQueryProvider
public List<UserModel> searchForUser(Map<String,String> attributes, RealmModel realm)
UserQueryProvider
searchForUser
in interface UserQueryProvider
public List<UserModel> searchForUser(Map<String,String> attributes, RealmModel realm, int firstResult, int maxResults)
UserQueryProvider
searchForUser
in interface UserQueryProvider
public List<UserModel> searchForUserByUserAttribute(String attrName, String attrValue, RealmModel realm)
UserQueryProvider
searchForUserByUserAttribute
in interface UserQueryProvider
UserFederatedStorageProvider
public Set<FederatedIdentityModel> getFederatedIdentities(UserModel user, RealmModel realm)
getFederatedIdentities
in interface UserProvider
public FederatedIdentityModel getFederatedIdentity(UserModel user, String identityProvider, RealmModel realm)
getFederatedIdentity
in interface UserProvider
public void preRemove(RealmModel realm, ComponentModel component)
preRemove
in interface UserProvider
protected void removeConsentByClientStorageProvider(RealmModel realm, String providerId)
public void updateCredential(RealmModel realm, UserModel user, CredentialModel cred)
updateCredential
in interface UserCredentialStore
public CredentialModel createCredential(RealmModel realm, UserModel user, CredentialModel cred)
createCredential
in interface UserCredentialStore
public boolean removeStoredCredential(RealmModel realm, UserModel user, String id)
removeStoredCredential
in interface UserCredentialStore
public CredentialModel getStoredCredentialById(RealmModel realm, UserModel user, String id)
getStoredCredentialById
in interface UserCredentialStore
protected CredentialModel toModel(CredentialEntity entity)
public List<CredentialModel> getStoredCredentials(RealmModel realm, UserModel user)
getStoredCredentials
in interface UserCredentialStore
public List<CredentialModel> getStoredCredentialsByType(RealmModel realm, UserModel user, String type)
getStoredCredentialsByType
in interface UserCredentialStore
public CredentialModel getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type)
getStoredCredentialByNameAndType
in interface UserCredentialStore
public boolean moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId)
moveCredentialTo
in interface UserCredentialStore
protected void ensureEmailConstraint(List<UserEntity> users, RealmModel realm)
Copyright © 2020 JBoss by Red Hat. All rights reserved.