Package org.keycloak.models.jpa

Class JpaRealmProvider

java.lang.Object

org.keycloak.models.jpa.JpaRealmProvider

All Implemented Interfaces:

ClientProvider, ClientScopeProvider, DeploymentStateProvider, GroupProvider, RealmProvider, RoleProvider, Provider, ClientLookupProvider, ClientScopeLookupProvider, GroupLookupProvider, RoleLookupProvider

public class JpaRealmProvider
extends Object
implements RealmProvider, ClientProvider, ClientScopeProvider, GroupProvider, RoleProvider, DeploymentStateProvider

Version:

$Revision: 1 $

Author:

Bill Burke

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
JpaRealmProvider(KeycloakSession session, jakarta.persistence.EntityManager em, Set<String> clientSearchableAttributes, Set<String> groupSearchableAttributes)

Method Summary

Modifier and Type	Method	Description
ClientModel	addClient(RealmModel realm, String clientId)
ClientModel	addClient(RealmModel realm, String id, String clientId)
RoleModel	addClientRole(ClientModel client, String name)
RoleModel	addClientRole(ClientModel client, String id, String name)
ClientScopeModel	addClientScope(RealmModel realm, String id, String name)
void	addClientScopes(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope)
RoleModel	addRealmRole(RealmModel realm, String name)
RoleModel	addRealmRole(RealmModel realm, String id, String name)
void	addTopLevelGroup(RealmModel realm, GroupModel subGroup)
void	close()
GroupModel	createGroup(RealmModel realm, String id, String name, GroupModel toParent)
RealmModel	createRealm(String name)
RealmModel	createRealm(String id, String name)
boolean	deleteLocalizationText(RealmModel realm, String locale, String key)
boolean	deleteLocalizationTextsByLocale(RealmModel realm, String locale)
Map<ClientModel,Set<String>>	getAllRedirectUrisOfEnabledClients(RealmModel realm)
Stream<ClientModel>	getAlwaysDisplayInConsoleClientsStream(RealmModel realm)
ClientModel	getClientByClientId(RealmModel realm, String clientId)
ClientModel	getClientById(RealmModel realm, String id)
RoleModel	getClientRole(ClientModel client, String name)
Stream<RoleModel>	getClientRolesStream(ClientModel client, Integer first, Integer max)
ClientScopeModel	getClientScopeById(RealmModel realm, String id)
Map<String,ClientScopeModel>	getClientScopes(RealmModel realm, ClientModel client, boolean defaultScope)
Stream<ClientScopeModel>	getClientScopesStream(RealmModel realm)
long	getClientsCount(RealmModel realm)
Set<String>	getClientSearchableAttributes()
Stream<ClientModel>	getClientsStream(RealmModel realm)
Stream<ClientModel>	getClientsStream(RealmModel realm, Integer firstResult, Integer maxResults)
GroupModel	getGroupById(RealmModel realm, String id)
GroupModel	getGroupByName(RealmModel realm, GroupModel parent, String name)
Stream<GroupModel>	getGroupsByRoleStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
Long	getGroupsCount(RealmModel realm, Boolean onlyTopGroups)
Long	getGroupsCount(RealmModel realm, Stream<String> ids, String search)
Long	getGroupsCountByNameContaining(RealmModel realm, String search)
Stream<GroupModel>	getGroupsStream(RealmModel realm)
Stream<GroupModel>	getGroupsStream(RealmModel realm, Stream<String> ids)
Stream<GroupModel>	getGroupsStream(RealmModel realm, Stream<String> ids, Integer first, Integer max)
Stream<GroupModel>	getGroupsStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
String	getLocalizationTextsById(RealmModel realm, String locale, String key)
MigrationModel	getMigrationModel()
RealmModel	getRealm(String id)
RealmModel	getRealmByName(String name)
RoleModel	getRealmRole(RealmModel realm, String name)
Stream<RoleModel>	getRealmRolesStream(RealmModel realm)
Stream<RoleModel>	getRealmRolesStream(RealmModel realm, Integer first, Integer max)
Stream<RealmModel>	getRealmsStream()
Stream<RealmModel>	getRealmsWithProviderTypeStream(Class<?> providerType)
RoleModel	getRoleById(RealmModel realm, String id)
protected Stream<RoleModel>	getRolesStream(jakarta.persistence.TypedQuery<RoleEntity> query, RealmModel realm, Integer first, Integer max)
Stream<RoleModel>	getRolesStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
Stream<GroupModel>	getTopLevelGroupsStream(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults)
void	moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
void	preRemove(RealmModel realm, RoleModel role)
boolean	removeClient(RealmModel realm, String id)
void	removeClients(RealmModel realm)
boolean	removeClientScope(RealmModel realm, String id)
void	removeClientScope(RealmModel realm, ClientModel client, ClientScopeModel clientScope)
void	removeClientScopes(RealmModel realm)
void	removeExpiredClientInitialAccess()
boolean	removeGroup(RealmModel realm, GroupModel group)
boolean	removeRealm(String id)
boolean	removeRole(RoleModel role)
void	removeRoles(ClientModel client)
void	removeRoles(RealmModel realm)
RoleContainerModel.RoleRemovedEvent	roleRemovedEvent(RoleModel role)
void	saveLocalizationText(RealmModel realm, String locale, String key, String text)
void	saveLocalizationTexts(RealmModel realm, String locale, Map<String,String> localizationTexts)
Stream<ClientModel>	searchClientsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
Stream<ClientModel>	searchClientsByAuthenticationFlowBindingOverrides(RealmModel realm, Map<String,String> overrides, Integer firstResult, Integer maxResults)
Stream<ClientModel>	searchClientsByClientIdStream(RealmModel realm, String clientId, Integer firstResult, Integer maxResults)
Stream<RoleModel>	searchForClientRolesStream(ClientModel client, String search, Integer first, Integer max)
Stream<RoleModel>	searchForClientRolesStream(RealmModel realm, String search, Stream<String> excludedIds, Integer first, Integer max)
Stream<RoleModel>	searchForClientRolesStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
Stream<GroupModel>	searchForGroupByNameStream(RealmModel realm, String search, Boolean exact, Integer first, Integer max)
protected Stream<RoleModel>	searchForRoles(jakarta.persistence.TypedQuery<RoleEntity> query, RealmModel realm, String search, Integer first, Integer max)
Stream<RoleModel>	searchForRolesStream(RealmModel realm, String search, Integer first, Integer max)
Stream<GroupModel>	searchGroupsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
boolean	updateLocalizationText(RealmModel realm, String locale, String key, String text)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.models.ClientScopeProvider

