a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
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 * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
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 * $Id: ResourceImpl.java,v 1.3 2008/06/25 05:48:13 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLSDKUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLSDKUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.context.Attribute;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.context.ContextFactory;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.context.ResourceContent;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The <code>Resource</code> element specifies information about the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * resource to which access is requested by listing a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * sequence of <code>Attribute</code> elements associated with the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * resource. it may include <code>ResourceContent</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:element name="Resource" type="xacml-context:ResourceType"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:complexType name="ResourceType">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:element ref="xacml-context:ResourceContent" minOccurs="0"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:element ref="xacml-context:Attribute" minOccurs="0"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * maxOccurs="unbounded"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:complexType>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *@supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Default constructor
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This constructor is used to build <code>Resource</code> object from a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * XML string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param xml A <code>java.lang.String</code> representing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * a <code>Resource</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception XACMLException if it could not process the XML string
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public ResourceImpl(String xml) throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Document document = XMLUtils.toDOMDocument(xml, XACMLSDKUtils.debug);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Element rootElement = document.getDocumentElement();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "SubjectImpl.processElement(): invalid XML input");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "errorObtainingElement"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This constructor is used to build <code>resource</code> object from a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * block of existing XML that has already been built into a DOM.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param element A <code>org.w3c.dom.Element</code> representing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DOM tree for <code>Resource</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception XACML2Exception if it could not process the Element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public ResourceImpl(Element element) throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster private void processElement(Element element) throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "ResourceImpl.processElement(): invalid root element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "invalid_element"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "ResourceImpl.processElement(): local name missing");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "missing_local_name"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (!elemName.equals(XACMLConstants.RESOURCE)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "ResourceImpl.processElement(): invalid local name " +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "invalid_local_name"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster // starts processing subelements
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster ContextFactory factory = ContextFactory.getInstance();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (child.getNodeType() == Node.ELEMENT_NODE) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster // The child nodes should be <Attribute> or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster // <ResourceContent>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (childName.equals(XACMLConstants.ATTRIBUTE)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /* not a schema violation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster XACMLSDKUtils.debug.error(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "ResourceImpl.processElement(): no attributes or resource "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster +"content");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new XACMLException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "missing_subelements"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the ResourceConent
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the ResourceContent of the Resource
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the ResourceContent of this Resource
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param resourceContent ResourceContent of this Resource.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * ResourceContent is optional, so could be null.
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>isMutable</code> on the object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setResourceContent(Element resourceContent)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "objectImmutable"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String elemName = resourceContent.getLocalName();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster || !elemName.equals(XACMLConstants.RESOURCE_CONTENT)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "StatusMessageImpl.processElement():"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "local name missing or incorrect");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "missing_local_name"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns zero to many <code>Attribute</code> elements of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If no attributes and present, empty <code>List</code> will be returned.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Typically a <code>Resource</code> element will contain an <code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Attribute</code> with an <code>AttributeId</code> of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "urn:oasis:names:tc:xacml:1.0:resource:resource-id". Each such
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>Attribute</code> SHALL be an absolute abd fully resolved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * representation of the identity of the single resource to which
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * access is requested.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return <code>List</code> containing the <code>Attribute</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * elements of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the <code>Attribute</code> elements of this object
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 * @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>isMutable</code> on the object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setAttributes(List attributes) throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "objectImmutable"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (attributes != null && !attributes.isEmpty()) {
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 public String toXMLString(boolean includeNSPrefix, boolean declareNS)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster NS.append(XACMLConstants.CONTEXT_NS_DECLARATION)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster .append(XACMLConstants.CONTEXT_SCHEMA_LOCATION);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster appendNS = XACMLConstants.CONTEXT_NS_PREFIX + ":";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster sb.append("<").append(appendNS).append(XACMLConstants.RESOURCE)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster sb.append(attr.toXMLString(includeNSPrefix, false));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster // ignore trailing ":"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (includeNSPrefix && (resourceContent.getPrefix() == null)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster resourceContent.setPrefix(appendNS.substring(0, appendNS.length()-1));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (resourceContent.getNamespaceURI() == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster resourceContent.setAttribute(namespaceName, namespaceURI);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster // does not seem to work to append namespace TODO
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster sb.append("</").append(appendNS).append(XACMLConstants.RESOURCE);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a string representation of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a string representation of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception XACMLException if conversion fails for any reason
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString() throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return toXMLString(true, false);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Makes the object immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Checks if the object is mutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return <code>true</code> if the object is mutable,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>false</code> otherwise