netconf/netconf-util/src/main/java/org/opendaylight/netconf/util/AnyXmlNamespaceContext.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.netconf.util;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12 import static javax.xml.XMLConstants.XMLNS_ATTRIBUTE;
  13 import static javax.xml.XMLConstants.XMLNS_ATTRIBUTE_NS_URI;
  14 import static javax.xml.XMLConstants.XML_NS_PREFIX;
  15 import static javax.xml.XMLConstants.XML_NS_URI;
  16
  17 import com.google.common.collect.BiMap;
  18 import com.google.common.collect.HashBiMap;
  19 import com.google.common.collect.ImmutableBiMap;
  20 import com.google.common.collect.ImmutableListMultimap;
  21 import java.util.Collection;
  22 import java.util.Iterator;
  23 import java.util.Map;
  24 import java.util.Map.Entry;
  25 import javax.xml.namespace.NamespaceContext;
  26 import org.opendaylight.yangtools.concepts.Immutable;
  27
  28 final class AnyXmlNamespaceContext implements Immutable, NamespaceContext {
  29     private static final ImmutableBiMap<String, String> FIXED_PREFIX_TO_URI = ImmutableBiMap.of(
  30         XML_NS_PREFIX, XML_NS_URI,
  31         XMLNS_ATTRIBUTE, XMLNS_ATTRIBUTE_NS_URI);
  32
  33     private final ImmutableListMultimap<String, String> uriToPrefix;
  34     private final ImmutableBiMap<String, String> prefixToUri;
  35
  36     AnyXmlNamespaceContext(final Map<String, String> prefixToUri) {
  37         final ImmutableListMultimap.Builder<String, String> uriToPrefixBuilder = ImmutableListMultimap.builder();
  38         final BiMap<String, String> prefixToUriBuilder = HashBiMap.create();
  39
  40         // Populate well-known prefixes
  41         prefixToUriBuilder.putAll(FIXED_PREFIX_TO_URI);
  42         uriToPrefixBuilder.putAll(FIXED_PREFIX_TO_URI.inverse().entrySet());
  43
  44         // Deal with default namespace first ...
  45         final String defaultURI = prefixToUri.get("");
  46         if (defaultURI != null) {
  47             checkMapping("", defaultURI);
  48             uriToPrefixBuilder.put(defaultURI, "");
  49             prefixToUriBuilder.putIfAbsent("", defaultURI);
  50         }
  51
  52         // ... and then process all the rest
  53         for (Entry<String, String> entry : prefixToUri.entrySet()) {
  54             final String prefix = requireNonNull(entry.getKey());
  55             if (!prefix.isEmpty()) {
  56                 final String namespaceURI = requireNonNull(entry.getValue());
  57                 checkMapping(prefix, namespaceURI);
  58                 uriToPrefixBuilder.put(namespaceURI, prefix);
  59                 prefixToUriBuilder.putIfAbsent(prefix, namespaceURI);
  60             }
  61         }
  62
  63         this.uriToPrefix = uriToPrefixBuilder.build();
  64         this.prefixToUri = ImmutableBiMap.copyOf(prefixToUriBuilder);
  65     }
  66
  67     @Override
  68     public String getNamespaceURI(final String prefix) {
  69         return getValue(prefixToUri, prefix, "");
  70     }
  71
  72     @Override
  73     public String getPrefix(final String namespaceURI) {
  74         return getValue(prefixToUri.inverse(), namespaceURI, null);
  75     }
  76
  77     @Override
  78     public Iterator<String> getPrefixes(final String namespaceURI) {
  79         checkArgument(namespaceURI != null);
  80         return uriToPrefix.get(namespaceURI).iterator();
  81     }
  82
  83     Collection<Entry<String, String>> uriPrefixEntries() {
  84         return uriToPrefix.entries();
  85     }
  86
  87     private static void checkMapping(final String prefix, final String namespaceURI) {
  88         checkArgument(!namespaceURI.isEmpty(), "Namespace must not be empty (%s)", prefix);
  89         checkArgument(!FIXED_PREFIX_TO_URI.containsKey(prefix), "Cannot bind prefix %s", prefix);
  90         checkArgument(!FIXED_PREFIX_TO_URI.containsValue(namespaceURI), "Cannot bind namespace %s", namespaceURI);
  91     }
  92
  93     private static String getValue(final ImmutableBiMap<String, String> map, final String key,
  94             final String defaultValue) {
  95         checkArgument(key != null);
  96         final String found;
  97         return (found = map.get(key)) == null ? defaultValue : found;
  98     }
  99 }