Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.sun.xacml
Interface PolicyTreeElement  view PolicyTreeElement download PolicyTreeElement.java

All Known Implementing Classes:
AbstractPolicy, Rule

public interface PolicyTreeElement

This represents a single node in a policy tree. A node is either a policy set, a policy, or a rule. This interface is used to interact with these node types in a general way. Note that rules are leaf nodes in a policy tree as they never contain children.

Since:
1.1

Method Summary
 void encode(java.io.OutputStream output)
          Encodes this element into its XML representation and writes this encoding to the given OutputStream with no indentation.
 void encode(java.io.OutputStream output, Indenter indenter)
          Encodes this element into its XML representation and writes this encoding to the given OutputStream with indentation.
 com.sun.xacml.ctx.Result evaluate(EvaluationCtx context)
          Evaluates this element in the policy tree, and therefore all elements underneath this element.
 java.util.List getChildren()
          Returns the List of PolicyTreeElement objects that are the children of this node.
 java.lang.String getDescription()
          Returns the given description of this element or null if there is no description
 java.net.URI getId()
          Returns the id of this element
 Target getTarget()
          Returns the target for this element or null if there is no target
 MatchResult match(EvaluationCtx context)
          Given the input context sees whether or not the request matches this element's target.
 

Method Detail

getChildren

public java.util.List getChildren()
Returns the List of PolicyTreeElement objects that are the children of this node. If this node has no children then this list is empty. The children are returned as a List instead of some unordered collection because in cases like combining or evaluation the order is often important.


getDescription

public java.lang.String getDescription()
Returns the given description of this element or null if there is no description


getId

public java.net.URI getId()
Returns the id of this element


getTarget

public Target getTarget()
Returns the target for this element or null if there is no target


match

public MatchResult match(EvaluationCtx context)
Given the input context sees whether or not the request matches this element's target. The rules for matching are different depending on the type of element being matched.


evaluate

public com.sun.xacml.ctx.Result evaluate(EvaluationCtx context)
Evaluates this element in the policy tree, and therefore all elements underneath this element. The rules for evaluation are different depending on the type of element being evaluated.


encode

public void encode(java.io.OutputStream output)
Encodes this element into its XML representation and writes this encoding to the given OutputStream with no indentation.


encode

public void encode(java.io.OutputStream output,
                   Indenter indenter)
Encodes this element into its XML representation and writes this encoding to the given OutputStream with indentation.