restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/spi/DataFormattableBody.java

   1 /*
   2  * Copyright (c) 2024 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.restconf.server.spi;
   9
  10 import static com.google.common.base.Verify.verify;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.gson.stream.JsonWriter;
  14 import java.io.IOException;
  15 import javax.xml.stream.XMLStreamWriter;
  16 import org.eclipse.jdt.annotation.NonNullByDefault;
  17 import org.opendaylight.restconf.server.api.DatabindContext;
  18 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  19 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  20 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  21 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactory;
  22 import org.opendaylight.yangtools.yang.data.codec.gson.JSONNormalizedNodeStreamWriter;
  23 import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
  24 import org.opendaylight.yangtools.yang.data.codec.xml.XmlCodecFactory;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeEffectiveStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.LeafListEffectiveStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
  28 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
  29
  30 /**
  31  * A {@link NormalizedFormattableBody} representing a data resource.
  32  */
  33 @NonNullByDefault
  34 final class DataFormattableBody<N extends NormalizedNode> extends NormalizedFormattableBody<N> {
  35     private final Inference parent;
  36
  37     DataFormattableBody(final DatabindContext databind, final Inference parent, final N data,
  38             final NormalizedNodeWriterFactory writerFactory) {
  39         super(databind, writerFactory, data);
  40         this.parent = requireNonNull(parent);
  41
  42         // RESTCONF allows returning one list item. We need to wrap it in map node in order to serialize it properly,
  43         // which is where the notion of "parent Inference" may be confusing. We mean
  44         // 'inference to the parent NormalizedNode', which for *EntryNode ends up the corresponding statement
  45         if (data instanceof MapEntryNode) {
  46             verifyParent(parent, ListEffectiveStatement.class, data);
  47         } else if (data instanceof LeafSetEntryNode) {
  48             verifyParent(parent, LeafListEffectiveStatement.class, data);
  49         }
  50     }
  51
  52     DataFormattableBody(final DatabindContext databind, final Inference parent, final N data) {
  53         this(databind, parent, data, NormalizedNodeWriterFactory.of());
  54     }
  55
  56     private static void verifyParent(final Inference inference,
  57             final Class<? extends DataTreeEffectiveStatement<?>> expectedStmt, final NormalizedNode data) {
  58         // Let's not bother with niceties of error report -- if we trip here, the caller is doing the wrong
  59         final var qname = expectedStmt.cast(inference.toSchemaInferenceStack().currentStatement()).argument();
  60         verify(qname.equals(data.name().getNodeType()));
  61     }
  62
  63     @Override
  64     protected void formatToJSON(final JSONCodecFactory codecs, final N data, final JsonWriter writer)
  65             throws IOException {
  66         writeTo(data, JSONNormalizedNodeStreamWriter.createExclusiveWriter(codecs, parent, null, writer));
  67     }
  68
  69     @Override
  70     protected void formatToXML(final XmlCodecFactory codecs, final N data, final XMLStreamWriter xmlWriter)
  71             throws IOException {
  72         writeTo(data, XMLStreamNormalizedNodeStreamWriter.create(xmlWriter, parent));
  73     }
  74 }