addClientScope

Methods inherited from interface org.keycloak.storage.group.GroupLookupProvider

searchForGroupByNameStream

Methods inherited from interface org.keycloak.models.GroupProvider

createGroup, createGroup, createGroup, getTopLevelGroupsStream, getTopLevelGroupsStream

Methods inherited from interface org.keycloak.models.RealmProvider

createClientInitialAccessModel, decreaseRemainingCount, getClientInitialAccessModel, listClientInitialAccessStream, removeClientInitialAccessModel

Methods inherited from interface org.keycloak.models.RoleProvider

getClientRolesStream

Field Details

logger

protected static final org.jboss.logging.Logger logger

em

protected jakarta.persistence.EntityManager em

Constructor Details

JpaRealmProvider

public JpaRealmProvider(KeycloakSession session,
 jakarta.persistence.EntityManager em,
 Set<String> clientSearchableAttributes,
 Set<String> groupSearchableAttributes)

Method Details

getMigrationModel

public MigrationModel getMigrationModel()

Specified by:

getMigrationModel in interface DeploymentStateProvider

createRealm

public RealmModel createRealm(String name)

Specified by:

createRealm in interface RealmProvider

createRealm

public RealmModel createRealm(String id,
 String name)

Specified by:

createRealm in interface RealmProvider

getRealm

public RealmModel getRealm(String id)

Specified by:

getRealm in interface RealmProvider

getRealmsWithProviderTypeStream

public Stream<RealmModel> getRealmsWithProviderTypeStream(Class<?> providerType)

Specified by:

getRealmsWithProviderTypeStream in interface RealmProvider

getRealmsStream

public Stream<RealmModel> getRealmsStream()

