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