Package org.keycloak.storage.jpa

Class JpaUserFederatedStorageProvider

java.lang.Object

org.keycloak.storage.jpa.JpaUserFederatedStorageProvider

All Implemented Interfaces:

UserCredentialStore, Provider, UserAttributeFederatedStorage, UserBrokerLinkFederatedStorage, UserConsentFederatedStorage, UserFederatedStorageProvider, UserFederatedUserCredentialStore, UserGroupMembershipFederatedStorage, UserNotBeforeFederatedStorage, UserRequiredActionsFederatedStorage, UserRoleMappingsFederatedStorage

public class JpaUserFederatedStorageProvider
extends Object
implements UserFederatedStorageProvider, UserCredentialStore

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.storage.federated.UserFederatedStorageProvider

UserFederatedStorageProvider.Streams

Field Summary

Fields

Modifier and Type	Field	Description
protected jakarta.persistence.EntityManager	em
protected static final org.jboss.logging.Logger	logger

Constructor Summary

Constructors

Constructor	Description
JpaUserFederatedStorageProvider(KeycloakSession session, jakarta.persistence.EntityManager em)

Method Summary

Modifier and Type	Method	Description
void	addConsent(RealmModel realm, String userId, UserConsentModel consent)
void	addFederatedIdentity(RealmModel realm, String userId, FederatedIdentityModel link)
void	addRequiredAction(RealmModel realm, String userId, String action)
void	close()
CredentialModel	createCredential(RealmModel realm, String userId, CredentialModel cred)
CredentialModel	createCredential(RealmModel realm, UserModel user, CredentialModel cred)
protected void	createIndex(RealmModel realm, String userId)	We create an entry so that its easy to iterate over all things in the database.
void	deleteRoleMapping(RealmModel realm, String userId, RoleModel role)
MultivaluedHashMap<String,String>	getAttributes(RealmModel realm, String userId)
UserConsentModel	getConsentByClient(RealmModel realm, String userId, String clientInternalId)
Stream<UserConsentModel>	getConsentsStream(RealmModel realm, String userId)	Obtains the consents associated with the federated user identified by userId.
Stream<FederatedIdentityModel>	getFederatedIdentitiesStream(String userId, RealmModel realm)	Obtains the identities of the federated user identified by userId.
FederatedIdentityModel	getFederatedIdentity(String userId, String socialProvider, RealmModel realm)
Stream<GroupModel>	getGroupsStream(RealmModel realm, String userId)	Obtains the groups associated with the federated user.
Stream<String>	getMembershipStream(RealmModel realm, GroupModel group, Integer firstResult, Integer max)	Obtains the federated users that are members of the given group in the specified realm.
int	getNotBeforeOfUser(RealmModel realm, String userId)
Stream<String>	getRequiredActionsStream(RealmModel realm, String userId)	Obtains the names of required actions associated with the federated user identified by userId.
Stream<RoleModel>	getRoleMappingsStream(RealmModel realm, String userId)	Obtains the roles associated with the federated user identified by userId.
Stream<String>	getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer max)	Obtains the federated users that are members of the given role in the specified realm.
CredentialModel	getStoredCredentialById(RealmModel realm, String userId, String id)
CredentialModel	getStoredCredentialById(RealmModel realm, UserModel user, String id)
CredentialModel	getStoredCredentialByNameAndType(RealmModel realm, String userId, String name, String type)
CredentialModel	getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type)
Stream<CredentialModel>	getStoredCredentialsByTypeStream(RealmModel realm, String userId, String type)	Obtains the credentials of type type that are associated with the federated user identified by userId.
Stream<CredentialModel>	getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type)	Obtains the stored credentials associated with the specified user that match the specified type.
Stream<CredentialModel>	getStoredCredentialsStream(RealmModel realm, String userId)	Obtains the credentials associated with the federated user identified by userId.
Stream<CredentialModel>	getStoredCredentialsStream(RealmModel realm, UserModel user)	Obtains the stored credentials associated with the specified user.
int	getStoredUsersCount(RealmModel realm)
Stream<String>	getStoredUsersStream(RealmModel realm, Integer first, Integer max)	Obtains the ids of all federated users in the realm.
String	getUserByFederatedIdentity(FederatedIdentityModel link, RealmModel realm)
Stream<String>	getUsersByUserAttributeStream(RealmModel realm, String name, String value)	Searches for federated users that have an attribute with the specified name and value.
void	grantRole(RealmModel realm, String userId, RoleModel role)
void	joinGroup(RealmModel realm, String userId, GroupModel group)
void	leaveGroup(RealmModel realm, String userId, GroupModel group)
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, ComponentModel model)
void	preRemove(RealmModel realm, ClientModel client)
void	preRemove(RealmModel realm, GroupModel group)
void	preRemove(RealmModel realm, IdentityProviderModel provider)
void	preRemove(RealmModel realm, RoleModel role)
void	preRemove(RealmModel realm, UserModel user)
void	removeAttribute(RealmModel realm, String userId, String name)
boolean	removeFederatedIdentity(RealmModel realm, String userId, String socialProvider)
void	removeRequiredAction(RealmModel realm, String userId, String action)
boolean	removeStoredCredential(RealmModel realm, String userId, String id)
boolean	removeStoredCredential(RealmModel realm, UserModel user, String id)	Removes credential with the id for the user.
boolean	revokeConsentForClient(RealmModel realm, String userId, String clientInternalId)
void	setAttribute(RealmModel realm, String userId, String name, List<String> values)
void	setNotBeforeForUser(RealmModel realm, String userId, int notBefore)
void	setSingleAttribute(RealmModel realm, String userId, String name, String value)
protected CredentialModel	toModel(FederatedUserCredentialEntity entity)
void	updateConsent(RealmModel realm, String userId, UserConsentModel consent)
void	updateCredential(RealmModel realm, String userId, CredentialModel cred)
void	updateCredential(RealmModel realm, UserModel user, CredentialModel cred)
void	updateFederatedIdentity(RealmModel realm, String userId, FederatedIdentityModel model)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