Specified by:

getRealmsStream in interface RealmProvider

getRealmByName

public RealmModel getRealmByName(String name)

Specified by:

getRealmByName in interface RealmProvider

removeRealm

public boolean removeRealm(String id)

Specified by:

removeRealm in interface RealmProvider

close

public void close()

Specified by:

close in interface Provider

addRealmRole

public RoleModel addRealmRole(RealmModel realm,
 String name)

Specified by:

addRealmRole in interface RoleProvider

addRealmRole

public RoleModel addRealmRole(RealmModel realm,
 String id,
 String name)

Specified by:

addRealmRole in interface RoleProvider

getRealmRole

public RoleModel getRealmRole(RealmModel realm,
 String name)

Specified by:

getRealmRole in interface RoleLookupProvider

addClientRole

public RoleModel addClientRole(ClientModel client,
 String name)

Specified by:

addClientRole in interface RoleProvider

addClientRole

public RoleModel addClientRole(ClientModel client,
 String id,
 String name)

Specified by:

addClientRole in interface RoleProvider

getRealmRolesStream

public Stream<RoleModel> getRealmRolesStream(RealmModel realm)

Specified by:

getRealmRolesStream in interface RoleProvider

getClientRole

public RoleModel getClientRole(ClientModel client,
 String name)

Specified by:

getClientRole in interface RoleLookupProvider

getAllRedirectUrisOfEnabledClients

public Map<ClientModel,Set<String>> getAllRedirectUrisOfEnabledClients(RealmModel realm)

Specified by:

getAllRedirectUrisOfEnabledClients in interface ClientProvider

getRealmRolesStream

public Stream<RoleModel> getRealmRolesStream(RealmModel realm,
 Integer first,
 Integer max)

Specified by:

getRealmRolesStream in interface RoleProvider

getRolesStream

public Stream<RoleModel> getRolesStream(RealmModel realm,
 Stream<String> ids,
 String search,
 Integer first,
 Integer max)

Specified by:

getRolesStream in interface RoleProvider

searchForClientRolesStream

public Stream<RoleModel> searchForClientRolesStream(RealmModel realm,
 Stream<String> ids,
 String search,
 Integer first,
 Integer max)

Specified by:

searchForClientRolesStream in interface RoleLookupProvider

searchForClientRolesStream

public Stream<RoleModel> searchForClientRolesStream(RealmModel realm,
 String search,
 Stream<String> excludedIds,
 Integer first,
 Integer max)

Specified by:

searchForClientRolesStream in interface RoleLookupProvider

getClientRolesStream

public Stream<RoleModel> getClientRolesStream(ClientModel client,
 Integer first,
 Integer max)

Specified by:

getClientRolesStream in interface RoleProvider

getRolesStream

protected Stream<RoleModel> getRolesStream(jakarta.persistence.TypedQuery<RoleEntity> query,
 RealmModel realm,
 Integer first,
 Integer max)

searchForClientRolesStream

public Stream<RoleModel> searchForClientRolesStream(ClientModel client,
 String search,
 Integer first,
 Integer max)

Specified by:

searchForClientRolesStream in interface RoleLookupProvider

searchForRolesStream

public Stream<RoleModel> searchForRolesStream(RealmModel realm,
 String search,
 Integer first,
 Integer max)

Specified by:

searchForRolesStream in interface RoleLookupProvider

searchForRoles

protected Stream<RoleModel> searchForRoles(jakarta.persistence.TypedQuery<RoleEntity> query,
 RealmModel realm,
 String search,
 Integer first,
 Integer max)

removeRole

public boolean removeRole(RoleModel role)

Specified by:

removeRole in interface RoleProvider

roleRemovedEvent

public RoleContainerModel.RoleRemovedEvent roleRemovedEvent(RoleModel role)

removeRoles

public void removeRoles(RealmModel realm)

Specified by:

removeRoles in interface RoleProvider

removeRoles

public void removeRoles(ClientModel client)

Specified by:

removeRoles in interface RoleProvider

getRoleById

public RoleModel getRoleById(RealmModel realm,
 String id)

Specified by:

getRoleById in interface RoleLookupProvider

getGroupById

