Package org.keycloak.models.jpa

Class ClientScopeAdapter

java.lang.Object

org.keycloak.models.jpa.ClientScopeAdapter

All Implemented Interfaces:

ClientScopeModel, JpaModel<ClientScopeEntity>, OrderedModel, ProtocolMapperContainerModel, ScopeContainerModel

public class ClientScopeAdapter
extends Object
implements ClientScopeModel, JpaModel<ClientScopeEntity>

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

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

ClientScopeModel.ClientScopeRemovedEvent, ClientScopeModel.SearchableFields

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

OrderedModel.OrderedModelComparator<OM extends OrderedModel>

Field Summary

Fields

Modifier and Type	Field	Description
protected jakarta.persistence.EntityManager	em
protected ClientScopeEntity	entity
protected RealmModel	realm
protected KeycloakSession	session

Fields inherited from interface org.keycloak.models.ClientScopeModel

CONSENT_SCREEN_TEXT, DISPLAY_ON_CONSENT_SCREEN, DYNAMIC_SCOPE_REGEXP, GUI_ORDER, INCLUDE_IN_TOKEN_SCOPE, IS_DYNAMIC_SCOPE

Constructor Summary

Constructors

Constructor	Description
ClientScopeAdapter(RealmModel realm, jakarta.persistence.EntityManager em, KeycloakSession session, ClientScopeEntity entity)

Method Summary

Modifier and Type	Method	Description
ProtocolMapperModel	addProtocolMapper(ProtocolMapperModel model)
void	addScopeMapping(RoleModel role)
void	deleteScopeMapping(RoleModel role)
protected ProtocolMapperModel	entityToModel(ProtocolMapperEntity entity)
boolean	equals(Object o)
String	getAttribute(String name)
Map<String,String>	getAttributes()
String	getDescription()
ClientScopeEntity	getEntity()
String	getId()
String	getName()
String	getProtocol()
ProtocolMapperModel	getProtocolMapperById(String id)
ProtocolMapperModel	getProtocolMapperByName(String protocol, String name)
protected ProtocolMapperEntity	getProtocolMapperEntity(String id)
protected ProtocolMapperEntity	getProtocolMapperEntityByName(String protocol, String name)
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.
int	hashCode()
boolean	hasScope(RoleModel role)	Returns true, if this object has the given role directly or indirectly in its scope, false otherwise.
void	removeAttribute(String name)
void	removeProtocolMapper(ProtocolMapperModel mapping)
void	setAttribute(String name, String value)
void	setDescription(String description)
void	setName(String name)
void	setProtocol(String protocol)
static ClientScopeEntity	toClientScopeEntity(ClientScopeModel model, jakarta.persistence.EntityManager em)
String	toString()
void	updateProtocolMapper(ProtocolMapperModel mapping)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.keycloak.models.ClientScopeModel

getConsentScreenText, getDynamicScopeRegexp, getGuiOrder, isDisplayOnConsentScreen, isDynamicScope, isIncludeInTokenScope, setConsentScreenText, setDisplayOnConsentScreen, setGuiOrder, setIncludeInTokenScope, setIsDynamicScope

Methods inherited from interface org.keycloak.models.ScopeContainerModel

hasDirectScope

Field Details

session

protected KeycloakSession session

realm

protected RealmModel realm

em

protected jakarta.persistence.EntityManager em

entity

protected ClientScopeEntity entity

Constructor Details

ClientScopeAdapter

public ClientScopeAdapter(RealmModel realm,
 jakarta.persistence.EntityManager em,
 KeycloakSession session,
 ClientScopeEntity entity)

Method Details

getEntity

public ClientScopeEntity getEntity()

Specified by:

getEntity in interface JpaModel<ClientScopeEntity>

getId

public String getId()

Specified by:

getId in interface ClientScopeModel

getRealm

public RealmModel getRealm()

Specified by:

getRealm in interface ClientScopeModel

getName

public String getName()

Specified by:

getName 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

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

getProtocolMapperEntity

protected ProtocolMapperEntity getProtocolMapperEntity(String id)

getProtocolMapperEntityByName

protected ProtocolMapperEntity getProtocolMapperEntityByName(String protocol,
 String name)

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

getProtocolMapperByName

public ProtocolMapperModel getProtocolMapperByName(String protocol,
 String name)

Specified by:

getProtocolMapperByName in interface ProtocolMapperContainerModel

entityToModel

protected ProtocolMapperModel entityToModel(ProtocolMapperEntity entity)

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.

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.

addScopeMapping

public void addScopeMapping(RoleModel role)

Specified by:

addScopeMapping in interface ScopeContainerModel

deleteScopeMapping

public void deleteScopeMapping(RoleModel role)

Specified by:

deleteScopeMapping in interface ScopeContainerModel

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

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

toClientScopeEntity

public static ClientScopeEntity toClientScopeEntity(ClientScopeModel model,
 jakarta.persistence.EntityManager em)

getAttributes

public Map<String,String> getAttributes()

Specified by:

getAttributes in interface ClientScopeModel

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object