protected static final org.jboss.logging.Logger logger

em

protected jakarta.persistence.EntityManager em

Constructor Details

JpaUserFederatedStorageProvider

public JpaUserFederatedStorageProvider(KeycloakSession session,
 jakarta.persistence.EntityManager em)

Method Details

close

public void close()

Specified by:

close in interface Provider

createIndex

protected void createIndex(RealmModel realm,
 String userId)

We create an entry so that its easy to iterate over all things in the database. Specifically useful for export

setAttribute

public void setAttribute(RealmModel realm,
 String userId,
 String name,
 List<String> values)

Specified by:

setAttribute in interface UserAttributeFederatedStorage

setSingleAttribute

public void setSingleAttribute(RealmModel realm,
 String userId,
 String name,
 String value)

Specified by:

setSingleAttribute in interface UserAttributeFederatedStorage

removeAttribute

public void removeAttribute(RealmModel realm,
 String userId,
 String name)

Specified by:

removeAttribute in interface UserAttributeFederatedStorage

getAttributes

public MultivaluedHashMap<String,String> getAttributes(RealmModel realm,
 String userId)

Specified by:

getAttributes in interface UserAttributeFederatedStorage

getUsersByUserAttributeStream

public Stream<String> getUsersByUserAttributeStream(RealmModel realm,
 String name,
 String value)

Description copied from interface: UserAttributeFederatedStorage

Searches for federated users that have an attribute with the specified name and value.

Specified by:

getUsersByUserAttributeStream in interface UserAttributeFederatedStorage

Parameters:

realm - a reference to the realm.

name - the attribute name.

value - the attribute value.

Returns:

a non-null Stream of user IDs that match the search criteria.

getUserByFederatedIdentity

public String getUserByFederatedIdentity(FederatedIdentityModel link,
 RealmModel realm)

Specified by:

getUserByFederatedIdentity in interface UserBrokerLinkFederatedStorage

addFederatedIdentity

public void addFederatedIdentity(RealmModel realm,
 String userId,
 FederatedIdentityModel link)

Specified by:

addFederatedIdentity in interface UserBrokerLinkFederatedStorage

removeFederatedIdentity

