org.keycloak.models

Interface ScopeContainerModel

All Known Subinterfaces:

ClientModel, ClientScopeModel

public interface ScopeContainerModel

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method and Description
void	addScopeMapping(RoleModel role)
void	deleteScopeMapping(RoleModel role)
default Set<RoleModel>	getRealmScopeMappings() Deprecated. Use getRealmScopeMappingsStream instead.
Stream<RoleModel>	getRealmScopeMappingsStream() From the scope mappings returned by getScopeMappingsStream() returns only those that belong to the realm that owns this scope container.
default Set<RoleModel>	getScopeMappings() Deprecated. Use getScopeMappingsStream instead.
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 Detail

getScopeMappings

@Deprecated
default Set<RoleModel> getScopeMappings()

Deprecated. Use getScopeMappingsStream instead.

getScopeMappingsStream

Stream<RoleModel> getScopeMappingsStream()

Returns scope mappings for this scope container as a stream.

Returns:

Stream of RoleModel. Never returns null.

getRealmScopeMappings

@Deprecated
default Set<RoleModel> getRealmScopeMappings()

Deprecated. Use getRealmScopeMappingsStream instead.

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

Returns:

set of RealmModel

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