org.jboss.security.xacml.sunxacml.combine
Class CombinerElement

java.lang.Object
  org.jboss.security.xacml.sunxacml.combine.CombinerElement

Direct Known Subclasses:

PolicyCombinerElement, RuleCombinerElement

public abstract class CombinerElement
extends Object

Represents one input (a Rule, Policy, PolicySet, or reference) to a combining algorithm and combiner parameters associated with that input.

Since:

2.0

Author:

Seth Proctor

Constructor Summary

CombinerElement(PolicyTreeElement element)
Constructor that only takes an element.

CombinerElement(PolicyTreeElement element, List parameters)
Constructor that takes both the element to combine and its associated combiner parameters.

Method Summary

abstract void	encode(OutputStream output, Indenter indenter) Encodes the element and parameters in this CombinerElement into their XML representation and writes this encoding to the given OutputStream with indentation.
PolicyTreeElement	getElement() Returns the PolicyTreeElement in this element.
List	getParameters() Returns the CombinerParameters associated with this element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CombinerElement

public CombinerElement(PolicyTreeElement element)

Constructor that only takes an element. No parameters are associated with this element when combining.

Parameters:

element - a PolicyTreeElement to use in combining

CombinerElement

public CombinerElement(PolicyTreeElement element,
                       List parameters)

Constructor that takes both the element to combine and its associated combiner parameters.

Parameters:

element - a PolicyTreeElement to use in combining

parameters - a (possibly empty) non-null List of CombinerParameters provided for general use (for all pre-2.0 policies this must be empty)

Method Detail

getElement

public PolicyTreeElement getElement()

Returns the PolicyTreeElement in this element.

Returns:

the PolicyTreeElement

getParameters

public List getParameters()

Returns the CombinerParameters associated with this element.

Returns:

a List of CombinerParameters

encode

public abstract void encode(OutputStream output,
                            Indenter indenter)

Encodes the element and parameters in this CombinerElement into their XML representation and writes this encoding to the given OutputStream with indentation.

Parameters:

output - a stream into which the XML-encoded data is written

indenter - an object that creates indentation strings