Class PolicyAdapter
- java.lang.Object
-
- org.keycloak.authorization.model.AbstractAuthorizationModel
-
- org.keycloak.authorization.jpa.store.PolicyAdapter
-
- All Implemented Interfaces:
Policy
,JpaModel<PolicyEntity>
public class PolicyAdapter extends AbstractAuthorizationModel implements Policy, JpaModel<PolicyEntity>
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.keycloak.authorization.model.Policy
Policy.FilterOption, Policy.SearchableFields
-
-
Field Summary
-
Fields inherited from interface org.keycloak.authorization.model.Policy
CONFIG_SEPARATOR
-
-
Constructor Summary
Constructors Constructor Description PolicyAdapter(PolicyEntity entity, javax.persistence.EntityManager em, StoreFactory storeFactory)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAssociatedPolicy(Policy associatedPolicy)
void
addResource(Resource resource)
void
addScope(Scope scope)
boolean
equals(Object o)
Set<Policy>
getAssociatedPolicies()
Returns thePolicy
instances associated with this policy and used to evaluate authorization decisions when this policy applies.Map<String,String>
getConfig()
Returns aMap
holding string-based key/value pairs representing any additional configuration for this policy.DecisionStrategy
getDecisionStrategy()
Returns theDecisionStrategy
for this policy.String
getDescription()
Returns the description of this policy.PolicyEntity
getEntity()
String
getId()
Returns the unique identifier for this instance.Logic
getLogic()
Returns theLogic
for this policy.String
getName()
Returns the name of this policy.String
getOwner()
Set<Resource>
getResources()
Returns theResource
instances where this policy applies.ResourceServer
getResourceServer()
Returns theResourceServer
where this policy belongs to.Set<Scope>
getScopes()
Returns theScope
instances where this policy applies.String
getType()
Returns the type of this policy.int
hashCode()
void
putConfig(String name, String value)
void
removeAssociatedPolicy(Policy associatedPolicy)
void
removeConfig(String name)
void
removeResource(Resource resource)
void
removeScope(Scope scope)
void
setConfig(Map<String,String> config)
Sets aMap
with string-based key/value pairs representing any additional configuration for this policy.void
setDecisionStrategy(DecisionStrategy decisionStrategy)
Sets the {DecisionStrategy} for this policy.void
setDescription(String description)
Sets the description for this policy.void
setLogic(Logic logic)
Sets the {Logic} for this policy.void
setName(String name)
Sets an unique name to this policy.void
setOwner(String owner)
static PolicyEntity
toEntity(javax.persistence.EntityManager em, Policy policy)
-
Methods inherited from class org.keycloak.authorization.model.AbstractAuthorizationModel
throwExceptionIfReadonly
-
-
-
-
Constructor Detail
-
PolicyAdapter
public PolicyAdapter(PolicyEntity entity, javax.persistence.EntityManager em, StoreFactory storeFactory)
-
-
Method Detail
-
getEntity
public PolicyEntity getEntity()
- Specified by:
getEntity
in interfaceJpaModel<PolicyEntity>
-
getId
public String getId()
Description copied from interface:Policy
Returns the unique identifier for this instance.
-
getType
public String getType()
Description copied from interface:Policy
Returns the type of this policy.
-
getDecisionStrategy
public DecisionStrategy getDecisionStrategy()
Description copied from interface:Policy
Returns theDecisionStrategy
for this policy.- Specified by:
getDecisionStrategy
in interfacePolicy
- Returns:
- the decision strategy defined for this policy
-
setDecisionStrategy
public void setDecisionStrategy(DecisionStrategy decisionStrategy)
Description copied from interface:Policy
Sets the {DecisionStrategy} for this policy.- Specified by:
setDecisionStrategy
in interfacePolicy
- Parameters:
decisionStrategy
- for this policy
-
getLogic
public Logic getLogic()
Description copied from interface:Policy
Returns theLogic
for this policy.
-
setLogic
public void setLogic(Logic logic)
Description copied from interface:Policy
Sets the {Logic} for this policy.
-
getConfig
public Map<String,String> getConfig()
Description copied from interface:Policy
Returns aMap
holding string-based key/value pairs representing any additional configuration for this policy.
-
setConfig
public void setConfig(Map<String,String> config)
Description copied from interface:Policy
Sets aMap
with string-based key/value pairs representing any additional configuration for this policy.
-
removeConfig
public void removeConfig(String name)
- Specified by:
removeConfig
in interfacePolicy
-
getName
public String getName()
Description copied from interface:Policy
Returns the name of this policy.
-
setName
public void setName(String name)
Description copied from interface:Policy
Sets an unique name to this policy.
-
getDescription
public String getDescription()
Description copied from interface:Policy
Returns the description of this policy.- Specified by:
getDescription
in interfacePolicy
- Returns:
- a description or null of there is no description
-
setDescription
public void setDescription(String description)
Description copied from interface:Policy
Sets the description for this policy.- Specified by:
setDescription
in interfacePolicy
- Parameters:
description
- a description
-
getResourceServer
public ResourceServer getResourceServer()
Description copied from interface:Policy
Returns theResourceServer
where this policy belongs to.- Specified by:
getResourceServer
in interfacePolicy
- Returns:
- a resource server
-
getAssociatedPolicies
public Set<Policy> getAssociatedPolicies()
Description copied from interface:Policy
Returns thePolicy
instances associated with this policy and used to evaluate authorization decisions when this policy applies.- Specified by:
getAssociatedPolicies
in interfacePolicy
- Returns:
- the associated policies or an empty set if no policy is associated with this policy
-
getResources
public Set<Resource> getResources()
Description copied from interface:Policy
Returns theResource
instances where this policy applies.- Specified by:
getResources
in interfacePolicy
- Returns:
- a set with all resource instances where this policy applies. Or an empty set if there is no resource associated with this policy
-
getScopes
public Set<Scope> getScopes()
Description copied from interface:Policy
Returns theScope
instances where this policy applies.
-
removeScope
public void removeScope(Scope scope)
- Specified by:
removeScope
in interfacePolicy
-
addAssociatedPolicy
public void addAssociatedPolicy(Policy associatedPolicy)
- Specified by:
addAssociatedPolicy
in interfacePolicy
-
removeAssociatedPolicy
public void removeAssociatedPolicy(Policy associatedPolicy)
- Specified by:
removeAssociatedPolicy
in interfacePolicy
-
addResource
public void addResource(Resource resource)
- Specified by:
addResource
in interfacePolicy
-
removeResource
public void removeResource(Resource resource)
- Specified by:
removeResource
in interfacePolicy
-
toEntity
public static PolicyEntity toEntity(javax.persistence.EntityManager em, Policy policy)
-
-