codec/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/SchemaAwareXMLStreamNormalizedNodeStreamWriter.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  * Copyright (c) 2016 Brocade Communications Systems, Inc. and others.  All rights reserved.
   4  *
   5  * This program and the accompanying materials are made available under the
   6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   7  * and is available at http://www.eclipse.org/legal/epl-v10.html
   8  */
   9 package org.opendaylight.yangtools.yang.data.codec.xml;
  10
  11 import static com.google.common.base.Preconditions.checkState;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import java.io.IOException;
  15 import javax.xml.stream.XMLStreamException;
  16 import javax.xml.stream.XMLStreamWriter;
  17 import javax.xml.transform.dom.DOMSource;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.opendaylight.yangtools.rfc7952.model.api.AnnotationSchemaNode;
  20 import org.opendaylight.yangtools.yang.common.AnnotationName;
  21 import org.opendaylight.yangtools.yang.common.QName;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  25 import org.opendaylight.yangtools.yang.data.util.NormalizedNodeStreamWriterStack;
  26 import org.opendaylight.yangtools.yang.model.api.AnydataSchemaNode;
  27 import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.ContainerLike;
  29 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  30 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  31 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  32 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  33 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  34 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
  35 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
  36
  37 final class SchemaAwareXMLStreamNormalizedNodeStreamWriter
  38         extends XMLStreamNormalizedNodeStreamWriter<TypedDataSchemaNode> {
  39     private final NormalizedNodeStreamWriterStack tracker;
  40     private final SchemaAwareXMLStreamWriterUtils streamUtils;
  41
  42     SchemaAwareXMLStreamNormalizedNodeStreamWriter(final XMLStreamWriter writer, final EffectiveModelContext context,
  43             final NormalizedNodeStreamWriterStack tracker) {
  44         super(writer);
  45         this.tracker = requireNonNull(tracker);
  46         streamUtils = new SchemaAwareXMLStreamWriterUtils(context);
  47     }
  48
  49     @Override
  50     String encodeValue(final ValueWriter xmlWriter, final Object value, final TypedDataSchemaNode schemaNode)
  51             throws XMLStreamException {
  52         return streamUtils.encodeValue(xmlWriter, resolveType(schemaNode.getType()), value,
  53             schemaNode.getQName().getModule());
  54     }
  55
  56     @Override
  57     String encodeAnnotationValue(final ValueWriter xmlWriter, final QName qname, final Object value)
  58             throws XMLStreamException {
  59         final var optAnnotation = AnnotationSchemaNode.find(streamUtils.getEffectiveModelContext(),
  60             new AnnotationName(qname));
  61         if (optAnnotation.isPresent()) {
  62             return streamUtils.encodeValue(xmlWriter, resolveType(optAnnotation.orElseThrow().getType()), value,
  63                 qname.getModule());
  64         }
  65
  66         if (qname.getRevision().isPresent()) {
  67             throw new IllegalArgumentException("Failed to find bound annotation " + qname);
  68         }
  69         if (value instanceof String str) {
  70             return str;
  71         }
  72         throw new IllegalArgumentException("Invalid non-string value " + value + " for unbound annotation " + qname);
  73     }
  74
  75     @Override
  76     void startList(final NodeIdentifier name) {
  77         tracker.startList(name);
  78     }
  79
  80     @Override
  81     void startListItem(final PathArgument name) throws IOException {
  82         tracker.startListItem(name);
  83         startElement(name.getNodeType());
  84     }
  85
  86     @Override
  87     public void endNode() throws IOException {
  88         final Object schema = tracker.endNode();
  89         if (schema instanceof ListSchemaNode || schema instanceof LeafListSchemaNode) {
  90             // For lists, we only emit end element on the inner frame
  91             final Object parent = tracker.getParent();
  92             if (parent == schema) {
  93                 endElement();
  94             }
  95         } else if (schema instanceof ContainerLike || schema instanceof LeafSchemaNode
  96                 || schema instanceof AnydataSchemaNode || schema instanceof AnyxmlSchemaNode) {
  97             endElement();
  98         }
  99     }
 100
 101     @Override
 102     public void startLeafNode(final NodeIdentifier name) throws IOException {
 103         tracker.startLeafNode(name);
 104         startElement(name.getNodeType());
 105     }
 106
 107     @Override
 108     public void startLeafSetEntryNode(final NodeWithValue<?> name) throws IOException {
 109         tracker.startLeafSetEntryNode(name);
 110         startElement(name.getNodeType());
 111     }
 112
 113     @Override
 114     public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
 115         tracker.startLeafSet(name);
 116     }
 117
 118     @Override
 119     public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) {
 120         tracker.startLeafSet(name);
 121     }
 122
 123     @Override
 124     public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 125         tracker.startContainerNode(name);
 126         startElement(name.getNodeType());
 127     }
 128
 129     @Override
 130     public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
 131         tracker.startChoiceNode(name);
 132     }
 133
 134     @Override
 135     public boolean startAnyxmlNode(final NodeIdentifier name, final Class<?> objectModel) throws IOException {
 136         if (DOMSource.class.isAssignableFrom(objectModel)) {
 137             tracker.startAnyxmlNode(name);
 138             startElement(name.getNodeType());
 139             return true;
 140         }
 141         return false;
 142     }
 143
 144     @Override
 145     public void scalarValue(final Object value) throws IOException {
 146         final Object current = tracker.getParent();
 147         if (current instanceof TypedDataSchemaNode typedSchema) {
 148             writeValue(value, typedSchema);
 149         } else if (current instanceof AnydataSchemaNode) {
 150             anydataValue(value);
 151         } else {
 152             throw new IllegalStateException("Unexpected scalar value " + value + " with " + current);
 153         }
 154     }
 155
 156     @Override
 157     public void domSourceValue(final DOMSource value) throws IOException {
 158         final Object current = tracker.getParent();
 159         checkState(current instanceof AnyxmlSchemaNode, "Unexpected value %s with %s", value, current);
 160         anyxmlValue(value);
 161     }
 162
 163     @Override
 164     void startAnydata(final NodeIdentifier name) {
 165         tracker.startAnydataNode(name);
 166     }
 167
 168     private @NonNull TypeDefinition<?> resolveType(final @NonNull TypeDefinition<?> type) throws XMLStreamException {
 169         if (type instanceof LeafrefTypeDefinition leafref) {
 170             try {
 171                 return tracker.resolveLeafref(leafref);
 172             } catch (IllegalArgumentException e) {
 173                 throw new XMLStreamException("Cannot resolve type " + type, e);
 174             }
 175         }
 176         return type;
 177     }
 178 }