org.keycloak.models.jpa

Class JpaRealmProvider

java.lang.Object

org.keycloak.models.jpa.JpaRealmProvider

All Implemented Interfaces:

ClientProvider, RealmProvider, Provider, ClientLookupProvider

public class JpaRealmProvider
extends Object
implements RealmProvider, ClientProvider

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
JpaRealmProvider(KeycloakSession session, javax.persistence.EntityManager em)

Method Summary

Modifier and Type	Method and Description
ClientModel	addClient(RealmModel realm, String clientId) Adds a client with given clientId to the given realm.
ClientModel	addClient(RealmModel realm, String id, String clientId) Adds a client with given internal ID and clientId to the given realm.
RoleModel	addClientRole(RealmModel realm, ClientModel client, String name) TODO: To be @deprecated Use the corresponding method from ??RoleProvider.
RoleModel	addClientRole(RealmModel realm, ClientModel client, String id, String name) TODO: To be @deprecated Use the corresponding method from ??RoleProvider.
RoleModel	addRealmRole(RealmModel realm, String name)
RoleModel	addRealmRole(RealmModel realm, String id, String name)
void	addTopLevelGroup(RealmModel realm, GroupModel subGroup)
void	close()
ClientInitialAccessModel	createClientInitialAccessModel(RealmModel realm, int expiration, int count)
GroupModel	createGroup(RealmModel realm, String id, String name, GroupModel toParent)
RealmModel	createRealm(String name)
RealmModel	createRealm(String id, String name)
void	decreaseRemainingCount(RealmModel realm, ClientInitialAccessModel clientInitialAccess)
List<ClientModel>	getAlwaysDisplayInConsoleClients(RealmModel realm) Returns a list of clients that are expected to always show up in account console.
ClientModel	getClientByClientId(RealmModel realm, String clientId) Exact search for a client by its public client identifier.
ClientModel	getClientById(RealmModel realm, String id) Exact search for a client by its internal ID.
ClientInitialAccessModel	getClientInitialAccessModel(RealmModel realm, String id)
RoleModel	getClientRole(RealmModel realm, ClientModel client, String name) TODO: To be @deprecated Use the corresponding method from ??RoleProvider.
Set<RoleModel>	getClientRoles(RealmModel realm, ClientModel client) TODO: To be @deprecated Use the corresponding method from ??RoleProvider.
Set<RoleModel>	getClientRoles(RealmModel realm, ClientModel client, Integer first, Integer max)
List<ClientModel>	getClients(RealmModel realm, Integer firstResult, Integer maxResults) Returns the clients of the given realm.
ClientScopeModel	getClientScopeById(String id, RealmModel realm)
long	getClientsCount(RealmModel realm) Returns number of clients in the given realm
GroupModel	getGroupById(String id, RealmModel realm)
List<GroupModel>	getGroups(RealmModel realm)
List<GroupModel>	getGroupsByRole(RealmModel realm, RoleModel role, int firstResult, int maxResults)
Long	getGroupsCount(RealmModel realm, Boolean onlyTopGroups)
Long	getGroupsCountByNameContaining(RealmModel realm, String search)
MigrationModel	getMigrationModel()
RealmModel	getRealm(String id)
RealmModel	getRealmByName(String name)
RoleModel	getRealmRole(RealmModel realm, String name)
Set<RoleModel>	getRealmRoles(RealmModel realm)
Set<RoleModel>	getRealmRoles(RealmModel realm, Integer first, Integer max)
List<RealmModel>	getRealms()
List<RealmModel>	getRealmsWithProviderType(Class<?> providerType)
RoleModel	getRoleById(String id, RealmModel realm)
protected Set<RoleModel>	getRoles(javax.persistence.TypedQuery<RoleEntity> query, RealmModel realm, Integer first, Integer max)
List<GroupModel>	getTopLevelGroups(RealmModel realm)
List<GroupModel>	getTopLevelGroups(RealmModel realm, Integer first, Integer max)
List<ClientInitialAccessModel>	listClientInitialAccess(RealmModel realm)
void	moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
boolean	removeClient(RealmModel realm, String id) Removes given client from the given realm.
void	removeClientInitialAccessModel(RealmModel realm, String id)
void	removeClients(RealmModel realm) Removes all clients from the given realm.
void	removeExpiredClientInitialAccess()
boolean	removeGroup(RealmModel realm, GroupModel group)
boolean	removeRealm(String id)
boolean	removeRole(RealmModel realm, RoleModel role)
List<ClientModel>	searchClientsByClientId(RealmModel realm, String clientId, Integer firstResult, Integer maxResults) Case-insensitive search for clients that contain the given string in their public client identifier.
Set<RoleModel>	searchForClientRoles(RealmModel realm, ClientModel client, String search, Integer first, Integer max)
List<GroupModel>	searchForGroupByName(RealmModel realm, String search, Integer first, Integer max)
Set<RoleModel>	searchForRoles(RealmModel realm, String search, Integer first, Integer max)
protected Set<RoleModel>	searchForRoles(javax.persistence.TypedQuery<RoleEntity> query, RealmModel realm, String search, Integer first, Integer max)

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

