public interface RealmProvider extends Provider, ClientProvider, ClientScopeProvider, GroupProvider, RoleProvider
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 . |
default RoleModel |
addClientRole(RealmModel realm,
ClientModel client,
String name)
Deprecated.
Use the corresponding method from
RoleProvider . |
default RoleModel |
addClientRole(RealmModel realm,
ClientModel client,
String id,
String name)
Deprecated.
Use the corresponding method from
RoleProvider . |
default RoleModel |
addRealmRole(RealmModel realm,
String name)
Deprecated.
Use the corresponding method from
RoleProvider . |
RoleModel |
addRealmRole(RealmModel realm,
String id,
String name)
Deprecated.
Use the corresponding method from
RoleProvider . |
void |
addTopLevelGroup(RealmModel realm,
GroupModel subGroup)
Deprecated.
Use the corresponding method from
GroupProvider . |
default ClientInitialAccessModel |
createClientInitialAccessModel(RealmModel realm,
int expiration,
int count) |
default GroupModel |
createGroup(RealmModel realm,
String name)
Deprecated.
Use the corresponding method from
GroupProvider . |
default GroupModel |
createGroup(RealmModel realm,
String name,
GroupModel toParent)
Deprecated.
Use the corresponding method from
GroupProvider . |
default GroupModel |
createGroup(RealmModel realm,
String id,
String name)
Deprecated.
Use the corresponding method from
GroupProvider . |
GroupModel |
createGroup(RealmModel realm,
String id,
String name,
GroupModel toParent)
Deprecated.
Use the corresponding method from
GroupProvider . |
RealmModel |
createRealm(String name)
Creates new realm with the given name.
|
RealmModel |
createRealm(String id,
String name)
Created new realm with given ID and name.
|
default void |
decreaseRemainingCount(RealmModel realm,
ClientInitialAccessModel clientInitialAccess) |
boolean |
deleteLocalizationText(RealmModel realm,
String locale,
String key) |
boolean |
deleteLocalizationTextsByLocale(RealmModel realm,
String locale) |
default List<ClientModel> |
getAlwaysDisplayInConsoleClients(RealmModel realm)
Deprecated.
Use the corresponding method from
ClientProvider . |
default ClientModel |
getClientByClientId(String clientId,
RealmModel realm)
Deprecated.
Use the corresponding method from
ClientProvider . |
default ClientModel |
getClientById(String id,
RealmModel realm)
Deprecated.
Use the corresponding method from
ClientProvider . |
default ClientInitialAccessModel |
getClientInitialAccessModel(RealmModel realm,
String id) |
default RoleModel |
getClientRole(RealmModel realm,
ClientModel client,
String name)
Deprecated.
Use the corresponding method from
RoleProvider . |
default Set<RoleModel> |
getClientRoles(RealmModel realm,
ClientModel client)
Deprecated.
Use the corresponding method from
RoleProvider . |
default Set<RoleModel> |
getClientRoles(RealmModel realm,
ClientModel client,
Integer first,
Integer max)
Deprecated.
Use the corresponding method from
RoleProvider . |
default List<ClientModel> |
getClients(RealmModel realm)
Deprecated.
Use the corresponding method from
ClientProvider . |
default List<ClientModel> |
getClients(RealmModel realm,
Integer firstResult,
Integer maxResults)
Deprecated.
Use the corresponding method from
ClientProvider . |
ClientScopeModel |
getClientScopeById(RealmModel realm,
String id)
Deprecated.
Use the corresponding method from
ClientScopeProvider . |
default ClientScopeModel |
getClientScopeById(String id,
RealmModel realm)
Deprecated.
Use the corresponding method from
ClientScopeProvider . |
long |
getClientsCount(RealmModel realm)
Deprecated.
Use the corresponding method from
ClientProvider . |
GroupModel |
getGroupById(RealmModel realm,
String id)
Deprecated.
Use the corresponding method from
GroupProvider . |
default GroupModel |
getGroupById(String id,
RealmModel realm)
Deprecated.
Use the corresponding method from
GroupProvider . |
default List<GroupModel> |
getGroups(RealmModel realm)
Deprecated.
Use the corresponding method from
GroupProvider . |
default List<GroupModel> |
getGroupsByRole(RealmModel realm,
RoleModel role,
int firstResult,
int maxResults)
Deprecated.
Use the corresponding method from
GroupProvider . |
Long |
getGroupsCount(RealmModel realm,
Boolean onlyTopGroups)
Deprecated.
Use the corresponding method from
GroupProvider . |
Long |
getGroupsCountByNameContaining(RealmModel realm,
String search)
Deprecated.
Use the corresponding method from
GroupProvider . |
String |
getLocalizationTextsById(RealmModel realm,
String locale,
String key) |
RealmModel |
getRealm(String id)
Exact search for a realm by its internal ID.
|
RealmModel |
getRealmByName(String name)
Exact search for a realm by its name.
|
RoleModel |
getRealmRole(RealmModel realm,
String name)
Deprecated.
Use the corresponding method from
RoleProvider . |
default Set<RoleModel> |
getRealmRoles(RealmModel realm)
Deprecated.
Use the corresponding method from
RoleProvider . |
default Set<RoleModel> |
getRealmRoles(RealmModel realm,
Integer first,
Integer max)
Deprecated.
Use the corresponding method from
RoleProvider . |
default List<RealmModel> |
getRealms()
Deprecated.
Use
getRealmsStream instead. |
Stream<RealmModel> |
getRealmsStream()
Returns realms as a stream.
|
default List<RealmModel> |
getRealmsWithProviderType(Class<?> type)
Deprecated.
Use
getRealmsWithProviderTypeStream instead. |
Stream<RealmModel> |
getRealmsWithProviderTypeStream(Class<?> type)
Returns stream of realms which has component with the given provider type.
|
default RoleModel |
getRoleById(String id,
RealmModel realm)
Deprecated.
Use the corresponding method from
RoleProvider . |
default List<GroupModel> |
getTopLevelGroups(RealmModel realm)
Deprecated.
Use the corresponding method from
GroupProvider . |
default List<GroupModel> |
getTopLevelGroups(RealmModel realm,
Integer first,
Integer max)
Deprecated.
Use the corresponding method from
GroupProvider . |
default List<ClientInitialAccessModel> |
listClientInitialAccess(RealmModel realm)
Deprecated.
Use
listClientInitialAccessStream instead. |
default Stream<ClientInitialAccessModel> |
listClientInitialAccessStream(RealmModel realm)
Returns client's initial access as a stream.
|
void |
moveGroup(RealmModel realm,
GroupModel group,
GroupModel toParent)
Deprecated.
Use the corresponding method from
GroupProvider . |
default boolean |
removeClient(String id,
RealmModel realm)
Deprecated.
Use the corresponding method from
ClientProvider . |
default void |
removeClientInitialAccessModel(RealmModel realm,
String id) |
void |
removeExpiredClientInitialAccess()
Removes all expired client initial accesses from all realms.
|
boolean |
removeGroup(RealmModel realm,
GroupModel group)
Deprecated.
Use the corresponding method from
GroupProvider . |
boolean |
removeRealm(String id)
Removes realm with the given id.
|
default boolean |
removeRole(RealmModel realm,
RoleModel role)
Deprecated.
Use the corresponding method from
RoleProvider . |
void |
saveLocalizationText(RealmModel realm,
String locale,
String key,
String text) |
void |
saveLocalizationTexts(RealmModel realm,
String locale,
Map<String,String> localizationTexts) |
default List<ClientModel> |
searchClientsByClientId(String clientId,
Integer firstResult,
Integer maxResults,
RealmModel realm)
Deprecated.
Use the corresponding method from
ClientProvider . |
default Set<RoleModel> |
searchForClientRoles(RealmModel realm,
ClientModel client,
String search,
Integer first,
Integer max)
Deprecated.
Use the corresponding method from
RoleProvider . |
default List<GroupModel> |
searchForGroupByName(RealmModel realm,
String search,
Integer first,
Integer max)
Deprecated.
Use the corresponding method from
GroupProvider . |
default Set<RoleModel> |
searchForRoles(RealmModel realm,
String search,
Integer first,
Integer max)
Deprecated.
Use the corresponding method from
RoleProvider . |
boolean |
updateLocalizationText(RealmModel realm,
String locale,
String key,
String text) |
addClientScopes, getAllRedirectUrisOfEnabledClients, getAlwaysDisplayInConsoleClientsStream, getClientsStream, getClientsStream, removeClient, removeClients, removeClientScope
getClientByClientId, getClientById, getClientScopes, searchClientsByAttributes, searchClientsByClientIdStream
addClientScope, addClientScope, getClientScopesStream, removeClientScope, removeClientScopes
getGroupsByRoleStream, getGroupsCount, getGroupsStream, getGroupsStream, getGroupsStream, getGroupsStream, getTopLevelGroupsStream, getTopLevelGroupsStream
searchForGroupByNameStream
addClientRole, addClientRole, getClientRolesStream, getClientRolesStream, getRealmRolesStream, getRealmRolesStream, removeRole, removeRoles, removeRoles
getClientRole, getRoleById, searchForClientRolesStream, searchForRolesStream
RealmModel createRealm(String name)
name
- String name of the realmRealmModel createRealm(String id, String name)
id
- Internal ID of the realm or null
if one is to be created by the underlying storename
- String name of the realmRealmModel getRealm(String id)
id
- Internal ID of the realm.RealmModel getRealmByName(String name)
name
- String name of the realmStream<RealmModel> getRealmsStream()
RealmModel
. Never returns null
.Stream<RealmModel> getRealmsWithProviderTypeStream(Class<?> type)
type
- Class<?>
Type of the provider.RealmModel
. Never returns null
.boolean removeRealm(String id)
id
- of realm.true
if the realm was successfully removed.default ClientInitialAccessModel createClientInitialAccessModel(RealmModel realm, int expiration, int count)
default ClientInitialAccessModel getClientInitialAccessModel(RealmModel realm, String id)
default void removeClientInitialAccessModel(RealmModel realm, String id)
default Stream<ClientInitialAccessModel> listClientInitialAccessStream(RealmModel realm)
realm
- RealmModel
The realm where to list client's initial access.ClientInitialAccessModel
. Never returns null
.void removeExpiredClientInitialAccess()
default void decreaseRemainingCount(RealmModel realm, ClientInitialAccessModel clientInitialAccess)
void saveLocalizationText(RealmModel realm, String locale, String key, String text)
void saveLocalizationTexts(RealmModel realm, String locale, Map<String,String> localizationTexts)
boolean updateLocalizationText(RealmModel realm, String locale, String key, String text)
boolean deleteLocalizationTextsByLocale(RealmModel realm, String locale)
boolean deleteLocalizationText(RealmModel realm, String locale, String key)
String getLocalizationTextsById(RealmModel realm, String locale, String key)
@Deprecated default List<RealmModel> getRealms()
getRealmsStream
instead.@Deprecated default List<RealmModel> getRealmsWithProviderType(Class<?> type)
getRealmsWithProviderTypeStream
instead.@Deprecated default List<ClientInitialAccessModel> listClientInitialAccess(RealmModel realm)
listClientInitialAccessStream
instead.ClientModel addClient(RealmModel realm, String id, String clientId)
ClientProvider
.ClientProvider
clientId
to the given realm.addClient
in interface ClientProvider
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.default ClientModel addClient(RealmModel realm, String clientId)
ClientProvider
.ClientProvider
clientId
to the given realm.
The internal ID of the client will be created automatically.addClient
in interface ClientProvider
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.default List<ClientModel> getClients(RealmModel realm)
ClientProvider
.ClientProvider
getClients
in interface ClientProvider
realm
- Realm.null
.default List<ClientModel> getClients(RealmModel realm, Integer firstResult, Integer maxResults)
ClientProvider
.ClientProvider
getClients
in interface ClientProvider
realm
- Realm.firstResult
- First result to return. Ignored if negative or null
.maxResults
- Maximum number of results to return. Ignored if negative or null
.null
.default List<ClientModel> searchClientsByClientId(String clientId, Integer firstResult, Integer maxResults, RealmModel realm)
ClientProvider
.ClientLookupProvider
searchClientsByClientId
in interface ClientLookupProvider
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
.realm
- Realm to limit the search for clients.default ClientModel getClientByClientId(String clientId, RealmModel realm)
ClientProvider
.ClientLookupProvider
getClientByClientId
in interface ClientLookupProvider
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.null
if no client is found.default ClientModel getClientById(String id, RealmModel realm)
ClientProvider
.ClientLookupProvider
getClientById
in interface ClientLookupProvider
id
- Internal IDrealm
- Realm to limit the search.null
if no client is found.default boolean removeClient(String id, RealmModel realm)
ClientProvider
.ClientProvider
removeClient
in interface ClientProvider
id
- Internal ID of the clientrealm
- Realm.true
if the client existed and has been removed, false
otherwise.default List<ClientModel> getAlwaysDisplayInConsoleClients(RealmModel realm)
ClientProvider
.ClientProvider
getAlwaysDisplayInConsoleClients
in interface ClientProvider
realm
- Realm owning the clients.null
.long getClientsCount(RealmModel realm)
ClientProvider
.ClientProvider
getClientsCount
in interface ClientProvider
realm
- Realm.default ClientScopeModel getClientScopeById(String id, RealmModel realm)
ClientScopeProvider
.ClientScopeModel getClientScopeById(RealmModel realm, String id)
ClientScopeProvider
.ClientScopeLookupProvider
getClientScopeById
in interface ClientScopeLookupProvider
realm
- Realm.id
- Internal ID of the role.default RoleModel addRealmRole(RealmModel realm, String name)
RoleProvider
.RoleProvider
name
to the given realm.
The internal ID of the role will be created automatically.addRealmRole
in interface RoleProvider
realm
- Realm owning this role.name
- String name of the role.RoleModel addRealmRole(RealmModel realm, String id, String name)
RoleProvider
.RoleProvider
name
to the given realm.addRealmRole
in interface RoleProvider
realm
- 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.RoleModel getRealmRole(RealmModel realm, String name)
RoleProvider
.RoleLookupProvider
getRealmRole
in interface RoleLookupProvider
realm
- Realm.name
- String name of the role.null
if no role is found.default RoleModel getRoleById(String id, RealmModel realm)
RoleProvider
.default Set<RoleModel> getRealmRoles(RealmModel realm)
RoleProvider
.RoleProvider
getRealmRoles(realm, null, null)
.getRealmRoles
in interface RoleProvider
realm
- Realm.null
.default Set<RoleModel> getRealmRoles(RealmModel realm, Integer first, Integer max)
RoleProvider
.default Set<RoleModel> searchForRoles(RealmModel realm, String search, Integer first, Integer max)
RoleProvider
.default boolean removeRole(RealmModel realm, RoleModel role)
RoleProvider
.default RoleModel addClientRole(RealmModel realm, ClientModel client, String name)
RoleProvider
.default RoleModel addClientRole(RealmModel realm, ClientModel client, String id, String name)
RoleProvider
.default RoleModel getClientRole(RealmModel realm, ClientModel client, String name)
RoleProvider
.default Set<RoleModel> getClientRoles(RealmModel realm, ClientModel client)
RoleProvider
.default Set<RoleModel> getClientRoles(RealmModel realm, ClientModel client, Integer first, Integer max)
RoleProvider
.default Set<RoleModel> searchForClientRoles(RealmModel realm, ClientModel client, String search, Integer first, Integer max)
RoleProvider
.void moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
GroupProvider
.GroupProvider
moveGroup
in interface GroupProvider
realm
- Realm owning this group.group
- Group to update.toParent
- New parent group, or null
if we are moving the group to top level group.GroupModel getGroupById(RealmModel realm, String id)
GroupProvider
.GroupLookupProvider
getGroupById
in interface GroupLookupProvider
realm
- Realm.id
- Id.default GroupModel getGroupById(String id, RealmModel realm)
GroupProvider
.GroupProvider
getGroupById
in interface GroupProvider
id
- Id.realm
- Realm.default List<GroupModel> getGroups(RealmModel realm)
GroupProvider
.GroupProvider
getGroups
in interface GroupProvider
realm
- Realm.Long getGroupsCount(RealmModel realm, Boolean onlyTopGroups)
GroupProvider
.GroupProvider
getGroupsCount
in interface GroupProvider
realm
- Realm.onlyTopGroups
- When true the function returns a count of top level groups only.Long getGroupsCountByNameContaining(RealmModel realm, String search)
GroupProvider
.GroupProvider
getGroupsCountByNameContaining
in interface GroupProvider
realm
- Realm.search
- Case insensitive string which will be searched for.default List<GroupModel> getGroupsByRole(RealmModel realm, RoleModel role, int firstResult, int maxResults)
GroupProvider
.GroupProvider
getGroupsByRole
in interface GroupProvider
realm
- 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
.default List<GroupModel> getTopLevelGroups(RealmModel realm)
GroupProvider
.GroupProvider
getTopLevelGroups
in interface GroupProvider
realm
- Realm.default List<GroupModel> getTopLevelGroups(RealmModel realm, Integer first, Integer max)
GroupProvider
.GroupProvider
getTopLevelGroups
in interface GroupProvider
realm
- Realm.first
- First result to return. Ignored if negative or null
.max
- Maximum number of results to return. Ignored if negative or null
.default List<GroupModel> searchForGroupByName(RealmModel realm, String search, Integer first, Integer max)
GroupProvider
.GroupLookupProvider
searchForGroupByName
in interface GroupLookupProvider
realm
- Realm.search
- Case sensitive searched string.first
- First result to return. Ignored if null
.max
- Maximum number of results to return. Ignored if null
.boolean removeGroup(RealmModel realm, GroupModel group)
GroupProvider
.GroupProvider
removeGroup
in interface GroupProvider
realm
- Realm.group
- Group.default GroupModel createGroup(RealmModel realm, String name)
GroupProvider
.GroupProvider
createGroup(realm, null, name, null)
.createGroup
in interface GroupProvider
realm
- Realm.name
- Name.default GroupModel createGroup(RealmModel realm, String id, String name)
GroupProvider
.GroupProvider
createGroup(realm, id, name, null)
createGroup
in interface GroupProvider
realm
- Realm.id
- Id.name
- Name.default GroupModel createGroup(RealmModel realm, String name, GroupModel toParent)
GroupProvider
.GroupProvider
createGroup(realm, null, name, toParent)
.createGroup
in interface GroupProvider
realm
- Realm.name
- Name.toParent
- Parent group.GroupModel createGroup(RealmModel realm, String id, String name, GroupModel toParent)
GroupProvider
.GroupProvider
createGroup
in interface GroupProvider
realm
- Realm.id
- Id, will be generated if null
.name
- Name.toParent
- Parent group, or null
if the group is top level groupvoid addTopLevelGroup(RealmModel realm, GroupModel subGroup)
GroupProvider
.GroupProvider
addTopLevelGroup
in interface GroupProvider
realm
- Realm.subGroup
- Group.Copyright © 2021 JBoss by Red Hat. All rights reserved.