2 * Copyright (c) 2014 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.controller.sal.rest.impl;
10 import com.google.common.base.Charsets;
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 javax.ws.rs.Produces;
19 import javax.ws.rs.WebApplicationException;
20 import javax.ws.rs.core.MediaType;
21 import javax.ws.rs.core.MultivaluedMap;
22 import javax.ws.rs.ext.MessageBodyWriter;
23 import javax.ws.rs.ext.Provider;
24 import org.opendaylight.controller.sal.rest.api.Draft02;
25 import org.opendaylight.controller.sal.rest.api.RestconfService;
26 import org.opendaylight.controller.sal.restconf.impl.InstanceIdentifierContext;
27 import org.opendaylight.controller.sal.restconf.impl.NormalizedNodeContext;
28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
29 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
31 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
34 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
35 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactory;
36 import org.opendaylight.yangtools.yang.data.codec.gson.JSONNormalizedNodeStreamWriter;
37 import org.opendaylight.yangtools.yang.data.codec.gson.JsonWriterFactory;
38 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
39 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
40 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
41 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
42 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
43 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
46 @Produces({ Draft02.MediaTypes.API + RestconfService.JSON, Draft02.MediaTypes.DATA + RestconfService.JSON,
47 Draft02.MediaTypes.OPERATION + RestconfService.JSON, MediaType.APPLICATION_JSON })
48 public class NormalizedNodeJsonBodyWriter implements MessageBodyWriter<NormalizedNodeContext> {
51 public boolean isWriteable(final Class<?> type, final Type genericType, final Annotation[] annotations, final MediaType mediaType) {
52 return type.equals(NormalizedNodeContext.class);
56 public long getSize(final NormalizedNodeContext t, final Class<?> type, final Type genericType, final Annotation[] annotations, final MediaType mediaType) {
61 public void writeTo(final NormalizedNodeContext t, final Class<?> type, final Type genericType, final Annotation[] annotations,
62 final MediaType mediaType, final MultivaluedMap<String, Object> httpHeaders, final OutputStream entityStream)
63 throws IOException, WebApplicationException {
64 NormalizedNode<?, ?> data = t.getData();
69 @SuppressWarnings("unchecked")
70 final InstanceIdentifierContext<SchemaNode> context = (InstanceIdentifierContext<SchemaNode>) t.getInstanceIdentifierContext();
72 SchemaPath path = context.getSchemaNode().getPath();
73 final JsonWriter jsonWriter = createJsonWriter(entityStream);
74 jsonWriter.beginObject();
75 writeNormalizedNode(jsonWriter,path,context,data);
76 jsonWriter.endObject();
80 private void writeNormalizedNode(JsonWriter jsonWriter, SchemaPath path,
81 InstanceIdentifierContext<SchemaNode> context, NormalizedNode<?, ?> data) throws IOException {
82 final NormalizedNodeWriter nnWriter;
83 if (SchemaPath.ROOT.equals(path)) {
85 * Creates writer without initialNs and we write children of root data container
86 * which is not visible in restconf
88 nnWriter = createNormalizedNodeWriter(context,path,jsonWriter);
89 writeChildren(nnWriter,(ContainerNode) data);
90 } else if (context.getSchemaNode() instanceof RpcDefinition) {
92 * RpcDefinition is not supported as initial codec in JSONStreamWriter,
93 * so we need to emit initial output declaratation..
95 path = ((RpcDefinition) context.getSchemaNode()).getOutput().getPath();
96 nnWriter = createNormalizedNodeWriter(context,path,jsonWriter);
97 jsonWriter.name("output");
98 jsonWriter.beginObject();
99 writeChildren(nnWriter, (ContainerNode) data);
100 jsonWriter.endObject();
102 path = path.getParent();
104 if(data instanceof MapEntryNode) {
105 data = ImmutableNodes.mapNodeBuilder(data.getNodeType()).withChild(((MapEntryNode) data)).build();
107 nnWriter = createNormalizedNodeWriter(context,path,jsonWriter);
108 nnWriter.write(data);
113 private void writeChildren(final NormalizedNodeWriter nnWriter, final ContainerNode data) throws IOException {
114 for(final DataContainerChild<? extends PathArgument, ?> child : data.getValue()) {
115 nnWriter.write(child);
119 private NormalizedNodeWriter createNormalizedNodeWriter(final InstanceIdentifierContext<SchemaNode> context,
120 final SchemaPath path, final JsonWriter jsonWriter) {
122 final SchemaNode schema = context.getSchemaNode();
123 final JSONCodecFactory codecs = getCodecFactory(context);
126 if ((schema instanceof DataSchemaNode)
127 && !((DataSchemaNode)schema).isAugmenting()
128 && !(schema instanceof SchemaContext)) {
129 initialNs = schema.getQName().getNamespace();
130 } else if (schema instanceof RpcDefinition) {
131 initialNs = schema.getQName().getNamespace();
135 final NormalizedNodeStreamWriter streamWriter = JSONNormalizedNodeStreamWriter.createNestedWriter(codecs,path,initialNs,jsonWriter);
136 return NormalizedNodeWriter.forStreamWriter(streamWriter);
139 private JsonWriter createJsonWriter(final OutputStream entityStream) {
140 // FIXME BUG-2153: Add pretty print support
141 return JsonWriterFactory.createJsonWriter(new OutputStreamWriter(entityStream, Charsets.UTF_8));
145 private JSONCodecFactory getCodecFactory(final InstanceIdentifierContext<?> context) {
146 // TODO: Performance: Cache JSON Codec factory and schema context
147 return JSONCodecFactory.create(context.getSchemaContext());