org.keycloak.models.mongo.keycloak.adapters

Class MongoUserProvider

java.lang.Object

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

All Implemented Interfaces:

UserProvider, Provider

public class MongoUserProvider
extends Object
implements UserProvider

Author:

Marek Posolda

Constructor Summary

Constructors

Constructor and Description
MongoUserProvider(KeycloakSession session, MongoStore mongoStore, MongoStoreInvocationContext invocationContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	addSocialLink(RealmModel realm, UserModel user, SocialLinkModel socialLink)
UserModel	addUser(RealmModel realm, String username)
UserAdapter	addUser(RealmModel realm, String id, String username, boolean addDefaultRoles)
protected UserAdapter	addUserEntity(RealmModel realm, String id, String username)
void	close()
protected List<UserModel>	convertUserEntities(RealmModel realm, List<MongoUserEntity> userEntities)
protected MongoStore	getMongoStore()
SocialLinkModel	getSocialLink(UserModel user, String socialProvider, RealmModel realm)
Set<SocialLinkModel>	getSocialLinks(UserModel userModel, RealmModel realm)
UserModel	getUserByEmail(String email, RealmModel realm)
UserModel	getUserById(String id, RealmModel realm)
UserModel	getUserBySocialLink(SocialLinkModel socialLink, 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)
void	preRemove(RealmModel realm)
void	preRemove(RealmModel realm, RoleModel role)
void	preRemove(RealmModel realm, UserFederationProviderModel link)
boolean	removeSocialLink(RealmModel realm, UserModel userModel, String socialProvider)
boolean	removeUser(RealmModel realm, UserModel user)
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)
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

Constructor Detail

MongoUserProvider

public MongoUserProvider(KeycloakSession session,
                 MongoStore mongoStore,
                 MongoStoreInvocationContext invocationContext)

Method Detail

close

public void close()

Specified by:

close in interface UserProvider

Specified by:

close in interface Provider

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

getMongoStore

protected MongoStore getMongoStore()

getUserBySocialLink

public UserModel getUserBySocialLink(SocialLinkModel socialLink,
                            RealmModel realm)

Specified by:

getUserBySocialLink 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 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

getSocialLinks

public Set<SocialLinkModel> getSocialLinks(UserModel userModel,
                                  RealmModel realm)

Specified by:

getSocialLinks in interface UserProvider

getSocialLink

public SocialLinkModel getSocialLink(UserModel user,
                            String socialProvider,
                            RealmModel realm)

Specified by:

getSocialLink in interface UserProvider

addUser

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

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 UserProvider

addSocialLink

public void addSocialLink(RealmModel realm,
                 UserModel user,
                 SocialLinkModel socialLink)

Specified by:

addSocialLink in interface UserProvider

removeSocialLink

public boolean removeSocialLink(RealmModel realm,
                       UserModel userModel,
                       String socialProvider)

Specified by:

removeSocialLink in interface UserProvider

addUser

public UserModel addUser(RealmModel realm,
                String username)

Specified by:

addUser in interface UserProvider

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,
             RoleModel role)

Specified by:

preRemove 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