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

Class JpaRoleEntity

java.lang.Object

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

org.keycloak.models.map.role.MapRoleEntity.AbstractRoleEntity

org.keycloak.models.map.storage.jpa.role.entity.JpaRoleEntity

All Implemented Interfaces:

Serializable, AbstractEntity, EntityWithAttributes, UpdatableEntity, MapRoleEntity, JpaRootEntity, JpaRootVersionedEntity

@Entity
public class JpaRoleEntity
extends MapRoleEntity.AbstractRoleEntity
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.role.MapRoleEntity

MapRoleEntity.AbstractRoleEntity

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
JpaRoleEntity()	No-argument constructor, used by hibernate to instantiate entities.
JpaRoleEntity(UUID id, int version, Integer entityVersion, String realmId, String clientId, String name, String description)	Used by hibernate when calling cb.construct from read(QueryParameters) method.
JpaRoleEntity(DeepCloner cloner)

Method Summary

Modifier and Type	Method	Description
void	addCompositeRole(String roleId)
boolean	equals(Object obj)
List<String>	getAttribute(String name)
Map<String,List<String>>	getAttributes()
String	getClientId()
Set<String>	getCompositeRoles()
Integer	getCurrentSchemaVersion()
String	getDescription()
Integer	getEntityVersion()
String	getId()
String	getName()
String	getRealmId()
int	getVersion()	Version of the JPA entity used for optimistic locking
int	hashCode()
boolean	isMetadataInitialized()
void	removeAttribute(String name)
void	removeCompositeRole(String roleId)
void	setAttribute(String name, List<String> values)
void	setAttributes(Map<String,List<String>> attributes)
void	setClientId(String clientId)
void	setCompositeRoles(Set<String> compositeRoles)
void	setDescription(String description)
void	setEntityVersion(Integer entityVersion)
void	setId(String id)
void	setName(String name)
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

JpaRoleEntity

public JpaRoleEntity()

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

JpaRoleEntity

public JpaRoleEntity(DeepCloner cloner)

JpaRoleEntity

public JpaRoleEntity(UUID id,
 int version,
 Integer entityVersion,
 String realmId,
 String clientId,
 String name,
 String description)

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

Method Details

isMetadataInitialized

public boolean isMetadataInitialized()

getCurrentSchemaVersion

public Integer getCurrentSchemaVersion()

Specified by:

getCurrentSchemaVersion in interface JpaRootEntity

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.

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 MapRoleEntity.AbstractRoleEntity

setId

public void setId(String id)

Specified by:

setId in interface AbstractEntity

Overrides:

setId in class MapRoleEntity.AbstractRoleEntity

getRealmId

public String getRealmId()

Specified by:

getRealmId in interface MapRoleEntity

getClientId

public String getClientId()

Specified by:

getClientId in interface MapRoleEntity

getName

public String getName()

Specified by:

getName in interface MapRoleEntity

getDescription

public String getDescription()

Specified by:

getDescription in interface MapRoleEntity

setRealmId

public void setRealmId(String realmId)

Specified by:

setRealmId in interface MapRoleEntity

setClientId

public void setClientId(String clientId)

Specified by:

setClientId in interface MapRoleEntity

setName

public void setName(String name)

Specified by:

setName in interface MapRoleEntity

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface MapRoleEntity

getCompositeRoles

public Set<String> getCompositeRoles()

Specified by:

getCompositeRoles in interface MapRoleEntity

setCompositeRoles

public void setCompositeRoles(Set<String> compositeRoles)

Specified by:

setCompositeRoles in interface MapRoleEntity

addCompositeRole

public void addCompositeRole(String roleId)

Specified by:

addCompositeRole in interface MapRoleEntity

removeCompositeRole

public void removeCompositeRole(String roleId)

Specified by:

removeCompositeRole in interface MapRoleEntity

getAttributes

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

Specified by:

getAttributes in interface EntityWithAttributes

getAttribute

public List<String> getAttribute(String name)

Specified by:

getAttribute in interface EntityWithAttributes

setAttributes

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

Specified by:

setAttributes in interface EntityWithAttributes

setAttribute

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

Specified by:

setAttribute in interface EntityWithAttributes

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface EntityWithAttributes

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object