/*
* @(#)PolicySet.java
*
* Copyright 2003-2005 Sun Microsystems, Inc. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistribution of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistribution in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* Neither the name of Sun Microsystems, Inc. or the names of contributors may
* be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* This software is provided "AS IS," without a warranty of any kind. ALL
* EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING
* ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
* OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN MICROSYSTEMS, INC. ("SUN")
* AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE
* AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
* DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR ANY LOST
* REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL,
* INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY
* OF LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE,
* EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
*
* You acknowledge that this software is not designed or intended for use in
* the design, construction, operation or maintenance of any nuclear facility.
*/
package com.sun.xacml;
import java.io.OutputStream;
import java.io.PrintStream;
import java.net.URI;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Set;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import com.sun.xacml.combine.CombinerElement;
import com.sun.xacml.combine.CombinerParameter;
import com.sun.xacml.combine.PolicyCombinerElement;
import com.sun.xacml.combine.PolicyCombiningAlgorithm;
import com.sun.xacml.finder.PolicyFinder;
/**
* Represents one of the two top-level constructs in XACML, the PolicySetType. This can contain
* other policies and policy sets, and can also contain URIs that point to policies and policy sets.
*
* @since 1.0
* @author Seth Proctor
*/
public class PolicySet extends AbstractPolicy {
/**
* Creates a new <code>PolicySet</code> with only the required elements.
*
* @param id
* the policy set identifier
* @param combiningAlg
* the <code>CombiningAlgorithm</code> used on the policies in this set
* @param target
* the <code>Target</code> for this set
*/
public PolicySet(URI id, PolicyCombiningAlgorithm combiningAlg, Target target) {
this(id, null, combiningAlg, null, target, null, null, null);
}
/**
* Creates a new <code>PolicySet</code> with only the required elements, plus some policies.
*
* @param id
* the policy set identifier
* @param combiningAlg
* the <code>CombiningAlgorithm</code> used on the policies in this set
* @param target
* the <code>Target</code> for this set
* @param policies
* a list of <code>AbstractPolicy</code> objects
*
* @throws IllegalArgumentException
* if the <code>List</code> of policies contains an object that is not an
* <code>AbstractPolicy</code>
*/
public PolicySet(URI id, PolicyCombiningAlgorithm combiningAlg, Target target,
List<AbstractPolicy> policies) {
this(id, null, combiningAlg, null, target, policies, null, null);
}
/**
* Creates a new <code>PolicySet</code> with the required elements plus some policies and a
* String description.
*
* @param id
* the policy set identifier
* @param version
* the policy version or null for the default (this is always null for pre-2.0
* policies)
* @param combiningAlg
* the <code>CombiningAlgorithm</code> used on the policies in this set
* @param description
* a <code>String</code> describing the policy
* @param target
* the <code>Target</code> for this set
* @param policies
* a list of <code>AbstractPolicy</code> objects
*
* @throws IllegalArgumentException
* if the <code>List</code> of policies contains an object that is not an
* <code>AbstractPolicy</code>
*/
public PolicySet(URI id, String version, PolicyCombiningAlgorithm combiningAlg,
String description, Target target, List<AbstractPolicy> policies) {
this(id, version, combiningAlg, description, target, policies, null, null);
}
/**
* Creates a new <code>PolicySet</code> with the required elements plus some policies, a String
* description, and policy defaults.
*
* @param id
* the policy set identifier
* @param version
* the policy version or null for the default (this is always null for pre-2.0
* policies)
* @param combiningAlg
* the <code>CombiningAlgorithm</code> used on the policies in this set
* @param description
* a <code>String</code> describing the policy
* @param target
* the <code>Target</code> for this set
* @param policies
* a list of <code>AbstractPolicy</code> objects
* @param defaultVersion
* the XPath version to use
*
* @throws IllegalArgumentException
* if the <code>List</code> of policies contains an object that is not an
* <code>AbstractPolicy</code>
*/
public PolicySet(URI id, String version, PolicyCombiningAlgorithm combiningAlg,
String description, Target target, List<AbstractPolicy> policies, String defaultVersion) {
this(id, version, combiningAlg, description, target, policies, defaultVersion, null);
}
/**
* Creates a new <code>PolicySet</code> with the required elements plus some policies, a String
* description, policy defaults, and obligations.
*
* @param id
* the policy set identifier
* @param version
* the policy version or null for the default (this is always null for pre-2.0
* policies)
* @param combiningAlg
* the <code>CombiningAlgorithm</code> used on the policies in this set
* @param description
* a <code>String</code> describing the policy
* @param target
* the <code>Target</code> for this set
* @param policies
* a list of <code>AbstractPolicy</code> objects
* @param defaultVersion
* the XPath version to use
* @param obligations
* a set of <code>Obligation</code> objects
*
* @throws IllegalArgumentException
* if the <code>List</code> of policies contains an object that is not an
* <code>AbstractPolicy</code>
*/
public PolicySet(URI id, String version, PolicyCombiningAlgorithm combiningAlg,
String description, Target target, List<AbstractPolicy> policies,
String defaultVersion, Set<Obligation> obligations) {
super(id, version, combiningAlg, description, target, defaultVersion, obligations, null);
List<PolicyCombinerElement> list = null;
// check that the list contains only AbstractPolicy objects
if (policies != null) {
list = new ArrayList<PolicyCombinerElement>();
for (AbstractPolicy p : policies)
list.add(new PolicyCombinerElement(p));
}
setChildren(list);
}
/**
* Creates a new <code>PolicySet</code> with the required and optional elements. If you need to
* provide combining algorithm parameters, you need to use this constructor. Note that unlike
* the other constructors in this class, the policies list is actually a list of
* <code>CombinerElement</code>s used to match a policy with any combiner parameters it may
* have.
*
* @param id
* the policy set identifier
* @param version
* the policy version or null for the default (this is always null for pre-2.0
* policies)
* @param combiningAlg
* the <code>CombiningAlgorithm</code> used on the rules in this set
* @param description
* a <code>String</code> describing the policy or null if there is no description
* @param target
* the <code>Target</code> for this policy
* @param policyElements
* a list of <code>CombinerElement</code> objects or null if there are no policies
* @param defaultVersion
* the XPath version to use or null if there is no default version
* @param obligations
* a set of <code>Obligations</code> objects or null if there are no obligations
* @param parameters
* the <code>List</code> of <code>CombinerParameter</code>s provided for general use
* by the combining algorithm
*
* @throws IllegalArgumentException
* if the <code>List</code> of rules contains an object that is not a
* <code>Rule</code>
*/
public PolicySet(URI id, String version, PolicyCombiningAlgorithm combiningAlg,
String description, Target target, List<CombinerElement> policyElements,
String defaultVersion, Set<Obligation> obligations, List<CombinerParameter> parameters) {
super(id, version, combiningAlg, description, target, defaultVersion, obligations,
parameters);
setChildren(policyElements);
}
/**
* Creates a new PolicySet based on the given root node. This is private since every class is
* supposed to use a getInstance() method to construct from a Node, but since we want some
* common code in the parent class, we need this functionality in a constructor.
*/
private PolicySet(Node root, PolicyFinder finder) throws ParsingException {
super(root, "PolicySet", "PolicyCombiningAlgId");
List<AbstractPolicy> policies = new ArrayList<AbstractPolicy>();
HashMap<String, List<CombinerParameter>> policyParameters = new HashMap<String, List<CombinerParameter>>();
HashMap<String, List<CombinerParameter>> policySetParameters = new HashMap<String, List<CombinerParameter>>();
PolicyMetaData metaData = getMetaData();
// collect the PolicySet-specific elements
NodeList children = root.getChildNodes();
for (int i = 0; i < children.getLength(); i++) {
Node child = children.item(i);
String name = child.getNodeName();
if (name.equals("PolicySet")) {
policies.add(PolicySet.getInstance(child, finder));
} else if (name.equals("Policy")) {
policies.add(Policy.getInstance(child));
} else if (name.equals("PolicySetIdReference")) {
policies.add(PolicyReference.getInstance(child, finder, metaData));
} else if (name.equals("PolicyIdReference")) {
policies.add(PolicyReference.getInstance(child, finder, metaData));
} else if (name.equals("PolicyCombinerParameters")) {
paramaterHelper(policyParameters, child, "Policy");
} else if (name.equals("PolicySetCombinerParameters")) {
paramaterHelper(policySetParameters, child, "PolicySet");
}
}
// now make sure that we can match up any parameters we may have
// found to a cooresponding Policy or PolicySet...
List<CombinerElement> elements = new ArrayList<CombinerElement>();
// right now we have to go though each policy and based on several
// possible cases figure out what paranmeters might apply...but
// there should be a better way to do this
for (AbstractPolicy policy : policies) {
List<CombinerParameter> list = null;
if (policy instanceof Policy) {
list = policyParameters.remove(policy.getId().toString());
} else if (policy instanceof PolicySet) {
list = policySetParameters.remove(policy.getId().toString());
} else {
PolicyReference ref = (PolicyReference) policy;
String id = ref.getReference().toString();
if (ref.getReferenceType() == PolicyReference.POLICY_REFERENCE)
list = policyParameters.remove(id);
else
list = policySetParameters.remove(id);
}
elements.add(new PolicyCombinerElement(policy, list));
}
// ...and that there aren't extra parameters
if (!policyParameters.isEmpty())
throw new ParsingException("Unmatched parameters in Policy");
if (!policySetParameters.isEmpty())
throw new ParsingException("Unmatched parameters in PolicySet");
// finally, set the list of Rules
setChildren(elements);
}
/**
* Private helper method that handles parsing a collection of parameters
*/
private void paramaterHelper(HashMap<String, List<CombinerParameter>> parameters, Node root,
String prefix) throws ParsingException {
String ref = root.getAttributes().getNamedItem(prefix + "IdRef").getNodeValue();
if (parameters.containsKey(ref)) {
List<CombinerParameter> list = parameters.get(ref);
parseParameters(list, root);
} else {
List<CombinerParameter> list = new ArrayList<CombinerParameter>();
parseParameters(list, root);
parameters.put(ref, list);
}
}
/**
* Private helper method that handles parsing a single parameter.
*/
private void parseParameters(List<CombinerParameter> parameters, Node root)
throws ParsingException {
NodeList nodes = root.getChildNodes();
for (int i = 0; i < nodes.getLength(); i++) {
Node node = nodes.item(i);
if (node.getNodeName().equals("CombinerParameter"))
parameters.add(CombinerParameter.getInstance(node));
}
}
/**
* Creates an instance of a <code>PolicySet</code> object based on a DOM node. The node must be
* the root of PolicySetType XML object, otherwise an exception is thrown. This
* <code>PolicySet</code> will not support references because it has no
* <code>PolicyFinder</code>.
*
* @param root
* the DOM root of a PolicySetType XML type
*
* @throws ParsingException
* if the PolicySetType is invalid
*/
public static PolicySet getInstance(Node root) throws ParsingException {
return getInstance(root, null);
}
/**
* Creates an instance of a <code>PolicySet</code> object based on a DOM node. The node must be
* the root of PolicySetType XML object, otherwise an exception is thrown. The finder is used to
* handle policy references.
*
* @param root
* the DOM root of a PolicySetType XML type
* @param finder
* the <code>PolicyFinder</code> used to handle references
*
* @throws ParsingException
* if the PolicySetType is invalid
*/
public static PolicySet getInstance(Node root, PolicyFinder finder) throws ParsingException {
// first off, check that it's the right kind of node
if (!root.getNodeName().equals("PolicySet")) {
throw new ParsingException("Cannot create PolicySet from root of" + " type "
+ root.getNodeName());
}
return new PolicySet(root, finder);
}
/**
* Encodes this <code>PolicySet</code> into its XML representation and writes this encoding to
* the given <code>OutputStream</code> with no indentation.
*
* @param output
* a stream into which the XML-encoded data is written
*/
public void encode(OutputStream output) {
encode(output, new Indenter(0));
}
/**
* Encodes this <code>PolicySet</code> into its XML representation and writes this encoding to
* the given <code>OutputStream</code> with indentation.
*
* @param output
* a stream into which the XML-encoded data is written
* @param indenter
* an object that creates indentation strings
*/
public void encode(OutputStream output, Indenter indenter) {
PrintStream out = new PrintStream(output);
String indent = indenter.makeString();
out.println(indent + "<PolicySet PolicySetId=\"" + getId().toString()
+ "\" PolicyCombiningAlgId=\"" + getCombiningAlg().getIdentifier().toString()
+ "\">");
indenter.in();
String nextIndent = indenter.makeString();
String description = getDescription();
if (description != null)
out.println(nextIndent + "<Description>" + description + "</Description>");
String version = getDefaultVersion();
if (version != null)
out.println("<PolicySetDefaults><XPathVersion>" + version
+ "</XPathVersion></PolicySetDefaults>");
getTarget().encode(output, indenter);
encodeCommonElements(output, indenter);
indenter.out();
out.println(indent + "</PolicySet>");
}
}