X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=yang%2Fyang-data-codec-xml%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fyang%2Fdata%2Fcodec%2Fxml%2FXmlParserStream.java;h=5c3d7e3735b2fb0b64c919fb094d6855c002f20f;hb=9f8750841e646bf5fdf93890f393ddfa1bf5d9a7;hp=471f29ba300c4dc4dc6b3f5940c3d68c6a23f851;hpb=b326cb386aafcf47ecad1d173bf48ea03c76446f;p=yangtools.git diff --git a/yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/XmlParserStream.java b/yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/XmlParserStream.java index 471f29ba30..5c3d7e3735 100644 --- a/yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/XmlParserStream.java +++ b/yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/XmlParserStream.java @@ -22,7 +22,9 @@ 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; @@ -30,7 +32,6 @@ import java.util.Optional; import java.util.Set; import javax.xml.XMLConstants; import javax.xml.namespace.NamespaceContext; -import javax.xml.stream.Location; import javax.xml.stream.XMLStreamConstants; import javax.xml.stream.XMLStreamException; import javax.xml.stream.XMLStreamReader; @@ -41,33 +42,47 @@ import javax.xml.transform.TransformerFactoryConfigurationError; import javax.xml.transform.dom.DOMResult; import javax.xml.transform.dom.DOMSource; import javax.xml.transform.stax.StAXSource; -import org.opendaylight.yangtools.odlext.model.api.YangModeledAnyXmlSchemaNode; +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.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.Module; import org.opendaylight.yangtools.yang.model.api.OperationDefinition; -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.slf4j.Logger; @@ -120,6 +135,10 @@ public final class XmlParserStream implements Closeable, Flushable { TRANSFORMER_FACTORY = fa; } + // Cache of nsUri Strings to QNameModules, as resolved in context + private final Map> resolvedNamespaces = new HashMap<>(); + // Cache of nsUri Strings to QNameModules, as inferred from document + private final Map rawNamespaces = new HashMap<>(); private final NormalizedNodeStreamWriter writer; private final XmlCodecFactory codecs; private final DataSchemaNode parentNode; @@ -174,23 +193,43 @@ public final class XmlParserStream implements Closeable, Flushable { /** * 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, - final SchemaNode parentNode) { + 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, - final SchemaNode parentNode, final boolean strictParsing) { + 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, 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 MountPointContext}. + */ + public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final MountPointContext mountCtx, + final SchemaNode parentNode, final boolean strictParsing) { + return create(writer, XmlCodecFactory.create(mountCtx), parentNode, strictParsing); + } + /** * This method parses the XML source and emits node events into a NormalizedNodeStreamWriter based on the * YANG-modeled data contained in the XML source. @@ -213,18 +252,20 @@ public final class XmlParserStream implements Closeable, Flushable { if (reader.hasNext()) { reader.nextTag(); final AbstractNodeDataWithSchema nodeDataWithSchema; - if (parentNode instanceof ContainerSchemaNode) { - nodeDataWithSchema = new ContainerNodeDataWithSchema((ContainerSchemaNode) parentNode); + if (parentNode instanceof ContainerLike) { + nodeDataWithSchema = new ContainerNodeDataWithSchema((ContainerLike) parentNode); } else if (parentNode instanceof ListSchemaNode) { 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 YangModeledAnyxmlSchemaNode) { + nodeDataWithSchema = new YangModeledAnyXmlNodeDataWithSchema((YangModeledAnyxmlSchemaNode) parentNode); + } else if (parentNode instanceof AnyxmlSchemaNode) { + nodeDataWithSchema = new AnyXmlNodeDataWithSchema((AnyxmlSchemaNode) parentNode); } else if (parentNode instanceof LeafSchemaNode) { nodeDataWithSchema = new LeafNodeDataWithSchema((LeafSchemaNode) parentNode); } else if (parentNode instanceof LeafListSchemaNode) { 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() + "."); } @@ -280,12 +321,11 @@ public final class XmlParserStream implements Closeable, Flushable { } // Cross-relate attribute namespace to the module - final URI uri = URI.create(attributeNS); - final SchemaContext schemaContext = codecs.getSchemaContext(); - final Set modules = schemaContext.findModules(uri); - if (!modules.isEmpty()) { - final QName qname = QName.create(modules.iterator().next().getQNameModule(), localName); - final Optional optAnnotation = AnnotationSchemaNode.find(schemaContext, qname); + final Optional optModule = resolveXmlNamespace(attributeNS); + if (optModule.isPresent()) { + final QName qname = QName.create(optModule.get(), localName); + final Optional optAnnotation = AnnotationSchemaNode.find( + codecs.getEffectiveModelContext(), qname); if (optAnnotation.isPresent()) { final AnnotationSchemaNode schema = optAnnotation.get(); final Object value = codecs.codecFor(schema).parseValue(in.getNamespaceContext(), attrValue); @@ -296,7 +336,7 @@ public final class XmlParserStream implements Closeable, Flushable { LOG.debug("Annotation for {} not found, using legacy QName", qname); } - attributes.put(QName.create(uri, localName), attrValue); + attributes.put(QName.create(rawXmlNamespace(attributeNS), localName), attrValue); } return ImmutableMap.copyOf(attributes); @@ -328,14 +368,14 @@ public final class XmlParserStream implements Closeable, Flushable { } private void read(final XMLStreamReader in, final AbstractNodeDataWithSchema parent, final String rootElement) - throws XMLStreamException, URISyntaxException { + 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; } @@ -365,7 +405,23 @@ public final class XmlParserStream implements Closeable, Flushable { } if (parent instanceof AnyXmlNodeDataWithSchema) { - setValue(parent, readAnyXmlValue(in), in.getNamespaceContext()); + setValue((AnyXmlNodeDataWithSchema) parent, readAnyXmlValue(in), in.getNamespaceContext()); + if (isNextEndDocument(in)) { + return; + } + + if (!isAtElement(in)) { + in.nextTag(); + } + + return; + } + + 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; } @@ -377,13 +433,15 @@ public final class XmlParserStream implements Closeable, Flushable { return; } - if (parent instanceof YangModeledAnyXmlSchemaNode) { + if (parent instanceof YangModeledAnyxmlSchemaNode) { parent.setAttributes(getElementAttributes(in)); } switch (in.nextTag()) { case XMLStreamConstants.START_ELEMENT: - // FIXME: why do we even need this tracker? either document it or remove it + // 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> namesakes = new HashSet<>(); while (in.hasNext()) { final String xmlElementName = in.getLocalName(); @@ -407,30 +465,78 @@ public final class XmlParserStream implements Closeable, Flushable { break; } - if (parentSchema instanceof YangModeledAnyXmlSchemaNode) { - parentSchema = ((YangModeledAnyXmlSchemaNode) parentSchema).getSchemaOfAnyXmlData(); + if (parentSchema instanceof YangModeledAnyxmlSchemaNode) { + parentSchema = ((YangModeledAnyxmlSchemaNode) parentSchema).getSchemaOfAnyXmlData(); } - final String xmlElementNamespace = in.getNamespaceURI(); - if (!namesakes.add(new SimpleImmutableEntry<>(xmlElementNamespace, xmlElementName))) { - final Location loc = in.getLocation(); - throw new IllegalStateException(String.format( - "Duplicate namespace \"%s\" element \"%s\" in XML input at: line %s column %s", - xmlElementNamespace, 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 Deque childDataSchemaNodes = - ParserStreamUtils.findSchemaNodeByNameAndNamespace(parentSchema, xmlElementName, - new URI(xmlElementNamespace)); + 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()); + } - if (childDataSchemaNodes.isEmpty()) { - checkState(!strictParsing, "Schema for node with name %s and namespace %s does not exist at %s", - xmlElementName, xmlElementNamespace, parentSchema.getPath()); - skipUnknownNode(in); + // 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 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 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: @@ -447,6 +553,32 @@ public final class XmlParserStream implements Closeable, Flushable { } } + // 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 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 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.hasNext() || in.next() == XMLStreamConstants.END_DOCUMENT; } @@ -484,30 +616,28 @@ public final class XmlParserStream implements Closeable, Flushable { in.nextTag(); } - - private void setValue(final AbstractNodeDataWithSchema parent, final Object value, + private void setValue(final SimpleNodeDataWithSchema parent, final Object value, final NamespaceContext nsContext) { - checkArgument(parent instanceof SimpleNodeDataWithSchema, "Node %s is not a simple type", - parent.getSchema().getQName()); - final SimpleNodeDataWithSchema parentSimpleNode = (SimpleNodeDataWithSchema) parent; - 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)); + 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 Object value, final DataSchemaNode node, final NamespaceContext namespaceCtx) { - if (node instanceof AnyXmlSchemaNode) { - + 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. */ return new DOMSource(((Document) value).getDocumentElement()); } + if (node instanceof AnydataSchemaNode) { + checkArgument(value instanceof Document); + return new DOMSourceAnydata(new DOMSource(((Document) value).getDocumentElement())); + } checkArgument(node instanceof TypedDataSchemaNode); checkArgument(value instanceof String); @@ -515,15 +645,8 @@ public final class XmlParserStream implements Closeable, Flushable { } private static AbstractNodeDataWithSchema newEntryNode(final AbstractNodeDataWithSchema parent) { - final AbstractNodeDataWithSchema newChild; - if (parent instanceof ListNodeDataWithSchema) { - newChild = ListEntryNodeDataWithSchema.forSchema(((ListNodeDataWithSchema) parent).getSchema()); - } else { - verify(parent instanceof LeafListNodeDataWithSchema, "Unexpected parent %s", parent); - newChild = new LeafListEntryNodeDataWithSchema(((LeafListNodeDataWithSchema) parent).getSchema()); - } - ((CompositeNodeDataWithSchema) parent).addChild(newChild); - return newChild; + verify(parent instanceof MultipleEntryDataWithSchema, "Unexpected parent %s", parent); + return ((MultipleEntryDataWithSchema) parent).newChildEntry(); } @Override @@ -536,4 +659,16 @@ public final class XmlParserStream implements Closeable, Flushable { public void flush() throws IOException { writer.flush(); } + + private Optional resolveXmlNamespace(final String xmlNamespace) { + return resolvedNamespaces.computeIfAbsent(xmlNamespace, nsUri -> { + final Iterator 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))); + } }