public class JpaRealmProvider extends Object implements RealmProvider, ClientProvider
Modifier and Type | Field and Description |
---|---|
protected javax.persistence.EntityManager |
em |
protected static org.jboss.logging.Logger |
logger |
Constructor and Description |
---|
JpaRealmProvider(KeycloakSession session,
javax.persistence.EntityManager em) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createGroup, createGroup, createGroup, getClientByClientId, getClientById, getClients, removeClient, searchClientsByClientId
protected static final org.jboss.logging.Logger logger
protected javax.persistence.EntityManager em
public JpaRealmProvider(KeycloakSession session, javax.persistence.EntityManager em)
public MigrationModel getMigrationModel()
getMigrationModel
in interface RealmProvider
public RealmModel createRealm(String name)
createRealm
in interface RealmProvider
public RealmModel createRealm(String id, String name)
createRealm
in interface RealmProvider
public RealmModel getRealm(String id)
getRealm
in interface RealmProvider
public List<RealmModel> getRealmsWithProviderType(Class<?> providerType)
getRealmsWithProviderType
in interface RealmProvider
public List<RealmModel> getRealms()
getRealms
in interface RealmProvider
public RealmModel getRealmByName(String name)
getRealmByName
in interface RealmProvider
public boolean removeRealm(String id)
removeRealm
in interface RealmProvider
public RoleModel addRealmRole(RealmModel realm, String name)
addRealmRole
in interface RealmProvider
public RoleModel addRealmRole(RealmModel realm, String id, String name)
addRealmRole
in interface RealmProvider
public RoleModel getRealmRole(RealmModel realm, String name)
getRealmRole
in interface RealmProvider
public RoleModel addClientRole(RealmModel realm, ClientModel client, String name)
RealmProvider
??RoleProvider
.addClientRole
in interface RealmProvider
public RoleModel addClientRole(RealmModel realm, ClientModel client, String id, String name)
RealmProvider
??RoleProvider
.addClientRole
in interface RealmProvider
public Set<RoleModel> getRealmRoles(RealmModel realm)
getRealmRoles
in interface RealmProvider
public RoleModel getClientRole(RealmModel realm, ClientModel client, String name)
RealmProvider
??RoleProvider
.getClientRole
in interface RealmProvider
public Set<RoleModel> getClientRoles(RealmModel realm, ClientModel client)
RealmProvider
??RoleProvider
.getClientRoles
in interface RealmProvider
public Set<RoleModel> getRealmRoles(RealmModel realm, Integer first, Integer max)
getRealmRoles
in interface RealmProvider
public Set<RoleModel> getClientRoles(RealmModel realm, ClientModel client, Integer first, Integer max)
getClientRoles
in interface RealmProvider
protected Set<RoleModel> getRoles(javax.persistence.TypedQuery<RoleEntity> query, RealmModel realm, Integer first, Integer max)
public Set<RoleModel> searchForClientRoles(RealmModel realm, ClientModel client, String search, Integer first, Integer max)
searchForClientRoles
in interface RealmProvider
public Set<RoleModel> searchForRoles(RealmModel realm, String search, Integer first, Integer max)
searchForRoles
in interface RealmProvider
protected Set<RoleModel> searchForRoles(javax.persistence.TypedQuery<RoleEntity> query, RealmModel realm, String search, Integer first, Integer max)
public boolean removeRole(RealmModel realm, RoleModel role)
removeRole
in interface RealmProvider
public RoleModel getRoleById(String id, RealmModel realm)
getRoleById
in interface RealmProvider
public GroupModel getGroupById(String id, RealmModel realm)
getGroupById
in interface RealmProvider
public void moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
moveGroup
in interface RealmProvider
public List<GroupModel> getGroups(RealmModel realm)
getGroups
in interface RealmProvider
public Long getGroupsCount(RealmModel realm, Boolean onlyTopGroups)
getGroupsCount
in interface RealmProvider
public long getClientsCount(RealmModel realm)
ClientProvider
getClientsCount
in interface ClientProvider
getClientsCount
in interface RealmProvider
realm
- Realm.public Long getGroupsCountByNameContaining(RealmModel realm, String search)
getGroupsCountByNameContaining
in interface RealmProvider
public List<GroupModel> getGroupsByRole(RealmModel realm, RoleModel role, int firstResult, int maxResults)
getGroupsByRole
in interface RealmProvider
public List<GroupModel> getTopLevelGroups(RealmModel realm)
getTopLevelGroups
in interface RealmProvider
public List<GroupModel> getTopLevelGroups(RealmModel realm, Integer first, Integer max)
getTopLevelGroups
in interface RealmProvider
public boolean removeGroup(RealmModel realm, GroupModel group)
removeGroup
in interface RealmProvider
public GroupModel createGroup(RealmModel realm, String id, String name, GroupModel toParent)
createGroup
in interface RealmProvider
public void addTopLevelGroup(RealmModel realm, GroupModel subGroup)
addTopLevelGroup
in interface RealmProvider
public ClientModel addClient(RealmModel realm, String clientId)
ClientProvider
clientId
to the given realm.
The internal ID of the client will be created automatically.addClient
in interface ClientProvider
addClient
in interface RealmProvider
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.public ClientModel addClient(RealmModel realm, String id, String clientId)
ClientProvider
clientId
to the given realm.addClient
in interface ClientProvider
addClient
in interface RealmProvider
realm
- Realm owning this client.id
- Internal ID of the client or null
if one is to be created by the underlying storeclientId
- String that identifies the client to the external parties.
Maps to client_id
in OIDC or entityID
in SAML.public List<ClientModel> getClients(RealmModel realm, Integer firstResult, Integer maxResults)
ClientProvider
getClients
in interface ClientProvider
getClients
in interface RealmProvider
realm
- Realm.firstResult
- First result to return. Ignored if negative or null
.maxResults
- Maximim number of results to return. Ignored if negative or null
.null
.public List<ClientModel> getAlwaysDisplayInConsoleClients(RealmModel realm)
ClientProvider
getAlwaysDisplayInConsoleClients
in interface ClientProvider
getAlwaysDisplayInConsoleClients
in interface RealmProvider
realm
- Realm owning the clients.null
.public ClientModel getClientById(RealmModel realm, String id)
ClientLookupProvider
getClientById
in interface RealmProvider
getClientById
in interface ClientLookupProvider
realm
- Realm to limit the search.id
- Internal IDnull
if no client is found.public ClientModel getClientByClientId(RealmModel realm, String clientId)
ClientLookupProvider
getClientByClientId
in interface RealmProvider
getClientByClientId
in interface ClientLookupProvider
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.null
if no client is found.public List<ClientModel> searchClientsByClientId(RealmModel realm, String clientId, Integer firstResult, Integer maxResults)
ClientLookupProvider
searchClientsByClientId
in interface RealmProvider
searchClientsByClientId
in interface ClientLookupProvider
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
.null
if no client is found.public void removeClients(RealmModel realm)
ClientProvider
removeClients
in interface ClientProvider
realm
- Realm.public boolean removeClient(RealmModel realm, String id)
ClientProvider
removeClient
in interface ClientProvider
removeClient
in interface RealmProvider
realm
- Realm.id
- Internal ID of the clienttrue
if the client existed and has been removed, false
otherwise.public ClientScopeModel getClientScopeById(String id, RealmModel realm)
getClientScopeById
in interface RealmProvider
public List<GroupModel> searchForGroupByName(RealmModel realm, String search, Integer first, Integer max)
searchForGroupByName
in interface RealmProvider
public ClientInitialAccessModel createClientInitialAccessModel(RealmModel realm, int expiration, int count)
createClientInitialAccessModel
in interface RealmProvider
public ClientInitialAccessModel getClientInitialAccessModel(RealmModel realm, String id)
getClientInitialAccessModel
in interface RealmProvider
public void removeClientInitialAccessModel(RealmModel realm, String id)
removeClientInitialAccessModel
in interface RealmProvider
public List<ClientInitialAccessModel> listClientInitialAccess(RealmModel realm)
listClientInitialAccess
in interface RealmProvider
public void removeExpiredClientInitialAccess()
removeExpiredClientInitialAccess
in interface RealmProvider
public void decreaseRemainingCount(RealmModel realm, ClientInitialAccessModel clientInitialAccess)
decreaseRemainingCount
in interface RealmProvider
Copyright © 2020 JBoss by Red Hat. All rights reserved.