context/impl/EnvironmentImpl.java

a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2007 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: EnvironmentImpl.java,v 1.3 2008/06/25 05:48:13 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage com.sun.identity.xacml.context.impl;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLSDKUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.context.Environment;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.context.Attribute;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.context.ContextFactory;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.xml.XMLUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.List;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.net.URI;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.ArrayList;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.Document;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.Element;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.Node;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.NodeList;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The <code>Environment</code> element specifies information about the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * environment requested in the <code>Request</code> context by listing a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * sequence of <code>Attribute</code> elements associated with the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * environment.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <pre>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * &lt;xs:element name="Environment" type="xacml-context:EnvironmentType"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * &lt;xs:complexType name="EnvironmentType">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *    &lt;xs:sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *       &lt;xs:element ref="xacml-context:Attribute" minOccurs="0"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *       maxOccurs="unbounded"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *    &lt;xs:sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * &lt;xs:complexType>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </pre>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *@supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class EnvironmentImpl implements Environment {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private List  attributes ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private boolean mutable = true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /** Creates a new instance of EnvironmentImpl */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public EnvironmentImpl() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * This constructor is used to build <code>Environment</code> object from a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * XML string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param xml A <code>java.lang.String</code> representing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        a <code>Environment</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @exception XACMLException if it could not process the XML string
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public EnvironmentImpl(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                "EnvironmentImpl.processElement(): invalid XML input");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new XACMLException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                 XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "errorObtainingElement"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * This constructor is used to build <code>Environment</code> object from a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * block of existing XML that has already been built into a DOM.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param element A <code>org.w3c.dom.Element</code> representing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        DOM tree for <code>Environment</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @exception XACMLException if it could not process the Element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public EnvironmentImpl(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        if (element == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            XACMLSDKUtils.debug.error(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "EnvironmentImpl.processElement(): invalid root element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new XACMLException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "invalid_element"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String elemName = element.getLocalName();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (elemName == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster             XACMLSDKUtils.debug.error(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "EnvironmentImpl.processElement(): local name missing");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new XACMLException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "missing_local_name"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (!elemName.equals(XACMLConstants.ENVIRONMENT)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            XACMLSDKUtils.debug.error(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "EnvironmentImpl.processElement(): invalid local name " +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                 elemName);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new XACMLException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "invalid_local_name"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        // starts processing subelements
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        NodeList nodes = element.getChildNodes();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        int numOfNodes = nodes.getLength();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (numOfNodes >= 1) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            ContextFactory factory = ContextFactory.getInstance();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            for (int nextElem = 0; nextElem < numOfNodes; nextElem++) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                Node child = (Node)nodes.item(nextElem);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                if (child.getNodeType() == Node.ELEMENT_NODE) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    // The child nodes should be <Attribute>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    String attrChildName = child.getLocalName();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    if (attrChildName.equals(XACMLConstants.ATTRIBUTE)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        if (this.attributes == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        this.attributes = new ArrayList();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        Attribute attribute = factory.getInstance().
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                createAttribute((Element)child);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        attributes.add(attribute);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        XACMLSDKUtils.debug.error("EnvironmentImpl."
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            +"processElement(): Invalid element :"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            +attrChildName);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        throw new XACMLException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                "invalid_element"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public java.util.List getAttributes() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return attributes;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets the <code>Attribute</code> elements of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param attributes <code>Attribute</code> elements of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * attributes could be an empty <code>List</code>, if no attributes
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * are present.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @exception XACMLException if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * An object is considered <code>immutable</code> if <code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * makeImmutable()</code> has been invoked on it. It can
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * be determined by calling <code>mutable</code> on the object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setAttributes(java.util.List attributes)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (!mutable) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new XACMLException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "objectImmutable"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (attributes != null &&  !attributes.isEmpty()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (this.attributes == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                this.attributes = new ArrayList();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            this.attributes.addAll(attributes);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * Returns a <code>String</code> 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 of this object
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        StringBuffer namespaceBuffer = new StringBuffer(100);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String nsDeclaration = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (declareNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            namespaceBuffer.append(XACMLConstants.CONTEXT_NS_DECLARATION).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                append(XACMLConstants.SPACE);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            namespaceBuffer.append(XACMLConstants.XSI_NS_URI).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                append(XACMLConstants.SPACE).append(XACMLConstants.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                CONTEXT_SCHEMA_LOCATION);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (includeNSPrefix) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            nsDeclaration = XACMLConstants.CONTEXT_NS_PREFIX + ":";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        sb.append("<").append(nsDeclaration).append(XACMLConstants.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            ENVIRONMENT).append(namespaceBuffer);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        sb.append(">");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        int length = 0;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (attributes != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            sb.append("\n");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            length = attributes.size();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            for (int i = 0; i < length; i++) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                Attribute attr = (Attribute)attributes.get(i);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                sb.append(attr.toXMLString(includeNSPrefix, false));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        sb.append("</").append(nsDeclaration).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            append(XACMLConstants.ENVIRONMENT);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        sb.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 of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * @exception XACMLException if conversion fails for any reason
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String toXMLString() throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return toXMLString(true, false);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * Makes the object immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void makeImmutable() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        mutable = false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * Checks if the 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}