org.keycloak.models

Interface RealmProvider

All Superinterfaces:

ClientLookupProvider, ClientProvider, Provider

All Known Subinterfaces:

CacheRealmProvider

All Known Implementing Classes:

JpaRealmProvider, RealmCacheSession

public interface RealmProvider
extends Provider, ClientProvider

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method and Description
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)
default GroupModel	createGroup(RealmModel realm, String name)
default GroupModel	createGroup(RealmModel realm, String name, GroupModel toParent)
default GroupModel	createGroup(RealmModel realm, String id, String name)
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)
ClientInitialAccessModel	getClientInitialAccessModel(RealmModel realm, String id)
Set<RoleModel>	getClientRoles(RealmModel realm, ClientModel client, Integer first, Integer max)
ClientScopeModel	getClientScopeById(String id, RealmModel realm)
Long	getClientsCount(RealmModel 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<?> type)
RoleModel	getRoleById(String id, RealmModel realm)
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)
void	removeClientInitialAccessModel(RealmModel realm, String id)
void	removeExpiredClientInitialAccess()
boolean	removeGroup(RealmModel realm, GroupModel group)
boolean	removeRealm(String id)
boolean	removeRole(RealmModel realm, RoleModel role)
Set<RoleModel>	searchForClientRoles(RealmModel realm, ClientModel client, String search, Integer first, Integer max)
List	searchForGroupByName(RealmModel realm, String search, Integer first, Integer max)
Set<RoleModel>	searchForRoles(RealmModel realm, String search, Integer first, Integer max)

Methods inherited from interface org.keycloak.models.ClientProvider

addClient, addClient, addClientRole, addClientRole, getAlwaysDisplayInConsoleClients, getClientRole, getClientRoles, getClients, getClients, removeClient

Methods inherited from interface org.keycloak.storage.client.ClientLookupProvider

getClientByClientId, getClientById, searchClientsByClientId

Method Detail

getMigrationModel

MigrationModel getMigrationModel()

createRealm

RealmModel createRealm(String name)

createRealm

RealmModel createRealm(String id,
                       String name)

getRealm

RealmModel getRealm(String id)

getRealmByName

RealmModel getRealmByName(String name)

moveGroup

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

getGroups

List<GroupModel> getGroups(RealmModel realm)

getGroupsCount

Long getGroupsCount(RealmModel realm,
                    Boolean onlyTopGroups)

getClientsCount

Long getClientsCount(RealmModel realm)

getGroupsCountByNameContaining

Long getGroupsCountByNameContaining(RealmModel realm,
                                    String search)

getGroupsByRole

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

getTopLevelGroups

List<GroupModel> getTopLevelGroups(RealmModel realm)

getTopLevelGroups

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

searchForGroupByName

List searchForGroupByName(RealmModel realm,
                          String search,
                          Integer first,
                          Integer max)

removeGroup

boolean removeGroup(RealmModel realm,
                    GroupModel group)

createGroup

default GroupModel createGroup(RealmModel realm,
                               String name)

createGroup

default GroupModel createGroup(RealmModel realm,
                               String id,
                               String name)

createGroup

default GroupModel createGroup(RealmModel realm,
                               String name,
                               GroupModel toParent)

createGroup

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

addTopLevelGroup

void addTopLevelGroup(RealmModel realm,
                      GroupModel subGroup)

addRealmRole

RoleModel addRealmRole(RealmModel realm,
                       String name)

addRealmRole

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

getRealmRole

RoleModel getRealmRole(RealmModel realm,
                       String name)

getRealmRoles

Set<RoleModel> getRealmRoles(RealmModel realm)

getRealmRoles

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

getClientRoles

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

searchForClientRoles

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

searchForRoles

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

removeRole

boolean removeRole(RealmModel realm,
                   RoleModel role)

getRoleById

RoleModel getRoleById(String id,
                      RealmModel realm)

getClientScopeById

ClientScopeModel getClientScopeById(String id,
                                    RealmModel realm)

getGroupById

GroupModel getGroupById(String id,
                        RealmModel realm)

getRealms

List<RealmModel> getRealms()

getRealmsWithProviderType

List<RealmModel> getRealmsWithProviderType(Class<?> type)

removeRealm

boolean removeRealm(String id)

close

void close()

Specified by:

close in interface Provider

createClientInitialAccessModel

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

getClientInitialAccessModel

ClientInitialAccessModel getClientInitialAccessModel(RealmModel realm,
                                                     String id)

removeClientInitialAccessModel

void removeClientInitialAccessModel(RealmModel realm,
                                    String id)

listClientInitialAccess

List<ClientInitialAccessModel> listClientInitialAccess(RealmModel realm)

removeExpiredClientInitialAccess

void removeExpiredClientInitialAccess()

decreaseRemainingCount

void decreaseRemainingCount(RealmModel realm,
                            ClientInitialAccessModel clientInitialAccess)