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.common.base.Optional;
  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.Map.Entry;
  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.MessageBodyWriter;
  25 import javax.ws.rs.ext.Provider;
  26 import org.opendaylight.netconf.sal.rest.api.Draft02;
  27 import org.opendaylight.netconf.sal.rest.api.RestconfNormalizedNodeWriter;
  28 import org.opendaylight.netconf.sal.rest.api.RestconfService;
  29 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  30 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
  31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  32 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  33 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  34 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  35 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  36 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  37 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactory;
  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.DataSchemaNode;
  42 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  43 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  44 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  45 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  46
  47 /**
  48  * Normalized node writer for JSON.
  49  *
  50  * @deprecated This class will be replaced by NormalizedNodeJsonBodyWriter from restconf-nb-rfc8040
  51  */
  52 @Deprecated
  53 @Provider
  54 @Produces({ Draft02.MediaTypes.API + RestconfService.JSON, Draft02.MediaTypes.DATA + RestconfService.JSON,
  55         Draft02.MediaTypes.OPERATION + RestconfService.JSON, MediaType.APPLICATION_JSON })
  56 public class NormalizedNodeJsonBodyWriter implements MessageBodyWriter<NormalizedNodeContext> {
  57
  58     private static final int DEFAULT_INDENT_SPACES_NUM = 2;
  59
  60     @Override
  61     public boolean isWriteable(final Class<?> type, final Type genericType, final Annotation[] annotations,
  62             final MediaType mediaType) {
  63         return type.equals(NormalizedNodeContext.class);
  64     }
  65
  66     @Override
  67     public long getSize(final NormalizedNodeContext context, final Class<?> type, final Type genericType,
  68             final Annotation[] annotations, final MediaType mediaType) {
  69         return -1;
  70     }
  71
  72     @Override
  73     public void writeTo(final NormalizedNodeContext context, final Class<?> type, final Type genericType,
  74             final Annotation[] annotations, final MediaType mediaType, final MultivaluedMap<String, Object> httpHeaders,
  75             final OutputStream entityStream) throws IOException, WebApplicationException {
  76         if (httpHeaders != null) {
  77             for (final Entry<String, Object> entry : context.getNewHeaders().entrySet()) {
  78                 httpHeaders.add(entry.getKey(), entry.getValue());
  79             }
  80         }
  81         final NormalizedNode<?, ?> data = context.getData();
  82         if (data == null) {
  83             return;
  84         }
  85
  86         @SuppressWarnings("unchecked")
  87         final InstanceIdentifierContext<SchemaNode> identifierCtx =
  88                 (InstanceIdentifierContext<SchemaNode>) context.getInstanceIdentifierContext();
  89
  90         final SchemaPath path = identifierCtx.getSchemaNode().getPath();
  91         try (JsonWriter jsonWriter = createJsonWriter(entityStream, context.getWriterParameters().isPrettyPrint())) {
  92             jsonWriter.beginObject();
  93             writeNormalizedNode(
  94                     jsonWriter, path, identifierCtx, data,
  95                     Optional.fromNullable(context.getWriterParameters().getDepth()));
  96             jsonWriter.endObject();
  97             jsonWriter.flush();
  98         }
  99     }
 100
 101     private static void writeNormalizedNode(final JsonWriter jsonWriter, SchemaPath path,
 102             final InstanceIdentifierContext<SchemaNode> context, NormalizedNode<?, ?> data,
 103             final Optional<Integer> depth) throws IOException {
 104         final RestconfNormalizedNodeWriter nnWriter;
 105         if (SchemaPath.ROOT.equals(path)) {
 106             /*
 107              *  Creates writer without initialNs and we write children of root data container
 108              *  which is not visible in restconf
 109              */
 110             nnWriter = createNormalizedNodeWriter(context,path,jsonWriter, depth);
 111             writeChildren(nnWriter,(ContainerNode) data);
 112         } else if (context.getSchemaNode() instanceof RpcDefinition) {
 113             /*
 114              *  RpcDefinition is not supported as initial codec in JSONStreamWriter,
 115              *  so we need to emit initial output declaratation..
 116              */
 117             path = ((RpcDefinition) context.getSchemaNode()).getOutput().getPath();
 118             nnWriter = createNormalizedNodeWriter(context,path,jsonWriter, depth);
 119             jsonWriter.name("output");
 120             jsonWriter.beginObject();
 121             writeChildren(nnWriter, (ContainerNode) data);
 122             jsonWriter.endObject();
 123         } else {
 124             path = path.getParent();
 125
 126             if (data instanceof MapEntryNode) {
 127                 data = ImmutableNodes.mapNodeBuilder(data.getNodeType()).withChild((MapEntryNode) data).build();
 128             }
 129             nnWriter = createNormalizedNodeWriter(context,path,jsonWriter, depth);
 130             nnWriter.write(data);
 131         }
 132         nnWriter.flush();
 133     }
 134
 135     private static void writeChildren(final RestconfNormalizedNodeWriter nnWriter, final ContainerNode data)
 136             throws IOException {
 137         for (final DataContainerChild<? extends PathArgument, ?> child : data.getValue()) {
 138             nnWriter.write(child);
 139         }
 140     }
 141
 142     private static RestconfNormalizedNodeWriter createNormalizedNodeWriter(
 143             final InstanceIdentifierContext<SchemaNode> context, final SchemaPath path, final JsonWriter jsonWriter,
 144             final Optional<Integer> depth) {
 145
 146         final SchemaNode schema = context.getSchemaNode();
 147         final JSONCodecFactory codecs = getCodecFactory(context);
 148
 149         final URI initialNs;
 150         if (schema instanceof DataSchemaNode && !((DataSchemaNode)schema).isAugmenting()
 151                 && !(schema instanceof SchemaContext)) {
 152             initialNs = schema.getQName().getNamespace();
 153         } else if (schema instanceof RpcDefinition) {
 154             initialNs = schema.getQName().getNamespace();
 155         } else {
 156             initialNs = null;
 157         }
 158         final NormalizedNodeStreamWriter streamWriter =
 159                 JSONNormalizedNodeStreamWriter.createNestedWriter(codecs, path, initialNs, jsonWriter);
 160         if (depth.isPresent()) {
 161             return DepthAwareNormalizedNodeWriter.forStreamWriter(streamWriter, depth.get());
 162         }
 163
 164         return RestconfDelegatingNormalizedNodeWriter.forStreamWriter(streamWriter);
 165     }
 166
 167     private static JsonWriter createJsonWriter(final OutputStream entityStream, final boolean prettyPrint) {
 168         if (prettyPrint) {
 169             return JsonWriterFactory.createJsonWriter(new OutputStreamWriter(entityStream, StandardCharsets.UTF_8),
 170                     DEFAULT_INDENT_SPACES_NUM);
 171         }
 172
 173         return JsonWriterFactory.createJsonWriter(new OutputStreamWriter(entityStream, StandardCharsets.UTF_8));
 174     }
 175
 176     private static JSONCodecFactory getCodecFactory(final InstanceIdentifierContext<?> context) {
 177         // TODO: Performance: Cache JSON Codec factory and schema context
 178         return JSONCodecFactory.getShared(context.getSchemaContext());
 179     }
 180 }