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

   1 /*
   2  * Copyright (c) 2019 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.yangtools.yang.data.codec.xml;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.VisibleForTesting;
  13 import com.google.common.base.MoreObjects.ToStringHelper;
  14 import java.io.IOException;
  15 import java.net.URISyntaxException;
  16 import javax.xml.stream.XMLStreamException;
  17 import javax.xml.stream.XMLStreamReader;
  18 import javax.xml.transform.dom.DOMSource;
  19 import org.eclipse.jdt.annotation.NonNullByDefault;
  20 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  21 import org.opendaylight.yangtools.yang.data.impl.schema.AbstractNormalizableAnydata;
  22 import org.opendaylight.yangtools.yang.model.api.EffectiveStatementInference;
  23 import org.xml.sax.SAXException;
  24
  25 /**
  26  * Internal parser representation of a parsed-out chunk of XML. This format is completely internal to the parser
  27  * and can be changed at any time. Current implementation uses W3C DOM tree as the backing implementations, but others
  28  * are possible as well.
  29  *
  30  * <p>
  31  * Note that the DOMSource is expected to contain a top-level synthetic element, which acts as holder of namespace
  32  * declarations coming from parsing context but is otherwise ignored. Parser-side of things is expected to reuse the
  33  * {@code anydata} element name for this purpose. Writer-side of things is expected to skip this element except for
  34  * its namespace declarations.
  35  *
  36  * @author Robert Varga
  37  */
  38 @NonNullByDefault
  39 final class DOMSourceAnydata extends AbstractNormalizableAnydata {
  40     private final DOMSource source;
  41
  42     DOMSourceAnydata(final DOMSource source) {
  43         this.source = requireNonNull(source);
  44     }
  45
  46     XMLStreamReader toStreamReader() throws XMLStreamException {
  47         return new DOMSourceXMLStreamReader(source);
  48     }
  49
  50     @Override
  51     protected void writeTo(final NormalizedNodeStreamWriter streamWriter, final EffectiveStatementInference inference)
  52             throws IOException {
  53         final XmlParserStream xmlParser;
  54         try {
  55             xmlParser = XmlParserStream.create(streamWriter, inference);
  56         } catch (IllegalArgumentException e) {
  57             throw new IOException("Failed to instantiate XML parser", e);
  58         }
  59
  60         try {
  61             final XMLStreamReader reader = toStreamReader();
  62             reader.nextTag();
  63
  64             xmlParser.parse(reader).flush();
  65         } catch (XMLStreamException | URISyntaxException | SAXException e) {
  66             throw new IOException("Failed to parse payload", e);
  67         }
  68     }
  69
  70     @Override
  71     protected ToStringHelper addToStringAttributes(final ToStringHelper helper) {
  72         return helper.add("source", source);
  73     }
  74
  75     @VisibleForTesting
  76     DOMSource getSource() {
  77         return source;
  78     }
  79 }