createGroup, createGroup, createGroup, getClientByClientId, getClientById, getClients, removeClient, searchClientsByClientId

Field Detail

logger

protected static final org.jboss.logging.Logger logger

em

protected javax.persistence.EntityManager em

Constructor Detail

JpaRealmProvider

public JpaRealmProvider(KeycloakSession session,
                        javax.persistence.EntityManager em)

Method Detail

getMigrationModel

public MigrationModel getMigrationModel()

Specified by:

getMigrationModel in interface RealmProvider

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

getRealmsWithProviderType

public List<RealmModel> getRealmsWithProviderType(Class<?> providerType)

Specified by:

getRealmsWithProviderType in interface RealmProvider

getRealms

public List<RealmModel> getRealms()

Specified by:

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

addRealmRole

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

Specified by:

addRealmRole in interface RealmProvider

getRealmRole

public RoleModel getRealmRole(RealmModel realm,
                              String name)

Specified by:

getRealmRole in interface RealmProvider

addClientRole

public RoleModel addClientRole(RealmModel realm,
                               ClientModel client,
                               String name)

Description copied from interface: RealmProvider

TODO: To be @deprecated Use the corresponding method from ??RoleProvider.

Specified by:

addClientRole in interface RealmProvider

addClientRole

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

Description copied from interface: RealmProvider

TODO: To be @deprecated Use the corresponding method from ??RoleProvider.

Specified by:

addClientRole in interface RealmProvider

getRealmRoles

public Set<RoleModel> getRealmRoles(RealmModel realm)

Specified by:

getRealmRoles in interface RealmProvider

getClientRole

public RoleModel getClientRole(RealmModel realm,
                               ClientModel client,
                               String name)

Description copied from interface: RealmProvider

TODO: To be @deprecated Use the corresponding method from ??RoleProvider.

Specified by:

getClientRole in interface RealmProvider

getClientRoles

public Set<RoleModel> getClientRoles(RealmModel realm,
                                     ClientModel client)

Description copied from interface: RealmProvider

TODO: To be @deprecated Use the corresponding method from ??RoleProvider.

Specified by:

getClientRoles in interface RealmProvider

getRealmRoles

public Set<RoleModel> getRealmRoles(RealmModel realm,
                                    Integer first,
                                    Integer max)

Specified by:

getRealmRoles in interface RealmProvider

getClientRoles

public Set<RoleModel> getClientRoles(RealmModel realm,
                                     ClientModel client,
                                     Integer first,
                                     Integer max)

Specified by:

getClientRoles in interface RealmProvider

getRoles

protected Set<RoleModel> getRoles(javax.persistence.TypedQuery<RoleEntity> query,
                                  RealmModel realm,
                                  Integer first,
                                  Integer max)

searchForClientRoles

public Set<RoleModel> searchForClientRoles(RealmModel realm,
                                           ClientModel client,
                                           String search,
                                           Integer first,
                                           Integer max)

