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=8db667bd735e7fb1559db5b119fdb6771e2c75b0;hpb=588fa01e1777c9191d8f29f9624834c271ca5fd7;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 8db667bd73..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,41 +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.eclipse.jdt.annotation.NonNull; -import org.eclipse.jdt.annotation.Nullable; -import org.opendaylight.yangtools.odlext.model.api.YangModeledAnyXmlSchemaNode; -import org.opendaylight.yangtools.rfc7952.data.util.AbstractImmutableOpaqueAnydataStreamWriter; -import org.opendaylight.yangtools.rfc7952.data.util.ImmutableNormalizedMetadata; +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.YangInstanceIdentifier.NodeIdentifier; -import org.opendaylight.yangtools.yang.data.api.schema.opaque.OpaqueData; 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.OpaqueAnydataNodeDataWithSchema; +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; @@ -187,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. @@ -226,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 OpaqueAnydataNodeDataWithSchema((AnyDataSchemaNode) parentNode); + } else if (parentNode instanceof AnydataSchemaNode) { + nodeDataWithSchema = new AnydataNodeDataWithSchema((AnydataSchemaNode) parentNode); } else { throw new IllegalStateException("Unsupported schema node type " + parentNode.getClass() + "."); } @@ -299,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); @@ -341,45 +367,6 @@ public final class XmlParserStream implements Closeable, Flushable { return (Document) result.getNode(); } - private void readOpaqueAnydataValue(final XMLStreamReader in, final OpaqueAnydataNodeDataWithSchema parent) - throws XMLStreamException { - final DefaultOpaqueAnydataStreamWriter opaqueWriter = new DefaultOpaqueAnydataStreamWriter(); - final Entry result; - while (true) { - final int event = in.next(); - try { - switch (event) { - case XMLStreamConstants.START_ELEMENT: - final String nsUri = in.getNamespaceURI(); - final QNameModule module = resolveXmlNamespace(nsUri).orElseGet(() -> rawXmlNamespace(nsUri)); - opaqueWriter.startOpaqueContainer(NodeIdentifier.create(QName.create(module, - in.getLocalName()))); - break; - case XMLStreamConstants.END_ELEMENT: - opaqueWriter.endOpaqueNode(); - break; - case XMLStreamConstants.CHARACTERS: - opaqueWriter.opaqueValue(in.getText()); - break; - default: - LOG.debug("Ignoring event {}", event); - continue; - } - } catch (IOException e) { - throw new XMLStreamException("Inconsistent anydata stream", e); - } - - final Entry optResult = opaqueWriter.result(); - if (optResult != null) { - result = optResult; - break; - } - } - - setValue(parent, result.getKey(), in.getNamespaceContext()); - parent.setMetadata(result.getValue()); - } - private void read(final XMLStreamReader in, final AbstractNodeDataWithSchema parent, final String rootElement) throws XMLStreamException { if (!in.hasNext()) { @@ -430,9 +417,11 @@ public final class XmlParserStream implements Closeable, Flushable { return; } - if (parent instanceof OpaqueAnydataNodeDataWithSchema) { - parent.setAttributes(getElementAttributes(in)); - readOpaqueAnydataValue(in, (OpaqueAnydataNodeDataWithSchema) parent); + 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; } @@ -444,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(); @@ -474,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 { @@ -495,21 +482,61 @@ 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()); + } - if (childDataSchemaNodes.isEmpty()) { - if (!strictParsing) { - LOG.debug("Skipping unknown node ns=\"{}\" localName=\"{}\" at path {}", elementNS, - xmlElementName, parentSchema.getPath()); - skipUnknownNode(in); - continue; + // We have a match, proceed with it + read(in, ((CompositeNodeDataWithSchema) parent).addChild(childDataSchemaNodes, + elementList ? ChildReusePolicy.REUSE : ChildReusePolicy.NOOP), rootElement); + continue; + } + + 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())); + elementNS, parentSchema.getPath()), in.getLocation()); } - read(in, ((CompositeNodeDataWithSchema) parent).addChild(childDataSchemaNodes), rootElement); + LOG.debug("Skipping unknown node ns=\"{}\" localName=\"{}\" at path {}", elementNS, xmlElementName, + parentSchema.getPath()); + skipUnknownNode(in); } break; case XMLStreamConstants.END_ELEMENT: @@ -526,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; } @@ -573,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 - @@ -581,9 +634,9 @@ public final class XmlParserStream implements Closeable, Flushable { */ return new DOMSource(((Document) value).getDocumentElement()); } - if (node instanceof AnyDataSchemaNode) { - checkArgument(value instanceof OpaqueData, "Unexpected anydata value %s", value); - return value; + if (node instanceof AnydataSchemaNode) { + checkArgument(value instanceof Document); + return new DOMSourceAnydata(new DOMSource(((Document) value).getDocumentElement())); } checkArgument(node instanceof TypedDataSchemaNode); @@ -592,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 @@ -616,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(); }); } @@ -624,28 +671,4 @@ public final class XmlParserStream implements Closeable, Flushable { private QNameModule rawXmlNamespace(final String xmlNamespace) { return rawNamespaces.computeIfAbsent(xmlNamespace, nsUri -> QNameModule.create(URI.create(nsUri))); } - - // Utility writer just to keep the event model intact. This requires us to build an intermediate representation, - // simply because we are required to perform list coalescence. - // - // FIXME: 5.0.0: we should be able to negotiate downstream's tolerance to reentrant lists, so that we are not - // not required to keep all the book keeping. Immutable builder should not care as long as structure - // is kept... - private static final class DefaultOpaqueAnydataStreamWriter extends AbstractImmutableOpaqueAnydataStreamWriter { - private Entry<@NonNull OpaqueData, @Nullable ImmutableNormalizedMetadata> result; - - DefaultOpaqueAnydataStreamWriter() { - super(false); - } - - Entry<@NonNull OpaqueData, @Nullable ImmutableNormalizedMetadata> result() { - return result; - } - - @Override - protected void finishAnydata(final OpaqueData opaqueData, final ImmutableNormalizedMetadata metadata) { - checkState(result == null, "Result already set to %s", result); - result = new SimpleImmutableEntry<>(requireNonNull(opaqueData), metadata); - } - } }