public boolean removeFederatedIdentity(RealmModel realm,
 String userId,
 String socialProvider)

Specified by:

removeFederatedIdentity in interface UserBrokerLinkFederatedStorage

preRemove

public void preRemove(RealmModel realm,
 IdentityProviderModel provider)

Specified by:

preRemove in interface UserBrokerLinkFederatedStorage

updateFederatedIdentity

public void updateFederatedIdentity(RealmModel realm,
 String userId,
 FederatedIdentityModel model)

Specified by:

updateFederatedIdentity in interface UserBrokerLinkFederatedStorage

getFederatedIdentitiesStream

public Stream<FederatedIdentityModel> getFederatedIdentitiesStream(String userId,
 RealmModel realm)

Description copied from interface: UserBrokerLinkFederatedStorage

Obtains the identities of the federated user identified by userId.

Specified by:

getFederatedIdentitiesStream in interface UserBrokerLinkFederatedStorage

Parameters:

userId - the user identifier.

realm - a reference to the realm.

Returns:

a non-null Stream of federated identities associated with the user.

getFederatedIdentity

public FederatedIdentityModel getFederatedIdentity(String userId,
 String socialProvider,
 RealmModel realm)

Specified by:

getFederatedIdentity in interface UserBrokerLinkFederatedStorage

addConsent

public void addConsent(RealmModel realm,
 String userId,
 UserConsentModel consent)

Specified by:

addConsent in interface UserConsentFederatedStorage

getConsentByClient

public UserConsentModel getConsentByClient(RealmModel realm,
 String userId,
 String clientInternalId)

Specified by:

getConsentByClient in interface UserConsentFederatedStorage

getConsentsStream

public Stream<UserConsentModel> getConsentsStream(RealmModel realm,
 String userId)

Description copied from interface: UserConsentFederatedStorage

Obtains the consents associated with the federated user identified by userId.

Specified by:

getConsentsStream in interface UserConsentFederatedStorage

Parameters:

realm - a reference to the realm.

userId - the user identifier.

Returns:

a non-null Stream of consents associated with the user.

updateConsent

public void updateConsent(RealmModel realm,
 String userId,
 UserConsentModel consent)

Specified by:

updateConsent in interface UserConsentFederatedStorage

revokeConsentForClient

public boolean revokeConsentForClient(RealmModel realm,
 String userId,
 String clientInternalId)

Specified by:

revokeConsentForClient in interface UserConsentFederatedStorage

setNotBeforeForUser

public void setNotBeforeForUser(RealmModel realm,
 String userId,
 int notBefore)

Specified by:

setNotBeforeForUser in interface UserNotBeforeFederatedStorage

getNotBeforeOfUser

public int getNotBeforeOfUser(RealmModel realm,
 String userId)

Specified by:

getNotBeforeOfUser in interface UserNotBeforeFederatedStorage

getGroupsStream

public Stream<GroupModel> getGroupsStream(RealmModel realm,
 String userId)

Description copied from interface: UserGroupMembershipFederatedStorage

Obtains the groups associated with the federated user.

Specified by:

getGroupsStream in interface UserGroupMembershipFederatedStorage

Parameters:

realm - a reference to the realm.

userId - the user identifier.

Returns:

a non-null Stream of groups.

joinGroup

public void joinGroup(RealmModel realm,
 String userId,
 GroupModel group)

Specified by:

joinGroup in interface UserGroupMembershipFederatedStorage

leaveGroup

public void leaveGroup(RealmModel realm,
 String userId,
 GroupModel group)

Specified by:

leaveGroup in interface UserGroupMembershipFederatedStorage

getMembershipStream

public Stream<String> getMembershipStream(RealmModel realm,
 GroupModel group,
 Integer firstResult,
 Integer max)

Description copied from interface: UserGroupMembershipFederatedStorage

Obtains the federated users that are members of the given group in the specified realm.

Specified by:

getMembershipStream in interface UserGroupMembershipFederatedStorage

Parameters:

realm - a reference to the realm.

group - a reference to the group whose federated members are being searched.

firstResult - first result to return. Ignored if negative or null.

