restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/jersey/providers/JsonNormalizedNodeBodyWriter.java

   1 /*
   2  * Copyright (c) 2016 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.restconf.nb.rfc8040.jersey.providers;
   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.nio.charset.StandardCharsets;
  17 import java.util.List;
  18 import java.util.Map;
  19 import java.util.Set;
  20 import javax.ws.rs.Produces;
  21 import javax.ws.rs.WebApplicationException;
  22 import javax.ws.rs.core.MediaType;
  23 import javax.ws.rs.core.MultivaluedMap;
  24 import javax.ws.rs.ext.Provider;
  25 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  26 import org.opendaylight.restconf.nb.rfc8040.MediaTypes;
  27 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.api.RestconfNormalizedNodeWriter;
  28 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  29 import org.opendaylight.yangtools.yang.common.QName;
  30 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  31 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  32 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  33 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  34 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  35 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  36 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactory;
  37 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactorySupplier;
  38 import org.opendaylight.yangtools.yang.data.codec.gson.JSONNormalizedNodeStreamWriter;
  39 import org.opendaylight.yangtools.yang.data.codec.gson.JsonWriterFactory;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  41 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  42 import org.opendaylight.yangtools.yang.model.api.Module;
  43 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  44 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  45 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  46
  47 @Provider
  48 @Produces({ MediaTypes.APPLICATION_YANG_DATA_JSON, MediaType.APPLICATION_JSON })
  49 public class JsonNormalizedNodeBodyWriter extends AbstractNormalizedNodeBodyWriter {
  50     private static final int DEFAULT_INDENT_SPACES_NUM = 2;
  51
  52     @Override
  53     public void writeTo(final NormalizedNodePayload context,
  54                         final Class<?> type,
  55                         final Type genericType,
  56                         final Annotation[] annotations,
  57                         final MediaType mediaType,
  58                         final MultivaluedMap<String, Object> httpHeaders,
  59                         final OutputStream entityStream) throws IOException, WebApplicationException {
  60         final NormalizedNode data = context.getData();
  61         if (data == null) {
  62             return;
  63         }
  64
  65         @SuppressWarnings("unchecked")
  66         final InstanceIdentifierContext<SchemaNode> identifierCtx =
  67                 (InstanceIdentifierContext<SchemaNode>) context.getInstanceIdentifierContext();
  68         final SchemaPath path = identifierCtx.getSchemaNode().getPath();
  69
  70         try (JsonWriter jsonWriter = createJsonWriter(entityStream, context.getWriterParameters().isPrettyPrint())) {
  71             jsonWriter.beginObject();
  72             writeNormalizedNode(jsonWriter, path, identifierCtx, data,
  73                     context.getWriterParameters().getDepth(), context.getWriterParameters().getFields());
  74             jsonWriter.endObject();
  75             jsonWriter.flush();
  76         }
  77
  78         if (httpHeaders != null) {
  79             for (final Map.Entry<String, Object> entry : context.getNewHeaders().entrySet()) {
  80                 httpHeaders.add(entry.getKey(), entry.getValue());
  81             }
  82         }
  83     }
  84
  85     private static void writeNormalizedNode(final JsonWriter jsonWriter,
  86             final SchemaPath path, final InstanceIdentifierContext<SchemaNode> context, final NormalizedNode data,
  87             final Integer depth, final List<Set<QName>> fields) throws IOException {
  88         final RestconfNormalizedNodeWriter nnWriter;
  89
  90         if (context.getSchemaNode() instanceof RpcDefinition) {
  91             /*
  92              *  RpcDefinition is not supported as initial codec in JSONStreamWriter,
  93              *  so we need to emit initial output declaration..
  94              */
  95             nnWriter = createNormalizedNodeWriter(
  96                     context,
  97                     ((RpcDefinition) context.getSchemaNode()).getOutput().getPath(),
  98                     jsonWriter,
  99                     depth,
 100                     fields);
 101             final Module module = context.getSchemaContext().findModule(data.getIdentifier().getNodeType().getModule())
 102                 .get();
 103             jsonWriter.name(module.getName() + ":output");
 104             jsonWriter.beginObject();
 105             writeChildren(nnWriter, (ContainerNode) data);
 106             jsonWriter.endObject();
 107         } else if (context.getSchemaNode() instanceof ActionDefinition) {
 108             /*
 109              *  ActionDefinition is not supported as initial codec in JSONStreamWriter,
 110              *  so we need to emit initial output declaration..
 111              */
 112             nnWriter = createNormalizedNodeWriter(context,
 113                 ((ActionDefinition) context.getSchemaNode()).getOutput().getPath(), jsonWriter, depth, fields);
 114             final Module module = context.getSchemaContext().findModule(data.getIdentifier().getNodeType().getModule())
 115                 .get();
 116             jsonWriter.name(module.getName() + ":output");
 117             jsonWriter.beginObject();
 118             writeChildren(nnWriter, (ContainerNode) data);
 119             jsonWriter.endObject();
 120         } else {
 121             if (SchemaPath.ROOT.equals(path)) {
 122                 nnWriter = createNormalizedNodeWriter(context, path, jsonWriter, depth, fields);
 123             } else {
 124                 nnWriter = createNormalizedNodeWriter(context, path.getParent(), jsonWriter, depth, fields);
 125             }
 126
 127             if (data instanceof MapEntryNode) {
 128                 // Restconf allows returning one list item. We need to wrap it
 129                 // in map node in order to serialize it properly
 130                 nnWriter.write(ImmutableNodes.mapNodeBuilder(data.getIdentifier().getNodeType())
 131                     .withChild((MapEntryNode) data)
 132                     .build());
 133             } else {
 134                 nnWriter.write(data);
 135             }
 136         }
 137
 138         nnWriter.flush();
 139     }
 140
 141     private static void writeChildren(final RestconfNormalizedNodeWriter nnWriter, final ContainerNode data)
 142             throws IOException {
 143         for (final DataContainerChild child : data.body()) {
 144             nnWriter.write(child);
 145         }
 146     }
 147
 148     private static RestconfNormalizedNodeWriter createNormalizedNodeWriter(
 149             final InstanceIdentifierContext<SchemaNode> context, final SchemaPath path, final JsonWriter jsonWriter,
 150             final Integer depth, final List<Set<QName>> fields) {
 151
 152         final SchemaNode schema = context.getSchemaNode();
 153         final JSONCodecFactory codecs = getCodecFactory(context);
 154
 155         final NormalizedNodeStreamWriter streamWriter = JSONNormalizedNodeStreamWriter.createNestedWriter(
 156                 codecs, path, initialNamespaceFor(schema), jsonWriter);
 157
 158         return ParameterAwareNormalizedNodeWriter.forStreamWriter(streamWriter, depth, fields);
 159     }
 160
 161     private static XMLNamespace initialNamespaceFor(final SchemaNode schema) {
 162         if (schema instanceof RpcDefinition) {
 163             return schema.getQName().getNamespace();
 164         }
 165         // For top-level elements we always want to use namespace prefix, hence use a null initial namespace
 166         return null;
 167     }
 168
 169     private static JsonWriter createJsonWriter(final OutputStream entityStream, final boolean prettyPrint) {
 170         if (prettyPrint) {
 171             return JsonWriterFactory.createJsonWriter(
 172                     new OutputStreamWriter(entityStream, StandardCharsets.UTF_8), DEFAULT_INDENT_SPACES_NUM);
 173         }
 174         return JsonWriterFactory.createJsonWriter(new OutputStreamWriter(entityStream, StandardCharsets.UTF_8));
 175     }
 176
 177     private static JSONCodecFactory getCodecFactory(final InstanceIdentifierContext<?> context) {
 178         // TODO: Performance: Cache JSON Codec factory and schema context
 179         return JSONCodecFactorySupplier.RFC7951.getShared(context.getSchemaContext());
 180     }
 181 }