Specified by:

searchForClientRoles in interface RealmProvider

searchForRoles

public Set<RoleModel> searchForRoles(RealmModel realm,
                                     String search,
                                     Integer first,
                                     Integer max)

Specified by:

searchForRoles in interface RealmProvider

searchForRoles

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

removeRole

public boolean removeRole(RealmModel realm,
                          RoleModel role)

Specified by:

removeRole in interface RealmProvider

getRoleById

public RoleModel getRoleById(String id,
                             RealmModel realm)

Specified by:

getRoleById in interface RealmProvider

getGroupById

public GroupModel getGroupById(String id,
                               RealmModel realm)

Specified by:

getGroupById in interface RealmProvider

moveGroup

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

Specified by:

moveGroup in interface RealmProvider

getGroups

public List<GroupModel> getGroups(RealmModel realm)

Specified by:

getGroups in interface RealmProvider

getGroupsCount

public Long getGroupsCount(RealmModel realm,
                           Boolean onlyTopGroups)

Specified by:

getGroupsCount in interface RealmProvider

getClientsCount

public long getClientsCount(RealmModel realm)

Description copied from interface: ClientProvider

Returns number of clients in the given realm

Specified by:

getClientsCount in interface ClientProvider

Specified by:

getClientsCount in interface RealmProvider

Parameters:

realm - Realm.

Returns:

Number of the clients in the given realm.

getGroupsCountByNameContaining

public Long getGroupsCountByNameContaining(RealmModel realm,
                                           String search)

Specified by:

getGroupsCountByNameContaining in interface RealmProvider

getGroupsByRole

public List<GroupModel> getGroupsByRole(RealmModel realm,
                                        RoleModel role,
                                        int firstResult,
                                        int maxResults)

Specified by:

getGroupsByRole in interface RealmProvider

getTopLevelGroups

public List<GroupModel> getTopLevelGroups(RealmModel realm)

Specified by:

getTopLevelGroups in interface RealmProvider

getTopLevelGroups

public List<GroupModel> getTopLevelGroups(RealmModel realm,
                                          Integer first,
                                          Integer max)

Specified by:

getTopLevelGroups in interface RealmProvider

removeGroup

public boolean removeGroup(RealmModel realm,
                           GroupModel group)

Specified by:

removeGroup in interface RealmProvider

createGroup

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

Specified by:

createGroup in interface RealmProvider

addTopLevelGroup

public void addTopLevelGroup(RealmModel realm,
                             GroupModel subGroup)

Specified by:

addTopLevelGroup in interface RealmProvider

addClient

public ClientModel addClient(RealmModel realm,
                             String clientId)

Description copied from interface: ClientProvider

Adds a client with given clientId to the given realm. The internal ID of the client will be created automatically.

Specified by:

addClient in interface ClientProvider

Specified by:

addClient in interface RealmProvider

Parameters:

realm - Realm owning this client.

clientId - String that identifies the client to the external parties. Maps to client_id in OIDC or entityID in SAML.

Returns:

Model of the created client.

addClient

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

Description copied from interface: ClientProvider

Adds a client with given internal ID and clientId to the given realm.

Specified by:

addClient in interface ClientProvider

Specified by:

addClient in interface RealmProvider

Parameters:

realm - Realm owning this client.

id - Internal ID of the client or null if one is to be created by the underlying store

clientId - String that identifies the client to the external parties. Maps to client_id in OIDC or entityID in SAML.

Returns:

Model of the created client.

getClients

public List<ClientModel> getClients(RealmModel realm,
                                    Integer firstResult,
                                    Integer maxResults)

Description copied from interface: ClientProvider

Returns the clients of the given realm.

Specified by:

getClients in interface ClientProvider

Specified by:

getClients in interface RealmProvider

Parameters:

realm - Realm.

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

maxResults - Maximim number of results to return. Ignored if negative or null.

Returns:

List of the clients. Never returns null.

getAlwaysDisplayInConsoleClients

public List<ClientModel> getAlwaysDisplayInConsoleClients(RealmModel realm)