max - maximum number of results to return. Ignored if negative or null.

Returns:

a non-null Stream of federated user ids that are members of the group in the realm.

getRoleMembersStream

public Stream<String> getRoleMembersStream(RealmModel realm,
 RoleModel role,
 Integer firstResult,
 Integer max)

Description copied from interface: UserRoleMappingsFederatedStorage

Obtains the federated users that are members of the given role in the specified realm.

Specified by:

getRoleMembersStream in interface UserRoleMappingsFederatedStorage

Parameters:

realm - a reference to the realm.

role - a reference to the role whose federated members are being searched.

firstResult - first result to return. Ignored if negative or null.

max - maximum number of results to return. Ignored if negative or null.

Returns:

a non-null Stream of federated user ids that are members of the role in the realm.

getRequiredActionsStream

public Stream<String> getRequiredActionsStream(RealmModel realm,
 String userId)

Description copied from interface: UserRequiredActionsFederatedStorage

Obtains the names of required actions associated with the federated user identified by userId.

Specified by:

getRequiredActionsStream in interface UserRequiredActionsFederatedStorage

Parameters:

realm - a reference to the realm.

userId - the user identifier.

Returns:

a non-null Stream of required action names.

addRequiredAction

public void addRequiredAction(RealmModel realm,
 String userId,
 String action)

Specified by:

addRequiredAction in interface UserRequiredActionsFederatedStorage

removeRequiredAction

public void removeRequiredAction(RealmModel realm,
 String userId,
 String action)

Specified by:

removeRequiredAction in interface UserRequiredActionsFederatedStorage

grantRole

public void grantRole(RealmModel realm,
 String userId,
 RoleModel role)

Specified by:

grantRole in interface UserRoleMappingsFederatedStorage

getRoleMappingsStream

public Stream<RoleModel> getRoleMappingsStream(RealmModel realm,
 String userId)

Description copied from interface: UserRoleMappingsFederatedStorage

Obtains the roles associated with the federated user identified by userId.

Specified by:

getRoleMappingsStream in interface UserRoleMappingsFederatedStorage

Parameters:

realm - a reference to the realm.

userId - the user identifier.

Returns:

a non-null Stream of roles.

deleteRoleMapping

public void deleteRoleMapping(RealmModel realm,
 String userId,
 RoleModel role)

Specified by:

deleteRoleMapping in interface UserRoleMappingsFederatedStorage

updateCredential

public void updateCredential(RealmModel realm,
 String userId,
 CredentialModel cred)

Specified by:

updateCredential in interface UserFederatedUserCredentialStore

createCredential

public CredentialModel createCredential(RealmModel realm,
 String userId,
 CredentialModel cred)

Specified by:

createCredential in interface UserFederatedUserCredentialStore

removeStoredCredential

public boolean removeStoredCredential(RealmModel realm,
 String userId,
 String id)

Specified by:

removeStoredCredential in interface UserFederatedUserCredentialStore

getStoredCredentialById

public CredentialModel getStoredCredentialById(RealmModel realm,
 String userId,
 String id)

Specified by:

getStoredCredentialById in interface UserFederatedUserCredentialStore

toModel

protected CredentialModel toModel(FederatedUserCredentialEntity entity)

getStoredCredentialsStream

public Stream<CredentialModel> getStoredCredentialsStream(RealmModel realm,
 String userId)

Description copied from interface: UserFederatedUserCredentialStore

Obtains the credentials associated with the federated user identified by userId.

Specified by:

getStoredCredentialsStream in interface UserFederatedUserCredentialStore

Parameters:

realm - a reference to the realm.

userId - the user identifier.

Returns:

a non-null Stream of credentials.

getStoredCredentialsByTypeStream

public Stream<CredentialModel> getStoredCredentialsByTypeStream(RealmModel realm,
 String userId,
 String type)

Description copied from interface: UserFederatedUserCredentialStore

Obtains the credentials of type type that are associated with the federated user identified by userId.

Specified by:

getStoredCredentialsByTypeStream in interface UserFederatedUserCredentialStore

Parameters:

realm - a reference to the realm.

userId - the user identifier.

type - the credential type.

