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

   1 /*
   2  * Copyright (c) 2016 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
   9 package org.opendaylight.yangtools.yang.data.codec.xml;
  10
  11 import com.google.common.annotations.Beta;
  12 import com.google.common.base.Preconditions;
  13 import java.io.Closeable;
  14 import java.io.Flushable;
  15 import java.io.IOException;
  16 import java.io.StringReader;
  17 import java.net.URI;
  18 import java.net.URISyntaxException;
  19 import java.util.Deque;
  20 import java.util.HashSet;
  21 import java.util.Set;
  22 import javax.annotation.concurrent.NotThreadSafe;
  23 import javax.xml.namespace.NamespaceContext;
  24 import javax.xml.parsers.DocumentBuilderFactory;
  25 import javax.xml.parsers.ParserConfigurationException;
  26 import javax.xml.stream.Location;
  27 import javax.xml.stream.XMLStreamConstants;
  28 import javax.xml.stream.XMLStreamException;
  29 import javax.xml.stream.XMLStreamReader;
  30 import javax.xml.transform.dom.DOMSource;
  31 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  32 import org.opendaylight.yangtools.yang.data.util.AbstractNodeDataWithSchema;
  33 import org.opendaylight.yangtools.yang.data.util.AnyXmlNodeDataWithSchema;
  34 import org.opendaylight.yangtools.yang.data.util.CompositeNodeDataWithSchema;
  35 import org.opendaylight.yangtools.yang.data.util.LeafListEntryNodeDataWithSchema;
  36 import org.opendaylight.yangtools.yang.data.util.LeafListNodeDataWithSchema;
  37 import org.opendaylight.yangtools.yang.data.util.LeafNodeDataWithSchema;
  38 import org.opendaylight.yangtools.yang.data.util.ListEntryNodeDataWithSchema;
  39 import org.opendaylight.yangtools.yang.data.util.ListNodeDataWithSchema;
  40 import org.opendaylight.yangtools.yang.data.util.ParserStreamUtils;
  41 import org.opendaylight.yangtools.yang.data.util.RpcAsContainer;
  42 import org.opendaylight.yangtools.yang.data.util.SimpleNodeDataWithSchema;
  43 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  44 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  45 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  46 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  47 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  48 import org.opendaylight.yangtools.yang.model.api.YangModeledAnyXmlSchemaNode;
  49 import org.w3c.dom.Document;
  50 import org.w3c.dom.Element;
  51 import org.xml.sax.InputSource;
  52 import org.xml.sax.SAXException;
  53
  54 /**
  55  * This class provides functionality for parsing an XML source containing YANG-modeled data. It disallows multiple
  56  * instances of the same element except for leaf-list and list entries. It also expects that the YANG-modeled data in
  57  * the XML source are wrapped in a root element.
  58  */
  59 @Beta
  60 @NotThreadSafe
  61 public final class XmlParserStream implements Closeable, Flushable {
  62     private static final DocumentBuilderFactory FACTORY;
  63
  64     static {
  65         DocumentBuilderFactory f = DocumentBuilderFactory.newInstance();
  66         f.setNamespaceAware(true);
  67         FACTORY = f;
  68     }
  69
  70     private final NormalizedNodeStreamWriter writer;
  71     private final XmlCodecFactory codecs;
  72     private final DataSchemaNode parentNode;
  73
  74     private XmlParserStream(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext,
  75                              final DataSchemaNode parentNode) {
  76         this.writer = Preconditions.checkNotNull(writer);
  77         this.codecs = XmlCodecFactory.create(schemaContext);
  78         this.parentNode = parentNode;
  79     }
  80
  81     public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext,
  82             final SchemaNode parentNode ) {
  83         if (parentNode instanceof RpcDefinition) {
  84             return new XmlParserStream(writer, schemaContext, new RpcAsContainer((RpcDefinition) parentNode));
  85         }
  86         Preconditions.checkArgument(parentNode instanceof DataSchemaNode, "Instance of DataSchemaNode class awaited.");
  87         return new XmlParserStream(writer, schemaContext, (DataSchemaNode) parentNode);
  88     }
  89
  90     public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext) {
  91         return new XmlParserStream(writer, schemaContext, schemaContext);
  92     }
  93
  94     /**
  95      * This method parses the XML source and emits node events into a NormalizedNodeStreamWriter based on the
  96      * YANG-modeled data contained in the XML source.
  97      *
  98      * @param reader
  99      *              StAX reader which is to used to walk through the XML source
 100      * @return
 101      *              instance of XmlParserStream
 102      * @throws XMLStreamException
 103      *              if a well-formedness error or an unexpected processing condition occurs while parsing the XML
 104      * @throws URISyntaxException
 105      *              if the namespace URI of an XML element contains a syntax error
 106      * @throws IOException
 107      *              if an error occurs while parsing the value of an anyxml node
 108      * @throws ParserConfigurationException
 109      *              if an error occurs while parsing the value of an anyxml node
 110      * @throws SAXException
 111      *              if an error occurs while parsing the value of an anyxml node
 112      */
 113     public XmlParserStream parse(final XMLStreamReader reader) throws XMLStreamException, URISyntaxException,
 114             IOException, ParserConfigurationException, SAXException {
 115         if (reader.hasNext()) {
 116             final CompositeNodeDataWithSchema compositeNodeDataWithSchema = new CompositeNodeDataWithSchema(parentNode);
 117             reader.nextTag();
 118             read(reader, compositeNodeDataWithSchema, reader.getLocalName());
 119             compositeNodeDataWithSchema.write(writer);
 120         }
 121
 122         return this;
 123     }
 124
 125     private static String readAnyXmlValue(final XMLStreamReader in) throws XMLStreamException {
 126         final StringBuilder sb = new StringBuilder();
 127         final String anyXmlElementName = in.getLocalName();
 128         sb.append('<').append(anyXmlElementName).append(" xmlns=\"").append(in.getNamespaceURI()).append("\">");
 129
 130         while (in.hasNext()) {
 131             final int eventType = in.next();
 132
 133             if (eventType == XMLStreamConstants.START_ELEMENT) {
 134                 sb.append('<').append(in.getLocalName()).append('>');
 135             } else if (eventType == XMLStreamConstants.END_ELEMENT) {
 136                 sb.append("</").append(in.getLocalName()).append('>');
 137
 138                 if (in.getLocalName().equals(anyXmlElementName)) {
 139                     break;
 140                 }
 141
 142             } else if (eventType == XMLStreamConstants.CHARACTERS) {
 143                 sb.append(in.getText());
 144             }
 145         }
 146
 147         return sb.toString();
 148     }
 149
 150     private void read(final XMLStreamReader in, final AbstractNodeDataWithSchema parent, final String rootElement)
 151             throws XMLStreamException, URISyntaxException, ParserConfigurationException, SAXException, IOException {
 152         if (!in.hasNext()) {
 153             return;
 154         }
 155
 156         if (parent instanceof LeafNodeDataWithSchema || parent instanceof LeafListEntryNodeDataWithSchema) {
 157             setValue(parent, in.getElementText().trim(), in.getNamespaceContext());
 158             in.nextTag();
 159             return;
 160         }
 161
 162         if (parent instanceof LeafListNodeDataWithSchema || parent instanceof ListNodeDataWithSchema) {
 163             String xmlElementName = in.getLocalName();
 164             while (xmlElementName.equals(parent.getSchema().getQName().getLocalName())) {
 165                 read(in, newEntryNode(parent), rootElement);
 166                 xmlElementName = in.getLocalName();
 167             }
 168
 169             return;
 170         }
 171
 172         if (parent instanceof AnyXmlNodeDataWithSchema) {
 173             setValue(parent, readAnyXmlValue(in), in.getNamespaceContext());
 174             in.nextTag();
 175             return;
 176         }
 177
 178         switch (in.nextTag()) {
 179             case XMLStreamConstants.START_ELEMENT:
 180                 final Set<String> namesakes = new HashSet<>();
 181                 while (in.hasNext()) {
 182                     final String xmlElementName = in.getLocalName();
 183                     if (rootElement.equals(xmlElementName)) {
 184                         break;
 185                     }
 186
 187                     DataSchemaNode parentSchema = parent.getSchema();
 188
 189                     final String parentSchemaName = parentSchema.getQName().getLocalName();
 190                     if (parentSchemaName.equals(xmlElementName) && in.getEventType() == XMLStreamConstants.END_ELEMENT) {
 191                         in.nextTag();
 192                         break;
 193                     }
 194
 195                     if (parentSchema instanceof YangModeledAnyXmlSchemaNode) {
 196                         parentSchema = ((YangModeledAnyXmlSchemaNode) parentSchema).getSchemaOfAnyXmlData();
 197                     }
 198
 199                     if (!namesakes.add(xmlElementName)) {
 200                         final Location loc = in.getLocation();
 201                         throw new IllegalStateException(String.format(
 202                                 "Duplicate element \"%s\" in XML input at: line %s column %s", xmlElementName,
 203                                 loc.getLineNumber(), loc.getColumnNumber()));
 204                     }
 205
 206                     final String xmlElementNamespace = in.getNamespaceURI();
 207                     final Deque<DataSchemaNode> childDataSchemaNodes =
 208                             ParserStreamUtils.findSchemaNodeByNameAndNamespace(parentSchema, xmlElementName,
 209                                     new URI(xmlElementNamespace));
 210
 211                     Preconditions.checkState(!childDataSchemaNodes.isEmpty(),
 212                             "Schema for node with name %s and namespace %s doesn't exist.",
 213                             xmlElementName, xmlElementNamespace);
 214
 215                     read(in, ((CompositeNodeDataWithSchema) parent).addChild(childDataSchemaNodes), rootElement);
 216                 }
 217                 break;
 218             case XMLStreamConstants.END_ELEMENT:
 219                 in.nextTag();
 220                 break;
 221         }
 222     }
 223
 224     private void setValue(final AbstractNodeDataWithSchema parent, final String value, final NamespaceContext nsContext)
 225             throws ParserConfigurationException, SAXException, IOException {
 226         Preconditions.checkArgument(parent instanceof SimpleNodeDataWithSchema, "Node %s is not a simple type",
 227                 parent.getSchema().getQName());
 228         final SimpleNodeDataWithSchema parentSimpleNode = (SimpleNodeDataWithSchema) parent;
 229         Preconditions.checkArgument(parentSimpleNode.getValue() == null, "Node '%s' has already set its value to '%s'",
 230                 parentSimpleNode.getSchema().getQName(), parentSimpleNode.getValue());
 231
 232         parentSimpleNode.setValue(translateValueByType(value, parentSimpleNode.getSchema(), nsContext));
 233     }
 234
 235     private Object translateValueByType(final String value, final DataSchemaNode node, final NamespaceContext namespaceCtx)
 236             throws IOException, SAXException, ParserConfigurationException {
 237         if (node instanceof AnyXmlSchemaNode) {
 238             /*
 239              *  FIXME: Figure out some YANG extension dispatch, which will
 240              *  reuse JSON parsing or XML parsing - anyxml is not well-defined in
 241              * JSON.
 242              */
 243             final Document doc = FACTORY.newDocumentBuilder().parse(new InputSource(new StringReader(value)));
 244             doc.normalize();
 245
 246             return new DOMSource(doc.getDocumentElement());
 247         } else {
 248             return codecs.codecFor(node, namespaceCtx).deserialize(value);
 249         }
 250     }
 251
 252     private static AbstractNodeDataWithSchema newEntryNode(final AbstractNodeDataWithSchema parent) {
 253         final AbstractNodeDataWithSchema newChild;
 254         if (parent instanceof ListNodeDataWithSchema) {
 255             newChild = new ListEntryNodeDataWithSchema(parent.getSchema());
 256         } else {
 257             newChild = new LeafListEntryNodeDataWithSchema(parent.getSchema());
 258         }
 259         ((CompositeNodeDataWithSchema) parent).addChild(newChild);
 260         return newChild;
 261     }
 262
 263     @Override
 264     public void close() throws IOException {
 265         writer.flush();
 266         writer.close();
 267     }
 268
 269     @Override
 270     public void flush() throws IOException {
 271         writer.flush();
 272     }
 273 }