public class MapRoleProvider extends Object implements RoleProvider
| Constructor and Description |
|---|
MapRoleProvider(KeycloakSession session,
MapStorage<UUID,MapRoleEntity> roleStore) |
| Modifier and Type | Method and Description |
|---|---|
RoleModel |
addClientRole(ClientModel client,
String id,
String name)
Adds a client role with given internal ID and
name to the given client. |
RoleModel |
addRealmRole(RealmModel realm,
String id,
String name)
Adds a realm role with given internal ID and
name to the given realm. |
void |
close() |
RoleModel |
getClientRole(ClientModel client,
String name)
Exact search for a client role by given name.
|
Stream<RoleModel> |
getClientRolesStream(ClientModel client)
Returns all the client roles of the given client.
|
Stream<RoleModel> |
getClientRolesStream(ClientModel client,
Integer first,
Integer max)
Returns the client roles of the given client.
|
RoleModel |
getRealmRole(RealmModel realm,
String name)
Exact search for a role by given name.
|
Stream<RoleModel> |
getRealmRolesStream(RealmModel realm)
Returns all the realm roles of the given realm as a stream.
|
Stream<RoleModel> |
getRealmRolesStream(RealmModel realm,
Integer first,
Integer max)
Returns the realm roles of the given realm as a stream.
|
RoleModel |
getRoleById(RealmModel realm,
String id)
Exact search for a role by its internal ID..
|
boolean |
removeRole(RoleModel role)
Removes given realm role from the given realm.
|
void |
removeRoles(ClientModel client)
Removes all roles from the given client.
|
void |
removeRoles(RealmModel realm)
Removes all roles from the given realm.
|
Stream<RoleModel> |
searchForClientRolesStream(ClientModel client,
String search,
Integer first,
Integer max)
Case-insensitive search for client roles that contain the given string in their name or description.
|
Stream<RoleModel> |
searchForRolesStream(RealmModel realm,
String search,
Integer first,
Integer max)
Case-insensitive search for roles that contain the given string in their name or description.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddClientRole, addRealmRole, getRealmRolespublic MapRoleProvider(KeycloakSession session, MapStorage<UUID,MapRoleEntity> roleStore)
public RoleModel addRealmRole(RealmModel realm, String id, String name)
RoleProvidername to the given realm.addRealmRole 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.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.public Stream<RoleModel> getRealmRolesStream(RealmModel realm)
RoleProvidergetRealmRolesStream(realm, null, null).getRealmRolesStream in interface RoleProviderrealm - Realm.null.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.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.public Stream<RoleModel> getClientRolesStream(ClientModel client)
RoleProvidergetClientRoles(client, null, null).getClientRolesStream in interface RoleProviderclient - Client.null.public boolean removeRole(RoleModel role)
RoleProviderremoveRole in interface RoleProviderrole - Role to be removed.true if the role existed and has been removed, false otherwise.public void removeRoles(RealmModel realm)
RoleProviderremoveRoles in interface RoleProviderrealm - Realm.public void removeRoles(ClientModel client)
RoleProviderremoveRoles in interface RoleProviderclient - Client.public RoleModel getRealmRole(RealmModel realm, String name)
RoleLookupProvidergetRealmRole in interface RoleLookupProviderrealm - Realm.name - String name of the role.null if no role is found.public RoleModel getClientRole(ClientModel client, String name)
RoleLookupProvidergetClientRole in interface RoleLookupProviderclient - Client.name - String name of the role.null if no role is found.public RoleModel getRoleById(RealmModel realm, String id)
RoleLookupProvidergetRoleById in interface RoleLookupProviderrealm - Realm.id - Internal ID of the role.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.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.