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, MongoStoreInvocationContext invocationContext)

Method Summary

Methods

Modifier and Type	Method and Description
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)
Set<FederatedIdentityModel>	getFederatedIdentities(UserModel userModel, RealmModel realm)
FederatedIdentityModel	getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)
protected MongoStore	getMongoStore()
UserModel	getUserByEmail(String email, RealmModel realm)
UserModel	getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)
UserModel	getUserById(String id, RealmModel realm)
UserModel	getUserByServiceAccountClient(ClientModel client)
UserModel	getUserByUsername(String username, RealmModel realm)
List<UserModel>	getUsers(RealmModel realm, boolean includeServiceAccounts)
List<UserModel>	getUsers(RealmModel realm, int firstResult, int maxResults, boolean includeServiceAccounts)
int	getUsersCount(RealmModel realm)
void	preRemove(ClientModel client, ProtocolMapperModel protocolMapper)
void	preRemove(RealmModel realm)
void	preRemove(RealmModel realm, ClientModel client)
void	preRemove(RealmModel realm, RoleModel role)
void	preRemove(RealmModel realm, UserFederationProviderModel link)
boolean	removeFederatedIdentity(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)
List<UserModel>	searchForUserByUserAttribute(String attrName, String attrValue, RealmModel realm)
void	updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)
CredentialValidationOutput	validCredentials(RealmModel realm, UserCredentialModel... input)
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,
                 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()

getUserByFederatedIdentity

public UserModel getUserByFederatedIdentity(FederatedIdentityModel socialLink,
                                   RealmModel realm)

Specified by:

getUserByFederatedIdentity in interface UserProvider

getUserByServiceAccountClient

public UserModel getUserByServiceAccountClient(ClientModel client)

Specified by:

getUserByServiceAccountClient in interface UserProvider

convertUserEntities

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

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 UserProvider

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

searchForUserByUserAttribute

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

Specified by:

searchForUserByUserAttribute in interface UserProvider

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 UserProvider

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 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,
             ClientModel client)

Specified by:

preRemove in interface UserProvider

preRemove

public void preRemove(ClientModel client,
             ProtocolMapperModel protocolMapper)

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

validCredentials

public CredentialValidationOutput validCredentials(RealmModel realm,
                                          UserCredentialModel... input)

Specified by:

validCredentials in interface UserProvider