* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
-
package org.opendaylight.yangtools.yang.data.codec.xml;
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Preconditions.checkState;
+import static com.google.common.base.Verify.verify;
+import static java.util.Objects.requireNonNull;
+
import com.google.common.annotations.Beta;
-import com.google.common.base.Preconditions;
+import com.google.common.base.Strings;
import com.google.common.collect.ImmutableMap;
import java.io.Closeable;
import java.io.Flushable;
import java.io.IOException;
-import java.io.StringReader;
import java.net.URI;
import java.net.URISyntaxException;
+import java.util.AbstractMap.SimpleImmutableEntry;
import java.util.Deque;
+import java.util.HashMap;
import java.util.HashSet;
+import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Map;
+import java.util.Map.Entry;
+import java.util.Optional;
import java.util.Set;
-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.stream.util.StreamReaderDelegate;
+import javax.xml.transform.TransformerException;
+import javax.xml.transform.TransformerFactory;
+import javax.xml.transform.TransformerFactoryConfigurationError;
+import javax.xml.transform.dom.DOMResult;
import javax.xml.transform.dom.DOMSource;
-import org.opendaylight.yangtools.util.xml.UntrustedXML;
+import javax.xml.transform.stax.StAXSource;
+import org.opendaylight.yangtools.odlext.model.api.YangModeledAnyxmlSchemaNode;
+import org.opendaylight.yangtools.rfc7952.model.api.AnnotationSchemaNode;
+import org.opendaylight.yangtools.rfc8528.data.api.MountPointContext;
+import org.opendaylight.yangtools.rfc8528.data.api.MountPointContextFactory;
+import org.opendaylight.yangtools.rfc8528.data.api.MountPointIdentifier;
+import org.opendaylight.yangtools.rfc8528.data.api.YangLibraryConstants;
+import org.opendaylight.yangtools.rfc8528.data.api.YangLibraryConstants.ContainerName;
+import org.opendaylight.yangtools.rfc8528.model.api.MountPointSchemaNode;
+import org.opendaylight.yangtools.rfc8528.model.api.SchemaMountConstants;
import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.QNameModule;
import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
+import org.opendaylight.yangtools.yang.data.util.AbstractMountPointDataWithSchema;
import org.opendaylight.yangtools.yang.data.util.AbstractNodeDataWithSchema;
import org.opendaylight.yangtools.yang.data.util.AnyXmlNodeDataWithSchema;
+import org.opendaylight.yangtools.yang.data.util.AnydataNodeDataWithSchema;
import org.opendaylight.yangtools.yang.data.util.CompositeNodeDataWithSchema;
+import org.opendaylight.yangtools.yang.data.util.CompositeNodeDataWithSchema.ChildReusePolicy;
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.ListEntryNodeDataWithSchema;
import org.opendaylight.yangtools.yang.data.util.ListNodeDataWithSchema;
+import org.opendaylight.yangtools.yang.data.util.MountPointData;
+import org.opendaylight.yangtools.yang.data.util.MultipleEntryDataWithSchema;
+import org.opendaylight.yangtools.yang.data.util.OperationAsContainer;
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.AnydataSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.ContainerLike;
import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
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.Module;
+import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
import org.opendaylight.yangtools.yang.model.api.SchemaNode;
-import org.opendaylight.yangtools.yang.model.api.TypedSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.YangModeledAnyXmlSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
-import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
/**
* This class provides functionality for parsing an XML source containing YANG-modeled data. It disallows multiple
* 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.
+ * the XML source are wrapped in a root element. This class is NOT thread-safe.
+ *
+ * <p>
+ * Due to backwards compatibility reasons, RFC7952 metadata emitted by this parser may include key QNames with empty URI
+ * (as exposed via {@link #LEGACY_ATTRIBUTE_NAMESPACE}) as their QNameModule. These indicate an unqualified XML
+ * attribute and their value can be assumed to be a String. Furthermore, this extends to qualified attributes, which
+ * uses the proper namespace, but will not bind to a proper module revision -- these need to be reconciled with a
+ * particular SchemaContext and are expected to either be fully decoded, or contain a String value. Handling of such
+ * annotations is at the discretion of the user encountering it: preferred way of handling is to either filter or
+ * normalize them to proper QNames/values when encountered. This caveat will be removed in a future version.
*/
@Beta
-@NotThreadSafe
public final class XmlParserStream implements Closeable, Flushable {
+ /**
+ * {@link QNameModule} for use with legacy XML attributes.
+ * @deprecated The use on this namespace is discouraged and users are strongly encouraged to proper RFC7952 metadata
+ * annotations.
+ */
+ @Deprecated
+ public static final QNameModule LEGACY_ATTRIBUTE_NAMESPACE = QNameModule.create(URI.create("")).intern();
+
+ private static final Logger LOG = LoggerFactory.getLogger(XmlParserStream.class);
+ private static final String XML_STANDARD_VERSION = "1.0";
+ private static final String COM_SUN_TRANSFORMER =
+ "com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl";
+
+ private static final TransformerFactory TRANSFORMER_FACTORY;
+
+ static {
+ TransformerFactory fa = TransformerFactory.newInstance();
+ if (!fa.getFeature(StAXSource.FEATURE)) {
+ LOG.warn("Platform-default TransformerFactory {} does not support StAXSource, attempting fallback to {}",
+ fa, COM_SUN_TRANSFORMER);
+ fa = TransformerFactory.newInstance(COM_SUN_TRANSFORMER, null);
+ if (!fa.getFeature(StAXSource.FEATURE)) {
+ throw new TransformerFactoryConfigurationError("No TransformerFactory supporting StAXResult found.");
+ }
+ }
+
+ TRANSFORMER_FACTORY = fa;
+ }
+
+ // Cache of nsUri Strings to QNameModules, as resolved in context
+ private final Map<String, Optional<QNameModule>> resolvedNamespaces = new HashMap<>();
+ // Cache of nsUri Strings to QNameModules, as inferred from document
+ private final Map<String, QNameModule> rawNamespaces = new HashMap<>();
private final NormalizedNodeStreamWriter writer;
private final XmlCodecFactory codecs;
private final DataSchemaNode parentNode;
private XmlParserStream(final NormalizedNodeStreamWriter writer, final XmlCodecFactory codecs,
final DataSchemaNode parentNode, final boolean strictParsing) {
- this.writer = Preconditions.checkNotNull(writer);
- this.codecs = Preconditions.checkNotNull(codecs);
+ this.writer = requireNonNull(writer);
+ this.codecs = requireNonNull(codecs);
this.parentNode = parentNode;
this.strictParsing = strictParsing;
}
*/
public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final XmlCodecFactory codecs,
final SchemaNode parentNode, final boolean strictParsing) {
- if (parentNode instanceof RpcDefinition) {
- return new XmlParserStream(writer, codecs, new RpcAsContainer((RpcDefinition) parentNode), strictParsing);
+ final DataSchemaNode parent;
+ if (parentNode instanceof DataSchemaNode) {
+ parent = (DataSchemaNode) parentNode;
+ } else if (parentNode instanceof OperationDefinition) {
+ parent = OperationAsContainer.of((OperationDefinition) parentNode);
+ } else {
+ throw new IllegalArgumentException("Illegal parent node " + parentNode);
}
- Preconditions.checkArgument(parentNode instanceof DataSchemaNode, "Instance of DataSchemaNode class awaited.");
- return new XmlParserStream(writer, codecs, (DataSchemaNode) parentNode, strictParsing);
+ return new XmlParserStream(writer, codecs, parent, strictParsing);
}
/**
- * Construct a new {@link XmlParserStream}.
- *
- * @deprecated Use {@link #create(NormalizedNodeStreamWriter, SchemaContext, SchemaNode)} instead.
+ * 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 EffectiveModelContext}.
*/
- @Deprecated
- public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext) {
- return create(writer, schemaContext, schemaContext);
+ public static XmlParserStream create(final NormalizedNodeStreamWriter writer,
+ final EffectiveModelContext schemaContext, final SchemaNode parentNode) {
+ return create(writer, schemaContext, parentNode, true);
}
/**
* 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}.
+ * maintain a {@link XmlCodecFactory} to match the current {@link EffectiveModelContext}.
*/
- public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext,
+ public static XmlParserStream create(final NormalizedNodeStreamWriter writer,
+ final EffectiveModelContext schemaContext, final SchemaNode parentNode, final boolean strictParsing) {
+ return create(writer, XmlCodecFactory.create(schemaContext), 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 MountPointContext}.
+ */
+ public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final MountPointContext mountCtx,
final SchemaNode parentNode) {
- return create(writer, schemaContext, parentNode, true);
+ return create(writer, mountCtx, parentNode, true);
}
/**
* 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}.
+ * maintain a {@link XmlCodecFactory} to match the current {@link MountPointContext}.
*/
- public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext,
+ public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final MountPointContext mountCtx,
final SchemaNode parentNode, final boolean strictParsing) {
- return create(writer, XmlCodecFactory.create(schemaContext), parentNode, strictParsing);
+ return create(writer, XmlCodecFactory.create(mountCtx), parentNode, strictParsing);
}
/**
* 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
*/
public XmlParserStream parse(final XMLStreamReader reader) throws XMLStreamException, URISyntaxException,
- IOException, ParserConfigurationException, SAXException {
+ IOException, SAXException {
if (reader.hasNext()) {
reader.nextTag();
- final AbstractNodeDataWithSchema nodeDataWithSchema;
- if (parentNode instanceof ContainerSchemaNode) {
- nodeDataWithSchema = new ContainerNodeDataWithSchema(parentNode);
+ final AbstractNodeDataWithSchema<?> nodeDataWithSchema;
+ if (parentNode instanceof ContainerLike) {
+ nodeDataWithSchema = new ContainerNodeDataWithSchema((ContainerLike) 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);
+ nodeDataWithSchema = new ListNodeDataWithSchema((ListSchemaNode) parentNode);
+ } else if (parentNode instanceof YangModeledAnyxmlSchemaNode) {
+ nodeDataWithSchema = new YangModeledAnyXmlNodeDataWithSchema((YangModeledAnyxmlSchemaNode) parentNode);
+ } else if (parentNode instanceof AnyxmlSchemaNode) {
+ nodeDataWithSchema = new AnyXmlNodeDataWithSchema((AnyxmlSchemaNode) parentNode);
} else if (parentNode instanceof LeafSchemaNode) {
- nodeDataWithSchema = new LeafNodeDataWithSchema(parentNode);
+ nodeDataWithSchema = new LeafNodeDataWithSchema((LeafSchemaNode) parentNode);
} else if (parentNode instanceof LeafListSchemaNode) {
- nodeDataWithSchema = new LeafListNodeDataWithSchema(parentNode);
+ nodeDataWithSchema = new LeafListNodeDataWithSchema((LeafListSchemaNode) parentNode);
+ } else if (parentNode instanceof AnydataSchemaNode) {
+ nodeDataWithSchema = new AnydataNodeDataWithSchema((AnydataSchemaNode) parentNode);
} else {
throw new IllegalStateException("Unsupported schema node type " + parentNode.getClass() + ".");
}
return this;
}
- private static Map<QName, String> getElementAttributes(final XMLStreamReader in) {
- Preconditions.checkState(in.isStartElement(), "Attributes can be extracted only from START_ELEMENT.");
- final Map<QName, String> attributes = new LinkedHashMap<>();
+ /**
+ * 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 SAXException
+ * if an error occurs while parsing the value of an anyxml node
+ */
+ @Beta
+ public XmlParserStream traverse(final DOMSource src) throws XMLStreamException, URISyntaxException, IOException,
+ SAXException {
+ return parse(new DOMSourceXMLStreamReader(src));
+ }
- for (int attrIndex = 0; attrIndex < in.getAttributeCount(); attrIndex++) {
- String attributeNS = in.getAttributeNamespace(attrIndex);
+ private ImmutableMap<QName, Object> getElementAttributes(final XMLStreamReader in) {
+ checkState(in.isStartElement(), "Attributes can be extracted only from START_ELEMENT.");
+ final Map<QName, Object> attributes = new LinkedHashMap<>();
- if (attributeNS == null) {
- attributeNS = "";
- }
+ for (int attrIndex = 0; attrIndex < in.getAttributeCount(); attrIndex++) {
+ final String attributeNS = in.getAttributeNamespace(attrIndex);
// Skip namespace definitions
if (XMLConstants.XMLNS_ATTRIBUTE_NS_URI.equals(attributeNS)) {
continue;
}
- final QName qName = new QName(URI.create(attributeNS), in.getAttributeLocalName(attrIndex));
- attributes.put(qName, in.getAttributeValue(attrIndex));
- }
+ final String localName = in.getAttributeLocalName(attrIndex);
+ final String attrValue = in.getAttributeValue(attrIndex);
+ if (Strings.isNullOrEmpty(attributeNS)) {
+ StreamWriterFacade.warnLegacyAttribute(localName);
+ attributes.put(QName.create(LEGACY_ATTRIBUTE_NAMESPACE, localName), attrValue);
+ continue;
+ }
- return ImmutableMap.copyOf(attributes);
- }
+ // Cross-relate attribute namespace to the module
+ final Optional<QNameModule> optModule = resolveXmlNamespace(attributeNS);
+ if (optModule.isPresent()) {
+ final QName qname = QName.create(optModule.get(), localName);
+ final Optional<AnnotationSchemaNode> optAnnotation = AnnotationSchemaNode.find(
+ codecs.getEffectiveModelContext(), qname);
+ if (optAnnotation.isPresent()) {
+ final AnnotationSchemaNode schema = optAnnotation.get();
+ final Object value = codecs.codecFor(schema).parseValue(in.getNamespaceContext(), attrValue);
+ attributes.put(schema.getQName(), value);
+ continue;
+ }
- 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("\">");
+ LOG.debug("Annotation for {} not found, using legacy QName", qname);
+ }
- while (in.hasNext()) {
- final int eventType = in.next();
+ attributes.put(QName.create(rawXmlNamespace(attributeNS), localName), attrValue);
+ }
- if (eventType == XMLStreamConstants.START_ELEMENT) {
- sb.append('<').append(in.getLocalName()).append('>');
- } else if (eventType == XMLStreamConstants.END_ELEMENT) {
- sb.append("</").append(in.getLocalName()).append('>');
+ return ImmutableMap.copyOf(attributes);
+ }
- if (in.getLocalName().equals(anyXmlElementName)) {
- break;
+ private static Document readAnyXmlValue(final XMLStreamReader in) throws XMLStreamException {
+ // Underlying reader might return null when asked for version, however when such reader is plugged into
+ // Stax -> DOM transformer, it fails with NPE due to null version. Use default xml version in such case.
+ final XMLStreamReader inWrapper;
+ if (in.getVersion() == null) {
+ inWrapper = new StreamReaderDelegate(in) {
+ @Override
+ public String getVersion() {
+ final String ver = super.getVersion();
+ return ver != null ? ver : XML_STANDARD_VERSION;
}
-
- } else if (eventType == XMLStreamConstants.CHARACTERS) {
- sb.append(in.getText());
- }
+ };
+ } else {
+ inWrapper = in;
}
- return sb.toString();
+ final DOMResult result = new DOMResult();
+ try {
+ TRANSFORMER_FACTORY.newTransformer().transform(new StAXSource(inWrapper), result);
+ } catch (final TransformerException e) {
+ throw new XMLStreamException("Unable to read anyxml value", e);
+ }
+ return (Document) result.getNode();
}
- private void read(final XMLStreamReader in, final AbstractNodeDataWithSchema parent, final String rootElement)
- throws XMLStreamException, URISyntaxException, ParserConfigurationException, SAXException, IOException {
+ private void read(final XMLStreamReader in, final AbstractNodeDataWithSchema<?> parent, final String rootElement)
+ throws XMLStreamException {
if (!in.hasNext()) {
return;
}
if (parent instanceof LeafNodeDataWithSchema || parent instanceof LeafListEntryNodeDataWithSchema) {
parent.setAttributes(getElementAttributes(in));
- setValue(parent, in.getElementText().trim(), in.getNamespaceContext());
+ setValue((SimpleNodeDataWithSchema<?>) parent, in.getElementText().trim(), in.getNamespaceContext());
if (isNextEndDocument(in)) {
return;
}
String xmlElementName = in.getLocalName();
while (xmlElementName.equals(parent.getSchema().getQName().getLocalName())) {
read(in, newEntryNode(parent), rootElement);
- if (in.getEventType() == XMLStreamConstants.END_DOCUMENT) {
+ if (in.getEventType() == XMLStreamConstants.END_DOCUMENT
+ || in.getEventType() == XMLStreamConstants.END_ELEMENT) {
break;
}
xmlElementName = in.getLocalName();
}
if (parent instanceof AnyXmlNodeDataWithSchema) {
- setValue(parent, readAnyXmlValue(in), in.getNamespaceContext());
+ setValue((AnyXmlNodeDataWithSchema) parent, readAnyXmlValue(in), in.getNamespaceContext());
if (isNextEndDocument(in)) {
return;
}
return;
}
- if (parent instanceof YangModeledAnyXmlSchemaNode) {
+ if (parent instanceof AnydataNodeDataWithSchema) {
+ final AnydataNodeDataWithSchema anydata = (AnydataNodeDataWithSchema) parent;
+ anydata.setObjectModel(DOMSourceAnydata.class);
+ anydata.setAttributes(getElementAttributes(in));
+ setValue(anydata, readAnyXmlValue(in), in.getNamespaceContext());
+ if (isNextEndDocument(in)) {
+ return;
+ }
+
+ if (!isAtElement(in)) {
+ in.nextTag();
+ }
+
+ return;
+ }
+
+ if (parent instanceof YangModeledAnyxmlSchemaNode) {
parent.setAttributes(getElementAttributes(in));
}
switch (in.nextTag()) {
case XMLStreamConstants.START_ELEMENT:
- final Set<String> namesakes = new HashSet<>();
+ // FIXME: 7.0.0: why do we even need this tracker? either document it or remove it.
+ // it looks like it is a crude duplicate finder, which should really be handled via
+ // ChildReusePolicy.REJECT
+ final Set<Entry<String, String>> namesakes = new HashSet<>();
while (in.hasNext()) {
final String xmlElementName = in.getLocalName();
break;
}
- if (parentSchema instanceof YangModeledAnyXmlSchemaNode) {
- parentSchema = ((YangModeledAnyXmlSchemaNode) parentSchema).getSchemaOfAnyXmlData();
+ 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()));
+ final String elementNS = in.getNamespaceURI();
+ final boolean added = namesakes.add(new SimpleImmutableEntry<>(elementNS, xmlElementName));
+
+ final URI nsUri;
+ try {
+ nsUri = rawXmlNamespace(elementNS).getNamespace();
+ } catch (IllegalArgumentException e) {
+ throw new XMLStreamException("Failed to convert namespace " + xmlElementName, in.getLocation(),
+ e);
}
- final String xmlElementNamespace = in.getNamespaceURI();
final Deque<DataSchemaNode> childDataSchemaNodes =
- ParserStreamUtils.findSchemaNodeByNameAndNamespace(parentSchema, xmlElementName,
- new URI(xmlElementNamespace));
-
- if (childDataSchemaNodes.isEmpty()) {
- Preconditions.checkState(!strictParsing,
- "Schema for node with name %s and namespace %s doesn't exist.", xmlElementName,
- xmlElementNamespace);
- skipUnknownNode(in);
+ ParserStreamUtils.findSchemaNodeByNameAndNamespace(parentSchema, xmlElementName, nsUri);
+ if (!childDataSchemaNodes.isEmpty()) {
+ final boolean elementList = isElementList(childDataSchemaNodes);
+ if (!added && !elementList) {
+ throw new XMLStreamException(String.format(
+ "Duplicate element \"%s\" in namespace \"%s\" with parent \"%s\" in XML input",
+ xmlElementName, elementNS, parentSchema), in.getLocation());
+ }
+
+ // We have a match, proceed with it
+ read(in, ((CompositeNodeDataWithSchema<?>) parent).addChild(childDataSchemaNodes,
+ elementList ? ChildReusePolicy.REUSE : ChildReusePolicy.NOOP), rootElement);
continue;
}
- read(in, ((CompositeNodeDataWithSchema) parent).addChild(childDataSchemaNodes), rootElement);
+ if (parent instanceof AbstractMountPointDataWithSchema) {
+ // Parent can potentially hold a mount point, let's see if there is a label present
+ final Optional<MountPointSchemaNode> optMount;
+ if (parentSchema instanceof ContainerSchemaNode) {
+ optMount = MountPointSchemaNode.streamAll((ContainerSchemaNode) parentSchema).findFirst();
+ } else if (parentSchema instanceof ListSchemaNode) {
+ optMount = MountPointSchemaNode.streamAll((ListSchemaNode) parentSchema).findFirst();
+ } else {
+ throw new XMLStreamException("Unhandled mount-aware schema " + parentSchema,
+ in.getLocation());
+ }
+
+ if (optMount.isPresent()) {
+ final MountPointIdentifier mountId = MountPointIdentifier.of(optMount.get().getQName());
+ LOG.debug("Assuming node {} and namespace {} belongs to mount point {}", xmlElementName,
+ nsUri, mountId);
+
+ final Optional<MountPointContextFactory> optFactory = codecs.mountPointContext()
+ .findMountPoint(mountId);
+ if (optFactory.isPresent()) {
+ final MountPointData mountData = ((AbstractMountPointDataWithSchema<?>) parent)
+ .getMountPointData(mountId, optFactory.get());
+ addMountPointChild(mountData, nsUri, xmlElementName,
+ new DOMSource(readAnyXmlValue(in).getDocumentElement()));
+ continue;
+ }
+
+ LOG.debug("Mount point {} not attached", mountId);
+ }
+ }
+
+ // We have not handled the node -- let's decide what to do about that
+ if (strictParsing) {
+ throw new XMLStreamException(String.format(
+ "Schema for node with name %s and namespace %s does not exist at %s", xmlElementName,
+ elementNS, parentSchema.getPath()), in.getLocation());
+ }
+
+ LOG.debug("Skipping unknown node ns=\"{}\" localName=\"{}\" at path {}", elementNS, xmlElementName,
+ parentSchema.getPath());
+ skipUnknownNode(in);
}
break;
case XMLStreamConstants.END_ELEMENT:
}
}
+ // Return true if schema represents a construct which uses multiple sibling elements to represent its content. The
+ // siblings MAY be interleaved as per RFC7950.
+ private static boolean isElementList(final Deque<DataSchemaNode> childDataSchemaNodes) {
+ final DataSchemaNode last = childDataSchemaNodes.getLast();
+ return last instanceof ListSchemaNode || last instanceof LeafListSchemaNode;
+ }
+
+ private static void addMountPointChild(final MountPointData mount, final URI namespace, final String localName,
+ final DOMSource source) {
+ final DOMSourceMountPointChild child = new DOMSourceMountPointChild(source);
+ if (YangLibraryConstants.MODULE_NAMESPACE.equals(namespace)) {
+ final Optional<ContainerName> optName = ContainerName.forLocalName(localName);
+ if (optName.isPresent()) {
+ mount.setContainer(optName.get(), child);
+ return;
+ }
+
+ LOG.warn("Encountered unknown element {} from YANG Library namespace", localName);
+ } else if (SchemaMountConstants.RFC8528_MODULE.getNamespace().equals(namespace)) {
+ mount.setSchemaMounts(child);
+ return;
+ }
+
+ mount.addChild(child);
+ }
+
private static boolean isNextEndDocument(final XMLStreamReader in) throws XMLStreamException {
- return in.next() == XMLStreamConstants.END_DOCUMENT;
+ return !in.hasNext() || in.next() == XMLStreamConstants.END_DOCUMENT;
}
private static boolean isAtElement(final XMLStreamReader in) {
in.nextTag();
}
- private void setValue(final AbstractNodeDataWithSchema parent, final String value, final NamespaceContext nsContext)
- throws ParserConfigurationException, SAXException, IOException {
- Preconditions.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'",
- parentSimpleNode.getSchema().getQName(), parentSimpleNode.getValue());
-
- parentSimpleNode.setValue(translateValueByType(value, parentSimpleNode.getSchema(), nsContext));
+ private void setValue(final SimpleNodeDataWithSchema<?> parent, final Object value,
+ final NamespaceContext nsContext) {
+ final DataSchemaNode schema = parent.getSchema();
+ final Object prev = parent.getValue();
+ checkArgument(prev == null, "Node '%s' has already set its value to '%s'", schema.getQName(), prev);
+ parent.setValue(translateValueByType(value, schema, nsContext));
}
- private Object translateValueByType(final String value, final DataSchemaNode node,
- final NamespaceContext namespaceCtx) throws IOException, SAXException, ParserConfigurationException {
- if (node instanceof AnyXmlSchemaNode) {
+ private Object translateValueByType(final Object value, final DataSchemaNode node,
+ final NamespaceContext namespaceCtx) {
+ if (node instanceof AnyxmlSchemaNode) {
+ checkArgument(value instanceof Document);
/*
- * FIXME: Figure out some YANG extension dispatch, which will
- * reuse JSON parsing or XML parsing - anyxml is not well-defined in
- * JSON.
+ * FIXME: Figure out some YANG extension dispatch, which will reuse JSON parsing or XML parsing -
+ * anyxml is not well-defined in JSON.
*/
- final Document doc = UntrustedXML.newDocumentBuilder().parse(new InputSource(new StringReader(value)));
- doc.normalize();
-
- return new DOMSource(doc.getDocumentElement());
+ return new DOMSource(((Document) value).getDocumentElement());
+ }
+ if (node instanceof AnydataSchemaNode) {
+ checkArgument(value instanceof Document);
+ return new DOMSourceAnydata(new DOMSource(((Document) value).getDocumentElement()));
}
- Preconditions.checkArgument(node instanceof TypedSchemaNode);
- return codecs.codecFor((TypedSchemaNode) node).parseValue(namespaceCtx, value);
+ checkArgument(node instanceof TypedDataSchemaNode);
+ checkArgument(value instanceof String);
+ return codecs.codecFor((TypedDataSchemaNode) node).parseValue(namespaceCtx, (String) value);
}
- private static AbstractNodeDataWithSchema newEntryNode(final AbstractNodeDataWithSchema parent) {
- final AbstractNodeDataWithSchema newChild;
- if (parent instanceof ListNodeDataWithSchema) {
- newChild = new ListEntryNodeDataWithSchema(parent.getSchema());
- } else {
- newChild = new LeafListEntryNodeDataWithSchema(parent.getSchema());
- }
- ((CompositeNodeDataWithSchema) parent).addChild(newChild);
- return newChild;
+ private static AbstractNodeDataWithSchema<?> newEntryNode(final AbstractNodeDataWithSchema<?> parent) {
+ verify(parent instanceof MultipleEntryDataWithSchema, "Unexpected parent %s", parent);
+ return ((MultipleEntryDataWithSchema<?>) parent).newChildEntry();
}
@Override
public void flush() throws IOException {
writer.flush();
}
+
+ private Optional<QNameModule> resolveXmlNamespace(final String xmlNamespace) {
+ return resolvedNamespaces.computeIfAbsent(xmlNamespace, nsUri -> {
+ final Iterator<? extends Module> it = codecs.getEffectiveModelContext().findModules(URI.create(nsUri))
+ .iterator();
+ return it.hasNext() ? Optional.of(it.next().getQNameModule()) : Optional.empty();
+ });
+ }
+
+ private QNameModule rawXmlNamespace(final String xmlNamespace) {
+ return rawNamespaces.computeIfAbsent(xmlNamespace, nsUri -> QNameModule.create(URI.create(nsUri)));
+ }
}
Code Review / yangtools.git / blobdiff