public GroupModel getGroupById(RealmModel realm,
 String id)

Specified by:

getGroupById in interface GroupLookupProvider

getGroupByName

public GroupModel getGroupByName(RealmModel realm,
 GroupModel parent,
 String name)

Specified by:

getGroupByName in interface GroupLookupProvider

moveGroup

public void moveGroup(RealmModel realm,
 GroupModel group,
 GroupModel toParent)

Specified by:

moveGroup in interface GroupProvider

getGroupsStream

public Stream<GroupModel> getGroupsStream(RealmModel realm)

Specified by:

getGroupsStream in interface GroupProvider

getGroupsStream

public Stream<GroupModel> getGroupsStream(RealmModel realm,
 Stream<String> ids,
 String search,
 Integer first,
 Integer max)

Specified by:

getGroupsStream in interface GroupProvider

getGroupsStream

public Stream<GroupModel> getGroupsStream(RealmModel realm,
 Stream<String> ids,
 Integer first,
 Integer max)

Specified by:

getGroupsStream in interface GroupProvider

getGroupsStream

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

Specified by:

getGroupsStream in interface GroupProvider

getGroupsCount

public Long getGroupsCount(RealmModel realm,
 Stream<String> ids,
 String search)

Specified by:

getGroupsCount in interface GroupProvider

getGroupsCount

public Long getGroupsCount(RealmModel realm,
 Boolean onlyTopGroups)

Specified by:

getGroupsCount in interface GroupProvider

getClientsCount

public long getClientsCount(RealmModel realm)

Specified by:

getClientsCount in interface ClientProvider

getGroupsCountByNameContaining

public Long getGroupsCountByNameContaining(RealmModel realm,
 String search)

Specified by:

getGroupsCountByNameContaining in interface GroupProvider

getGroupsByRoleStream

public Stream<GroupModel> getGroupsByRoleStream(RealmModel realm,
 RoleModel role,
 Integer firstResult,
 Integer maxResults)

Specified by:

getGroupsByRoleStream in interface GroupProvider

getTopLevelGroupsStream

public Stream<GroupModel> getTopLevelGroupsStream(RealmModel realm,
 String search,
 Boolean exact,
 Integer firstResult,
 Integer maxResults)

Specified by:

getTopLevelGroupsStream in interface GroupProvider

removeGroup

public boolean removeGroup(RealmModel realm,
 GroupModel group)

Specified by:

removeGroup in interface GroupProvider

createGroup

public GroupModel createGroup(RealmModel realm,
 String id,
 String name,
 GroupModel toParent)

Specified by:

createGroup in interface GroupProvider

addTopLevelGroup

public void addTopLevelGroup(RealmModel realm,
 GroupModel subGroup)

Specified by:

addTopLevelGroup in interface GroupProvider

preRemove

public void preRemove(RealmModel realm,
 RoleModel role)

addClient

public ClientModel addClient(RealmModel realm,
 String clientId)

Specified by:

addClient in interface ClientProvider

addClient

public ClientModel addClient(RealmModel realm,
 String id,
 String clientId)

Specified by:

addClient in interface ClientProvider

getClientsStream

public Stream<ClientModel> getClientsStream(RealmModel realm)

Specified by:

getClientsStream in interface ClientProvider

getClientsStream

public Stream<ClientModel> getClientsStream(RealmModel realm,
 Integer firstResult,
 Integer maxResults)

Specified by:

getClientsStream in interface ClientProvider

getAlwaysDisplayInConsoleClientsStream

public Stream<ClientModel> getAlwaysDisplayInConsoleClientsStream(RealmModel realm)

Specified by:

getAlwaysDisplayInConsoleClientsStream in interface ClientProvider

getClientById

public ClientModel getClientById(RealmModel realm,
 String id)

Specified by:

getClientById in interface ClientLookupProvider

getClientByClientId

public ClientModel getClientByClientId(RealmModel realm,
 String clientId)

Specified by:

getClientByClientId in interface ClientLookupProvider

searchClientsByClientIdStream

public Stream<ClientModel> searchClientsByClientIdStream(RealmModel realm,
 String clientId,
 Integer firstResult,
 Integer maxResults)

Specified by:

