yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/XMLStreamNormalizedNodeStreamWriter.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. 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.yangtools.yang.data.codec.xml;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.base.Strings;
  14 import java.io.IOException;
  15 import java.io.StringWriter;
  16 import java.net.URI;
  17 import java.util.Map;
  18 import java.util.Map.Entry;
  19 import java.util.Set;
  20 import java.util.concurrent.ConcurrentHashMap;
  21 import javax.xml.XMLConstants;
  22 import javax.xml.namespace.NamespaceContext;
  23 import javax.xml.stream.XMLStreamException;
  24 import javax.xml.stream.XMLStreamWriter;
  25 import javax.xml.transform.OutputKeys;
  26 import javax.xml.transform.Transformer;
  27 import javax.xml.transform.TransformerException;
  28 import javax.xml.transform.TransformerFactory;
  29 import javax.xml.transform.TransformerFactoryConfigurationError;
  30 import javax.xml.transform.dom.DOMSource;
  31 import javax.xml.transform.stax.StAXResult;
  32 import javax.xml.transform.stream.StreamResult;
  33 import org.eclipse.jdt.annotation.NonNull;
  34 import org.eclipse.jdt.annotation.Nullable;
  35 import org.opendaylight.yangtools.yang.common.QName;
  36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  39 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamAttributeWriter;
  40 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  41 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  42 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  43 import org.slf4j.Logger;
  44 import org.slf4j.LoggerFactory;
  45 import org.w3c.dom.Element;
  46
  47 /**
  48  * A {@link NormalizedNodeStreamWriter} which translates the events into an {@link XMLStreamWriter},
  49  * resulting in a RFC 6020 XML encoding. There are 2 versions of this class, one that takes a
  50  * SchemaContext and encodes values appropriately according to the yang schema. The other is
  51  * schema-less and merely outputs values using toString. The latter is intended for debugging
  52  * where doesn't have a SchemaContext available and isn't meant for production use.
  53  */
  54 public abstract class XMLStreamNormalizedNodeStreamWriter<T> implements NormalizedNodeStreamAttributeWriter {
  55     private static final Logger LOG = LoggerFactory.getLogger(XMLStreamNormalizedNodeStreamWriter.class);
  56     private static final String COM_SUN_TRANSFORMER =
  57         "com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl";
  58
  59     static final TransformerFactory TRANSFORMER_FACTORY;
  60
  61     static {
  62         TransformerFactory fa = TransformerFactory.newInstance();
  63         if (!fa.getFeature(StAXResult.FEATURE)) {
  64             LOG.warn("Platform-default TransformerFactory {} does not support StAXResult, attempting fallback to {}",
  65                     fa, COM_SUN_TRANSFORMER);
  66             fa = TransformerFactory.newInstance(COM_SUN_TRANSFORMER, null);
  67             if (!fa.getFeature(StAXResult.FEATURE)) {
  68                 throw new TransformerFactoryConfigurationError("No TransformerFactory supporting StAXResult found.");
  69             }
  70         }
  71
  72         TRANSFORMER_FACTORY = fa;
  73     }
  74
  75     private static final Set<String> BROKEN_NAMESPACES = ConcurrentHashMap.newKeySet();
  76
  77     private final RandomPrefix prefixes;
  78     final XMLStreamWriter writer;
  79
  80     XMLStreamNormalizedNodeStreamWriter(final XMLStreamWriter writer) {
  81         this.writer = requireNonNull(writer);
  82         this.prefixes = new RandomPrefix(writer.getNamespaceContext());
  83     }
  84
  85     /**
  86      * Create a new writer with the specified context as its root.
  87      *
  88      * @param writer Output {@link XMLStreamWriter}
  89      * @param context Associated {@link SchemaContext}.
  90      * @return A new {@link NormalizedNodeStreamWriter}
  91      */
  92     public static NormalizedNodeStreamWriter create(final XMLStreamWriter writer, final SchemaContext context) {
  93         return create(writer, context, SchemaPath.ROOT);
  94     }
  95
  96     /**
  97      * Create a new writer with the specified context and rooted in the specified schema path.
  98      *
  99      * @param writer Output {@link XMLStreamWriter}
 100      * @param context Associated {@link SchemaContext}.
 101      * @param path path
 102      *
 103      * @return A new {@link NormalizedNodeStreamWriter}
 104      */
 105     public static NormalizedNodeStreamWriter create(final XMLStreamWriter writer, final SchemaContext context,
 106             final SchemaPath path) {
 107         return SchemaAwareXMLStreamNormalizedNodeStreamWriter.newInstance(writer, context, path);
 108     }
 109
 110     /**
 111      * Create a new schema-less writer. Note that this version is intended for debugging
 112      * where doesn't have a SchemaContext available and isn't meant for production use.
 113      *
 114      * @param writer Output {@link XMLStreamWriter}
 115      *
 116      * @return A new {@link NormalizedNodeStreamWriter}
 117      */
 118     public static NormalizedNodeStreamWriter createSchemaless(final XMLStreamWriter writer) {
 119         return SchemalessXMLStreamNormalizedNodeStreamWriter.newInstance(writer);
 120     }
 121
 122     abstract void writeValue(XMLStreamWriter xmlWriter, QName qname, @NonNull Object value, T context)
 123             throws IOException, XMLStreamException;
 124
 125     abstract void startList(NodeIdentifier name);
 126
 127     abstract void startListItem(PathArgument name) throws IOException;
 128
 129     private void writeAttributes(final @NonNull Map<QName, String> attributes) throws IOException {
 130         for (final Entry<QName, String> entry : attributes.entrySet()) {
 131             try {
 132                 final QName qname = entry.getKey();
 133                 final String namespace = qname.getNamespace().toString();
 134
 135                 if (!Strings.isNullOrEmpty(namespace)) {
 136                     final String prefix = getPrefix(qname.getNamespace(), namespace);
 137                     writer.writeAttribute(prefix, namespace, qname.getLocalName(), entry.getValue());
 138                 } else {
 139                     writer.writeAttribute(qname.getLocalName(), entry.getValue());
 140                 }
 141             } catch (final XMLStreamException e) {
 142                 throw new IOException("Unable to emit attribute " + entry, e);
 143             }
 144         }
 145     }
 146
 147     private String getPrefix(final URI uri, final String str) throws XMLStreamException {
 148         final String prefix = writer.getPrefix(str);
 149         if (prefix != null) {
 150             return prefix;
 151         }
 152
 153         // This is needed to recover from attributes emitted while the namespace was not declared. Ordinarily
 154         // attribute namespaces would be bound in the writer, so the resulting XML is efficient, but we cannot rely
 155         // on that having been done.
 156         if (BROKEN_NAMESPACES.add(str)) {
 157             LOG.info("Namespace {} was not bound, please fix the caller", str, new Throwable());
 158         }
 159
 160         return prefixes.encodePrefix(uri);
 161     }
 162
 163     private void writeStartElement(final QName qname) throws XMLStreamException {
 164         final String ns = qname.getNamespace().toString();
 165         final NamespaceContext context = writer.getNamespaceContext();
 166         final boolean needDefaultNs;
 167         if (context != null) {
 168             final String parentNs = context.getNamespaceURI(XMLConstants.DEFAULT_NS_PREFIX);
 169             needDefaultNs = !ns.equals(parentNs);
 170         } else {
 171             needDefaultNs = false;
 172         }
 173
 174         writer.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, qname.getLocalName(), ns);
 175         if (needDefaultNs) {
 176             writer.writeDefaultNamespace(ns);
 177         }
 178     }
 179
 180     void writeElement(final QName qname, final Object value, final @Nullable Map<QName, String> attributes,
 181             final T context) throws IOException {
 182         try {
 183             writeStartElement(qname);
 184             if (attributes != null) {
 185                 writeAttributes(attributes);
 186             }
 187             if (value != null) {
 188                 writeValue(writer, qname, value, context);
 189             }
 190             writer.writeEndElement();
 191         } catch (XMLStreamException e) {
 192             throw new IOException("Failed to emit element", e);
 193         }
 194     }
 195
 196     void startElement(final QName qname) throws IOException {
 197         try {
 198             writeStartElement(qname);
 199         } catch (XMLStreamException e) {
 200             throw new IOException("Failed to start element", e);
 201         }
 202     }
 203
 204     void anyxmlNode(final QName qname, final Object value) throws IOException {
 205         if (value != null) {
 206             checkArgument(value instanceof DOMSource, "AnyXML value must be DOMSource, not %s", value);
 207             final DOMSource domSource = (DOMSource) value;
 208             requireNonNull(domSource.getNode());
 209             checkArgument(domSource.getNode().getNodeName().equals(qname.getLocalName()));
 210             checkArgument(domSource.getNode().getNamespaceURI().equals(qname.getNamespace().toString()));
 211             try {
 212                 // TODO can the transformer be a constant ? is it thread safe ?
 213                 final Transformer transformer = TRANSFORMER_FACTORY.newTransformer();
 214                 // Writer has to be wrapped in a wrapper that ignores endDocument event
 215                 // EndDocument event forbids any other modification to the writer so a nested anyXml breaks
 216                 // serialization
 217                 transformer.transform(domSource, new StAXResult(new DelegateWriterNoEndDoc(writer)));
 218             } catch (final TransformerException e) {
 219                 throw new IOException("Unable to transform anyXml(" + qname + ") value: " + value, e);
 220             }
 221         }
 222     }
 223
 224     @Override
 225     public final void startContainerNode(final NodeIdentifier name, final int childSizeHint,
 226                                          final Map<QName, String> attributes) throws IOException {
 227         startContainerNode(name, childSizeHint);
 228         writeAttributes(attributes);
 229     }
 230
 231     @Override
 232     public final void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint,
 233                                                  final Map<QName, String> attributes) throws IOException {
 234         startYangModeledAnyXmlNode(name, childSizeHint);
 235         writeAttributes(attributes);
 236     }
 237
 238     @Override
 239     public final void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint,
 240                                            final Map<QName, String> attributes) throws IOException {
 241         startUnkeyedListItem(name, childSizeHint);
 242         writeAttributes(attributes);
 243     }
 244
 245     @Override
 246     public final void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) throws IOException {
 247         startListItem(name);
 248     }
 249
 250     @Override
 251     public final void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint,
 252                                         final Map<QName, String> attributes) throws IOException {
 253         startMapEntryNode(identifier, childSizeHint);
 254         writeAttributes(attributes);
 255     }
 256
 257     @Override
 258     public final void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint)
 259             throws IOException {
 260         startListItem(identifier);
 261     }
 262
 263     @Override
 264     public final void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) {
 265         startList(name);
 266     }
 267
 268     @Override
 269     public final void startMapNode(final NodeIdentifier name, final int childSizeHint) {
 270         startList(name);
 271     }
 272
 273     @Override
 274     public final void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) {
 275         startList(name);
 276     }
 277
 278     public static String toString(final Element xml) {
 279         try {
 280             final Transformer transformer = TRANSFORMER_FACTORY.newTransformer();
 281             transformer.setOutputProperty(OutputKeys.INDENT, "yes");
 282
 283             final StreamResult result = new StreamResult(new StringWriter());
 284             final DOMSource source = new DOMSource(xml);
 285             transformer.transform(source, result);
 286
 287             return result.getWriter().toString();
 288         } catch (IllegalArgumentException | TransformerException e) {
 289             throw new IllegalStateException("Unable to serialize xml element " + xml, e);
 290         }
 291     }
 292
 293     abstract void endNode(XMLStreamWriter xmlWriter) throws IOException, XMLStreamException;
 294
 295     @Override
 296     public final void endNode() throws IOException {
 297         try {
 298             endNode(writer);
 299         } catch (XMLStreamException e) {
 300             throw new IOException("Failed to end element", e);
 301         }
 302     }
 303
 304     @Override
 305     public final void close() throws IOException {
 306         try {
 307             writer.close();
 308         } catch (XMLStreamException e) {
 309             throw new IOException("Failed to close writer", e);
 310         }
 311     }
 312
 313     @Override
 314     public final void flush() throws IOException {
 315         try {
 316             writer.flush();
 317         } catch (XMLStreamException e) {
 318             throw new IOException("Failed to flush writer", e);
 319         }
 320     }
 321
 322     /**
 323      * Delegate writer that ignores writeEndDocument event. Used for AnyXml serialization.
 324      */
 325     private static final class DelegateWriterNoEndDoc implements XMLStreamWriter {
 326         private final XMLStreamWriter writer;
 327
 328         DelegateWriterNoEndDoc(final XMLStreamWriter writer) {
 329             this.writer = writer;
 330         }
 331
 332         @Override
 333         public void writeStartElement(final String localName) throws XMLStreamException {
 334             writer.writeStartElement(localName);
 335         }
 336
 337         @Override
 338         public void writeStartElement(final String namespaceURI, final String localName) throws XMLStreamException {
 339             writer.writeStartElement(namespaceURI, localName);
 340         }
 341
 342         @Override
 343         public void writeStartElement(final String prefix, final String localName, final String namespaceURI)
 344                 throws XMLStreamException {
 345             writer.writeStartElement(prefix, localName, namespaceURI);
 346         }
 347
 348         @Override
 349         public void writeEmptyElement(final String namespaceURI, final String localName) throws XMLStreamException {
 350             writer.writeEmptyElement(namespaceURI, localName);
 351         }
 352
 353         @Override
 354         public void writeEmptyElement(final String prefix, final String localName, final String namespaceURI)
 355                 throws XMLStreamException {
 356             writer.writeEmptyElement(prefix, localName, namespaceURI);
 357         }
 358
 359         @Override
 360         public void writeEmptyElement(final String localName) throws XMLStreamException {
 361             writer.writeEmptyElement(localName);
 362         }
 363
 364         @Override
 365         public void writeEndElement() throws XMLStreamException {
 366             writer.writeEndElement();
 367
 368         }
 369
 370         @Override
 371         public void writeEndDocument() throws XMLStreamException {
 372             // End document is disabled
 373         }
 374
 375         @Override
 376         public void close() throws XMLStreamException {
 377             writer.close();
 378         }
 379
 380         @Override
 381         public void flush() throws XMLStreamException {
 382             writer.flush();
 383         }
 384
 385         @Override
 386         public void writeAttribute(final String localName, final String value) throws XMLStreamException {
 387             writer.writeAttribute(localName, value);
 388         }
 389
 390         @Override
 391         public void writeAttribute(final String prefix, final String namespaceURI, final String localName,
 392                                    final String value) throws XMLStreamException {
 393             writer.writeAttribute(prefix, namespaceURI, localName, value);
 394         }
 395
 396         @Override
 397         public void writeAttribute(final String namespaceURI, final String localName, final String value)
 398                 throws XMLStreamException {
 399             writer.writeAttribute(namespaceURI, localName, value);
 400         }
 401
 402         @Override
 403         public void writeNamespace(final String prefix, final String namespaceURI) throws XMLStreamException {
 404             // Workaround for default namespace
 405             // If a namespace is not prefixed, it is is still treated as prefix namespace.
 406             // This results in the NamespaceSupport class ignoring the namespace since xmlns is not a valid prefix
 407             // Write the namespace at least as an attribute
 408             // TODO this is a hotfix, the transformer itself should write namespaces passing the namespace
 409             // in writeStartElement method
 410             if (prefix.equals("xml") || prefix.equals("xmlns")) {
 411                 writer.writeAttribute(prefix, namespaceURI);
 412             } else {
 413                 writer.writeNamespace(prefix, namespaceURI);
 414             }
 415         }
 416
 417         @Override
 418         public void writeDefaultNamespace(final String namespaceURI) throws XMLStreamException {
 419             writer.writeDefaultNamespace(namespaceURI);
 420         }
 421
 422         @Override
 423         public void writeComment(final String data) throws XMLStreamException {
 424             writer.writeComment(data);
 425         }
 426
 427         @Override
 428         public void writeProcessingInstruction(final String target) throws XMLStreamException {
 429             writer.writeProcessingInstruction(target);
 430         }
 431
 432         @Override
 433         public void writeProcessingInstruction(final String target, final String data) throws XMLStreamException {
 434             writer.writeProcessingInstruction(target, data);
 435         }
 436
 437         @Override
 438         public void writeCData(final String data) throws XMLStreamException {
 439             writer.writeCData(data);
 440         }
 441
 442         @Override
 443         public void writeDTD(final String dtd) throws XMLStreamException {
 444             writer.writeDTD(dtd);
 445         }
 446
 447         @Override
 448         public void writeEntityRef(final String name) throws XMLStreamException {
 449             writer.writeEntityRef(name);
 450         }
 451
 452         @Override
 453         public void writeStartDocument() throws XMLStreamException {
 454         }
 455
 456         @Override
 457         public void writeStartDocument(final String version) throws XMLStreamException {
 458         }
 459
 460         @Override
 461         public void writeStartDocument(final String encoding, final String version) throws XMLStreamException {
 462         }
 463
 464         @Override
 465         public void writeCharacters(final String text) throws XMLStreamException {
 466             writer.writeCharacters(text);
 467         }
 468
 469         @Override
 470         public void writeCharacters(final char[] text, final int start, final int len) throws XMLStreamException {
 471             writer.writeCharacters(text, start, len);
 472         }
 473
 474         @Override
 475         public String getPrefix(final String uri) throws XMLStreamException {
 476             return writer.getPrefix(uri);
 477         }
 478
 479         @Override
 480         public void setPrefix(final String prefix, final String uri) throws XMLStreamException {
 481             // Disabled since it causes exceptions in the underlying writer
 482         }
 483
 484         @Override
 485         public void setDefaultNamespace(final String uri) throws XMLStreamException {
 486             writer.setDefaultNamespace(uri);
 487         }
 488
 489         @Override
 490         public void setNamespaceContext(final NamespaceContext context) throws XMLStreamException {
 491             writer.setNamespaceContext(context);
 492         }
 493
 494         @Override
 495         public NamespaceContext getNamespaceContext() {
 496             return writer.getNamespaceContext();
 497         }
 498
 499         @Override
 500         public Object getProperty(final String name) {
 501             return writer.getProperty(name);
 502         }
 503     }
 504 }