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