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=bb5f2ebe7f2d4854c209f3357b112704e5506795;hpb=12ea317a81f8e3504b05c2baac0e722bc71676d1;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 bb5f2ebe7f..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 @@ -42,11 +42,15 @@ 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.YangLibraryConstants; -import org.opendaylight.yangtools.rfc8528.model.api.YangLibraryConstants.ContainerName; +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; @@ -55,6 +59,7 @@ 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; @@ -62,20 +67,22 @@ 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.AnyDataSchemaNode; -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; @@ -186,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. @@ -225,20 +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 if (parentNode instanceof AnydataSchemaNode) { + nodeDataWithSchema = new AnydataNodeDataWithSchema((AnydataSchemaNode) parentNode); } else { throw new IllegalStateException("Unsupported schema node type " + parentNode.getClass() + "."); } @@ -298,7 +325,7 @@ public final class XmlParserStream implements Closeable, Flushable { if (optModule.isPresent()) { final QName qname = QName.create(optModule.get(), localName); final Optional optAnnotation = AnnotationSchemaNode.find( - codecs.getSchemaContext(), qname); + codecs.getEffectiveModelContext(), qname); if (optAnnotation.isPresent()) { final AnnotationSchemaNode schema = optAnnotation.get(); final Object value = codecs.codecFor(schema).parseValue(in.getNamespaceContext(), attrValue); @@ -406,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(); @@ -436,16 +465,12 @@ 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 elementNS = in.getNamespaceURI(); - if (!namesakes.add(new SimpleImmutableEntry<>(elementNS, xmlElementName))) { - throw new XMLStreamException(String.format( - "Duplicate namespace \"%s\" element \"%s\" in XML input", elementNS, xmlElementName), - in.getLocation()); - } + final boolean added = namesakes.add(new SimpleImmutableEntry<>(elementNS, xmlElementName)); final URI nsUri; try { @@ -458,8 +483,16 @@ public final class XmlParserStream implements Closeable, Flushable { final Deque childDataSchemaNodes = 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), rootElement); + read(in, ((CompositeNodeDataWithSchema) parent).addChild(childDataSchemaNodes, + elementList ? ChildReusePolicy.REUSE : ChildReusePolicy.NOOP), rootElement); continue; } @@ -471,19 +504,26 @@ public final class XmlParserStream implements Closeable, Flushable { } else if (parentSchema instanceof ListSchemaNode) { optMount = MountPointSchemaNode.streamAll((ListSchemaNode) parentSchema).findFirst(); } else { - throw new XMLStreamException("Unhandled mount-aware schema " + parentSchema); + throw new XMLStreamException("Unhandled mount-aware schema " + parentSchema, + in.getLocation()); } if (optMount.isPresent()) { - final QName label = optMount.get().getQName(); + final MountPointIdentifier mountId = MountPointIdentifier.of(optMount.get().getQName()); LOG.debug("Assuming node {} and namespace {} belongs to mount point {}", xmlElementName, - nsUri, label); - - final MountPointData mountData = - ((AbstractMountPointDataWithSchema) parent).getMountPointData(label); - addMountPointChild(mountData, nsUri, xmlElementName, - new DOMSource(readAnyXmlValue(in).getDocumentElement())); - continue; + 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); } } @@ -491,7 +531,7 @@ public final class XmlParserStream implements Closeable, Flushable { 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())); + elementNS, parentSchema.getPath()), in.getLocation()); } LOG.debug("Skipping unknown node ns=\"{}\" localName=\"{}\" at path {}", elementNS, xmlElementName, @@ -513,6 +553,13 @@ 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); @@ -524,6 +571,9 @@ public final class XmlParserStream implements Closeable, Flushable { } 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); @@ -576,7 +626,7 @@ public final class XmlParserStream implements Closeable, Flushable { 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 - @@ -584,7 +634,7 @@ public final class XmlParserStream implements Closeable, Flushable { */ return new DOMSource(((Document) value).getDocumentElement()); } - if (node instanceof AnyDataSchemaNode) { + if (node instanceof AnydataSchemaNode) { checkArgument(value instanceof Document); return new DOMSourceAnydata(new DOMSource(((Document) value).getDocumentElement())); } @@ -595,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 @@ -619,7 +662,8 @@ public final class XmlParserStream implements Closeable, Flushable { private Optional resolveXmlNamespace(final String xmlNamespace) { return resolvedNamespaces.computeIfAbsent(xmlNamespace, nsUri -> { - final Iterator it = codecs.getSchemaContext().findModules(URI.create(nsUri)).iterator(); + final Iterator it = codecs.getEffectiveModelContext().findModules(URI.create(nsUri)) + .iterator(); return it.hasNext() ? Optional.of(it.next().getQNameModule()) : Optional.empty(); }); }