--- /dev/null
+/*
+ * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.netconf.util;
+
+import static com.google.common.base.Preconditions.checkArgument;
+import static java.util.Objects.requireNonNull;
+import static javax.xml.XMLConstants.XMLNS_ATTRIBUTE;
+import static javax.xml.XMLConstants.XMLNS_ATTRIBUTE_NS_URI;
+import static javax.xml.XMLConstants.XML_NS_PREFIX;
+import static javax.xml.XMLConstants.XML_NS_URI;
+
+import com.google.common.collect.BiMap;
+import com.google.common.collect.HashBiMap;
+import com.google.common.collect.ImmutableBiMap;
+import com.google.common.collect.ImmutableListMultimap;
+import java.util.Collection;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Map.Entry;
+import javax.xml.namespace.NamespaceContext;
+import org.opendaylight.yangtools.concepts.Immutable;
+
+final class AnyXmlNamespaceContext implements Immutable, NamespaceContext {
+ private static final ImmutableBiMap<String, String> FIXED_PREFIX_TO_URI = ImmutableBiMap.of(
+ XML_NS_PREFIX, XML_NS_URI,
+ XMLNS_ATTRIBUTE, XMLNS_ATTRIBUTE_NS_URI);
+
+ private final ImmutableListMultimap<String, String> uriToPrefix;
+ private final ImmutableBiMap<String, String> prefixToUri;
+
+ AnyXmlNamespaceContext(final Map<String, String> prefixToUri) {
+ final ImmutableListMultimap.Builder<String, String> uriToPrefixBuilder = ImmutableListMultimap.builder();
+ final BiMap<String, String> prefixToUriBuilder = HashBiMap.create();
+
+ // Populate well-known prefixes
+ prefixToUriBuilder.putAll(FIXED_PREFIX_TO_URI);
+ uriToPrefixBuilder.putAll(FIXED_PREFIX_TO_URI.inverse().entrySet());
+
+ // Deal with default namespace first ...
+ final String defaultURI = prefixToUri.get("");
+ if (defaultURI != null) {
+ checkMapping("", defaultURI);
+ uriToPrefixBuilder.put(defaultURI, "");
+ prefixToUriBuilder.putIfAbsent("", defaultURI);
+ }
+
+ // ... and then process all the rest
+ for (Entry<String, String> entry : prefixToUri.entrySet()) {
+ final String prefix = requireNonNull(entry.getKey());
+ if (!prefix.isEmpty()) {
+ final String namespaceURI = requireNonNull(entry.getValue());
+ checkMapping(prefix, namespaceURI);
+ uriToPrefixBuilder.put(namespaceURI, prefix);
+ prefixToUriBuilder.putIfAbsent(prefix, namespaceURI);
+ }
+ }
+
+ this.uriToPrefix = uriToPrefixBuilder.build();
+ this.prefixToUri = ImmutableBiMap.copyOf(prefixToUriBuilder);
+ }
+
+ @Override
+ public String getNamespaceURI(final String prefix) {
+ return getValue(prefixToUri, prefix, "");
+ }
+
+ @Override
+ public String getPrefix(final String namespaceURI) {
+ return getValue(prefixToUri.inverse(), namespaceURI, null);
+ }
+
+ @Override
+ public Iterator<String> getPrefixes(final String namespaceURI) {
+ checkArgument(namespaceURI != null);
+ return uriToPrefix.get(namespaceURI).iterator();
+ }
+
+ Collection<Entry<String, String>> uriPrefixEntries() {
+ return uriToPrefix.entries();
+ }
+
+ private static void checkMapping(final String prefix, final String namespaceURI) {
+ checkArgument(!namespaceURI.isEmpty(), "Namespace must not be empty (%s)", prefix);
+ checkArgument(!FIXED_PREFIX_TO_URI.containsKey(prefix), "Cannot bind prefix %s", prefix);
+ checkArgument(!FIXED_PREFIX_TO_URI.containsValue(namespaceURI), "Cannot bind namespace %s", namespaceURI);
+ }
+
+ private static String getValue(final ImmutableBiMap<String, String> map, final String key,
+ final String defaultValue) {
+ checkArgument(key != null);
+ final String found;
+ return (found = map.get(key)) == null ? defaultValue : found;
+ }
+}
import static com.google.common.base.Preconditions.checkState;
+import com.google.common.collect.ImmutableMap;
import java.io.IOException;
import java.net.URISyntaxException;
import java.util.Iterator;
import org.xml.sax.SAXException;
public final class NetconfUtil {
+ /**
+ * Shim interface to handle differences around namespace handling between various XMLStreamWriter implementations.
+ * Specifically:
+ * <ul>
+ * <li>OpenJDK DOM writer (com.sun.xml.internal.stream.writers.XMLDOMWriterImpl) throws
+ * UnsupportedOperationException from its setNamespaceContext() method</li>
+ * <li>Woodstox DOM writer (com.ctc.wstx.dom.WstxDOMWrappingWriter) works with namespace context, but treats
+ * setPrefix() calls as hints -- which are not discoverable.</li>
+ * </ul>
+ *
+ * <p>
+ * Due to this we perform a quick test for behavior and decide the appropriate strategy.
+ */
+ @FunctionalInterface
+ private interface NamespaceSetter {
+ void initializeNamespace(XMLStreamWriter writer) throws XMLStreamException;
+
+ static NamespaceSetter forFactory(final XMLOutputFactory xmlFactory) {
+ final String netconfNamespace = NETCONF_QNAME.getNamespace().toString();
+ final AnyXmlNamespaceContext namespaceContext = new AnyXmlNamespaceContext(ImmutableMap.of(
+ "op", netconfNamespace));
+
+ try {
+ final XMLStreamWriter testWriter = xmlFactory.createXMLStreamWriter(new DOMResult(
+ XmlUtil.newDocument()));
+ testWriter.setNamespaceContext(namespaceContext);
+ } catch (final UnsupportedOperationException e) {
+ // This happens with JDK's DOM writer, which we may be using
+ LOG.warn("Unable to set namespace context, falling back to setPrefix()", e);
+ return writer -> writer.setPrefix("op", netconfNamespace);
+ } catch (XMLStreamException e) {
+ throw new ExceptionInInitializerError(e);
+ }
+
+ // Success, we can use setNamespaceContext()
+ return writer -> writer.setNamespaceContext(namespaceContext);
+ }
+ }
+
private static final Logger LOG = LoggerFactory.getLogger(NetconfUtil.class);
// FIXME: document what exactly this QName means, as it is not referring to a tangible node nor the ietf-module.
Revision.of("2011-06-01")), "netconf").intern();
// FIXME: is this the device-bound revision?
public static final QName NETCONF_DATA_QNAME = QName.create(NETCONF_QNAME, "data").intern();
+
public static final XMLOutputFactory XML_FACTORY;
static {
XML_FACTORY = f;
}
+ private static final NamespaceSetter XML_NAMESPACE_SETTER = NamespaceSetter.forFactory(XML_FACTORY);
+
private NetconfUtil() {
// No-op
}
}
final XMLStreamWriter writer = XML_FACTORY.createXMLStreamWriter(result);
+ XML_NAMESPACE_SETTER.initializeNamespace(writer);
try (
NormalizedNodeStreamWriter normalizedNodeStreamWriter =
XMLStreamNormalizedNodeStreamWriter.create(writer, context, schemaPath);