Package org.keycloak.authorization.model
Interface Policy
-
- All Known Implementing Classes:
AbstractPolicyModel
,MapPolicyAdapter
,PolicyAdapter
,PolicyAdapter
public interface Policy
Represents an authorization policy and all the configuration associated with it.- Author:
- Pedro Igor
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Policy.FilterOption
static class
Policy.SearchableFields
-
Field Summary
Fields Modifier and Type Field Description static String
CONFIG_SEPARATOR
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addAssociatedPolicy(Policy associatedPolicy)
void
addResource(Resource resource)
void
addScope(Scope scope)
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.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.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)
-
-
-
Field Detail
-
CONFIG_SEPARATOR
static final String CONFIG_SEPARATOR
- See Also:
- Constant Field Values
-
-
Method Detail
-
getId
String getId()
Returns the unique identifier for this instance.- Returns:
- the unique identifier for this instance
-
getType
String getType()
Returns the type of this policy.- Returns:
- the type of this policy
-
getDecisionStrategy
DecisionStrategy getDecisionStrategy()
Returns theDecisionStrategy
for this policy.- Returns:
- the decision strategy defined for this policy
-
setDecisionStrategy
void setDecisionStrategy(DecisionStrategy decisionStrategy)
Sets the {DecisionStrategy} for this policy.- Parameters:
decisionStrategy
- for this policy
-
getLogic
Logic getLogic()
Returns theLogic
for this policy.- Returns:
- the decision strategy defined for this policy
-
setLogic
void setLogic(Logic logic)
Sets the {Logic} for this policy.- Parameters:
logic
- for this policy
-
getConfig
Map<String,String> getConfig()
Returns aMap
holding string-based key/value pairs representing any additional configuration for this policy.- Returns:
- a unmodifiable map with any additional configuration defined for this policy.
-
setConfig
void setConfig(Map<String,String> config)
Sets aMap
with string-based key/value pairs representing any additional configuration for this policy.- Parameters:
config
- a map with any additional configuration for this policy.
-
removeConfig
void removeConfig(String name)
-
getName
String getName()
Returns the name of this policy.- Returns:
- the name of this policy
-
setName
void setName(String name)
Sets an unique name to this policy.- Parameters:
name
- an unique name
-
getDescription
String getDescription()
Returns the description of this policy.- Returns:
- a description or null of there is no description
-
setDescription
void setDescription(String description)
Sets the description for this policy.- Parameters:
description
- a description
-
getResourceServer
ResourceServer getResourceServer()
Returns theResourceServer
where this policy belongs to.- Returns:
- a resource server
-
getAssociatedPolicies
Set<Policy> getAssociatedPolicies()
Returns thePolicy
instances associated with this policy and used to evaluate authorization decisions when this policy applies.- Returns:
- the associated policies or an empty set if no policy is associated with this policy
-
getResources
Set<Resource> getResources()
Returns theResource
instances where this policy applies.- 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
Set<Scope> getScopes()
Returns theScope
instances where this policy applies.- Returns:
- a set with all scope instances where this policy applies. Or an empty set if there is no scope associated with this policy
-
getOwner
String getOwner()
-
setOwner
void setOwner(String owner)
-
addScope
void addScope(Scope scope)
-
removeScope
void removeScope(Scope scope)
-
addAssociatedPolicy
void addAssociatedPolicy(Policy associatedPolicy)
-
removeAssociatedPolicy
void removeAssociatedPolicy(Policy associatedPolicy)
-
addResource
void addResource(Resource resource)
-
removeResource
void removeResource(Resource resource)
-
-