Returns:

a non-null Stream of credentials.

getStoredCredentialByNameAndType

public CredentialModel getStoredCredentialByNameAndType(RealmModel realm,
 String userId,
 String name,
 String type)

Specified by:

getStoredCredentialByNameAndType in interface UserFederatedUserCredentialStore

getStoredUsersStream

public Stream<String> getStoredUsersStream(RealmModel realm,
 Integer first,
 Integer max)

Description copied from interface: UserFederatedStorageProvider

Obtains the ids of all federated users in the realm.

Specified by:

getStoredUsersStream in interface UserFederatedStorageProvider

Parameters:

realm - a reference to the realm.

first - first result to return. Ignored if negative or null.

max - maximum number of results to return. Ignored if negative or null.

Returns:

a non-null Stream of federated user ids.

updateCredential

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

Specified by:

updateCredential in interface UserCredentialStore

createCredential

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

Specified by:

createCredential in interface UserCredentialStore

removeStoredCredential

public boolean removeStoredCredential(RealmModel realm,
 UserModel user,
 String id)

Description copied from interface: UserCredentialStore

Removes credential with the id for the user.

Specified by:

removeStoredCredential in interface UserCredentialStore

Parameters:

realm - realm.

user - user

id - id

Returns:

true if the credential was removed, false otherwise TODO: Make this method return Boolean so that store can return "I don't know" answer, this can be used for example in async stores

getStoredCredentialById

public CredentialModel getStoredCredentialById(RealmModel realm,
 UserModel user,
 String id)

Specified by:

getStoredCredentialById in interface UserCredentialStore

getStoredCredentialsStream

public Stream<CredentialModel> getStoredCredentialsStream(RealmModel realm,
 UserModel user)

Description copied from interface: UserCredentialStore

Obtains the stored credentials associated with the specified user.

Specified by:

getStoredCredentialsStream in interface UserCredentialStore

Parameters:

realm - a reference to the realm.

user - the user whose credentials are being searched.

Returns:

a non-null Stream of credentials.

getStoredCredentialsByTypeStream

public Stream<CredentialModel> getStoredCredentialsByTypeStream(RealmModel realm,
 UserModel user,
 String type)

Description copied from interface: UserCredentialStore

Obtains the stored credentials associated with the specified user that match the specified type.

Specified by:

getStoredCredentialsByTypeStream in interface UserCredentialStore

Parameters:

realm - a reference to the realm.

user - the user whose credentials are being searched.

type - the type of credentials being searched.

Returns:

a non-null Stream of credentials.

getStoredCredentialByNameAndType

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

Specified by:

getStoredCredentialByNameAndType in interface UserCredentialStore

moveCredentialTo

public boolean moveCredentialTo(RealmModel realm,
 UserModel user,
 String id,
 String newPreviousCredentialId)

Specified by:

moveCredentialTo in interface UserCredentialStore

getStoredUsersCount

public int getStoredUsersCount(RealmModel realm)

Specified by:

getStoredUsersCount in interface UserFederatedStorageProvider

preRemove

public void preRemove(RealmModel realm)

Specified by:

preRemove in interface UserFederatedStorageProvider

preRemove

public void preRemove(RealmModel realm,
 RoleModel role)

Specified by:

preRemove in interface UserFederatedStorageProvider

preRemove

public void preRemove(RealmModel realm,
 GroupModel group)

Specified by:

preRemove in interface UserFederatedStorageProvider

preRemove

public void preRemove(RealmModel realm,
 ClientModel client)

Specified by:

preRemove in interface UserFederatedStorageProvider

preRemove

public void preRemove(ProtocolMapperModel protocolMapper)

Specified by:

preRemove in interface UserFederatedStorageProvider

preRemove

public void preRemove(ClientScopeModel clientScope)

Specified by:

preRemove in interface UserFederatedStorageProvider

preRemove

public void preRemove(RealmModel realm,
 UserModel user)

Specified by:

preRemove in interface UserFederatedStorageProvider

preRemove

public void preRemove(RealmModel realm,
 ComponentModel model)

Specified by:

preRemove in interface UserFederatedStorageProvider