org.keycloak.models

Class UserFederationManager

java.lang.Object

org.keycloak.models.UserFederationManager

All Implemented Interfaces:

UserProvider, Provider

public class UserFederationManager
extends Object
implements UserProvider

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
protected KeycloakSession	session

Constructor Summary

Constructors

Constructor and Description
UserFederationManager(KeycloakSession session)

Method Summary

Modifier and Type	Method and Description
void	addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)
UserModel	addUser(RealmModel realm, String username)
UserModel	addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)
void	close()
boolean	configuredForCredentialType(String type, RealmModel realm, UserModel user) Is the user configured to use this credential type
protected void	deleteInvalidUser(RealmModel realm, UserModel user)
Set<FederatedIdentityModel>	getFederatedIdentities(UserModel user, RealmModel realm)
FederatedIdentityModel	getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)
protected UserFederationProvider	getFederationLink(RealmModel realm, UserModel user)
protected UserFederationProvider	getFederationProvider(UserFederationProviderModel model)
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	grantToAllUsers(RealmModel realm, RoleModel role)
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 model)
protected List<UserModel>	query(org.keycloak.models.UserFederationManager.PaginatedQuery pagedQuery, RealmModel realm, int firstResult, int maxResults)
protected UserModel	registerWithFederation(RealmModel realm, UserModel user)
boolean	removeFederatedIdentity(RealmModel realm, UserModel user, 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	updateCredential(RealmModel realm, UserModel user, UserCredentialModel credential)
void	updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)
protected UserModel	validateAndProxyUser(RealmModel realm, UserModel user)
protected void	validateUser(RealmModel realm, UserModel user)
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

Field Detail

session

protected KeycloakSession session

Constructor Detail

UserFederationManager

public UserFederationManager(KeycloakSession session)

Method Detail

addUser

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

Specified by:

addUser in interface UserProvider

getFederationProvider

protected UserFederationProvider getFederationProvider(UserFederationProviderModel model)

addUser

public UserModel addUser(RealmModel realm,
                         String username)

Specified by:

addUser in interface UserProvider

registerWithFederation

protected UserModel registerWithFederation(RealmModel realm,
                                           UserModel user)

getFederationLink

protected UserFederationProvider getFederationLink(RealmModel realm,
                                                   UserModel user)

removeUser

public boolean removeUser(RealmModel realm,
                          UserModel user)

Specified by:

removeUser in interface UserProvider

validateUser

protected void validateUser(RealmModel realm,
                            UserModel user)

deleteInvalidUser

protected void deleteInvalidUser(RealmModel realm,
                                 UserModel user)

validateAndProxyUser

protected UserModel validateAndProxyUser(RealmModel realm,
                                         UserModel user)

addFederatedIdentity

public void addFederatedIdentity(RealmModel realm,
                                 UserModel user,
                                 FederatedIdentityModel socialLink)

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

Specified by:

removeFederatedIdentity in interface UserProvider

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

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

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

query

protected List<UserModel> query(org.keycloak.models.UserFederationManager.PaginatedQuery pagedQuery,
                                RealmModel realm,
                                int firstResult,
                                int maxResults)

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 user,
                                                          RealmModel realm)

Specified by:

getFederatedIdentities in interface UserProvider

getFederatedIdentity

public FederatedIdentityModel getFederatedIdentity(UserModel user,
                                                   String socialProvider,
                                                   RealmModel realm)

Specified by:

getFederatedIdentity in interface UserProvider

grantToAllUsers

public void grantToAllUsers(RealmModel realm,
                            RoleModel role)

Specified by:

grantToAllUsers in interface UserProvider

preRemove

public void preRemove(RealmModel realm)

Specified by:

preRemove in interface UserProvider

preRemove

public void preRemove(RealmModel realm,
                      UserFederationProviderModel model)

Specified by:

preRemove in interface UserProvider

preRemove

public void preRemove(RealmModel realm,
                      RoleModel role)

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

updateCredential

public void updateCredential(RealmModel realm,
                             UserModel user,
                             UserCredentialModel credential)

validCredentials

public boolean validCredentials(RealmModel realm,
                                UserModel user,
                                List<UserCredentialModel> input)

Specified by:

validCredentials in interface UserProvider

configuredForCredentialType

public boolean configuredForCredentialType(String type,
                                           RealmModel realm,
                                           UserModel user)

Is the user configured to use this credential type

Returns:

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

close

public void close()

Specified by:

close in interface UserProvider

Specified by:

close in interface Provider