restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/spi/OperationOutputBody.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 java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.VisibleForTesting;
  13 import java.io.IOException;
  14 import java.io.OutputStream;
  15 import javax.xml.XMLConstants;
  16 import javax.xml.stream.XMLStreamException;
  17 import javax.xml.stream.XMLStreamWriter;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.eclipse.jdt.annotation.NonNullByDefault;
  20 import org.opendaylight.restconf.api.FormatParameters;
  21 import org.opendaylight.restconf.api.FormattableBody;
  22 import org.opendaylight.restconf.server.api.DatabindPath.OperationPath;
  23 import org.opendaylight.restconf.server.api.DatabindPathFormattableBody;
  24 import org.opendaylight.yangtools.yang.common.QName;
  25 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  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.util.SchemaInferenceStack;
  30
  31 /**
  32  * A {@link FormattableBody} corresponding to a {@code rpc} or {@code action} invocation.
  33  */
  34 @NonNullByDefault
  35 public final class OperationOutputBody extends DatabindPathFormattableBody<OperationPath> {
  36     private final ContainerNode output;
  37
  38     public OperationOutputBody(final OperationPath path, final ContainerNode output) {
  39         super(path);
  40         this.output = requireNonNull(output);
  41         if (output.isEmpty()) {
  42             throw new IllegalArgumentException("output may not be empty");
  43         }
  44     }
  45
  46     @VisibleForTesting
  47     public ContainerNode output() {
  48         return output;
  49     }
  50
  51     @Override
  52     public void formatToJSON(final FormatParameters format, final OutputStream out) throws IOException {
  53         final var stack = prepareStack();
  54
  55         // RpcDefinition/ActionDefinition is not supported as initial codec in JSONStreamWriter, so we need to emit
  56         // initial output declaration
  57         try (var jsonWriter = FormattableBodySupport.createJsonWriter(out, format)) {
  58             final var module = stack.currentModule();
  59             jsonWriter.beginObject().name(module.argument().getLocalName() + ":output").beginObject();
  60
  61             final var nnWriter = NormalizedNodeWriter.forStreamWriter(
  62                 JSONNormalizedNodeStreamWriter.createNestedWriter(path().databind().jsonCodecs(), stack.toInference(),
  63                     module.namespace().argument(), jsonWriter));
  64             for (var child : output.body()) {
  65                 nnWriter.write(child);
  66             }
  67             nnWriter.flush();
  68
  69             jsonWriter.endObject().endObject();
  70         }
  71     }
  72
  73     @Override
  74     public void formatToXML(final FormatParameters format, final OutputStream out) throws IOException {
  75         final var stack = prepareStack();
  76
  77         // RpcDefinition/ActionDefinition is not supported as initial codec in XMLStreamWriter, so we need to emit
  78         // initial output declaration.
  79         final var xmlWriter = FormattableBodySupport.createXmlWriter(out, format);
  80         final var nnWriter = NormalizedNodeWriter.forStreamWriter(
  81             XMLStreamNormalizedNodeStreamWriter.create(xmlWriter, stack.toInference()));
  82
  83         writeElements(xmlWriter, nnWriter, output);
  84         nnWriter.flush();
  85     }
  86
  87     @Override
  88     protected @NonNull Object bodyAttribute() {
  89         return output.prettyTree();
  90     }
  91
  92     private SchemaInferenceStack prepareStack() {
  93         final var path = path();
  94         final var stack = path.inference().toSchemaInferenceStack();
  95         stack.enterSchemaTree(path.outputStatement().argument());
  96         return stack;
  97     }
  98
  99     private static void writeElements(final XMLStreamWriter xmlWriter, final NormalizedNodeWriter nnWriter,
 100             final ContainerNode data) throws IOException {
 101         final QName nodeType = data.name().getNodeType();
 102         final String namespace = nodeType.getNamespace().toString();
 103         try {
 104             xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, nodeType.getLocalName(), namespace);
 105             xmlWriter.writeDefaultNamespace(namespace);
 106             for (var child : data.body()) {
 107                 nnWriter.write(child);
 108             }
 109             nnWriter.flush();
 110             xmlWriter.writeEndElement();
 111             xmlWriter.flush();
 112         } catch (final XMLStreamException e) {
 113             throw new IOException("Failed to write elements", e);
 114         }
 115     }
 116 }