restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/rest/impl/NormalizedNodeJsonBodyWriter.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. 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.netconf.sal.rest.impl;
   9
  10 import com.google.gson.stream.JsonWriter;
  11 import java.io.IOException;
  12 import java.io.OutputStream;
  13 import java.io.OutputStreamWriter;
  14 import java.lang.annotation.Annotation;
  15 import java.lang.reflect.Type;
  16 import java.net.URISyntaxException;
  17 import java.nio.charset.StandardCharsets;
  18 import java.util.Map.Entry;
  19 import javax.ws.rs.Produces;
  20 import javax.ws.rs.WebApplicationException;
  21 import javax.ws.rs.core.MediaType;
  22 import javax.ws.rs.core.MultivaluedMap;
  23 import javax.ws.rs.ext.MessageBodyWriter;
  24 import javax.ws.rs.ext.Provider;
  25 import javax.xml.stream.XMLStreamException;
  26 import org.eclipse.jdt.annotation.Nullable;
  27 import org.opendaylight.netconf.sal.rest.api.Draft02;
  28 import org.opendaylight.netconf.sal.rest.api.RestconfNormalizedNodeWriter;
  29 import org.opendaylight.netconf.sal.rest.api.RestconfService;
  30 import org.opendaylight.netconf.util.NetconfUtil;
  31 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  32 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  33 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  34 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
  35 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  36 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  37 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  38 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  39 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactory;
  40 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactorySupplier;
  41 import org.opendaylight.yangtools.yang.data.codec.gson.JSONNormalizedNodeStreamWriter;
  42 import org.opendaylight.yangtools.yang.data.codec.gson.JsonWriterFactory;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  44 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  45 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  46 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  47 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  48 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  49 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
  50 import org.xml.sax.SAXException;
  51
  52 /**
  53  * Normalized node writer for JSON.
  54  *
  55  * @deprecated This class will be replaced by NormalizedNodeJsonBodyWriter from restconf-nb-rfc8040
  56  */
  57 @Deprecated
  58 @Provider
  59 @Produces({
  60     Draft02.MediaTypes.API + RestconfService.JSON,
  61     Draft02.MediaTypes.DATA + RestconfService.JSON,
  62     Draft02.MediaTypes.OPERATION + RestconfService.JSON,
  63     MediaType.APPLICATION_JSON
  64 })
  65 public class NormalizedNodeJsonBodyWriter implements MessageBodyWriter<NormalizedNodeContext> {
  66
  67     private static final int DEFAULT_INDENT_SPACES_NUM = 2;
  68
  69     @Override
  70     public boolean isWriteable(final Class<?> type, final Type genericType, final Annotation[] annotations,
  71             final MediaType mediaType) {
  72         return type.equals(NormalizedNodeContext.class);
  73     }
  74
  75     @Override
  76     public long getSize(final NormalizedNodeContext context, final Class<?> type, final Type genericType,
  77             final Annotation[] annotations, final MediaType mediaType) {
  78         return -1;
  79     }
  80
  81     @Override
  82     public void writeTo(final NormalizedNodeContext context, final Class<?> type, final Type genericType,
  83             final Annotation[] annotations, final MediaType mediaType, final MultivaluedMap<String, Object> httpHeaders,
  84             final OutputStream entityStream) throws IOException, WebApplicationException {
  85         if (httpHeaders != null) {
  86             for (final Entry<String, Object> entry : context.getNewHeaders().entrySet()) {
  87                 httpHeaders.add(entry.getKey(), entry.getValue());
  88             }
  89         }
  90         NormalizedNode data = context.getData();
  91         if (data == null) {
  92             return;
  93         }
  94
  95         final InstanceIdentifierContext identifierCtx = context.getInstanceIdentifierContext();
  96
  97         try (JsonWriter jsonWriter = createJsonWriter(entityStream, context.getWriterParameters().isPrettyPrint())) {
  98             jsonWriter.beginObject();
  99             writeNormalizedNode(jsonWriter, identifierCtx, data, context.getWriterParameters().getDepth());
 100             jsonWriter.endObject();
 101             jsonWriter.flush();
 102         }
 103     }
 104
 105     private static void writeNormalizedNode(final JsonWriter jsonWriter, final InstanceIdentifierContext context,
 106             // Note: mutable argument
 107             NormalizedNode data, final @Nullable Integer depth) throws IOException {
 108
 109         final var stack = context.inference().toSchemaInferenceStack();
 110         final RestconfNormalizedNodeWriter nnWriter;
 111         if (stack.isEmpty()) {
 112             /*
 113              *  Creates writer without initialNs and we write children of root data container
 114              *  which is not visible in restconf
 115              */
 116             nnWriter = createNormalizedNodeWriter(context, context.inference(), jsonWriter, depth);
 117             if (data instanceof ContainerNode) {
 118                 writeChildren(nnWriter,(ContainerNode) data);
 119             } else if (data instanceof DOMSourceAnyxmlNode) {
 120                 try {
 121                     writeChildren(nnWriter,
 122                             (ContainerNode) NetconfUtil.transformDOMSourceToNormalizedNode(
 123                                     context.getSchemaContext(), ((DOMSourceAnyxmlNode)data).body()).getResult());
 124                 } catch (XMLStreamException | URISyntaxException | SAXException e) {
 125                     throw new IOException("Cannot write anyxml.", e);
 126                 }
 127             }
 128         } else if (context.getSchemaNode() instanceof RpcDefinition) {
 129             /*
 130              *  RpcDefinition is not supported as initial codec in JSONStreamWriter,
 131              *  so we need to emit initial output declaratation..
 132              */
 133             final var rpc = (RpcDefinition) context.getSchemaNode();
 134             final var tmp = SchemaInferenceStack.of(context.getSchemaContext());
 135             tmp.enterSchemaTree(rpc.getQName());
 136             tmp.enterSchemaTree(rpc.getOutput().getQName());
 137
 138             nnWriter = createNormalizedNodeWriter(context, tmp.toInference(), jsonWriter, depth);
 139             jsonWriter.name("output");
 140             jsonWriter.beginObject();
 141             writeChildren(nnWriter, (ContainerNode) data);
 142             jsonWriter.endObject();
 143         } else {
 144             stack.exit();
 145
 146             if (data instanceof MapEntryNode) {
 147                 data = ImmutableNodes.mapNodeBuilder(data.getIdentifier().getNodeType())
 148                     .withChild((MapEntryNode) data)
 149                     .build();
 150             }
 151             nnWriter = createNormalizedNodeWriter(context, stack.toInference(), jsonWriter, depth);
 152             nnWriter.write(data);
 153         }
 154         nnWriter.flush();
 155     }
 156
 157     private static void writeChildren(final RestconfNormalizedNodeWriter nnWriter, final ContainerNode data)
 158             throws IOException {
 159         for (final DataContainerChild child : data.body()) {
 160             nnWriter.write(child);
 161         }
 162     }
 163
 164     private static RestconfNormalizedNodeWriter createNormalizedNodeWriter(
 165             final InstanceIdentifierContext context, final Inference inference, final JsonWriter jsonWriter,
 166             final @Nullable Integer depth) {
 167
 168         final SchemaNode schema = context.getSchemaNode();
 169         final JSONCodecFactory codecs = getCodecFactory(context);
 170
 171         final XMLNamespace initialNs;
 172         if (schema instanceof DataSchemaNode && !((DataSchemaNode)schema).isAugmenting()
 173                 && !(schema instanceof SchemaContext) || schema instanceof RpcDefinition) {
 174             initialNs = schema.getQName().getNamespace();
 175         } else {
 176             initialNs = null;
 177         }
 178         final NormalizedNodeStreamWriter streamWriter =
 179                 JSONNormalizedNodeStreamWriter.createNestedWriter(codecs, inference, initialNs, jsonWriter);
 180         if (depth != null) {
 181             return DepthAwareNormalizedNodeWriter.forStreamWriter(streamWriter, depth);
 182         }
 183
 184         return RestconfDelegatingNormalizedNodeWriter.forStreamWriter(streamWriter);
 185     }
 186
 187     private static JsonWriter createJsonWriter(final OutputStream entityStream, final boolean prettyPrint) {
 188         if (prettyPrint) {
 189             return JsonWriterFactory.createJsonWriter(new OutputStreamWriter(entityStream, StandardCharsets.UTF_8),
 190                     DEFAULT_INDENT_SPACES_NUM);
 191         }
 192
 193         return JsonWriterFactory.createJsonWriter(new OutputStreamWriter(entityStream, StandardCharsets.UTF_8));
 194     }
 195
 196     private static JSONCodecFactory getCodecFactory(final InstanceIdentifierContext context) {
 197         // TODO: Performance: Cache JSON Codec factory and schema context
 198         return JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02.getShared(context.getSchemaContext());
 199     }
 200 }