2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.yangtools.yang.data.codec.xml;
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;
18 import java.net.URISyntaxException;
19 import java.util.Deque;
20 import java.util.HashSet;
22 import javax.annotation.concurrent.NotThreadSafe;
23 import javax.xml.namespace.NamespaceContext;
24 import javax.xml.parsers.ParserConfigurationException;
25 import javax.xml.stream.Location;
26 import javax.xml.stream.XMLStreamConstants;
27 import javax.xml.stream.XMLStreamException;
28 import javax.xml.stream.XMLStreamReader;
29 import javax.xml.transform.dom.DOMSource;
30 import org.opendaylight.yangtools.util.xml.UntrustedXML;
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.xml.sax.InputSource;
51 import org.xml.sax.SAXException;
54 * This class provides functionality for parsing an XML source containing YANG-modeled data. It disallows multiple
55 * instances of the same element except for leaf-list and list entries. It also expects that the YANG-modeled data in
56 * the XML source are wrapped in a root element.
60 public final class XmlParserStream implements Closeable, Flushable {
61 private final NormalizedNodeStreamWriter writer;
62 private final XmlCodecFactory codecs;
63 private final DataSchemaNode parentNode;
65 private XmlParserStream(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext,
66 final DataSchemaNode parentNode) {
67 this.writer = Preconditions.checkNotNull(writer);
68 this.codecs = XmlCodecFactory.create(schemaContext);
69 this.parentNode = parentNode;
72 public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext,
73 final SchemaNode parentNode ) {
74 if (parentNode instanceof RpcDefinition) {
75 return new XmlParserStream(writer, schemaContext, new RpcAsContainer((RpcDefinition) parentNode));
77 Preconditions.checkArgument(parentNode instanceof DataSchemaNode, "Instance of DataSchemaNode class awaited.");
78 return new XmlParserStream(writer, schemaContext, (DataSchemaNode) parentNode);
81 public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext) {
82 return new XmlParserStream(writer, schemaContext, schemaContext);
86 * This method parses the XML source and emits node events into a NormalizedNodeStreamWriter based on the
87 * YANG-modeled data contained in the XML source.
90 * StAX reader which is to used to walk through the XML source
92 * instance of XmlParserStream
93 * @throws XMLStreamException
94 * if a well-formedness error or an unexpected processing condition occurs while parsing the XML
95 * @throws URISyntaxException
96 * if the namespace URI of an XML element contains a syntax error
98 * if an error occurs while parsing the value of an anyxml node
99 * @throws ParserConfigurationException
100 * if an error occurs while parsing the value of an anyxml node
101 * @throws SAXException
102 * if an error occurs while parsing the value of an anyxml node
104 public XmlParserStream parse(final XMLStreamReader reader) throws XMLStreamException, URISyntaxException,
105 IOException, ParserConfigurationException, SAXException {
106 if (reader.hasNext()) {
107 final CompositeNodeDataWithSchema compositeNodeDataWithSchema = new CompositeNodeDataWithSchema(parentNode);
109 read(reader, compositeNodeDataWithSchema, reader.getLocalName());
110 compositeNodeDataWithSchema.write(writer);
116 private static String readAnyXmlValue(final XMLStreamReader in) throws XMLStreamException {
117 final StringBuilder sb = new StringBuilder();
118 final String anyXmlElementName = in.getLocalName();
119 sb.append('<').append(anyXmlElementName).append(" xmlns=\"").append(in.getNamespaceURI()).append("\">");
121 while (in.hasNext()) {
122 final int eventType = in.next();
124 if (eventType == XMLStreamConstants.START_ELEMENT) {
125 sb.append('<').append(in.getLocalName()).append('>');
126 } else if (eventType == XMLStreamConstants.END_ELEMENT) {
127 sb.append("</").append(in.getLocalName()).append('>');
129 if (in.getLocalName().equals(anyXmlElementName)) {
133 } else if (eventType == XMLStreamConstants.CHARACTERS) {
134 sb.append(in.getText());
138 return sb.toString();
141 private void read(final XMLStreamReader in, final AbstractNodeDataWithSchema parent, final String rootElement)
142 throws XMLStreamException, URISyntaxException, ParserConfigurationException, SAXException, IOException {
147 if (parent instanceof LeafNodeDataWithSchema || parent instanceof LeafListEntryNodeDataWithSchema) {
148 setValue(parent, in.getElementText().trim(), in.getNamespaceContext());
153 if (parent instanceof LeafListNodeDataWithSchema || parent instanceof ListNodeDataWithSchema) {
154 String xmlElementName = in.getLocalName();
155 while (xmlElementName.equals(parent.getSchema().getQName().getLocalName())) {
156 read(in, newEntryNode(parent), rootElement);
157 xmlElementName = in.getLocalName();
163 if (parent instanceof AnyXmlNodeDataWithSchema) {
164 setValue(parent, readAnyXmlValue(in), in.getNamespaceContext());
169 switch (in.nextTag()) {
170 case XMLStreamConstants.START_ELEMENT:
171 final Set<String> namesakes = new HashSet<>();
172 while (in.hasNext()) {
173 final String xmlElementName = in.getLocalName();
174 if (rootElement.equals(xmlElementName)) {
178 DataSchemaNode parentSchema = parent.getSchema();
180 final String parentSchemaName = parentSchema.getQName().getLocalName();
181 if (parentSchemaName.equals(xmlElementName) && in.getEventType() == XMLStreamConstants.END_ELEMENT) {
186 if (parentSchema instanceof YangModeledAnyXmlSchemaNode) {
187 parentSchema = ((YangModeledAnyXmlSchemaNode) parentSchema).getSchemaOfAnyXmlData();
190 if (!namesakes.add(xmlElementName)) {
191 final Location loc = in.getLocation();
192 throw new IllegalStateException(String.format(
193 "Duplicate element \"%s\" in XML input at: line %s column %s", xmlElementName,
194 loc.getLineNumber(), loc.getColumnNumber()));
197 final String xmlElementNamespace = in.getNamespaceURI();
198 final Deque<DataSchemaNode> childDataSchemaNodes =
199 ParserStreamUtils.findSchemaNodeByNameAndNamespace(parentSchema, xmlElementName,
200 new URI(xmlElementNamespace));
202 Preconditions.checkState(!childDataSchemaNodes.isEmpty(),
203 "Schema for node with name %s and namespace %s doesn't exist.",
204 xmlElementName, xmlElementNamespace);
206 read(in, ((CompositeNodeDataWithSchema) parent).addChild(childDataSchemaNodes), rootElement);
209 case XMLStreamConstants.END_ELEMENT:
215 private void setValue(final AbstractNodeDataWithSchema parent, final String value, final NamespaceContext nsContext)
216 throws ParserConfigurationException, SAXException, IOException {
217 Preconditions.checkArgument(parent instanceof SimpleNodeDataWithSchema, "Node %s is not a simple type",
218 parent.getSchema().getQName());
219 final SimpleNodeDataWithSchema parentSimpleNode = (SimpleNodeDataWithSchema) parent;
220 Preconditions.checkArgument(parentSimpleNode.getValue() == null, "Node '%s' has already set its value to '%s'",
221 parentSimpleNode.getSchema().getQName(), parentSimpleNode.getValue());
223 parentSimpleNode.setValue(translateValueByType(value, parentSimpleNode.getSchema(), nsContext));
226 private Object translateValueByType(final String value, final DataSchemaNode node, final NamespaceContext namespaceCtx)
227 throws IOException, SAXException, ParserConfigurationException {
228 if (node instanceof AnyXmlSchemaNode) {
230 * FIXME: Figure out some YANG extension dispatch, which will
231 * reuse JSON parsing or XML parsing - anyxml is not well-defined in
234 final Document doc = UntrustedXML.newDocumentBuilder().parse(new InputSource(new StringReader(value)));
237 return new DOMSource(doc.getDocumentElement());
240 return codecs.codecFor(node, namespaceCtx).deserialize(value);
243 private static AbstractNodeDataWithSchema newEntryNode(final AbstractNodeDataWithSchema parent) {
244 final AbstractNodeDataWithSchema newChild;
245 if (parent instanceof ListNodeDataWithSchema) {
246 newChild = new ListEntryNodeDataWithSchema(parent.getSchema());
248 newChild = new LeafListEntryNodeDataWithSchema(parent.getSchema());
250 ((CompositeNodeDataWithSchema) parent).addChild(newChild);
255 public void close() throws IOException {
261 public void flush() throws IOException {