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