2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.restconf.nb.rfc8040.jersey.providers;
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;
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.DepthParam;
27 import org.opendaylight.restconf.nb.rfc8040.MediaTypes;
28 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.api.RestconfNormalizedNodeWriter;
29 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
30 import org.opendaylight.yangtools.yang.common.QName;
31 import org.opendaylight.yangtools.yang.common.XMLNamespace;
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.JSONCodecFactorySupplier;
39 import org.opendaylight.yangtools.yang.data.codec.gson.JSONNormalizedNodeStreamWriter;
40 import org.opendaylight.yangtools.yang.data.codec.gson.JsonWriterFactory;
41 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
42 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
43 import org.opendaylight.yangtools.yang.model.api.Module;
44 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
45 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
46 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
49 @Produces({ MediaTypes.APPLICATION_YANG_DATA_JSON, MediaType.APPLICATION_JSON })
50 public class JsonNormalizedNodeBodyWriter extends AbstractNormalizedNodeBodyWriter {
51 private static final int DEFAULT_INDENT_SPACES_NUM = 2;
54 public void writeTo(final NormalizedNodePayload context,
56 final Type genericType,
57 final Annotation[] annotations,
58 final MediaType mediaType,
59 final MultivaluedMap<String, Object> httpHeaders,
60 final OutputStream entityStream) throws IOException, WebApplicationException {
61 final NormalizedNode data = context.getData();
66 @SuppressWarnings("unchecked")
67 final InstanceIdentifierContext<SchemaNode> identifierCtx =
68 (InstanceIdentifierContext<SchemaNode>) context.getInstanceIdentifierContext();
69 final SchemaPath path = identifierCtx.getSchemaNode().getPath();
70 final var pretty = context.getWriterParameters().prettyPrint();
72 try (JsonWriter jsonWriter = createJsonWriter(entityStream, pretty == null ? false : pretty.value())) {
73 jsonWriter.beginObject();
74 writeNormalizedNode(jsonWriter, path, identifierCtx, data,
75 context.getWriterParameters().depth(), context.getWriterParameters().fields());
76 jsonWriter.endObject();
80 if (httpHeaders != null) {
81 for (final Map.Entry<String, Object> entry : context.getNewHeaders().entrySet()) {
82 httpHeaders.add(entry.getKey(), entry.getValue());
87 private static void writeNormalizedNode(final JsonWriter jsonWriter,
88 final SchemaPath path, final InstanceIdentifierContext<SchemaNode> context, final NormalizedNode data,
89 final DepthParam depth, final List<Set<QName>> fields) throws IOException {
90 final RestconfNormalizedNodeWriter nnWriter;
92 if (context.getSchemaNode() instanceof RpcDefinition) {
94 * RpcDefinition is not supported as initial codec in JSONStreamWriter,
95 * so we need to emit initial output declaration..
97 nnWriter = createNormalizedNodeWriter(
99 ((RpcDefinition) context.getSchemaNode()).getOutput().getPath(),
103 final Module module = context.getSchemaContext().findModule(data.getIdentifier().getNodeType().getModule())
105 jsonWriter.name(module.getName() + ":output");
106 jsonWriter.beginObject();
107 writeChildren(nnWriter, (ContainerNode) data);
108 jsonWriter.endObject();
109 } else if (context.getSchemaNode() instanceof ActionDefinition) {
111 * ActionDefinition is not supported as initial codec in JSONStreamWriter,
112 * so we need to emit initial output declaration..
114 nnWriter = createNormalizedNodeWriter(context,
115 ((ActionDefinition) context.getSchemaNode()).getOutput().getPath(), jsonWriter, depth, fields);
116 final Module module = context.getSchemaContext().findModule(data.getIdentifier().getNodeType().getModule())
118 jsonWriter.name(module.getName() + ":output");
119 jsonWriter.beginObject();
120 writeChildren(nnWriter, (ContainerNode) data);
121 jsonWriter.endObject();
123 if (SchemaPath.ROOT.equals(path)) {
124 nnWriter = createNormalizedNodeWriter(context, path, jsonWriter, depth, fields);
126 nnWriter = createNormalizedNodeWriter(context, path.getParent(), jsonWriter, depth, fields);
129 if (data instanceof MapEntryNode) {
130 // Restconf allows returning one list item. We need to wrap it
131 // in map node in order to serialize it properly
132 nnWriter.write(ImmutableNodes.mapNodeBuilder(data.getIdentifier().getNodeType())
133 .withChild((MapEntryNode) data)
136 nnWriter.write(data);
143 private static void writeChildren(final RestconfNormalizedNodeWriter nnWriter, final ContainerNode data)
145 for (final DataContainerChild child : data.body()) {
146 nnWriter.write(child);
150 private static RestconfNormalizedNodeWriter createNormalizedNodeWriter(
151 final InstanceIdentifierContext<SchemaNode> context, final SchemaPath path, final JsonWriter jsonWriter,
152 final DepthParam depth, final List<Set<QName>> fields) {
154 final SchemaNode schema = context.getSchemaNode();
155 final JSONCodecFactory codecs = getCodecFactory(context);
157 final NormalizedNodeStreamWriter streamWriter = JSONNormalizedNodeStreamWriter.createNestedWriter(
158 codecs, path, initialNamespaceFor(schema), jsonWriter);
160 return ParameterAwareNormalizedNodeWriter.forStreamWriter(streamWriter, depth, fields);
163 private static XMLNamespace initialNamespaceFor(final SchemaNode schema) {
164 if (schema instanceof RpcDefinition) {
165 return schema.getQName().getNamespace();
167 // For top-level elements we always want to use namespace prefix, hence use a null initial namespace
171 private static JsonWriter createJsonWriter(final OutputStream entityStream, final boolean prettyPrint) {
173 return JsonWriterFactory.createJsonWriter(
174 new OutputStreamWriter(entityStream, StandardCharsets.UTF_8), DEFAULT_INDENT_SPACES_NUM);
176 return JsonWriterFactory.createJsonWriter(new OutputStreamWriter(entityStream, StandardCharsets.UTF_8));
179 private static JSONCodecFactory getCodecFactory(final InstanceIdentifierContext<?> context) {
180 // TODO: Performance: Cache JSON Codec factory and schema context
181 return JSONCodecFactorySupplier.RFC7951.getShared(context.getSchemaContext());