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