openaz-xacml-pdp/src/main/java/org/apache/openaz/xacml/pdp/policy/dom/DOMRuleCombinerParameters.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 *
 */

/*
 *                        AT&T - PROPRIETARY
 *          THIS FILE CONTAINS PROPRIETARY INFORMATION OF
 *        AT&T AND IS NOT TO BE DISCLOSED OR USED EXCEPT IN
 *             ACCORDANCE WITH APPLICABLE AGREEMENTS.
 *
 *          Copyright (c) 2013 AT&T Knowledge Ventures
 *              Unpublished and Not for Publication
 *                     All Rights Reserved
 */
package org.apache.openaz.xacml.pdp.policy.dom;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.openaz.xacml.api.XACML3;
import org.apache.openaz.xacml.pdp.policy.Rule;
import org.apache.openaz.xacml.pdp.policy.TargetedCombinerParameter;
import org.apache.openaz.xacml.std.StdStatusCode;
import org.apache.openaz.xacml.std.dom.DOMAttributeValue;
import org.apache.openaz.xacml.std.dom.DOMProperties;
import org.apache.openaz.xacml.std.dom.DOMStructureException;
import org.apache.openaz.xacml.std.dom.DOMUtil;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

/**
 * DOMRuleCombinerParameters extends {@link org.apache.openaz.xacml.pdp.policy.TargetedCombinerParameter}
 * with methods for creation from DOM {@link org.w3c.dom.Node}s.
 */
public class DOMRuleCombinerParameters extends TargetedCombinerParameter<String, Rule> {
    private static final Log logger = LogFactory.getLog(DOMRuleCombinerParameters.class);

    protected DOMRuleCombinerParameters() {
    }

    /**
     * Creates a new <code>TargetedCombinerParameter</code> for
     * {@link org.apache.openaz.xacml.pdp.policy.Rule}s by parsing the given <code>Node</code> representing
     * a XACML RuleCombinerParameters element.
     *
     * @param nodeRuleCombinerParameters the <code>Node</code> representing the XACML RuleCombinerParameters
     *            element.
     * @return a new <code>TargetedCombinerParameter</code> for <code>Rule</code>s parsed from the given
     *         <code>Node</code>
     * @throws DOMStructureException if there is an error parsing the <code>Node</code>.
     */
    public static TargetedCombinerParameter<String, Rule> newInstance(Node nodeRuleCombinerParameters)
        throws DOMStructureException {
        Element elementRuleCombinerParameters = DOMUtil.getElement(nodeRuleCombinerParameters);
        boolean bLenient = DOMProperties.isLenient();

        DOMRuleCombinerParameters domRuleCombinerParameters = new DOMRuleCombinerParameters();

        try {
            NodeList children = elementRuleCombinerParameters.getChildNodes();
            int numChildren;
            if (children != null && (numChildren = children.getLength()) > 0) {
                for (int i = 0; i < numChildren; i++) {
                    Node child = children.item(i);
                    if (DOMUtil.isElement(child)) {
                        if (DOMUtil.isInNamespace(child, XACML3.XMLNS)
                            && XACML3.ELEMENT_ATTRIBUTEVALUE.equals(child.getLocalName())) {
                            if (domRuleCombinerParameters.getAttributeValue() != null) {
                                throw DOMUtil
                                    .newUnexpectedElementException(child, nodeRuleCombinerParameters);
                            }
                            domRuleCombinerParameters.setAttributeValue(DOMAttributeValue.newInstance(child,
                                                                                                      null));
                        } else if (!bLenient) {
                            throw DOMUtil.newUnexpectedElementException(child, nodeRuleCombinerParameters);
                        }
                    }
                }
            }
            if (domRuleCombinerParameters.getAttributeValue() == null && !bLenient) {
                throw DOMUtil.newMissingElementException(nodeRuleCombinerParameters, XACML3.XMLNS,
                                                         XACML3.ELEMENT_ATTRIBUTEVALUE);
            }
            domRuleCombinerParameters.setName(DOMUtil.getStringAttribute(elementRuleCombinerParameters,
                                                                         XACML3.ATTRIBUTE_PARAMETERNAME,
                                                                         !bLenient));
            domRuleCombinerParameters.setTargetId(DOMUtil.getStringAttribute(elementRuleCombinerParameters,
                                                                             XACML3.ATTRIBUTE_RULEIDREF,
                                                                             !bLenient));
        } catch (DOMStructureException ex) {
            domRuleCombinerParameters.setStatus(StdStatusCode.STATUS_CODE_SYNTAX_ERROR, ex.getMessage());
            if (DOMProperties.throwsExceptions()) {
                throw ex;
            }
        }
        return domRuleCombinerParameters;
    }

    public static boolean repair(Node nodeRuleCombinerParameters) throws DOMStructureException {
        Element elementRuleCombinerParameters = DOMUtil.getElement(nodeRuleCombinerParameters);
        boolean result = false;

        NodeList children = elementRuleCombinerParameters.getChildNodes();
        int numChildren;
        boolean sawAttributeValue = false;
        if (children != null && (numChildren = children.getLength()) > 0) {
            for (int i = 0; i < numChildren; i++) {
                Node child = children.item(i);
                if (DOMUtil.isElement(child)) {
                    if (DOMUtil.isInNamespace(child, XACML3.XMLNS)
                        && XACML3.ELEMENT_ATTRIBUTEVALUE.equals(child.getLocalName())) {
                        if (sawAttributeValue) {
                            logger.warn("Unexpected element " + child.getNodeName());
                            elementRuleCombinerParameters.removeChild(child);
                            result = true;
                        } else {
                            sawAttributeValue = true;
                            result = result || DOMAttributeValue.repair(child);
                        }
                    } else {
                        logger.warn("Unexpected element " + child.getNodeName());
                        elementRuleCombinerParameters.removeChild(child);
                        result = true;
                    }
                }
            }
        }
        if (!sawAttributeValue) {
            throw DOMUtil.newMissingElementException(nodeRuleCombinerParameters, XACML3.XMLNS,
                                                     XACML3.ELEMENT_ATTRIBUTEVALUE);
        }
        result = result
                 || DOMUtil.repairStringAttribute(elementRuleCombinerParameters,
                                                  XACML3.ATTRIBUTE_PARAMETERNAME, "parameter", logger);
        result = result
                 || DOMUtil.repairIdentifierAttribute(elementRuleCombinerParameters,
                                                      XACML3.ATTRIBUTE_RULEIDREF, logger);

        return result;
    }
}