restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/spi/NormalizedFormattableBody.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.common.base.MoreObjects.ToStringHelper;
  14 import java.io.IOException;
  15 import java.io.OutputStream;
  16 import javax.xml.stream.XMLStreamException;
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18 import org.opendaylight.restconf.api.FormatParameters;
  19 import org.opendaylight.restconf.api.FormattableBody;
  20 import org.opendaylight.restconf.server.api.DatabindContext;
  21 import org.opendaylight.restconf.server.api.DatabindFormattableBody;
  22 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  23 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  24 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  25 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  26 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  27 import org.opendaylight.yangtools.yang.data.codec.gson.JSONNormalizedNodeStreamWriter;
  28 import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeEffectiveStatement;
  30 import org.opendaylight.yangtools.yang.model.api.stmt.LeafListEffectiveStatement;
  31 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
  32 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
  33
  34 /**
  35  * A {@link FormattableBody} representing a data resource.
  36  */
  37 @NonNullByDefault
  38 public final class NormalizedFormattableBody<N extends NormalizedNode> extends DatabindFormattableBody {
  39     private final Inference parent;
  40     private final N data;
  41
  42     public NormalizedFormattableBody(final FormatParameters format, final DatabindContext databind,
  43             final Inference parent, final N data) {
  44         super(format, databind);
  45         this.parent = requireNonNull(parent);
  46         this.data = requireNonNull(data);
  47         // RESTCONF allows returning one list item. We need to wrap it in map node in order to serialize it properly,
  48         // which is where the notion of "parent Inference" may be confusing. We mean
  49         // 'inference to the parent NormalizedNode', which for *EntryNode ends up the corresponding statement
  50         if (data instanceof MapEntryNode) {
  51             verifyParent(parent, ListEffectiveStatement.class, data);
  52         } else if (data instanceof LeafSetEntryNode) {
  53             verifyParent(parent, LeafListEffectiveStatement.class, data);
  54         }
  55     }
  56
  57     private static void verifyParent(final Inference inference,
  58             final Class<? extends DataTreeEffectiveStatement<?>> expectedStmt, final NormalizedNode data) {
  59         // Let's not bother with niceties of error report -- if we trip here, the caller is doing the wrong
  60         final var qname = expectedStmt.cast(inference.toSchemaInferenceStack().currentStatement()).argument();
  61         verify(qname.equals(data.name().getNodeType()));
  62     }
  63
  64     @Override
  65     protected void formatToJSON(final OutputStream out, final FormatParameters format, final DatabindContext databind)
  66             throws IOException {
  67         writeTo(JSONNormalizedNodeStreamWriter.createExclusiveWriter(databind.jsonCodecs(), parent, null,
  68             FormattableBodySupport.createJsonWriter(out, format)));
  69     }
  70
  71     @Override
  72     protected void formatToXML(final OutputStream out, final FormatParameters format, final DatabindContext databind)
  73             throws IOException {
  74         final var xmlWriter = FormattableBodySupport.createXmlWriter(out, format);
  75         writeTo(XMLStreamNormalizedNodeStreamWriter.create(xmlWriter, parent));
  76         try {
  77             xmlWriter.close();
  78         } catch (XMLStreamException e) {
  79             throw new IOException("Failed to write data", e);
  80         }
  81     }
  82
  83     @Override
  84     protected ToStringHelper addToStringAttributes(final ToStringHelper helper) {
  85         return super.addToStringAttributes(helper.add("body", data.prettyTree()));
  86     }
  87
  88     private void writeTo(final NormalizedNodeStreamWriter streamWriter) throws IOException {
  89         try (var writer = NormalizedNodeWriter.forStreamWriter(streamWriter)) {
  90             writer.write(data);
  91         }
  92     }
  93 }