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