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