com.github.tomakehurst.wiremock.common.xml.XmlDocument Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wiremock-standalone Show documentation

A web service test double for all occasions - standalone edition

There is a newer version: 3.0.1

/*
 * Copyright (C) 2020-2021 Thomas Akehurst
 *
 * Licensed 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.
 */
package com.github.tomakehurst.wiremock.common.xml;

import static javax.xml.xpath.XPathConstants.NODESET;

import com.github.tomakehurst.wiremock.common.ListOrSingle;
import java.util.HashMap;
import java.util.Map;
import javax.xml.XMLConstants;
import javax.xml.namespace.NamespaceContext;
import javax.xml.transform.dom.DOMSource;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathExpressionException;
import org.w3c.dom.Document;
import org.w3c.dom.NodeList;
import org.xmlunit.util.Convert;

public class XmlDocument extends XmlNode {

  private final Document document;

  public XmlDocument(Document document) {
    super(document);
    this.document = document;
  }

  public ListOrSingle findNodes(String xPathExpression) {
    return findNodes(xPathExpression, null);
  }

  public ListOrSingle findNodes(String xPathExpression, Map namespaces) {
    try {
      final XPath xPath = XPATH_CACHE.get();
      xPath.reset();

      NodeList nodeSet;
      if (namespaces != null) {
        Map fullNamespaces = addStandardNamespaces(namespaces);
        NamespaceContext namespaceContext = Convert.toNamespaceContext(fullNamespaces);
        xPath.setNamespaceContext(namespaceContext);
        nodeSet =
            (NodeList)
                xPath.evaluate(
                    xPathExpression, Convert.toInputSource(new DOMSource(document)), NODESET);
      } else {
        nodeSet = (NodeList) xPath.evaluate(xPathExpression, document, NODESET);
      }

      return toListOrSingle(nodeSet);
    } catch (XPathExpressionException e) {
      throw XPathException.fromXPathException(e);
    }
  }

  private static Map addStandardNamespaces(Map namespaces) {
    Map result = new HashMap();
    for (String prefix : namespaces.keySet()) {
      String uri = namespaces.get(prefix);
      // according to the Javadocs only the constants defined in
      // XMLConstants are allowed as prefixes for the following
      // two URIs
      if (!XMLConstants.XML_NS_URI.equals(uri)
          && !XMLConstants.XMLNS_ATTRIBUTE_NS_URI.equals(uri)) {
        result.put(prefix, uri);
      }
    }
    result.put(XMLConstants.XML_NS_PREFIX, XMLConstants.XML_NS_URI);
    result.put(XMLConstants.XMLNS_ATTRIBUTE, XMLConstants.XMLNS_ATTRIBUTE_NS_URI);

    return result;
  }
}