public class MapRealmProvider extends Object implements RealmProvider
| Constructor and Description |
|---|
MapRealmProvider(KeycloakSession session,
MapStorage<MapRealmEntity,RealmModel> realmStore) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddClient, addClientRole, addClientRole, addRealmRole, createClientInitialAccessModel, createGroup, createGroup, createGroup, decreaseRemainingCount, getAlwaysDisplayInConsoleClients, getClientByClientId, getClientById, getClientInitialAccessModel, getClientRole, getClientRoles, getClientRoles, getClients, getClients, getClientScopeById, getGroupById, getGroups, getGroupsByRole, getRealmRoles, getRealmRoles, getRealms, getRealmsWithProviderType, getRoleById, getTopLevelGroups, getTopLevelGroups, listClientInitialAccess, listClientInitialAccessStream, removeClient, removeClientInitialAccessModel, removeRole, searchClientsByClientId, searchForClientRoles, searchForGroupByName, searchForRolesgetClientsStreamaddClientScopegetGroupsCount, getGroupsStream, getGroupsStreamaddClientRole, getClientRolesStream, getRealmRolesStreampublic MapRealmProvider(KeycloakSession session, MapStorage<MapRealmEntity,RealmModel> realmStore)
public RealmModel createRealm(String name)
RealmProvidercreateRealm in interface RealmProvidername - String name of the realmpublic RealmModel createRealm(String id, String name)
RealmProvidercreateRealm in interface RealmProviderid - Internal ID of the realm or null if one is to be created by the underlying storename - String name of the realmpublic RealmModel getRealm(String id)
RealmProvidergetRealm in interface RealmProviderid - Internal ID of the realm.public RealmModel getRealmByName(String name)
RealmProvidergetRealmByName in interface RealmProvidername - String name of the realmpublic Stream<RealmModel> getRealmsStream()
RealmProvidergetRealmsStream in interface RealmProviderRealmModel. Never returns null.public Stream<RealmModel> getRealmsWithProviderTypeStream(Class<?> type)
RealmProvidergetRealmsWithProviderTypeStream in interface RealmProvidertype - Class<?> Type of the provider.RealmModel. Never returns null.public boolean removeRealm(String id)
RealmProviderremoveRealm in interface RealmProviderid - of realm.true if the realm was successfully removed.public void removeExpiredClientInitialAccess()
RealmProviderremoveExpiredClientInitialAccess in interface RealmProviderpublic void saveLocalizationText(RealmModel realm, String locale, String key, String text)
saveLocalizationText in interface RealmProviderpublic void saveLocalizationTexts(RealmModel realm, String locale, Map<String,String> localizationTexts)
saveLocalizationTexts in interface RealmProviderpublic boolean updateLocalizationText(RealmModel realm, String locale, String key, String text)
updateLocalizationText in interface RealmProviderpublic boolean deleteLocalizationTextsByLocale(RealmModel realm, String locale)
deleteLocalizationTextsByLocale in interface RealmProviderpublic boolean deleteLocalizationText(RealmModel realm, String locale, String key)
deleteLocalizationText in interface RealmProviderpublic String getLocalizationTextsById(RealmModel realm, String locale, String key)
getLocalizationTextsById in interface RealmProvider@Deprecated public ClientModel addClient(RealmModel realm, String id, String clientId)
ClientProviderclientId to the given realm.addClient in interface ClientProvideraddClient in interface RealmProviderrealm - 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.@Deprecated public long getClientsCount(RealmModel realm)
ClientProvidergetClientsCount in interface ClientProvidergetClientsCount in interface RealmProviderrealm - Realm.@Deprecated public Stream<ClientModel> getClientsStream(RealmModel realm, Integer firstResult, Integer maxResults)
ClientProvidergetClientsStream in interface ClientProviderrealm - Realm.firstResult - First result to return. Ignored if negative or null.maxResults - Maximum number of results to return. Ignored if negative or null.null.@Deprecated public Stream<ClientModel> getAlwaysDisplayInConsoleClientsStream(RealmModel realm)
ClientProvidergetAlwaysDisplayInConsoleClientsStream in interface ClientProviderrealm - Realm owning the clients.null.@Deprecated public boolean removeClient(RealmModel realm, String id)
ClientProviderremoveClient in interface ClientProviderrealm - Realm.id - Internal ID of the clienttrue if the client existed and has been removed, false otherwise.@Deprecated public void removeClients(RealmModel realm)
ClientProviderremoveClients in interface ClientProviderrealm - Realm.@Deprecated public ClientModel getClientById(RealmModel realm, String id)
ClientLookupProvidergetClientById in interface ClientLookupProviderrealm - Realm to limit the search.id - Internal IDnull if no client is found.@Deprecated public ClientModel getClientByClientId(RealmModel realm, String clientId)
ClientLookupProvidergetClientByClientId in interface ClientLookupProviderrealm - 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.@Deprecated public Stream<ClientModel> searchClientsByClientIdStream(RealmModel realm, String clientId, Integer firstResult, Integer maxResults)
ClientLookupProvidersearchClientsByClientIdStream in interface ClientLookupProviderrealm - 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 - Maximum number of results to return. Ignored if negative or null.null.@Deprecated public Stream<ClientModel> searchClientsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
searchClientsByAttributes in interface ClientLookupProvider@Deprecated public void addClientScopes(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope)
ClientProvideraddClientScopes in interface ClientProviderrealm - Realm.client - Client.clientScopes - to be assigneddefaultScope - if true the scopes are assigned as default, or optional in case of false@Deprecated public void removeClientScope(RealmModel realm, ClientModel client, ClientScopeModel clientScope)
ClientProviderremoveClientScope in interface ClientProviderrealm - Realm.client - Client.clientScope - to be unassigned@Deprecated public Map<String,ClientScopeModel> getClientScopes(RealmModel realm, ClientModel client, boolean defaultScopes)
ClientLookupProviderdefaultScope is true) or all optional scopes (if defaultScope is false) linked with the clientgetClientScopes in interface ClientLookupProviderrealm - Realmclient - ClientdefaultScopes - if true default scopes, if false optional scopes, are returned@Deprecated public ClientScopeModel getClientScopeById(RealmModel realm, String id)
ClientScopeLookupProvidergetClientScopeById in interface RealmProvidergetClientScopeById in interface ClientScopeLookupProviderrealm - Realm.id - Internal ID of the role.@Deprecated public Stream<ClientScopeModel> getClientScopesStream(RealmModel realm)
ClientScopeProvidergetClientScopesStream in interface ClientScopeProviderrealm - Realm.null.@Deprecated public ClientScopeModel addClientScope(RealmModel realm, String id, String name)
ClientScopeProvidername to the given realm.
Spaces in name will be replaced by underscore so that scope name
can be used as value of scope parameter.addClientScope in interface ClientScopeProviderrealm - Realm owning this client scope.id - Internal ID of the client scope or null if one is to be created by the underlying storename - String name of the client scope.@Deprecated public boolean removeClientScope(RealmModel realm, String id)
ClientScopeProviderremoveClientScope in interface ClientScopeProviderrealm - Realm.id - Internal ID of the client scopetrue if the client scope existed and has been removed, false otherwise.@Deprecated public void removeClientScopes(RealmModel realm)
ClientScopeProviderremoveClientScopes in interface ClientScopeProviderrealm - Realm.@Deprecated public Map<ClientModel,Set<String>> getAllRedirectUrisOfEnabledClients(RealmModel realm)
ClientProvidergetAllRedirectUrisOfEnabledClients in interface ClientProvider@Deprecated public void moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
GroupProvidermoveGroup in interface GroupProvidermoveGroup in interface RealmProviderrealm - Realm owning this group.group - Group to update.toParent - New parent group, or null if we are moving the group to top level group.@Deprecated public GroupModel getGroupById(RealmModel realm, String id)
GroupLookupProvidergetGroupById in interface RealmProvidergetGroupById in interface GroupLookupProviderrealm - Realm.id - Id.@Deprecated public Long getGroupsCount(RealmModel realm, Boolean onlyTopGroups)
GroupProvidergetGroupsCount in interface GroupProvidergetGroupsCount in interface RealmProviderrealm - Realm.onlyTopGroups - When true the function returns a count of top level groups only.@Deprecated public Long getGroupsCountByNameContaining(RealmModel realm, String search)
GroupProvidergetGroupsCountByNameContaining in interface GroupProvidergetGroupsCountByNameContaining in interface RealmProviderrealm - Realm.search - Case insensitive string which will be searched for.@Deprecated public boolean removeGroup(RealmModel realm, GroupModel group)
GroupProviderremoveGroup in interface GroupProviderremoveGroup in interface RealmProviderrealm - Realm.group - Group.@Deprecated public GroupModel createGroup(RealmModel realm, String id, String name, GroupModel toParent)
GroupProvidercreateGroup in interface GroupProvidercreateGroup in interface RealmProviderrealm - Realm.id - Id, will be generated if null.name - Name.toParent - Parent group, or null if the group is top level group@Deprecated public void addTopLevelGroup(RealmModel realm, GroupModel subGroup)
GroupProvideraddTopLevelGroup in interface GroupProvideraddTopLevelGroup in interface RealmProviderrealm - Realm.subGroup - Group.@Deprecated public Stream<GroupModel> getGroupsStream(RealmModel realm)
GroupProvidergetGroupsStream in interface GroupProviderrealm - Realm.@Deprecated public Stream<GroupModel> getGroupsStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
GroupProvidergetGroupsStream in interface GroupProviderrealm - Realm.ids - Stream of ids.search - Case insensitive string which will be searched for. Ignored if null.first - Index of the first result to return. Ignored if negative or null.max - Maximum number of results to return. Ignored if negative or null.null.@Deprecated public Stream<GroupModel> getGroupsByRoleStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
GroupProvidergetGroupsByRoleStream in interface GroupProviderrealm - Realm.role - Role.firstResult - First result to return. Ignored if negative or null.maxResults - Maximum number of results to return. Ignored if negative or null.null.@Deprecated public Stream<GroupModel> getTopLevelGroupsStream(RealmModel realm)
GroupProvidergetTopLevelGroupsStream in interface GroupProviderrealm - Realm.null.@Deprecated public Stream<GroupModel> getTopLevelGroupsStream(RealmModel realm, Integer firstResult, Integer maxResults)
GroupProvidergetTopLevelGroupsStream in interface GroupProviderrealm - Realm.firstResult - First result to return. Ignored if negative or null.maxResults - Maximum number of results to return. Ignored if negative or null.null.@Deprecated public Stream<GroupModel> searchForGroupByNameStream(RealmModel realm, String search, Integer firstResult, Integer maxResults)
GroupLookupProvidersearchForGroupByNameStream in interface GroupLookupProviderrealm - Realm.search - Case sensitive searched string.firstResult - First result to return. Ignored if negative or null.maxResults - Maximum number of results to return. Ignored if negative or null.null.@Deprecated public RoleModel addRealmRole(RealmModel realm, String id, String name)
RoleProvidername to the given realm.addRealmRole in interface RealmProvideraddRealmRole in interface RoleProviderrealm - Realm owning this role.id - Internal ID of the role or null if one is to be created by the underlying storename - String name of the role.@Deprecated public RoleModel getRealmRole(RealmModel realm, String name)
RoleLookupProvidergetRealmRole in interface RealmProvidergetRealmRole in interface RoleLookupProviderrealm - Realm.name - String name of the role.null if no role is found.@Deprecated public Stream<RoleModel> getRealmRolesStream(RealmModel realm, Integer first, Integer max)
RoleProvidergetRealmRolesStream in interface RoleProviderrealm - Realm.first - First result to return. Ignored if negative or null.max - Maximum number of results to return. Ignored if negative or null.null.@Deprecated public boolean removeRole(RoleModel role)
RoleProviderremoveRole in interface RoleProviderrole - Role to be removed.true if the role existed and has been removed, false otherwise.@Deprecated public void removeRoles(RealmModel realm)
RoleProviderremoveRoles in interface RoleProviderrealm - Realm.@Deprecated public RoleModel addClientRole(ClientModel client, String id, String name)
RoleProvidername to the given client.addClientRole in interface RoleProviderclient - Client owning this role.id - Internal ID of the client role or null if one is to be created by the underlying store.name - String name of the role.@Deprecated public Stream<RoleModel> getClientRolesStream(ClientModel client, Integer first, Integer max)
RoleProvidergetClientRolesStream in interface RoleProviderclient - Client.first - First result to return. Ignored if negative or null.max - Maximum number of results to return. Ignored if negative or null.null.@Deprecated public void removeRoles(ClientModel client)
RoleProviderremoveRoles in interface RoleProviderclient - Client.@Deprecated public RoleModel getRoleById(RealmModel realm, String id)
RoleLookupProvidergetRoleById in interface RoleLookupProviderrealm - Realm.id - Internal ID of the role.@Deprecated public Stream<RoleModel> searchForRolesStream(RealmModel realm, String search, Integer first, Integer max)
RoleLookupProvidersearchForRolesStream in interface RoleLookupProviderrealm - Realm.search - Searched substring of the role's name or description.first - First result to return. Ignored if negative or null.max - Maximum number of results to return. Ignored if negative or null.null.@Deprecated public RoleModel getClientRole(ClientModel client, String name)
RoleLookupProvidergetClientRole in interface RoleLookupProviderclient - Client.name - String name of the role.null if no role is found.@Deprecated public Stream<RoleModel> searchForClientRolesStream(ClientModel client, String search, Integer first, Integer max)
RoleLookupProvidersearchForClientRolesStream in interface RoleLookupProviderclient - Client.search - String to search by role's name or description.first - First result to return. Ignored if negative or null.max - Maximum number of results to return. Ignored if negative or null.null.Copyright © 2021 JBoss by Red Hat. All rights reserved.