Package org.keycloak.models.map.storage.jpa.authorization.policy.entity

Class JpaPolicyEntity

java.lang.Object

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

org.keycloak.models.map.authorization.entity.MapPolicyEntity.AbstractMapPolicyEntity

org.keycloak.models.map.storage.jpa.authorization.policy.entity.JpaPolicyEntity

All Implemented Interfaces:

Serializable, MapPolicyEntity, AbstractEntity, UpdatableEntity, JpaRootEntity, JpaRootVersionedEntity

@Entity
public class JpaPolicyEntity
extends MapPolicyEntity.AbstractMapPolicyEntity
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.authorization.entity.MapPolicyEntity

MapPolicyEntity.AbstractMapPolicyEntity

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

Method Summary

Modifier and Type	Method	Description
void	addAssociatedPolicyId(String policyId)
void	addResourceId(String resourceId)
void	addScopeId(String scopeId)
boolean	equals(Object obj)
Set<String>	getAssociatedPolicyIds()
String	getConfig(String name)
Map<String,String>	getConfigs()
Integer	getCurrentSchemaVersion()
org.keycloak.representations.idm.authorization.DecisionStrategy	getDecisionStrategy()
String	getDescription()
Integer	getEntityVersion()
String	getId()
org.keycloak.representations.idm.authorization.Logic	getLogic()
String	getName()
String	getOwner()
String	getRealmId()
Set<String>	getResourceIds()
String	getResourceServerId()
Set<String>	getScopeIds()
String	getType()
int	getVersion()	Version of the JPA entity used for optimistic locking
int	hashCode()
boolean	isMetadataInitialized()
void	removeAssociatedPolicyId(String policyId)
void	removeConfig(String name)
void	removeResourceId(String resourceId)
void	removeScopeId(String scopeId)
void	setConfig(String name, String value)
void	setConfigs(Map<String,String> config)
void	setDecisionStrategy(org.keycloak.representations.idm.authorization.DecisionStrategy decisionStrategy)
void	setDescription(String description)
void	setEntityVersion(Integer entityVersion)
void	setId(String id)
void	setLogic(org.keycloak.representations.idm.authorization.Logic logic)
void	setName(String name)
void	setOwner(String owner)
void	setRealmId(String realmId)
void	setResourceServerId(String resourceServerId)
void	setType(String type)

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

JpaPolicyEntity

public JpaPolicyEntity()

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

JpaPolicyEntity

public JpaPolicyEntity(DeepCloner cloner)

JpaPolicyEntity

public JpaPolicyEntity(UUID id,
 int version,
 Integer entityVersion,
 String realmId,
 UUID resourceServerId,
 String name,
 String owner,
 String type)

Used by hibernate when calling cb.construct from read(QueryParameters) method. It is used to select object 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 MapPolicyEntity.AbstractMapPolicyEntity

setId

public void setId(String id)

Specified by:

setId in interface AbstractEntity

Overrides:

setId in class MapPolicyEntity.AbstractMapPolicyEntity

getRealmId

public String getRealmId()

Specified by:

getRealmId in interface MapPolicyEntity

setRealmId

public void setRealmId(String realmId)

Specified by:

setRealmId in interface MapPolicyEntity

getResourceServerId

public String getResourceServerId()

Specified by:

getResourceServerId in interface MapPolicyEntity

setResourceServerId

public void setResourceServerId(String resourceServerId)

Specified by:

setResourceServerId in interface MapPolicyEntity

getName

public String getName()

Specified by:

getName in interface MapPolicyEntity

setName

public void setName(String name)

Specified by:

setName in interface MapPolicyEntity

getType

public String getType()

Specified by:

getType in interface MapPolicyEntity

setType

public void setType(String type)

Specified by:

setType in interface MapPolicyEntity

getDescription

public String getDescription()

Specified by:

getDescription in interface MapPolicyEntity

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface MapPolicyEntity

getDecisionStrategy

public org.keycloak.representations.idm.authorization.DecisionStrategy getDecisionStrategy()

Specified by:

getDecisionStrategy in interface MapPolicyEntity

setDecisionStrategy

public void setDecisionStrategy(org.keycloak.representations.idm.authorization.DecisionStrategy decisionStrategy)

Specified by:

setDecisionStrategy in interface MapPolicyEntity

getLogic

public org.keycloak.representations.idm.authorization.Logic getLogic()

Specified by:

getLogic in interface MapPolicyEntity

setLogic

public void setLogic(org.keycloak.representations.idm.authorization.Logic logic)

Specified by:

setLogic in interface MapPolicyEntity

getConfigs

public Map<String,String> getConfigs()

Specified by:

getConfigs in interface MapPolicyEntity

setConfigs

public void setConfigs(Map<String,String> config)

Specified by:

setConfigs in interface MapPolicyEntity

getConfig

public String getConfig(String name)

Specified by:

getConfig in interface MapPolicyEntity

setConfig

public void setConfig(String name,
 String value)

Specified by:

setConfig in interface MapPolicyEntity

removeConfig

public void removeConfig(String name)

Specified by:

removeConfig in interface MapPolicyEntity

getAssociatedPolicyIds

public Set<String> getAssociatedPolicyIds()

Specified by:

getAssociatedPolicyIds in interface MapPolicyEntity

addAssociatedPolicyId

public void addAssociatedPolicyId(String policyId)

Specified by:

addAssociatedPolicyId in interface MapPolicyEntity

removeAssociatedPolicyId

public void removeAssociatedPolicyId(String policyId)

Specified by:

removeAssociatedPolicyId in interface MapPolicyEntity

getResourceIds

public Set<String> getResourceIds()

Specified by:

getResourceIds in interface MapPolicyEntity

addResourceId

public void addResourceId(String resourceId)

Specified by:

addResourceId in interface MapPolicyEntity

removeResourceId

public void removeResourceId(String resourceId)

Specified by:

removeResourceId in interface MapPolicyEntity

getScopeIds

public Set<String> getScopeIds()

Specified by:

getScopeIds in interface MapPolicyEntity

addScopeId

public void addScopeId(String scopeId)

Specified by:

addScopeId in interface MapPolicyEntity

removeScopeId

public void removeScopeId(String scopeId)

Specified by:

removeScopeId in interface MapPolicyEntity

getOwner

public String getOwner()

Specified by:

getOwner in interface MapPolicyEntity

setOwner

public void setOwner(String owner)

Specified by:

setOwner in interface MapPolicyEntity

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object