Package org.keycloak.models

Interface ScopeContainerModel

All Known Subinterfaces:

ClientModel, ClientScopeModel

All Known Implementing Classes:

AbstractClientModel, AbstractClientScopeModel, AbstractClientStorageAdapter, AbstractReadOnlyClientScopeAdapter, AbstractReadOnlyClientStorageAdapter, ClientAdapter, ClientAdapter, ClientModelLazyDelegate, ClientModelLazyDelegate.WithId, ClientScopeAdapter, ClientScopeAdapter, MapClientAdapter, MapClientScopeAdapter, OIDCClientSecretConfigWrapper.ReadOnlyRotatedSecretClientModel, UnsupportedOperationsClientStorageAdapter

public interface ScopeContainerModel

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method	Description
void	addScopeMapping(RoleModel role)
void	deleteScopeMapping(RoleModel role)
Stream<RoleModel>	getRealmScopeMappingsStream()	From the scope mappings returned by getScopeMappingsStream() returns only those that belong to the realm that owns this scope container.
Stream<RoleModel>	getScopeMappingsStream()	Returns scope mappings for this scope container as a stream.
default boolean	hasDirectScope(RoleModel role)	Returns true, if this object has the given role directly in its scope.
boolean	hasScope(RoleModel role)	Returns true, if this object has the given role directly or indirectly in its scope, false otherwise.

Method Details

getScopeMappingsStream

Stream<RoleModel> getScopeMappingsStream()

Returns scope mappings for this scope container as a stream.

Returns:

Stream of RoleModel. Never returns null.

getRealmScopeMappingsStream

Stream<RoleModel> getRealmScopeMappingsStream()

From the scope mappings returned by getScopeMappingsStream() returns only those that belong to the realm that owns this scope container.

Returns:

stream of RoleModel. Never returns null.

addScopeMapping

void addScopeMapping(RoleModel role)

deleteScopeMapping

void deleteScopeMapping(RoleModel role)

hasDirectScope

default boolean hasDirectScope(RoleModel role)

Returns true, if this object has the given role directly in its scope.

Parameters:

role - the role

Returns:

see description

See Also:

• if you want to check whether this object has the given role directly or indirectly in its scope

hasScope

boolean hasScope(RoleModel role)

Returns true, if this object has the given role directly or indirectly in its scope, false otherwise.

Parameters:

role - the role

Returns:

see description

See Also:

• if you want to check if this object has the given role directly in its scope