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
9 package org.opendaylight.restconf.nb.rfc8040.jersey.providers;
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;
18 import java.nio.charset.StandardCharsets;
19 import java.util.List;
22 import javax.ws.rs.Produces;
23 import javax.ws.rs.WebApplicationException;
24 import javax.ws.rs.core.MediaType;
25 import javax.ws.rs.core.MultivaluedMap;
26 import javax.ws.rs.ext.MessageBodyWriter;
27 import javax.ws.rs.ext.Provider;
28 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
29 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
30 import org.opendaylight.restconf.nb.rfc8040.MediaTypes;
31 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.api.RestconfNormalizedNodeWriter;
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.Module;
46 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
47 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
48 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
51 @Produces({ MediaTypes.APPLICATION_YANG_DATA_JSON, MediaType.APPLICATION_JSON })
52 public class NormalizedNodeJsonBodyWriter implements MessageBodyWriter<NormalizedNodeContext> {
54 private static final int DEFAULT_INDENT_SPACES_NUM = 2;
57 public boolean isWriteable(final Class<?> type,
58 final Type genericType,
59 final Annotation[] annotations,
60 final MediaType mediaType) {
61 return type.equals(NormalizedNodeContext.class);
65 public long getSize(final NormalizedNodeContext context,
67 final Type genericType,
68 final Annotation[] annotations,
69 final MediaType mediaType) {
74 public void writeTo(final NormalizedNodeContext context,
76 final Type genericType,
77 final Annotation[] annotations,
78 final MediaType mediaType,
79 final MultivaluedMap<String, Object> httpHeaders,
80 final OutputStream entityStream) throws IOException, WebApplicationException {
81 final NormalizedNode<?, ?> data = context.getData();
86 @SuppressWarnings("unchecked")
87 final InstanceIdentifierContext<SchemaNode> identifierCtx =
88 (InstanceIdentifierContext<SchemaNode>) context.getInstanceIdentifierContext();
89 final SchemaPath path = identifierCtx.getSchemaNode().getPath();
91 try (JsonWriter jsonWriter = createJsonWriter(entityStream, context.getWriterParameters().isPrettyPrint())) {
92 jsonWriter.beginObject();
93 writeNormalizedNode(jsonWriter, path, identifierCtx, data,
94 context.getWriterParameters().getDepth(), context.getWriterParameters().getFields());
95 jsonWriter.endObject();
99 if (httpHeaders != null) {
100 for (final Map.Entry<String, Object> entry : context.getNewHeaders().entrySet()) {
101 httpHeaders.add(entry.getKey(), entry.getValue());
106 private static void writeNormalizedNode(final JsonWriter jsonWriter,
107 final SchemaPath path, final InstanceIdentifierContext<SchemaNode> context, final NormalizedNode<?, ?> data,
108 final Integer depth, final List<Set<QName>> fields) throws IOException {
109 final RestconfNormalizedNodeWriter nnWriter;
111 if (context.getSchemaNode() instanceof RpcDefinition) {
113 * RpcDefinition is not supported as initial codec in JSONStreamWriter,
114 * so we need to emit initial output declaration..
116 nnWriter = createNormalizedNodeWriter(
118 ((RpcDefinition) context.getSchemaNode()).getOutput().getPath(),
122 final Module module = context.getSchemaContext().findModule(data.getNodeType().getModule()).get();
123 jsonWriter.name(module.getName() + ":output");
124 jsonWriter.beginObject();
125 writeChildren(nnWriter, (ContainerNode) data);
126 jsonWriter.endObject();
127 } else if (context.getSchemaNode() instanceof ActionDefinition) {
129 * ActionDefinition is not supported as initial codec in JSONStreamWriter,
130 * so we need to emit initial output declaration..
132 nnWriter = createNormalizedNodeWriter(context,
133 ((ActionDefinition) context.getSchemaNode()).getOutput().getPath(), jsonWriter, depth, fields);
134 final Module module = context.getSchemaContext().findModule(data.getNodeType().getModule()).get();
135 jsonWriter.name(module.getName() + ":output");
136 jsonWriter.beginObject();
137 writeChildren(nnWriter, (ContainerNode) data);
138 jsonWriter.endObject();
140 if (SchemaPath.ROOT.equals(path)) {
141 nnWriter = createNormalizedNodeWriter(context, path, jsonWriter, depth, fields);
143 nnWriter = createNormalizedNodeWriter(context, path.getParent(), jsonWriter, depth, fields);
146 if (data instanceof MapEntryNode) {
147 // Restconf allows returning one list item. We need to wrap it
148 // in map node in order to serialize it properly
150 ImmutableNodes.mapNodeBuilder(data.getNodeType()).withChild((MapEntryNode) data).build());
152 nnWriter.write(data);
159 private static void writeChildren(final RestconfNormalizedNodeWriter nnWriter,
160 final ContainerNode data) throws IOException {
161 for (final DataContainerChild<? extends PathArgument, ?> child : data.getValue()) {
162 nnWriter.write(child);
166 private static RestconfNormalizedNodeWriter createNormalizedNodeWriter(
167 final InstanceIdentifierContext<SchemaNode> context, final SchemaPath path, final JsonWriter jsonWriter,
168 final Integer depth, final List<Set<QName>> fields) {
170 final SchemaNode schema = context.getSchemaNode();
171 final JSONCodecFactory codecs = getCodecFactory(context);
173 final NormalizedNodeStreamWriter streamWriter = JSONNormalizedNodeStreamWriter.createNestedWriter(
174 codecs, path, initialNamespaceFor(schema), jsonWriter);
176 return ParameterAwareNormalizedNodeWriter.forStreamWriter(streamWriter, depth, fields);
179 private static URI initialNamespaceFor(final SchemaNode schema) {
180 if (schema instanceof RpcDefinition) {
181 return schema.getQName().getNamespace();
183 // For top-level elements we always want to use namespace prefix, hence use a null initial namespace
187 private static JsonWriter createJsonWriter(final OutputStream entityStream, final boolean prettyPrint) {
189 return JsonWriterFactory.createJsonWriter(
190 new OutputStreamWriter(entityStream, StandardCharsets.UTF_8), DEFAULT_INDENT_SPACES_NUM);
192 return JsonWriterFactory.createJsonWriter(new OutputStreamWriter(entityStream, StandardCharsets.UTF_8));
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());