public interface ClientScopeProvider extends Provider, ClientScopeLookupProvider
Modifier and Type | Method and Description |
---|---|
default ClientScopeModel |
addClientScope(RealmModel realm,
String name)
Creates new client scope with given
name to the given realm. |
ClientScopeModel |
addClientScope(RealmModel realm,
String id,
String name)
Creates new client scope with given internal ID and
name to the given realm. |
Stream<ClientScopeModel> |
getClientScopesStream(RealmModel realm)
Returns all the client scopes of the given realm as a stream.
|
boolean |
removeClientScope(RealmModel realm,
String id)
Removes client scope from the given realm.
|
void |
removeClientScopes(RealmModel realm)
Removes all client scopes from the given realm.
|
getClientScopeById
Stream<ClientScopeModel> getClientScopesStream(RealmModel realm)
realm
- Realm.null
.default ClientScopeModel addClientScope(RealmModel realm, String name)
name
to the given realm.
Spaces in name
will be replaced by underscore so that scope name
can be used as value of scope parameter. The internal ID will be created automatically.realm
- Realm owning this client scope.name
- String name of the client scope.ModelDuplicateException
- if client scope with given name already existsClientScopeModel addClientScope(RealmModel realm, String id, String name)
name
to the given realm.
Spaces in name
will be replaced by underscore so that scope name
can be used as value of scope parameter.realm
- 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.IllegalArgumentException
- If id
does not conform
the format understood by the underlying store.ModelDuplicateException
- if client scope with given name already existsboolean removeClientScope(RealmModel realm, String id)
realm
- Realm.id
- Internal ID of the client scopetrue
if the client scope existed and has been removed, false
otherwise.ModelException
- if client scope is in use.void removeClientScopes(RealmModel realm)
realm
- Realm.Copyright © 2021 JBoss by Red Hat. All rights reserved.