Package org.keycloak.models.map.storage.jpa.clientScope.entity

Class JpaClientScopeEntity

java.lang.Object

org.keycloak.models.map.common.UpdatableEntity.Impl

org.keycloak.models.map.clientscope.MapClientScopeEntity.AbstractClientScopeEntity

org.keycloak.models.map.storage.jpa.clientScope.entity.JpaClientScopeEntity

All Implemented Interfaces:

Serializable, MapClientScopeEntity, AbstractEntity, EntityWithAttributes, UpdatableEntity, JpaRootEntity, JpaRootVersionedEntity

@Entity
public class JpaClientScopeEntity
extends MapClientScopeEntity.AbstractClientScopeEntity
implements JpaRootVersionedEntity

There are some fields marked by @Column(insertable = false, updatable = false). Those fields are automatically generated by database from json field, therefore marked as non-insertable and non-updatable to instruct hibernate.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.map.clientscope.MapClientScopeEntity

MapClientScopeEntity.AbstractClientScopeEntity

Nested classes/interfaces inherited from interface org.keycloak.models.map.common.UpdatableEntity

UpdatableEntity.Impl

Field Summary

Fields inherited from class org.keycloak.models.map.common.UpdatableEntity.Impl

updated

Constructor Summary

Constructors

Constructor	Description
JpaClientScopeEntity()	No-argument constructor, used by hibernate to instantiate entities.
JpaClientScopeEntity(UUID id, int version, Integer entityVersion, String realmId, String name)	Used by hibernate when calling cb.construct from read(QueryParameters) method.
JpaClientScopeEntity(DeepCloner cloner)

Method Summary

Modifier and Type	Method	Description
void	addProtocolMapper(MapProtocolMapperEntity mapping)
void	addScopeMapping(String id)
boolean	equals(Object obj)
List<String>	getAttribute(String name)
Map<String,List<String>>	getAttributes()
Integer	getCurrentSchemaVersion()
String	getDescription()
Integer	getEntityVersion()
String	getId()
String	getName()
String	getProtocol()
Optional<MapProtocolMapperEntity>	getProtocolMapper(String id)
Set<MapProtocolMapperEntity>	getProtocolMappers()
String	getRealmId()
Collection<String>	getScopeMappings()
int	getVersion()	Version of the JPA entity used for optimistic locking
int	hashCode()
boolean	isMetadataInitialized()
void	removeAttribute(String name)
void	removeProtocolMapper(String id)
void	removeScopeMapping(String id)
void	setAttribute(String name, List<String> values)
void	setAttributes(Map<String,List<String>> attributes)
void	setDescription(String description)
void	setEntityVersion(Integer entityVersion)
void	setId(String id)
void	setName(String name)
void	setProtocol(String protocol)
void	setRealmId(String realmId)

Methods inherited from class org.keycloak.models.map.common.UpdatableEntity.Impl

clearUpdatedFlag, isUpdated, markUpdatedFlag

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.models.map.storage.jpa.JpaRootEntity

updateEntityVersion

Methods inherited from interface org.keycloak.models.map.common.UpdatableEntity

clearUpdatedFlag, isUpdated, markUpdatedFlag

Constructor Details

JpaClientScopeEntity

public JpaClientScopeEntity()

No-argument constructor, used by hibernate to instantiate entities.

JpaClientScopeEntity

public JpaClientScopeEntity(DeepCloner cloner)

JpaClientScopeEntity

public JpaClientScopeEntity(UUID id,
 int version,
 Integer entityVersion,
 String realmId,
 String name)

Used by hibernate when calling cb.construct from read(QueryParameters) method. It is used to select client without metadata(json) field.

Method Details

isMetadataInitialized

public boolean isMetadataInitialized()

getEntityVersion

public Integer getEntityVersion()

Specified by:

getEntityVersion in interface JpaRootEntity

Returns:

current supported version of the JPA entity used for schema versioning.

setEntityVersion

public void setEntityVersion(Integer entityVersion)

Specified by:

setEntityVersion in interface JpaRootEntity

Parameters:

entityVersion - sets current supported version to JPA entity.

getCurrentSchemaVersion

public Integer getCurrentSchemaVersion()

Specified by:

getCurrentSchemaVersion in interface JpaRootEntity

getVersion

public int getVersion()

Description copied from interface: JpaRootVersionedEntity

Version of the JPA entity used for optimistic locking

Specified by:

getVersion in interface JpaRootVersionedEntity

getId

public String getId()

Specified by:

getId in interface AbstractEntity

Overrides:

getId in class MapClientScopeEntity.AbstractClientScopeEntity

setId

public void setId(String id)

Specified by:

setId in interface AbstractEntity

Overrides:

setId in class MapClientScopeEntity.AbstractClientScopeEntity

getRealmId

public String getRealmId()

Specified by:

getRealmId in interface MapClientScopeEntity

setRealmId

public void setRealmId(String realmId)

Specified by:

setRealmId in interface MapClientScopeEntity

getProtocolMappers

public Set<MapProtocolMapperEntity> getProtocolMappers()

Specified by:

getProtocolMappers in interface MapClientScopeEntity

getProtocolMapper

public Optional<MapProtocolMapperEntity> getProtocolMapper(String id)

Specified by:

getProtocolMapper in interface MapClientScopeEntity

addProtocolMapper

public void addProtocolMapper(MapProtocolMapperEntity mapping)

Specified by:

addProtocolMapper in interface MapClientScopeEntity

removeProtocolMapper

public void removeProtocolMapper(String id)

Specified by:

removeProtocolMapper in interface MapClientScopeEntity

addScopeMapping

public void addScopeMapping(String id)

Specified by:

addScopeMapping in interface MapClientScopeEntity

removeScopeMapping

public void removeScopeMapping(String id)

Specified by:

removeScopeMapping in interface MapClientScopeEntity

getScopeMappings

public Collection<String> getScopeMappings()

Specified by:

getScopeMappings in interface MapClientScopeEntity

getDescription

public String getDescription()

Specified by:

getDescription in interface MapClientScopeEntity

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface MapClientScopeEntity

getName

public String getName()

Specified by:

getName in interface MapClientScopeEntity

setName

public void setName(String name)

Specified by:

setName in interface MapClientScopeEntity

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface MapClientScopeEntity

setProtocol

public void setProtocol(String protocol)

Specified by:

setProtocol in interface MapClientScopeEntity

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface EntityWithAttributes

setAttribute

public void setAttribute(String name,
 List<String> values)

Specified by:

setAttribute in interface EntityWithAttributes

getAttribute

public List<String> getAttribute(String name)

Specified by:

getAttribute in interface EntityWithAttributes

getAttributes

public Map<String,List<String>> getAttributes()

Specified by:

getAttributes in interface EntityWithAttributes

setAttributes

public void setAttributes(Map<String,List<String>> attributes)

Specified by:

setAttributes in interface EntityWithAttributes

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object