searchClientsByClientIdStream in interface ClientLookupProvider

searchClientsByAttributes

public Stream<ClientModel> searchClientsByAttributes(RealmModel realm,
 Map<String,String> attributes,
 Integer firstResult,
 Integer maxResults)

Specified by:

searchClientsByAttributes in interface ClientLookupProvider

searchClientsByAuthenticationFlowBindingOverrides

public Stream<ClientModel> searchClientsByAuthenticationFlowBindingOverrides(RealmModel realm,
 Map<String,String> overrides,
 Integer firstResult,
 Integer maxResults)

Specified by:

searchClientsByAuthenticationFlowBindingOverrides in interface ClientLookupProvider

removeClients

public void removeClients(RealmModel realm)

Specified by:

removeClients in interface ClientProvider

removeClient

public boolean removeClient(RealmModel realm,
 String id)

Specified by:

removeClient in interface ClientProvider

getClientScopeById

public ClientScopeModel getClientScopeById(RealmModel realm,
 String id)

Specified by:

getClientScopeById in interface ClientScopeLookupProvider

getClientScopesStream

public Stream<ClientScopeModel> getClientScopesStream(RealmModel realm)

Specified by:

getClientScopesStream in interface ClientScopeProvider

addClientScope

public ClientScopeModel addClientScope(RealmModel realm,
 String id,
 String name)

Specified by:

addClientScope in interface ClientScopeProvider

removeClientScope

public boolean removeClientScope(RealmModel realm,
 String id)

Specified by:

removeClientScope in interface ClientScopeProvider

removeClientScopes

public void removeClientScopes(RealmModel realm)

Specified by:

removeClientScopes in interface ClientScopeProvider

addClientScopes

public void addClientScopes(RealmModel realm,
 ClientModel client,
 Set<ClientScopeModel> clientScopes,
 boolean defaultScope)

Specified by:

addClientScopes in interface ClientProvider

removeClientScope

public void removeClientScope(RealmModel realm,
 ClientModel client,
 ClientScopeModel clientScope)

Specified by:

removeClientScope in interface ClientProvider

getClientScopes

public Map<String,ClientScopeModel> getClientScopes(RealmModel realm,
 ClientModel client,
 boolean defaultScope)

Specified by:

getClientScopes in interface ClientLookupProvider

searchForGroupByNameStream

public Stream<GroupModel> searchForGroupByNameStream(RealmModel realm,
 String search,
 Boolean exact,
 Integer first,
 Integer max)

Specified by:

searchForGroupByNameStream in interface GroupLookupProvider

searchGroupsByAttributes

public Stream<GroupModel> searchGroupsByAttributes(RealmModel realm,
 Map<String,String> attributes,
 Integer firstResult,
 Integer maxResults)

Specified by:

searchGroupsByAttributes in interface GroupLookupProvider

removeExpiredClientInitialAccess

public void removeExpiredClientInitialAccess()

Specified by:

removeExpiredClientInitialAccess in interface RealmProvider

updateLocalizationText

public boolean updateLocalizationText(RealmModel realm,
 String locale,
 String key,
 String text)

Specified by:

updateLocalizationText in interface RealmProvider

saveLocalizationText

public void saveLocalizationText(RealmModel realm,
 String locale,
 String key,
 String text)

Specified by:

saveLocalizationText in interface RealmProvider

saveLocalizationTexts

public void saveLocalizationTexts(RealmModel realm,
 String locale,
 Map<String,String> localizationTexts)

Specified by:

saveLocalizationTexts in interface RealmProvider

deleteLocalizationTextsByLocale

public boolean deleteLocalizationTextsByLocale(RealmModel realm,
 String locale)

Specified by:

deleteLocalizationTextsByLocale in interface RealmProvider

getLocalizationTextsById

public String getLocalizationTextsById(RealmModel realm,
 String locale,
 String key)

Specified by:

getLocalizationTextsById in interface RealmProvider

deleteLocalizationText

public boolean deleteLocalizationText(RealmModel realm,
 String locale,
 String key)

Specified by:

deleteLocalizationText in interface RealmProvider

getClientSearchableAttributes

public Set<String> getClientSearchableAttributes()