org.keycloak.models.mongo.keycloak.adapters

Class MongoUserProvider

java.lang.Object

org.keycloak.models.mongo.keycloak.adapters.MongoUserProvider

All Implemented Interfaces:

UserCredentialStore, UserProvider, Provider, UserLookupProvider, UserQueryProvider, UserRegistrationProvider

public class MongoUserProvider
extends Object
implements UserProvider, UserCredentialStore

Author:

Marek Posolda

Constructor Summary

Constructors

Constructor and Description
MongoUserProvider(KeycloakSession session, MongoStoreInvocationContext invocationContext)

Method Summary

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)
UserAdapter	addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)
protected UserAdapter	addUserEntity(RealmModel realm, String id, String username)
void	close()
protected List<UserModel>	convertUserEntities(RealmModel realm, List<MongoUserEntity> userEntities)
CredentialModel	createCredential(RealmModel realm, UserModel user, CredentialModel cred)
UserConsentModel	getConsentByClient(RealmModel realm, String userId, String clientId)
List<UserConsentModel>	getConsents(RealmModel realm, String userId)
CredentialEntity	getCredentialEntity(CredentialModel cred, MongoUserEntity mongoUser)
Set<FederatedIdentityModel>	getFederatedIdentities(UserModel userModel, RealmModel realm)
FederatedIdentityModel	getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)
List<UserModel>	getGroupMembers(RealmModel realm, GroupModel group)
List<UserModel>	getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)
protected MongoStore	getMongoStore()
MongoUserEntity	getMongoUserEntity(UserModel user)
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 socialLink, RealmModel realm)
UserAdapter	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(RealmModel realm)
void	grantToAllUsers(RealmModel realm, RoleModel role)
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, RoleModel role)
void	preRemove(RealmModel realm, UserFederationProviderModel link)
boolean	removeFederatedIdentity(RealmModel realm, UserModel userModel, String socialProvider)
boolean	removeStoredCredential(RealmModel realm, UserModel user, String id)
boolean	removeUser(RealmModel realm, UserModel user)
boolean	revokeConsentForClient(RealmModel realm, String userId, String clientId)
List<UserModel>	searchForUser(Map<String,String> attributes, RealmModel realm)
List<UserModel>	searchForUser(Map<String,String> attributes, RealmModel realm, int firstResult, int maxResults)
List<UserModel>	searchForUser(String search, RealmModel realm)
List<UserModel>	searchForUser(String search, RealmModel realm, int firstResult, int maxResults)
List<UserModel>	searchForUserByUserAttribute(String attrName, String attrValue, RealmModel realm)
void	setValues(CredentialModel cred, CredentialEntity credentialEntity)
CredentialModel	toModel(CredentialEntity credEntity)
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

Constructor Detail

MongoUserProvider

public MongoUserProvider(KeycloakSession session,
                         MongoStoreInvocationContext invocationContext)

Method Detail

close

public void close()

Specified by:

close in interface UserProvider

Specified by:

close in interface Provider

getUserById

public UserAdapter getUserById(String id,
                               RealmModel realm)

Specified by:

getUserById in interface UserLookupProvider

getUserByUsername

public UserModel getUserByUsername(String username,
                                   RealmModel realm)

Specified by:

getUserByUsername in interface UserLookupProvider

getUserByEmail

public UserModel getUserByEmail(String email,
                                RealmModel realm)

Specified by:

getUserByEmail in interface UserLookupProvider

getGroupMembers

public List<UserModel> getGroupMembers(RealmModel realm,
                                       GroupModel group,
                                       int firstResult,
                                       int maxResults)

Specified by:

getGroupMembers in interface UserQueryProvider

getMongoStore

protected MongoStore getMongoStore()

getGroupMembers

public List<UserModel> getGroupMembers(RealmModel realm,
                                       GroupModel group)

Specified by:

getGroupMembers in interface UserQueryProvider

getUserByFederatedIdentity

public UserModel getUserByFederatedIdentity(FederatedIdentityModel socialLink,
                                            RealmModel realm)

