org.keycloak.models

Interface RealmProvider

All Superinterfaces:

ClientLookupProvider, ClientProvider, Provider

public interface RealmProvider
extends Provider, ClientProvider

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method and Description
default ClientModel	addClient(RealmModel realm, String clientId) Deprecated. Use the corresponding method from ClientProvider.
ClientModel	addClient(RealmModel realm, String id, String clientId) Deprecated. Use the corresponding method from ClientProvider.
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)
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)
List<ClientModel>	getAlwaysDisplayInConsoleClients(RealmModel realm) Deprecated. Use the corresponding method from ClientProvider.
ClientModel	getClientByClientId(RealmModel realm, String clientId) Deprecated. Use the corresponding method from ClientProvider.
default ClientModel	getClientByClientId(String clientId, RealmModel realm) Deprecated. Use the corresponding method from ClientProvider.
ClientModel	getClientById(RealmModel realm, String id) Deprecated. Use the corresponding method from ClientProvider.
default ClientModel	getClientById(String id, RealmModel realm) Deprecated. Use the corresponding method from ClientProvider.
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)
default List<ClientModel>	getClients(RealmModel realm) Deprecated. Use the corresponding method from ClientProvider.
List<ClientModel>	getClients(RealmModel realm, Integer firstResult, Integer maxResults) Deprecated. Use the corresponding method from ClientProvider.
ClientScopeModel	getClientScopeById(String id, RealmModel realm)
long	getClientsCount(RealmModel realm) Deprecated. Use the corresponding method from ClientProvider.
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)
boolean	removeClient(RealmModel realm, String id) Deprecated. Use the corresponding method from ClientProvider.
default boolean	removeClient(String id, RealmModel realm) Deprecated. Use the corresponding method from ClientProvider.
void	removeClientInitialAccessModel(RealmModel realm, String id)
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) Deprecated. Use the corresponding method from ClientProvider.
default List<ClientModel>	searchClientsByClientId(String clientId, Integer firstResult, Integer maxResults, RealmModel realm) Deprecated. Use the corresponding method from ClientProvider.
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

removeClients

Methods inherited from interface org.keycloak.provider.Provider

close

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)

Deprecated. Use the corresponding method from ClientProvider.

Description copied from interface: ClientProvider

Returns number of clients in the given realm

Specified by:

getClientsCount in interface ClientProvider

Parameters:

realm - Realm.

Returns:

Number of the clients in the given 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)

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)

getClientRoles

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

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

getClientRole

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

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

addClientRole

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

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

addClientRole

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

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

addClient

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

Deprecated. Use the corresponding method from ClientProvider.

Description copied from interface: ClientProvider

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

Specified by:

addClient in interface ClientProvider

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.

addClient

default ClientModel addClient(RealmModel realm,
                              String clientId)

Deprecated. Use the corresponding method from ClientProvider.

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

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.

getClients

default List<ClientModel> getClients(RealmModel realm)

Deprecated. Use the corresponding method from ClientProvider.

Description copied from interface: ClientProvider

Returns all the clients of the given realm. Effectively the same as the call getClients(realm, null, null).

Specified by:

getClients in interface ClientProvider

Parameters:

realm - Realm.

Returns:

List of the clients. Never returns null.

getClients

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

Deprecated. Use the corresponding method from ClientProvider.

Description copied from interface: ClientProvider

Returns the clients of the given realm.

Specified by:

getClients in interface ClientProvider

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.

searchClientsByClientId

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

Deprecated. Use the corresponding method from ClientProvider.

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 ClientLookupProvider

Parameters:

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.

realm - Realm to limit the search for clients.

Returns:

Models of the matching clients. Never returns null.

getClientByClientId

default ClientModel getClientByClientId(String clientId,
                                        RealmModel realm)

Deprecated. Use the corresponding method from ClientProvider.

Description copied from interface: ClientLookupProvider

Exact search for a client by its public client identifier.

Specified by:

getClientByClientId in interface ClientLookupProvider

Parameters:

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

realm - Realm to limit the search.

Returns:

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

getClientById

default ClientModel getClientById(String id,
                                  RealmModel realm)

Deprecated. Use the corresponding method from ClientProvider.

Description copied from interface: ClientLookupProvider

Exact search for a client by its internal ID.

Specified by:

getClientById in interface ClientLookupProvider

Parameters:

id - Internal ID

realm - Realm to limit the search.

Returns:

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

searchClientsByClientId

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

Deprecated. Use the corresponding method from ClientProvider.

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

getClientByClientId

ClientModel getClientByClientId(RealmModel realm,
                                String clientId)

Deprecated. Use the corresponding method from ClientProvider.

Description copied from interface: ClientLookupProvider

Exact search for a client by its public client identifier.

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.

getClientById

ClientModel getClientById(RealmModel realm,
                          String id)

Deprecated. Use the corresponding method from ClientProvider.

Description copied from interface: ClientLookupProvider

Exact search for a client by its internal ID.

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.

removeClient

boolean removeClient(RealmModel realm,
                     String id)

Deprecated. Use the corresponding method from ClientProvider.

Description copied from interface: ClientProvider

Removes given client from the given realm.

Specified by:

removeClient in interface ClientProvider

Parameters:

realm - Realm.

id - Internal ID of the client

Returns:

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

removeClient

default boolean removeClient(String id,
                             RealmModel realm)

Deprecated. Use the corresponding method from ClientProvider.

Description copied from interface: ClientProvider

Removes given client from the given realm.

Specified by:

removeClient in interface ClientProvider

Parameters:

id - Internal ID of the client

realm - Realm.

Returns:

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

getAlwaysDisplayInConsoleClients

List<ClientModel> getAlwaysDisplayInConsoleClients(RealmModel realm)

Deprecated. Use the corresponding method from ClientProvider.

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

Parameters:

realm - Realm owning the clients.

Returns:

List of the clients. Never returns null.