policy/impl/ObligationImpl.java

a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of the Common Development and Distribution License
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * (the License). You may not use this file except in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * compliance with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * opensso/legal/CDDLv1.0.txt
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * at opensso/legal/CDDLv1.0.txt.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If applicable, add the following below the CDDL Header,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with the fields enclosed by brackets [] replaced by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * your own identifying information:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: ObligationImpl.java,v 1.3 2008/11/10 22:57:06 veiming Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage com.sun.identity.xacml.policy.impl;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.xml.XMLUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLSDKUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.policy.Obligation;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.net.URI;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.ArrayList;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.Iterator;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.List;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.Document;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.Element;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.NamedNodeMap;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.Node;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.NodeList;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The <code>Obligation</code> element is a container of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * one or more <code>AttributeAssignment</code>s issuded by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * authorization authority.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <pre>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *   &lt;xs:element name="Obligation" type="xacml:ObligationType"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *      &lt;xs:complexType name="ObligationType">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *          &lt;xs:sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *              &lt;xs:element ref="xacml:AttributeAssignment" minOccurs="0"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *                  maxOccurs="unbounded"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *              &lt;/xs:sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *              &lt;xs:attribute name="ObligationId" type="xs:anyURI"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *                  use="required"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *              &lt;xs:attribute name="FulfillOn" type="xacml:EffectType"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *                  use="required"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *          &lt;/xs:complexType>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *   &lt;/xs:element>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </pre>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class ObligationImpl implements Obligation {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    // AttributeAssignment rquires AttributeId and DataType
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private URI obligationId = null; //required
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private String fulfillOn = null; //optional
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private List attributeAssignments = null; //required
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private boolean mutable = true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Default constructor
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public ObligationImpl() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * This constructor is used to build <code>Obligation</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * from an XML string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param xml  a <code>String</code> representation of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * <code>Obligation</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @exception XACMLException if it could not process the XML string
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public ObligationImpl(String xml) throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        Document document = XMLUtils.toDOMDocument(xml, XACMLSDKUtils.debug);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (document != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            Element rootElement = document.getDocumentElement();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            processElement(rootElement);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            makeImmutable();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            XACMLSDKUtils.debug.error(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "ObligationImpl.processElement(): invalid XML input");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new XACMLException(XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "errorObtainingElement"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * This constructor is used to build <code>ObligationImpl</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * from a  block of existing XML that has already been built into a DOM.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param element  DOM tree for <code>Request</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @exception XACML2Exception if it could not process the Element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public ObligationImpl(Element element) throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        processElement(element);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        makeImmutable();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private void processElement(Element element) throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String value = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (element == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            XACMLSDKUtils.debug.error(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "ObligationImpl.processElement(): invalid root element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new XACMLException( XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "invalid_element"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      // First check that we're really parsing an Obligation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      if (! element.getLocalName().equals(XACMLConstants.OBLIGATION)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            XACMLSDKUtils.debug.error(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "ObligationImpl.processElement(): invalid root element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new XACMLException( XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "invalid_element"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      NamedNodeMap attrs = element.getAttributes();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      try {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          obligationId = new URI(attrs.getNamedItem(XACMLConstants.OBLIGATION_ID)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                .getNodeValue());
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      } catch (Exception e) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new XACMLException( XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "attribute_not_uri"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      if (obligationId == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new XACMLException( XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "attribute_missing"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      try {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          fulfillOn = attrs.getNamedItem(XACMLConstants.FULFILL_ON)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                .getNodeValue();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      } catch (Exception e) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new XACMLException( XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "error_parsing_attribute"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      // now we get the AttributeAssignment(s)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      // AttributeAssignment requires AttributeId and DataType
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      NodeList nodes = element.getChildNodes();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      for (int i = 0; i < nodes.getLength(); i++) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          Node node = nodes.item(i);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          if ((node.getNodeType() == Node.ELEMENT_NODE) ) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster              if (node.getLocalName().equals(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        XACMLConstants.ATTRIBUTE_ASSIGNMENT)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                  if (attributeAssignments == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                      attributeAssignments = new ArrayList();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                  }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                  Element aa = (Element)node;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                  // aa should have attributes AtributeId, DataType
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                  String aid = aa.getAttribute(XACMLConstants.ATTRIBUTE_ID);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                  if ((aid == null) || (aid.length() == 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        throw new XACMLException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            "missing_attribute"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                  }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                  String dt = aa.getAttribute(XACMLConstants.DATA_TYPE);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                  if ((dt == null) || (dt.length() == 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        throw new XACMLException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            "missing_attribute"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                  }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                  attributeAssignments.add(aa);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster              } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    throw new XACMLException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        "missing_element"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster              }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns the ObligationId of this <code>Obligation</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return the <code>URI</code> representing ObligationId of this
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * <code>Obligation</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public URI getObligationId() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return obligationId;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets the ObligationId of the <code>Obligation</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param obligationId <code>URI</code> representing the ObligationId.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @exception XACMLException if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setObligationId(URI obligationId)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.obligationId = obligationId;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns the FullFillOn effect type of this obligation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return the FullFillOn effect type of this obligation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String getFulfillOn() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return fulfillOn;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets the FullFillOn effect type of this obligation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param fulfillOn FullFillOn effect type of this obligation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setFulfillOn(String fulfillOn)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.fulfillOn = fulfillOn;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns XML elements corresponding to
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * <code>AttributeAssignment</code> elements for  this obligation.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return the XML elements corresponding to
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * <code>AttributeAssignment</code> elements for  this obligation.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public List getAttributeAssignments() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return attributeAssignments;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets XML elements corresponding to
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * <code>AttributeAssignment</code> elements for  this obligation.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param attributeAssignments XML elements corresponding to
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * <code>AttributeAssignment</code> elements for  this obligation.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setAttributeAssignments(List attributeAssignments)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      if (attributeAssignments == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          return;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      Iterator iter = attributeAssignments.iterator();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      while (iter.hasNext()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          Object obj = iter.next();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          if (!(obj instanceof Element)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                throw new XACMLException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    "not_xml_element"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          Element elem = (Element)obj;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          String aid = elem.getAttribute(XACMLConstants.ATTRIBUTE_ID);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          if ((aid == null) || (aid.length() == 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                throw new XACMLException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    "missing_attribute"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          String dt = elem.getAttribute(XACMLConstants.DATA_TYPE);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          if ((dt == null) || (dt.length() == 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                throw new XACMLException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    "missing_attribute"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      this.attributeAssignments = attributeAssignments;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster   /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * Returns a string representation of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * @param includeNSPrefix Determines whether or not the namespace qualifier
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    *        is prepended to the Element when converted
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * @param declareNS Determines whether or not the namespace is declared
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    *        within the Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * @return a string representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * @exception XACMLException if conversion fails for any reason
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String toXMLString(boolean includeNSPrefix, boolean declareNS)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        StringBuffer sb = new StringBuffer(2000);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String nsPrefix = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String nsDeclaration = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (includeNSPrefix) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            nsPrefix = XACMLConstants.XACML_NS_PREFIX + ":";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (declareNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            nsDeclaration = XACMLConstants.XACML_NS_DECLARATION;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        sb.append("<").append(nsPrefix)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                .append(XACMLConstants.OBLIGATION);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(declareNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            sb.append(" ").append(nsDeclaration);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (obligationId != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            sb.append(" ").append(XACMLConstants.OBLIGATION_ID).append("=")
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                .append(XACMLSDKUtils.quote(obligationId.toString()));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (fulfillOn != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            sb.append(" ").append(XACMLConstants.FULFILL_ON).append("=")
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                .append(XACMLSDKUtils.quote(fulfillOn));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        sb.append(">\n");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        int length = 0;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (attributeAssignments != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            length = attributeAssignments.size();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            for (int i = 0; i < length; i++) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                Element elem = (Element)attributeAssignments.get(i);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                sb.append(XMLUtils.print(elem));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        sb.append("</").append(nsPrefix)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                .append(XACMLConstants.OBLIGATION).append(">\n");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return sb.toString();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster   /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * Returns a string representation of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * @return a string representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * @exception XACMLException if conversion fails for any reason
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String toXMLString() throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return toXMLString(true, true);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster   /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * Makes this object immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void makeImmutable() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        mutable = false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster   /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * Checks if this object is mutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * @return <code>true</code> if the object is mutable,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    *         <code>false</code> otherwise
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public boolean isMutable() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return mutable;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster}