AbstractPolicy (WSO2 Balana Core 1.1.12 API)

java.lang.Object
- org.wso2.balana.AbstractPolicy

All Implemented Interfaces:

PolicyTreeElement

Direct Known Subclasses:

Policy, PolicyReference, PolicySet
```
public abstract class AbstractPolicy
extends Object
implements PolicyTreeElement
```
Represents an instance of an XACML policy.

Since:

1.0

Author:

Seth Proctor, Marco Barreno

Field Summary

Fields
Modifier and Type Field and Description

protected PolicyMetaData metaData

Fields
Modifier and Type	Field and Description
`protected PolicyMetaData`	`metaData`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractPolicy()` Constructor used by `PolicyReference`, which supplies its own values for the methods in this class.
`protected`	`AbstractPolicy(Node root, String policyPrefix, String combiningName)` Constructor used by child classes to initialize the shared data from a DOM root node.
`protected`	`AbstractPolicy(URI id, String version, CombiningAlgorithm combiningAlg, String description, AbstractTarget target)` Constructor used to create a policy from concrete components.
`protected`	`AbstractPolicy(URI id, String version, CombiningAlgorithm combiningAlg, String description, AbstractTarget target, String defaultVersion)` Constructor used to create a policy from concrete components.
`protected`	`AbstractPolicy(URI id, String version, CombiningAlgorithm combiningAlg, String description, AbstractTarget target, String defaultVersion, Set<AbstractObligation> obligationExpressions, Set<AdviceExpression> adviceExpressions, List<CombinerParameter> parameters)` Constructor used to create a policy from concrete components.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`encodeCommonElements(StringBuilder builder)` Encodes this `Obligation` into its XML form and writes this out to the provided `StringBuilder`
`AbstractResult`	`evaluate(EvaluationCtx context)` Tries to evaluate the policy by calling the combining algorithm on the given policies or rules.
`String`	`getActionPolicyValue()`
`Set`	`getAdviceExpressions()` Returns the Set of advice expressions for this policy, which may be empty
`List<CombinerElement>`	`getChildElements()` Returns the `List` of `CombinerElement`s that is provided to the combining algorithm.
`List<PolicyTreeElement>`	`getChildren()` Returns the `List` of children under this node in the policy tree.
`CombiningAlgorithm`	`getCombiningAlg()` Returns the combining algorithm used by this policy
`List`	`getCombiningParameters()` Returns the list of input parameters for the combining algorithm.
`String`	`getDefaultVersion()` Returns the XPath version to use or null if none was specified
`String`	`getDescription()` Returns the given description of this policy or null if there is no description
`String`	`getEnvPolicyValue()`
`URI`	`getId()` Returns the id of this policy
`PolicyMetaData`	`getMetaData()` Returns the meta-data associated with this policy
`Set`	`getObligationExpressions()` Returns the Set of obligations for this policy, which may be empty
`String`	`getResourcePolicyValue()`
`String`	`getSubjectPolicyValue()`
`AbstractTarget`	`getTarget()` Returns the target for this policy
`String`	`getVersion()` Returns the version of this policy.
`MatchResult`	`match(EvaluationCtx context)` Given the input context sees whether or not the request matches this policy.
`void`	`setActionPolicyValue(String actionPolicyValue)`
`protected void`	`setChildren(List<CombinerElement> children)` Sets the child policy tree elements for this node, which are passed to the combining algorithm on evaluation.
`void`	`setEnvPolicyValue(String envPolicyValue)`
`void`	`setResourcePolicyValue(String resourcePolicyValue)`
`void`	`setSubjectPolicyValue(String subjectPolicyValue)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.wso2.balana.PolicyTreeElement
encode, encode

- Field Detail
  - metaData
```
protected PolicyMetaData metaData
```
- Constructor Detail
  - AbstractPolicy
```
protected AbstractPolicy()
```
    Constructor used by PolicyReference, which supplies its own values for the methods in this class.
  - AbstractPolicy
