Package org.keycloak.models

Class ClientScopeDecorator

java.lang.Object

org.keycloak.models.ClientScopeDecorator

All Implemented Interfaces:

ClientScopeModel, OrderedModel, ProtocolMapperContainerModel, ScopeContainerModel

public class ClientScopeDecorator
extends Object
implements ClientScopeModel

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.ClientScopeModel

ClientScopeModel.ClientScopeCreatedEvent, ClientScopeModel.ClientScopeRemovedEvent

Nested classes/interfaces inherited from interface org.keycloak.models.OrderedModel

OrderedModel.OrderedModelComparator<OM extends OrderedModel>

Field Summary

Fields inherited from interface org.keycloak.models.ClientScopeModel

CONSENT_SCREEN_TEXT, DISPLAY_ON_CONSENT_SCREEN, DYNAMIC_SCOPE_REGEXP, GUI_ORDER, INCLUDE_IN_OPENID_PROVIDER_METADATA, INCLUDE_IN_TOKEN_SCOPE, IS_DYNAMIC_SCOPE, VALUE_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
ClientScopeDecorator(ClientScopeModel delegate, String name)

Method Summary

Modifier and Type	Method	Description
ProtocolMapperModel	addProtocolMapper(ProtocolMapperModel model)
void	addScopeMapping(RoleModel role)
void	deleteScopeMapping(RoleModel role)
String	getAttribute(String name)
Map<String,String>	getAttributes()
String	getConsentScreenText()
String	getDescription()
String	getDynamicScopeRegexp()
String	getGuiOrder()
String	getId()
String	getName()
String	getProtocol()
ProtocolMapperModel	getProtocolMapperById(String id)
ProtocolMapperModel	getProtocolMapperByName(String protocol, String name)
List<ProtocolMapperModel>	getProtocolMapperByType(String type)
Stream<ProtocolMapperModel>	getProtocolMappersStream()	Returns protocol mappers as a stream.
RealmModel	getRealm()
Stream<RoleModel>	getRealmScopeMappingsStream()	From the scope mappings returned by ScopeContainerModel.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.
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.
boolean	isDisplayOnConsentScreen()
boolean	isDynamicScope()
boolean	isIncludeInTokenScope()
void	removeAttribute(String name)
void	removeProtocolMapper(ProtocolMapperModel mapping)
void	setAttribute(String name, String value)
void	setConsentScreenText(String consentScreenText)
void	setDescription(String description)
void	setDisplayOnConsentScreen(boolean displayOnConsentScreen)
void	setGuiOrder(String guiOrder)
void	setIncludeInTokenScope(boolean includeInTokenScope)
void	setIsDynamicScope(boolean isDynamicScope)
void	setName(String name)
void	setProtocol(String protocol)
void	updateProtocolMapper(ProtocolMapperModel mapping)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.models.ClientScopeModel

isIncludeInOpenIDProviderMetadata, setIncludeInOpenIDProviderMetadata

Constructor Details

ClientScopeDecorator

public ClientScopeDecorator(ClientScopeModel delegate,
 String name)

Method Details

getId

public String getId()

Specified by:

getId in interface ClientScopeModel

getName

public String getName()

Specified by:

getName in interface ClientScopeModel

getRealm

public RealmModel getRealm()

Specified by:

getRealm in interface ClientScopeModel

setName

public void setName(String name)

Specified by:

setName in interface ClientScopeModel

getDescription

public String getDescription()

Specified by:

getDescription in interface ClientScopeModel

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface ClientScopeModel

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface ClientScopeModel

setProtocol

public void setProtocol(String protocol)

Specified by:

setProtocol in interface ClientScopeModel

setAttribute

public void setAttribute(String name,
 String value)

Specified by:

setAttribute in interface ClientScopeModel

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface ClientScopeModel

getAttribute

public String getAttribute(String name)

Specified by:

getAttribute in interface ClientScopeModel

getAttributes

public Map<String,String> getAttributes()

Specified by:

getAttributes in interface ClientScopeModel

isDisplayOnConsentScreen

public boolean isDisplayOnConsentScreen()

Specified by:

isDisplayOnConsentScreen in interface ClientScopeModel

