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.modelContext(), new AnnotationName(qname));
  60         if (optAnnotation.isPresent()) {
  61             return streamUtils.encodeValue(xmlWriter, resolveType(optAnnotation.orElseThrow().getType()), value,
  62                 qname.getModule());
  63         }
  64
  65         if (qname.getRevision().isPresent()) {
  66             throw new IllegalArgumentException("Failed to find bound annotation " + qname);
  67         }
  68         if (value instanceof String str) {
  69             return str;
  70         }
  71         throw new IllegalArgumentException("Invalid non-string value " + value + " for unbound annotation " + qname);
  72     }
  73
  74     @Override
  75     void startList(final NodeIdentifier name) {
  76         tracker.startList(name);
  77     }
  78
  79     @Override
  80     void startListItem(final PathArgument name) throws IOException {
  81         tracker.startListItem(name);
  82         startElement(name.getNodeType());
  83     }
  84
  85     @Override
  86     public void endNode() throws IOException {
  87         final Object schema = tracker.endNode();
  88         if (schema instanceof ListSchemaNode || schema instanceof LeafListSchemaNode) {
  89             // For lists, we only emit end element on the inner frame
  90             final Object parent = tracker.getParent();
  91             if (parent == schema) {
  92                 endElement();
  93             }
  94         } else if (schema instanceof ContainerLike || schema instanceof LeafSchemaNode
  95                 || schema instanceof AnydataSchemaNode || schema instanceof AnyxmlSchemaNode) {
  96             endElement();
  97         }
  98     }
  99
 100     @Override
 101     public void startLeafNode(final NodeIdentifier name) throws IOException {
 102         tracker.startLeafNode(name);
 103         startElement(name.getNodeType());
 104     }
 105
 106     @Override
 107     public void startLeafSetEntryNode(final NodeWithValue<?> name) throws IOException {
 108         tracker.startLeafSetEntryNode(name);
 109         startElement(name.getNodeType());
 110     }
 111
 112     @Override
 113     public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
 114         tracker.startLeafSet(name);
 115     }
 116
 117     @Override
 118     public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) {
 119         tracker.startLeafSet(name);
 120     }
 121
 122     @Override
 123     public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 124         tracker.startContainerNode(name);
 125         startElement(name.getNodeType());
 126     }
 127
 128     @Override
 129     public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
 130         tracker.startChoiceNode(name);
 131     }
 132
 133     @Override
 134     public boolean startAnyxmlNode(final NodeIdentifier name, final Class<?> objectModel) throws IOException {
 135         if (DOMSource.class.isAssignableFrom(objectModel)) {
 136             tracker.startAnyxmlNode(name);
 137             startElement(name.getNodeType());
 138             return true;
 139         }
 140         return false;
 141     }
 142
 143     @Override
 144     public void scalarValue(final Object value) throws IOException {
 145         final Object current = tracker.getParent();
 146         if (current instanceof TypedDataSchemaNode typedSchema) {
 147             writeValue(value, typedSchema);
 148         } else if (current instanceof AnydataSchemaNode) {
 149             anydataValue(value);
 150         } else {
 151             throw new IllegalStateException("Unexpected scalar value " + value + " with " + current);
 152         }
 153     }
 154
 155     @Override
 156     public void domSourceValue(final DOMSource value) throws IOException {
 157         final Object current = tracker.getParent();
 158         checkState(current instanceof AnyxmlSchemaNode, "Unexpected value %s with %s", value, current);
 159         anyxmlValue(value);
 160     }
 161
 162     @Override
 163     void startAnydata(final NodeIdentifier name) {
 164         tracker.startAnydataNode(name);
 165     }
 166
 167     private @NonNull TypeDefinition<?> resolveType(final @NonNull TypeDefinition<?> type) throws XMLStreamException {
 168         if (type instanceof LeafrefTypeDefinition leafref) {
 169             try {
 170                 return tracker.resolveLeafref(leafref);
 171             } catch (IllegalArgumentException e) {
 172                 throw new XMLStreamException("Cannot resolve type " + type, e);
 173             }
 174         }
 175         return type;
 176     }
 177 }