Description copied from interface: ClientProvider

Returns a list of clients that are expected to always show up in account console.

Specified by:

getAlwaysDisplayInConsoleClients in interface ClientProvider

Specified by:

getAlwaysDisplayInConsoleClients in interface RealmProvider

Parameters:

realm - Realm owning the clients.

Returns:

List of the clients. Never returns null.

getClientById

public ClientModel getClientById(RealmModel realm,
                                 String id)

Description copied from interface: ClientLookupProvider

Exact search for a client by its internal ID.

Specified by:

getClientById in interface RealmProvider

Specified by:

getClientById in interface ClientLookupProvider

Parameters:

realm - Realm to limit the search.

id - Internal ID

Returns:

Model of the client, or null if no client is found.

getClientByClientId

public ClientModel getClientByClientId(RealmModel realm,
                                       String clientId)

Description copied from interface: ClientLookupProvider

Exact search for a client by its public client identifier.

Specified by:

getClientByClientId in interface RealmProvider

Specified by:

getClientByClientId in interface ClientLookupProvider

Parameters:

realm - Realm to limit the search for clients.

clientId - String that identifies the client to the external parties. Maps to client_id in OIDC or entityID in SAML.

Returns:

Model of the client, or null if no client is found.

searchClientsByClientId

public List<ClientModel> searchClientsByClientId(RealmModel realm,
                                                 String clientId,
                                                 Integer firstResult,
                                                 Integer maxResults)

Description copied from interface: ClientLookupProvider

Case-insensitive search for clients that contain the given string in their public client identifier.

Specified by:

searchClientsByClientId in interface RealmProvider

Specified by:

searchClientsByClientId in interface ClientLookupProvider

Parameters:

realm - Realm to limit the search for clients.

clientId - Searched substring of the public client identifier (client_id in OIDC or entityID in SAML.)

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

maxResults - Maximim number of results to return. Ignored if negative or null.

Returns:

Model of the client, or null if no client is found.

removeClients

public void removeClients(RealmModel realm)

Description copied from interface: ClientProvider

Removes all clients from the given realm.

Specified by:

removeClients in interface ClientProvider

Parameters:

realm - Realm.

removeClient

public boolean removeClient(RealmModel realm,
                            String id)

Description copied from interface: ClientProvider

Removes given client from the given realm.

Specified by:

removeClient in interface ClientProvider

Specified by:

removeClient in interface RealmProvider

Parameters:

realm - Realm.

id - Internal ID of the client

Returns:

true if the client existed and has been removed, false otherwise.

getClientScopeById

public ClientScopeModel getClientScopeById(String id,
                                           RealmModel realm)

Specified by:

getClientScopeById in interface RealmProvider

searchForGroupByName

public List<GroupModel> searchForGroupByName(RealmModel realm,
                                             String search,
                                             Integer first,
                                             Integer max)

Specified by:

searchForGroupByName in interface RealmProvider

createClientInitialAccessModel

public ClientInitialAccessModel createClientInitialAccessModel(RealmModel realm,
                                                               int expiration,
                                                               int count)

Specified by:

createClientInitialAccessModel in interface RealmProvider

getClientInitialAccessModel

public ClientInitialAccessModel getClientInitialAccessModel(RealmModel realm,
                                                            String id)

Specified by:

getClientInitialAccessModel in interface RealmProvider

removeClientInitialAccessModel

public void removeClientInitialAccessModel(RealmModel realm,
                                           String id)

Specified by:

removeClientInitialAccessModel in interface RealmProvider

listClientInitialAccess

public List<ClientInitialAccessModel> listClientInitialAccess(RealmModel realm)

Specified by:

listClientInitialAccess in interface RealmProvider

removeExpiredClientInitialAccess

public void removeExpiredClientInitialAccess()

Specified by:

removeExpiredClientInitialAccess in interface RealmProvider

decreaseRemainingCount

public void decreaseRemainingCount(RealmModel realm,
                                   ClientInitialAccessModel clientInitialAccess)

Specified by:

decreaseRemainingCount in interface RealmProvider