```
protected AbstractPolicy(URI id,
                         String version,
                         CombiningAlgorithm combiningAlg,
                         String description,
                         AbstractTarget target)
```
    Constructor used to create a policy from concrete components.
    
    Parameters:
    
    id - the policy id
    
    version - the policy version or null for the default (this is always null for pre-2.0 policies)
    
    combiningAlg - the combining algorithm to use
    
    description - describes the policy or null if there is none
    
    target - the policy's target
  - AbstractPolicy
```
protected AbstractPolicy(URI id,
                         String version,
                         CombiningAlgorithm combiningAlg,
                         String description,
                         AbstractTarget target,
                         String defaultVersion)
```
    Constructor used to create a policy from concrete components.
    
    Parameters:
    
    id - the policy id
    
    version - the policy version or null for the default (this is always null for pre-2.0 policies)
    
    combiningAlg - the combining algorithm to use
    
    description - describes the policy or null if there is none
    
    target - the policy's target
    
    defaultVersion - the XPath version to use for selectors
  - AbstractPolicy
```
protected AbstractPolicy(URI id,
                         String version,
                         CombiningAlgorithm combiningAlg,
                         String description,
                         AbstractTarget target,
                         String defaultVersion,
                         Set<AbstractObligation> obligationExpressions,
                         Set<AdviceExpression> adviceExpressions,
                         List<CombinerParameter> parameters)
```
    Constructor used to create a policy from concrete components.
    
    Parameters:
    
    id - the policy id
    
    version - the policy version or null for the default (this is always null for pre-2.0 policies)
    
    combiningAlg - the combining algorithm to use
    
    description - describes the policy or null if there is none
    
    target - the policy's target
    
    defaultVersion - the XPath version to use for selectors
    
    obligationExpressions - the policy's ObligationExpressions
    
    adviceExpressions - the policy's advice expressions
    
    parameters - the policy's parameters
  - AbstractPolicy
```
protected AbstractPolicy(Node root,
                         String policyPrefix,
                         String combiningName)
                  throws ParsingException
```
    Constructor used by child classes to initialize the shared data from a DOM root node.
    
    Parameters:
    
    root - the DOM root of the policy
    
    policyPrefix - either "Policy" or "PolicySet"
    
    combiningName - name of the field naming the combining alg the XACML policy, if null use default factories
    
    Throws:
    
    ParsingException - if the policy is invalid
- Method Detail
  - getSubjectPolicyValue
```
public String getSubjectPolicyValue()
```
  - setSubjectPolicyValue
```
public void setSubjectPolicyValue(String subjectPolicyValue)
```
  - getResourcePolicyValue
```
public String getResourcePolicyValue()
```
  - setResourcePolicyValue
```
public void setResourcePolicyValue(String resourcePolicyValue)
```
  - getActionPolicyValue
```
public String getActionPolicyValue()
```
  - setActionPolicyValue
```
public void setActionPolicyValue(String actionPolicyValue)
```
  - getEnvPolicyValue
```
public String getEnvPolicyValue()
```
  - setEnvPolicyValue
```
public void setEnvPolicyValue(String envPolicyValue)
```
  - getId
```
public URI getId()
```
    Returns the id of this policy
    
    Specified by:
    
    getId in interface PolicyTreeElement
    
    Returns:
    
    the policy id
  - getVersion
```
public String getVersion()
```
    Returns the version of this policy. If this is an XACML 1.x policy then this will always return "1.0".
    
    Returns:
    
    the policy version
  - getCombiningAlg
```
public CombiningAlgorithm getCombiningAlg()
```
    Returns the combining algorithm used by this policy
    
    Returns:
    
    the combining algorithm
  - getCombiningParameters
```
public List getCombiningParameters()
```
    Returns the list of input parameters for the combining algorithm. If this is an XACML 1.x policy then the list will always be empty.
    
    Returns:
    
    a List of CombinerParameters
  - getDescription