setDisplayOnConsentScreen

public void setDisplayOnConsentScreen(boolean displayOnConsentScreen)

Specified by:

setDisplayOnConsentScreen in interface ClientScopeModel

getConsentScreenText

public String getConsentScreenText()

Specified by:

getConsentScreenText in interface ClientScopeModel

setConsentScreenText

public void setConsentScreenText(String consentScreenText)

Specified by:

setConsentScreenText in interface ClientScopeModel

getGuiOrder

public String getGuiOrder()

Specified by:

getGuiOrder in interface ClientScopeModel

Specified by:

getGuiOrder in interface OrderedModel

setGuiOrder

public void setGuiOrder(String guiOrder)

Specified by:

setGuiOrder in interface ClientScopeModel

isIncludeInTokenScope

public boolean isIncludeInTokenScope()

Specified by:

isIncludeInTokenScope in interface ClientScopeModel

setIncludeInTokenScope

public void setIncludeInTokenScope(boolean includeInTokenScope)

Specified by:

setIncludeInTokenScope in interface ClientScopeModel

isDynamicScope

public boolean isDynamicScope()

Specified by:

isDynamicScope in interface ClientScopeModel

setIsDynamicScope

public void setIsDynamicScope(boolean isDynamicScope)

Specified by:

setIsDynamicScope in interface ClientScopeModel

getDynamicScopeRegexp

public String getDynamicScopeRegexp()

Specified by:

getDynamicScopeRegexp in interface ClientScopeModel

getProtocolMappersStream

public Stream<ProtocolMapperModel> getProtocolMappersStream()

Description copied from interface: ProtocolMapperContainerModel

Returns protocol mappers as a stream.

Specified by:

getProtocolMappersStream in interface ProtocolMapperContainerModel

Returns:

Stream of protocol mapper. Never returns null.

addProtocolMapper

public ProtocolMapperModel addProtocolMapper(ProtocolMapperModel model)

Specified by:

addProtocolMapper in interface ProtocolMapperContainerModel

removeProtocolMapper

public void removeProtocolMapper(ProtocolMapperModel mapping)

Specified by:

removeProtocolMapper in interface ProtocolMapperContainerModel

updateProtocolMapper

public void updateProtocolMapper(ProtocolMapperModel mapping)

Specified by:

updateProtocolMapper in interface ProtocolMapperContainerModel

getProtocolMapperById

public ProtocolMapperModel getProtocolMapperById(String id)

Specified by:

getProtocolMapperById in interface ProtocolMapperContainerModel

getProtocolMapperByType

public List<ProtocolMapperModel> getProtocolMapperByType(String type)

Specified by:

getProtocolMapperByType in interface ProtocolMapperContainerModel

getProtocolMapperByName

public ProtocolMapperModel getProtocolMapperByName(String protocol,
 String name)

Specified by:

getProtocolMapperByName in interface ProtocolMapperContainerModel

getScopeMappingsStream

public Stream<RoleModel> getScopeMappingsStream()

Description copied from interface: ScopeContainerModel

Returns scope mappings for this scope container as a stream.

Specified by:

getScopeMappingsStream in interface ScopeContainerModel

Returns:

Stream of RoleModel. Never returns null.

getRealmScopeMappingsStream

public Stream<RoleModel> getRealmScopeMappingsStream()

Description copied from interface: ScopeContainerModel

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

Specified by:

getRealmScopeMappingsStream in interface ScopeContainerModel

Returns:

stream of RoleModel. Never returns null.

addScopeMapping

public void addScopeMapping(RoleModel role)

Specified by:

addScopeMapping in interface ScopeContainerModel

deleteScopeMapping

public void deleteScopeMapping(RoleModel role)

Specified by:

deleteScopeMapping in interface ScopeContainerModel

hasDirectScope

public boolean hasDirectScope(RoleModel role)

Description copied from interface: ScopeContainerModel

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

Specified by:

hasDirectScope in interface ScopeContainerModel

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

public boolean hasScope(RoleModel role)

Description copied from interface: ScopeContainerModel

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

Specified by:

hasScope in interface ScopeContainerModel

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