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.Rfc8040;
31 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.api.RestconfNormalizedNodeWriter;
32 import org.opendaylight.restconf.nb.rfc8040.utils.RestconfConstants;
33 import org.opendaylight.yangtools.yang.common.QName;
34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
35 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
37 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
38 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
40 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactory;
41 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactorySupplier;
42 import org.opendaylight.yangtools.yang.data.codec.gson.JSONNormalizedNodeStreamWriter;
43 import org.opendaylight.yangtools.yang.data.codec.gson.JsonWriterFactory;
44 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
45 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
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.SchemaNode;
49 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
52 @Produces({ Rfc8040.MediaTypes.DATA + RestconfConstants.JSON, MediaType.APPLICATION_JSON })
53 public class NormalizedNodeJsonBodyWriter implements MessageBodyWriter<NormalizedNodeContext> {
55 private static final int DEFAULT_INDENT_SPACES_NUM = 2;
58 public boolean isWriteable(final Class<?> type,
59 final Type genericType,
60 final Annotation[] annotations,
61 final MediaType mediaType) {
62 return type.equals(NormalizedNodeContext.class);
66 public long getSize(final NormalizedNodeContext context,
68 final Type genericType,
69 final Annotation[] annotations,
70 final MediaType mediaType) {
75 public void writeTo(final NormalizedNodeContext context,
77 final Type genericType,
78 final Annotation[] annotations,
79 final MediaType mediaType,
80 final MultivaluedMap<String, Object> httpHeaders,
81 final OutputStream entityStream) throws IOException, WebApplicationException {
82 final NormalizedNode<?, ?> data = context.getData();
87 @SuppressWarnings("unchecked")
88 final InstanceIdentifierContext<SchemaNode> identifierCtx =
89 (InstanceIdentifierContext<SchemaNode>) context.getInstanceIdentifierContext();
90 final SchemaPath path = identifierCtx.getSchemaNode().getPath();
92 try (JsonWriter jsonWriter = createJsonWriter(entityStream, context.getWriterParameters().isPrettyPrint())) {
93 jsonWriter.beginObject();
94 writeNormalizedNode(jsonWriter, path, identifierCtx, data,
95 context.getWriterParameters().getDepth(), context.getWriterParameters().getFields());
96 jsonWriter.endObject();
100 if (httpHeaders != null) {
101 for (final Map.Entry<String, Object> entry : context.getNewHeaders().entrySet()) {
102 httpHeaders.add(entry.getKey(), entry.getValue());
107 private static void writeNormalizedNode(final JsonWriter jsonWriter,
108 final SchemaPath path, final InstanceIdentifierContext<SchemaNode> context, final NormalizedNode<?, ?> data,
109 final Integer depth, final List<Set<QName>> fields) throws IOException {
110 final RestconfNormalizedNodeWriter nnWriter;
112 if (context.getSchemaNode() instanceof RpcDefinition) {
114 * RpcDefinition is not supported as initial codec in JSONStreamWriter,
115 * so we need to emit initial output declaration..
117 nnWriter = createNormalizedNodeWriter(
119 ((RpcDefinition) context.getSchemaNode()).getOutput().getPath(),
123 final Module module = context.getSchemaContext().findModule(data.getNodeType().getModule()).get();
124 jsonWriter.name(module.getName() + ":output");
125 jsonWriter.beginObject();
126 writeChildren(nnWriter, (ContainerNode) data);
127 jsonWriter.endObject();
128 } else if (context.getSchemaNode() instanceof ActionDefinition) {
130 * ActionDefinition is not supported as initial codec in JSONStreamWriter,
131 * so we need to emit initial output declaration..
133 nnWriter = createNormalizedNodeWriter(context,
134 ((ActionDefinition) context.getSchemaNode()).getOutput().getPath(), jsonWriter, depth, fields);
135 final Module module = context.getSchemaContext().findModule(data.getNodeType().getModule()).get();
136 jsonWriter.name(module.getName() + ":output");
137 jsonWriter.beginObject();
138 writeChildren(nnWriter, (ContainerNode) data);
139 jsonWriter.endObject();
141 if (SchemaPath.ROOT.equals(path)) {
142 nnWriter = createNormalizedNodeWriter(context, path, jsonWriter, depth, fields);
144 nnWriter = createNormalizedNodeWriter(context, path.getParent(), jsonWriter, depth, fields);
147 if (data instanceof MapEntryNode) {
148 // Restconf allows returning one list item. We need to wrap it
149 // in map node in order to serialize it properly
151 ImmutableNodes.mapNodeBuilder(data.getNodeType()).withChild((MapEntryNode) data).build());
153 nnWriter.write(data);
160 private static void writeChildren(final RestconfNormalizedNodeWriter nnWriter,
161 final ContainerNode data) throws IOException {
162 for (final DataContainerChild<? extends PathArgument, ?> child : data.getValue()) {
163 nnWriter.write(child);
167 private static RestconfNormalizedNodeWriter createNormalizedNodeWriter(
168 final InstanceIdentifierContext<SchemaNode> context, final SchemaPath path, final JsonWriter jsonWriter,
169 final Integer depth, final List<Set<QName>> fields) {
171 final SchemaNode schema = context.getSchemaNode();
172 final JSONCodecFactory codecs = getCodecFactory(context);
174 final NormalizedNodeStreamWriter streamWriter = JSONNormalizedNodeStreamWriter.createNestedWriter(
175 codecs, path, initialNamespaceFor(schema), jsonWriter);
177 return ParameterAwareNormalizedNodeWriter.forStreamWriter(streamWriter, depth, fields);
180 private static URI initialNamespaceFor(final SchemaNode schema) {
181 if (schema instanceof RpcDefinition) {
182 return schema.getQName().getNamespace();
184 // For top-level elements we always want to use namespace prefix, hence use a null initial namespace
188 private static JsonWriter createJsonWriter(final OutputStream entityStream, final boolean prettyPrint) {
190 return JsonWriterFactory.createJsonWriter(
191 new OutputStreamWriter(entityStream, StandardCharsets.UTF_8), DEFAULT_INDENT_SPACES_NUM);
193 return JsonWriterFactory.createJsonWriter(new OutputStreamWriter(entityStream, StandardCharsets.UTF_8));
196 private static JSONCodecFactory getCodecFactory(final InstanceIdentifierContext<?> context) {
197 // TODO: Performance: Cache JSON Codec factory and schema context
198 return JSONCodecFactorySupplier.RFC7951.getShared(context.getSchemaContext());