package org.opendaylight.yangtools.yang.data.codec.xml;
-import com.google.common.base.Preconditions;
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Preconditions.checkState;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.annotations.Beta;
+import com.google.common.collect.ImmutableMap;
+import com.google.common.xml.XmlEscapers;
import java.io.Closeable;
import java.io.Flushable;
import java.io.IOException;
import java.net.URISyntaxException;
import java.util.Deque;
import java.util.HashSet;
+import java.util.LinkedHashMap;
+import java.util.Map;
import java.util.Set;
-import javax.xml.parsers.DocumentBuilder;
-import javax.xml.parsers.DocumentBuilderFactory;
+import javax.annotation.concurrent.NotThreadSafe;
+import javax.xml.XMLConstants;
+import javax.xml.namespace.NamespaceContext;
import javax.xml.parsers.ParserConfigurationException;
+import javax.xml.stream.Location;
import javax.xml.stream.XMLStreamConstants;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import javax.xml.transform.dom.DOMSource;
-import org.opendaylight.yangtools.yang.data.api.schema.stream.DataSchemaNodeAwareAdaptor;
+import org.opendaylight.yangtools.util.xml.UntrustedXML;
+import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
-import org.opendaylight.yangtools.yang.data.api.schema.stream.SchemaAwareNormalizedNodeStreamWriter;
import org.opendaylight.yangtools.yang.data.util.AbstractNodeDataWithSchema;
import org.opendaylight.yangtools.yang.data.util.AnyXmlNodeDataWithSchema;
import org.opendaylight.yangtools.yang.data.util.CompositeNodeDataWithSchema;
+import org.opendaylight.yangtools.yang.data.util.ContainerNodeDataWithSchema;
import org.opendaylight.yangtools.yang.data.util.LeafListEntryNodeDataWithSchema;
import org.opendaylight.yangtools.yang.data.util.LeafListNodeDataWithSchema;
import org.opendaylight.yangtools.yang.data.util.LeafNodeDataWithSchema;
import org.opendaylight.yangtools.yang.data.util.ParserStreamUtils;
import org.opendaylight.yangtools.yang.data.util.RpcAsContainer;
import org.opendaylight.yangtools.yang.data.util.SimpleNodeDataWithSchema;
+import org.opendaylight.yangtools.yang.data.util.YangModeledAnyXmlNodeDataWithSchema;
import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
import org.opendaylight.yangtools.yang.model.api.SchemaContext;
import org.opendaylight.yangtools.yang.model.api.SchemaNode;
+import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
import org.opendaylight.yangtools.yang.model.api.YangModeledAnyXmlSchemaNode;
import org.w3c.dom.Document;
import org.xml.sax.InputSource;
* instances of the same element except for leaf-list and list entries. It also expects that the YANG-modeled data in
* the XML source are wrapped in a root element.
*/
+@Beta
+@NotThreadSafe
public final class XmlParserStream implements Closeable, Flushable {
-
- private String rootElement = null;
- private final SchemaAwareNormalizedNodeStreamWriter writer;
+ private final NormalizedNodeStreamWriter writer;
private final XmlCodecFactory codecs;
- private final SchemaContext schema;
private final DataSchemaNode parentNode;
+ private final boolean strictParsing;
- private XmlParserStream(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext,
- final DataSchemaNode parentNode) {
- this.schema = Preconditions.checkNotNull(schemaContext);
- this.writer = DataSchemaNodeAwareAdaptor.forWriter(writer);
- this.codecs = XmlCodecFactory.create(schemaContext);
+ private XmlParserStream(final NormalizedNodeStreamWriter writer, final XmlCodecFactory codecs,
+ final DataSchemaNode parentNode, final boolean strictParsing) {
+ this.writer = requireNonNull(writer);
+ this.codecs = requireNonNull(codecs);
this.parentNode = parentNode;
+ this.strictParsing = strictParsing;
}
- public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext,
- final SchemaNode parentNode ) {
+ /**
+ * Construct a new {@link XmlParserStream} with strict parsing mode switched on.
+ *
+ * @param writer Output writer
+ * @param codecs Shared codecs
+ * @param parentNode Parent root node
+ * @return A new stream instance
+ */
+ public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final XmlCodecFactory codecs,
+ final SchemaNode parentNode) {
+ return create(writer, codecs, parentNode, true);
+ }
+
+ /**
+ * Construct a new {@link XmlParserStream}.
+ *
+ * @param writer Output writer
+ * @param codecs Shared codecs
+ * @param parentNode Parent root node
+ * @param strictParsing parsing mode
+ * if set to true, the parser will throw an exception if it encounters unknown child nodes
+ * (nodes, that are not defined in the provided SchemaContext) in containers and lists
+ * if set to false, the parser will skip unknown child nodes
+ * @return A new stream instance
+ */
+ public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final XmlCodecFactory codecs,
+ final SchemaNode parentNode, final boolean strictParsing) {
if (parentNode instanceof RpcDefinition) {
- return new XmlParserStream(writer, schemaContext, new RpcAsContainer((RpcDefinition) parentNode));
+ return new XmlParserStream(writer, codecs, new RpcAsContainer((RpcDefinition) parentNode), strictParsing);
}
- Preconditions.checkArgument(parentNode instanceof DataSchemaNode, "Instance of DataSchemaNode class awaited.");
- return new XmlParserStream(writer, schemaContext, (DataSchemaNode) parentNode);
+ checkArgument(parentNode instanceof DataSchemaNode, "Instance of DataSchemaNode class awaited.");
+ return new XmlParserStream(writer, codecs, (DataSchemaNode) parentNode, strictParsing);
+ }
+
+ /**
+ * Utility method for use when caching {@link XmlCodecFactory} is not feasible. Users with high performance
+ * requirements should use {@link #create(NormalizedNodeStreamWriter, XmlCodecFactory, SchemaNode)} instead and
+ * maintain a {@link XmlCodecFactory} to match the current {@link SchemaContext}.
+ */
+ public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext,
+ final SchemaNode parentNode) {
+ return create(writer, schemaContext, parentNode, true);
}
- public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext) {
- return new XmlParserStream(writer, schemaContext, schemaContext);
+ /**
+ * Utility method for use when caching {@link XmlCodecFactory} is not feasible. Users with high performance
+ * requirements should use {@link #create(NormalizedNodeStreamWriter, XmlCodecFactory, SchemaNode)} instead and
+ * maintain a {@link XmlCodecFactory} to match the current {@link SchemaContext}.
+ */
+ public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext,
+ final SchemaNode parentNode, final boolean strictParsing) {
+ return create(writer, XmlCodecFactory.create(schemaContext), parentNode, strictParsing);
}
/**
public XmlParserStream parse(final XMLStreamReader reader) throws XMLStreamException, URISyntaxException,
IOException, ParserConfigurationException, SAXException {
if (reader.hasNext()) {
- final CompositeNodeDataWithSchema compositeNodeDataWithSchema = new CompositeNodeDataWithSchema(parentNode);
reader.nextTag();
- rootElement = reader.getLocalName();
- read(reader, compositeNodeDataWithSchema);
- compositeNodeDataWithSchema.write(writer);
+ final AbstractNodeDataWithSchema nodeDataWithSchema;
+ if (parentNode instanceof ContainerSchemaNode) {
+ nodeDataWithSchema = new ContainerNodeDataWithSchema(parentNode);
+ } else if (parentNode instanceof ListSchemaNode) {
+ nodeDataWithSchema = new ListNodeDataWithSchema(parentNode);
+ } else if (parentNode instanceof YangModeledAnyXmlSchemaNode) {
+ nodeDataWithSchema = new YangModeledAnyXmlNodeDataWithSchema((YangModeledAnyXmlSchemaNode) parentNode);
+ } else if (parentNode instanceof AnyXmlSchemaNode) {
+ nodeDataWithSchema = new AnyXmlNodeDataWithSchema(parentNode);
+ } else if (parentNode instanceof LeafSchemaNode) {
+ nodeDataWithSchema = new LeafNodeDataWithSchema(parentNode);
+ } else if (parentNode instanceof LeafListSchemaNode) {
+ nodeDataWithSchema = new LeafListNodeDataWithSchema(parentNode);
+ } else {
+ throw new IllegalStateException("Unsupported schema node type " + parentNode.getClass() + ".");
+ }
+
+ read(reader, nodeDataWithSchema, reader.getLocalName());
+ nodeDataWithSchema.write(writer);
}
return this;
}
- private String readAnyXmlValue(XMLStreamReader in) throws XMLStreamException {
- String result = "";
- String anyXmlElementName = in.getLocalName();
+ /**
+ * This method traverses a {@link DOMSource} and emits node events into a NormalizedNodeStreamWriter based on the
+ * YANG-modeled data contained in the source.
+ *
+ * @param src
+ * {@link DOMSource} to be traversed
+ * @return
+ * instance of XmlParserStream
+ * @throws XMLStreamException
+ * if a well-formedness error or an unexpected processing condition occurs while parsing the XML
+ * @throws URISyntaxException
+ * if the namespace URI of an XML element contains a syntax error
+ * @throws IOException
+ * if an error occurs while parsing the value of an anyxml node
+ * @throws ParserConfigurationException
+ * if an error occurs while parsing the value of an anyxml node
+ * @throws SAXException
+ * if an error occurs while parsing the value of an anyxml node
+ */
+ @Beta
+ public XmlParserStream traverse(final DOMSource src) throws XMLStreamException, URISyntaxException,
+ IOException, ParserConfigurationException, SAXException {
+ return parse(new DOMSourceXMLStreamReader(src));
+ }
+
+ private static Map<QName, String> getElementAttributes(final XMLStreamReader in) {
+ checkState(in.isStartElement(), "Attributes can be extracted only from START_ELEMENT.");
+ final Map<QName, String> attributes = new LinkedHashMap<>();
+
+ for (int attrIndex = 0; attrIndex < in.getAttributeCount(); attrIndex++) {
+ String attributeNS = in.getAttributeNamespace(attrIndex);
+
+ if (attributeNS == null) {
+ attributeNS = "";
+ }
+
+ // Skip namespace definitions
+ if (XMLConstants.XMLNS_ATTRIBUTE_NS_URI.equals(attributeNS)) {
+ continue;
+ }
+
+ final QName qName = QName.create(URI.create(attributeNS), in.getAttributeLocalName(attrIndex));
+ attributes.put(qName, in.getAttributeValue(attrIndex));
+ }
+
+ return ImmutableMap.copyOf(attributes);
+ }
+
+ private static String readAnyXmlValue(final XMLStreamReader in) throws XMLStreamException {
+ final StringBuilder sb = new StringBuilder();
+ final String anyXmlElementName = in.getLocalName();
+ sb.append('<').append(anyXmlElementName).append(" xmlns=\"").append(in.getNamespaceURI()).append("\">");
while (in.hasNext()) {
- int eventType = in.next();
+ final int eventType = in.next();
if (eventType == XMLStreamConstants.START_ELEMENT) {
- result += "<" + in.getLocalName() + ">";
+ sb.append('<').append(in.getLocalName()).append('>');
} else if (eventType == XMLStreamConstants.END_ELEMENT) {
+ sb.append("</").append(in.getLocalName()).append('>');
+
if (in.getLocalName().equals(anyXmlElementName)) {
break;
}
- result += "</" + in.getLocalName() + ">";
} else if (eventType == XMLStreamConstants.CHARACTERS) {
- result += in.getText();
+ sb.append(XmlEscapers.xmlContentEscaper().escape(in.getText()));
}
}
- return result;
+ return sb.toString();
}
- private void read(final XMLStreamReader in, AbstractNodeDataWithSchema parent) throws XMLStreamException,
- URISyntaxException, ParserConfigurationException, SAXException, IOException {
- if (in.hasNext()) {
- if (parent instanceof LeafNodeDataWithSchema || parent instanceof LeafListEntryNodeDataWithSchema) {
- setValue(parent, in.getElementText().trim());
- in.nextTag();
+ private void read(final XMLStreamReader in, final AbstractNodeDataWithSchema parent, final String rootElement)
+ throws XMLStreamException, URISyntaxException, ParserConfigurationException, SAXException, IOException {
+ if (!in.hasNext()) {
+ return;
+ }
+
+ if (parent instanceof LeafNodeDataWithSchema || parent instanceof LeafListEntryNodeDataWithSchema) {
+ parent.setAttributes(getElementAttributes(in));
+ setValue(parent, in.getElementText().trim(), in.getNamespaceContext());
+ if (isNextEndDocument(in)) {
return;
- } else if (parent instanceof LeafListNodeDataWithSchema || parent instanceof ListNodeDataWithSchema) {
- String parentSchemaName = parent.getSchema().getQName().getLocalName();
- String xmlElementName = in.getLocalName();
- while (xmlElementName.equals(parentSchemaName)) {
- AbstractNodeDataWithSchema newChild = newEntryNode(parent);
- read(in, newChild);
- xmlElementName = in.getLocalName();
+ }
+
+ if (!isAtElement(in)) {
+ in.nextTag();
+ }
+ return;
+ }
+
+ if (parent instanceof ListEntryNodeDataWithSchema || parent instanceof ContainerNodeDataWithSchema) {
+ parent.setAttributes(getElementAttributes(in));
+ }
+
+ if (parent instanceof LeafListNodeDataWithSchema || parent instanceof ListNodeDataWithSchema) {
+ String xmlElementName = in.getLocalName();
+ while (xmlElementName.equals(parent.getSchema().getQName().getLocalName())) {
+ read(in, newEntryNode(parent), rootElement);
+ if (in.getEventType() == XMLStreamConstants.END_DOCUMENT) {
+ break;
}
+ xmlElementName = in.getLocalName();
+ }
+
+ return;
+ }
+ if (parent instanceof AnyXmlNodeDataWithSchema) {
+ setValue(parent, readAnyXmlValue(in), in.getNamespaceContext());
+ if (isNextEndDocument(in)) {
return;
- } else if (parent instanceof AnyXmlNodeDataWithSchema) {
- setValue(parent, readAnyXmlValue(in));
+ }
+
+ if (!isAtElement(in)) {
in.nextTag();
- return;
}
- switch (in.nextTag()) {
- case XMLStreamConstants.START_ELEMENT:
- final Set<String> namesakes = new HashSet<>();
- while (in.hasNext()) {
- String xmlElementName = in.getLocalName();
- String xmlElementNamespace = in.getNamespaceURI();
+ return;
+ }
- if (xmlElementName.equals(rootElement)) {
- break;
- }
+ if (parent instanceof YangModeledAnyXmlSchemaNode) {
+ parent.setAttributes(getElementAttributes(in));
+ }
- DataSchemaNode parentSchema = parent.getSchema();
- if (parentSchema instanceof YangModeledAnyXmlSchemaNode) {
- parentSchema = ((YangModeledAnyXmlSchemaNode) parentSchema).getSchemaOfAnyXmlData();
- }
+ switch (in.nextTag()) {
+ case XMLStreamConstants.START_ELEMENT:
+ final Set<String> namesakes = new HashSet<>();
+ while (in.hasNext()) {
+ final String xmlElementName = in.getLocalName();
- String parentSchemaName = parentSchema.getQName().getLocalName();
- if (parentSchemaName.equals(xmlElementName)
- && in.getEventType() == XMLStreamConstants.END_ELEMENT) {
- in.nextTag();
+ DataSchemaNode parentSchema = parent.getSchema();
+
+ final String parentSchemaName = parentSchema.getQName().getLocalName();
+ if (parentSchemaName.equals(xmlElementName)
+ && in.getEventType() == XMLStreamConstants.END_ELEMENT) {
+ if (isNextEndDocument(in)) {
break;
}
- if (namesakes.contains(xmlElementName)) {
- int lineNumber = in.getLocation().getLineNumber();
- int columnNumber = in.getLocation().getColumnNumber();
- throw new IllegalStateException("Duplicate element \"" + xmlElementName + "\" in XML " +
- "input at: line " + lineNumber + " column " + columnNumber);
+ if (!isAtElement(in)) {
+ in.nextTag();
}
- namesakes.add(xmlElementName);
+ break;
+ }
- Deque<DataSchemaNode> childDataSchemaNodes = ParserStreamUtils.findSchemaNodeByNameAndNamespace(
- parentSchema, xmlElementName, new URI(xmlElementNamespace));
+ if (in.isEndElement() && rootElement.equals(xmlElementName)) {
+ break;
+ }
- if (childDataSchemaNodes.isEmpty()) {
- throw new IllegalStateException("Schema for node with name " + xmlElementName +
- " and namespace " + xmlElementNamespace + " doesn't exist.");
- }
+ if (parentSchema instanceof YangModeledAnyXmlSchemaNode) {
+ parentSchema = ((YangModeledAnyXmlSchemaNode) parentSchema).getSchemaOfAnyXmlData();
+ }
+
+ if (!namesakes.add(xmlElementName)) {
+ final Location loc = in.getLocation();
+ throw new IllegalStateException(String.format(
+ "Duplicate element \"%s\" in XML input at: line %s column %s", xmlElementName,
+ loc.getLineNumber(), loc.getColumnNumber()));
+ }
- AbstractNodeDataWithSchema newChild =
- ((CompositeNodeDataWithSchema) parent).addChild(childDataSchemaNodes);
+ final String xmlElementNamespace = in.getNamespaceURI();
+ final Deque<DataSchemaNode> childDataSchemaNodes =
+ ParserStreamUtils.findSchemaNodeByNameAndNamespace(parentSchema, xmlElementName,
+ new URI(xmlElementNamespace));
- read(in, newChild);
+ if (childDataSchemaNodes.isEmpty()) {
+ checkState(!strictParsing, "Schema for node with name %s and namespace %s doesn't exist.",
+ xmlElementName, xmlElementNamespace);
+ skipUnknownNode(in);
+ continue;
}
+
+ read(in, ((CompositeNodeDataWithSchema) parent).addChild(childDataSchemaNodes), rootElement);
+ }
+ break;
+ case XMLStreamConstants.END_ELEMENT:
+ if (isNextEndDocument(in)) {
break;
- case XMLStreamConstants.END_ELEMENT:
+ }
+
+ if (!isAtElement(in)) {
in.nextTag();
+ }
+ break;
+ default:
+ break;
+ }
+ }
+
+ private static boolean isNextEndDocument(final XMLStreamReader in) throws XMLStreamException {
+ return in.next() == XMLStreamConstants.END_DOCUMENT;
+ }
+
+ private static boolean isAtElement(final XMLStreamReader in) {
+ return in.getEventType() == XMLStreamConstants.START_ELEMENT
+ || in.getEventType() == XMLStreamConstants.END_ELEMENT;
+ }
+
+ private static void skipUnknownNode(final XMLStreamReader in) throws XMLStreamException {
+ // in case when the unknown node and at least one of its descendant nodes have the same name
+ // we cannot properly reach the end just by checking if the current node is an end element and has the same name
+ // as the root unknown element. therefore we ignore the names completely and just track the level of nesting
+ int levelOfNesting = 0;
+ while (in.hasNext()) {
+ // in case there are text characters in an element, we cannot skip them by calling nextTag()
+ // therefore we skip them by calling next(), and then proceed to next element
+ in.next();
+ if (!isAtElement(in)) {
+ in.nextTag();
+ }
+ if (in.isStartElement()) {
+ levelOfNesting++;
+ }
+
+ if (in.isEndElement()) {
+ if (levelOfNesting == 0) {
break;
+ }
+
+ levelOfNesting--;
}
}
+
+ in.nextTag();
}
- private void setValue(final AbstractNodeDataWithSchema parent, final String value) throws
- ParserConfigurationException, SAXException, IOException {
- Preconditions.checkArgument(parent instanceof SimpleNodeDataWithSchema, "Node %s is not a simple type",
+ private void setValue(final AbstractNodeDataWithSchema parent, final String value, final NamespaceContext nsContext)
+ throws ParserConfigurationException, SAXException, IOException {
+ checkArgument(parent instanceof SimpleNodeDataWithSchema, "Node %s is not a simple type",
parent.getSchema().getQName());
final SimpleNodeDataWithSchema parentSimpleNode = (SimpleNodeDataWithSchema) parent;
- Preconditions.checkArgument(parentSimpleNode.getValue() == null, "Node '%s' has already set its value to '%s'",
+ checkArgument(parentSimpleNode.getValue() == null, "Node '%s' has already set its value to '%s'",
parentSimpleNode.getSchema().getQName(), parentSimpleNode.getValue());
- final Object translatedValue = translateValueByType(value, parentSimpleNode.getSchema());
- parentSimpleNode.setValue(translatedValue);
+ parentSimpleNode.setValue(translateValueByType(value, parentSimpleNode.getSchema(), nsContext));
}
- private Object translateValueByType(final String value, final DataSchemaNode node) throws IOException,
- SAXException, ParserConfigurationException {
+ private Object translateValueByType(final String value, final DataSchemaNode node,
+ final NamespaceContext namespaceCtx) throws IOException, SAXException, ParserConfigurationException {
if (node instanceof AnyXmlSchemaNode) {
/*
* FIXME: Figure out some YANG extension dispatch, which will
* reuse JSON parsing or XML parsing - anyxml is not well-defined in
* JSON.
*/
- DocumentBuilder db = DocumentBuilderFactory.newInstance().newDocumentBuilder();
- Document doc = db.parse( new InputSource(new StringReader(value)));
+ final Document doc = UntrustedXML.newDocumentBuilder().parse(new InputSource(new StringReader(value)));
doc.normalize();
- DOMSource anyXmlValueSource = new DOMSource(doc);
- return anyXmlValueSource;
+ return new DOMSource(doc.getDocumentElement());
}
- return codecs.codecFor(node).deserialize(value);
+
+ checkArgument(node instanceof TypedDataSchemaNode);
+ return codecs.codecFor((TypedDataSchemaNode) node).parseValue(namespaceCtx, value);
}
- private AbstractNodeDataWithSchema newEntryNode(final AbstractNodeDataWithSchema parent) {
- AbstractNodeDataWithSchema newChild;
+ private static AbstractNodeDataWithSchema newEntryNode(final AbstractNodeDataWithSchema parent) {
+ final AbstractNodeDataWithSchema newChild;
if (parent instanceof ListNodeDataWithSchema) {
newChild = new ListEntryNodeDataWithSchema(parent.getSchema());
} else {
Code Review / yangtools.git / blobdiff