public interface RoleProvider extends Provider, RoleLookupProvider
Modifier and Type | Method and Description |
---|---|
default RoleModel |
addClientRole(ClientModel client,
String name)
Adds a client role with given
name to the given client. |
RoleModel |
addClientRole(ClientModel client,
String id,
String name)
Adds a client role with given internal ID and
name to the given client. |
default RoleModel |
addRealmRole(RealmModel realm,
String name)
Adds a realm role with given
name to the given realm. |
RoleModel |
addRealmRole(RealmModel realm,
String id,
String name)
Adds a realm role with given internal ID and
name to the given realm. |
default 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.
|
default Set<RoleModel> |
getRealmRoles(RealmModel realm)
Deprecated.
use the stream variant instead
|
default 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.
|
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.
|
getClientRole, getRealmRole, getRoleById, searchForClientRolesStream, searchForRolesStream
default RoleModel addRealmRole(RealmModel realm, String name)
name
to the given realm.
The internal ID of the role will be created automatically.realm
- Realm owning this role.name
- String name of the role.RoleModel addRealmRole(RealmModel realm, String id, String name)
name
to the given realm.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.IllegalArgumentException
- If id
does not conform
the format understood by the underlying store.@Deprecated default Set<RoleModel> getRealmRoles(RealmModel realm)
getRealmRoles(realm, null, null)
.realm
- Realm.null
.default Stream<RoleModel> getRealmRolesStream(RealmModel realm)
getRealmRolesStream(realm, null, null)
.realm
- Realm.null
.Stream<RoleModel> getRealmRolesStream(RealmModel realm, Integer first, Integer max)
realm
- Realm.first
- First result to return. Ignored if negative or null
.max
- Maximum number of results to return. Ignored if negative or null
.null
.boolean removeRole(RoleModel role)
role
- Role to be removed.true
if the role existed and has been removed, false
otherwise.void removeRoles(RealmModel realm)
realm
- Realm.default RoleModel addClientRole(ClientModel client, String name)
name
to the given client.
The internal ID of the role will be created automatically.client
- Client owning this role.name
- String name of the role.RoleModel addClientRole(ClientModel client, String id, String name)
name
to the given client.client
- 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.default Stream<RoleModel> getClientRolesStream(ClientModel client)
getClientRoles(client, null, null)
.client
- Client.null
.Stream<RoleModel> getClientRolesStream(ClientModel client, Integer first, Integer max)
client
- Client.first
- First result to return. Ignored if negative or null
.max
- Maximum number of results to return. Ignored if negative or null
.null
.void removeRoles(ClientModel client)
client
- Client.Copyright © 2021 JBoss by Red Hat. All rights reserved.