Specified by:

getUserByFederatedIdentity in interface UserProvider

getServiceAccount

public UserModel getServiceAccount(ClientModel client)

Specified by:

getServiceAccount in interface UserProvider

convertUserEntities

protected List<UserModel> convertUserEntities(RealmModel realm,
                                              List<MongoUserEntity> userEntities)

getUsers

public List<UserModel> getUsers(RealmModel realm)

Specified by:

getUsers in interface UserQueryProvider

getUsers

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

Specified by:

getUsers in interface UserQueryProvider

getUsers

public List<UserModel> getUsers(RealmModel realm,
                                boolean includeServiceAccounts)

Specified by:

getUsers in interface UserProvider

getUsersCount

public int getUsersCount(RealmModel realm)

Specified by:

getUsersCount in interface UserQueryProvider

getUsers

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

Specified by:

getUsers in interface UserProvider

searchForUser

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

Specified by:

searchForUser in interface UserQueryProvider

searchForUser

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

Specified by:

searchForUser in interface UserQueryProvider

searchForUser

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

Specified by:

searchForUser in interface UserQueryProvider

searchForUser

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

Specified by:

searchForUser in interface UserQueryProvider

searchForUserByUserAttribute

public List<UserModel> searchForUserByUserAttribute(String attrName,
                                                    String attrValue,
                                                    RealmModel realm)

Specified by:

searchForUserByUserAttribute in interface UserQueryProvider

getFederatedIdentities

public Set<FederatedIdentityModel> getFederatedIdentities(UserModel userModel,
                                                          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 UserAdapter addUser(RealmModel realm,
                           String id,
                           String username,
                           boolean addDefaultRoles,
                           boolean addDefaultRequiredActions)

Specified by:

addUser in interface UserProvider

addUserEntity

protected UserAdapter addUserEntity(RealmModel realm,
                                    String id,
                                    String username)

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 userModel,
                                       String socialProvider)

Specified by:

removeFederatedIdentity in interface UserProvider

addUser

public UserModel addUser(RealmModel realm,
                         String username)

Specified by:

addUser in interface UserRegistrationProvider

grantToAllUsers

public void grantToAllUsers(RealmModel realm,
                            RoleModel role)

Specified by:

grantToAllUsers in interface UserRegistrationProvider

preRemove

public void preRemove(RealmModel realm)

Specified by:

preRemove in interface UserProvider

preRemove

public void preRemove(RealmModel realm,
                      UserFederationProviderModel link)

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(RealmModel realm,
                      GroupModel group)

Specified by:

preRemove in interface UserProvider

preRemove

public void preRemove(RealmModel realm,
                      RoleModel role)

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

getConsents

public List<UserConsentModel> getConsents(RealmModel realm,
                                          String userId)

Specified by:

getConsents 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

preRemove

public void preRemove(RealmModel realm,
                      ComponentModel component)

Specified by:

preRemove in interface UserProvider

updateCredential

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

Specified by:

updateCredential in interface UserCredentialStore

getCredentialEntity

public CredentialEntity getCredentialEntity(CredentialModel cred,
                                            MongoUserEntity mongoUser)

getMongoUserEntity

public MongoUserEntity getMongoUserEntity(UserModel user)

createCredential

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

Specified by:

createCredential in interface UserCredentialStore

setValues

public void setValues(CredentialModel cred,
                      CredentialEntity credentialEntity)

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

public CredentialModel toModel(CredentialEntity credEntity)

getStoredCredentials

public List<CredentialModel> getStoredCredentials(RealmModel realm,
                                                  UserModel user)

Specified by:

getStoredCredentials in interface UserCredentialStore

getStoredCredentialsByType

public List<CredentialModel> getStoredCredentialsByType(RealmModel realm,
                                                        UserModel user,
                                                        String type)

Specified by:

getStoredCredentialsByType in interface UserCredentialStore

getStoredCredentialByNameAndType

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

Specified by:

getStoredCredentialByNameAndType in interface UserCredentialStore