```
public String getDescription()
```
    Returns the given description of this policy or null if there is no description
    
    Specified by:
    
    getDescription in interface PolicyTreeElement
    
    Returns:
    
    the description or null
  - getTarget
```
public AbstractTarget getTarget()
```
    Returns the target for this policy
    
    Specified by:
    
    getTarget in interface PolicyTreeElement
    
    Returns:
    
    the policy's target
  - getDefaultVersion
```
public String getDefaultVersion()
```
    Returns the XPath version to use or null if none was specified
    
    Returns:
    
    XPath version or null
  - getChildren
```
public List<PolicyTreeElement> getChildren()
```
    Returns the List of children under this node in the policy tree. Depending on what kind of policy this node represents the children will either be AbstractPolicy objects or Rules.
    
    Specified by:
    
    getChildren in interface PolicyTreeElement
    
    Returns:
    
    a List of child nodes
  - getChildElements
```
public List<CombinerElement> getChildElements()
```
    Returns the List of CombinerElements that is provided to the combining algorithm. This returns the same set of children that getChildren provides along with any associated combiner parameters.
    
    Returns:
    
    a List of CombinerElements
  - getObligationExpressions
```
public Set getObligationExpressions()
```
    Returns the Set of obligations for this policy, which may be empty
    
    Returns:
    
    the policy's obligations
  - getAdviceExpressions
```
public Set getAdviceExpressions()
```
    Returns the Set of advice expressions for this policy, which may be empty
    
    Returns:
    
    the policy's advice expressions
  - getMetaData
```
public PolicyMetaData getMetaData()
```
    Returns the meta-data associated with this policy
  - match
```
public MatchResult match(EvaluationCtx context)
```
    Given the input context sees whether or not the request matches this policy. This must be called by combining algorithms before they evaluate a policy. This is also used in the initial policy finding operation to determine which top-level policies might apply to the request.
    
    Specified by:
    
    match in interface PolicyTreeElement
    
    Parameters:
    
    context - the representation of the request
    
    Returns:
    
    the result of trying to match the policy and the request
  - setChildren
```
protected void setChildren(List<CombinerElement> children)
```
    Sets the child policy tree elements for this node, which are passed to the combining algorithm on evaluation. The List must contain CombinerElements, which in turn will contain Rules or AbstractPolicys, but may not contain both types of elements.
    
    Parameters:
    
    children - a List of CombinerElements representing the child elements used by the combining algorithm
  - evaluate
```
public AbstractResult evaluate(EvaluationCtx context)
```
    Tries to evaluate the policy by calling the combining algorithm on the given policies or rules. The match method must always be called first, and must always return MATCH, before this method is called.
    
    Specified by:
    
    evaluate in interface PolicyTreeElement
    
    Parameters:
    
    context - the representation of the request
    
    Returns:
    
    the result of evaluation
  - encodeCommonElements
```
protected void encodeCommonElements(StringBuilder builder)
```
    Encodes this Obligation into its XML form and writes this out to the provided StringBuilder
    Parameters: builder - string stream into which the XML-encoded data is written

Class AbstractPolicy

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.wso2.balana.PolicyTreeElement

Field Detail

metaData

Constructor Detail

AbstractPolicy

AbstractPolicy

AbstractPolicy

AbstractPolicy

AbstractPolicy

Method Detail

getSubjectPolicyValue

setSubjectPolicyValue

getResourcePolicyValue

setResourcePolicyValue

getActionPolicyValue

setActionPolicyValue

getEnvPolicyValue

setEnvPolicyValue

getId

getVersion

getCombiningAlg

getCombiningParameters

getDescription

getTarget

getDefaultVersion

getChildren

getChildElements

getObligationExpressions

getAdviceExpressions

getMetaData

match

setChildren

evaluate

encodeCommonElements