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 static com.google.common.base.Preconditions.checkNotNull;
12 import com.google.common.base.Preconditions;
13 import com.google.gson.stream.JsonWriter;
14 import java.io.IOException;
16 import java.util.Collections;
17 import java.util.HashSet;
18 import java.util.List;
20 import javax.activation.UnsupportedDataTypeException;
21 import org.opendaylight.controller.sal.core.api.mount.MountInstance;
22 import org.opendaylight.controller.sal.restconf.impl.ControllerContext;
23 import org.opendaylight.controller.sal.restconf.impl.IdentityValuesDTO;
24 import org.opendaylight.controller.sal.restconf.impl.IdentityValuesDTO.IdentityValue;
25 import org.opendaylight.controller.sal.restconf.impl.IdentityValuesDTO.Predicate;
26 import org.opendaylight.controller.sal.restconf.impl.RestCodec;
27 import org.opendaylight.yangtools.yang.common.QName;
28 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
29 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
30 import org.opendaylight.yangtools.yang.data.api.Node;
31 import org.opendaylight.yangtools.yang.data.api.SimpleNode;
32 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
33 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
34 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
35 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
36 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
37 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
38 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
39 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
40 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
41 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
42 import org.opendaylight.yangtools.yang.model.api.type.BooleanTypeDefinition;
43 import org.opendaylight.yangtools.yang.model.api.type.DecimalTypeDefinition;
44 import org.opendaylight.yangtools.yang.model.api.type.EmptyTypeDefinition;
45 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
46 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
47 import org.opendaylight.yangtools.yang.model.api.type.IntegerTypeDefinition;
48 import org.opendaylight.yangtools.yang.model.api.type.UnsignedIntegerTypeDefinition;
49 import org.slf4j.Logger;
50 import org.slf4j.LoggerFactory;
54 private MountInstance mountPoint;
55 private final Logger logger = LoggerFactory.getLogger(JsonMapper.class);
57 public void write(final JsonWriter writer, final CompositeNode data, final DataNodeContainer schema, final MountInstance mountPoint)
59 Preconditions.checkNotNull(writer);
60 Preconditions.checkNotNull(data);
61 Preconditions.checkNotNull(schema);
62 this.mountPoint = mountPoint;
66 if (schema instanceof ContainerSchemaNode) {
67 writeContainer(writer, data, (ContainerSchemaNode) schema);
68 } else if (schema instanceof ListSchemaNode) {
69 writeList(writer, null, data, (ListSchemaNode) schema);
71 throw new UnsupportedDataTypeException(
72 "Schema can be ContainerSchemaNode or ListSchemaNode. Other types are not supported yet.");
78 private void writeChildrenOfParent(final JsonWriter writer, final CompositeNode parent, final DataNodeContainer parentSchema)
82 final Set<QName> foundLists = new HashSet<>();
84 Set<DataSchemaNode> parentSchemaChildNodes = parentSchema == null ?
85 Collections.<DataSchemaNode>emptySet() : parentSchema.getChildNodes();
88 for (Node<?> child : parent.getValue()) {
89 DataSchemaNode childSchema = findFirstSchemaForNode(child, parentSchemaChildNodes);
91 if (childSchema == null) {
92 // Node may not conform to schema or allows "anyxml" - we'll process it.
94 logger.debug( "No schema found for data node \"" + child.getNodeType() );
96 if( !foundLists.contains( child.getNodeType() ) ) {
97 handleNoSchemaFound( writer, child, parent );
99 // Since we don't have a schema, we don't know which nodes are supposed to be
100 // lists so treat every one as a potential list to avoid outputting duplicates.
102 foundLists.add( child.getNodeType() );
105 else if (childSchema instanceof ContainerSchemaNode) {
106 Preconditions.checkState(child instanceof CompositeNode,
107 "Data representation of Container should be CompositeNode - " + child.getNodeType());
108 writeContainer(writer, (CompositeNode) child, (ContainerSchemaNode) childSchema);
109 } else if (childSchema instanceof ListSchemaNode) {
110 if (!foundLists.contains( child.getNodeType() ) ) {
111 Preconditions.checkState(child instanceof CompositeNode,
112 "Data representation of List should be CompositeNode - " + child.getNodeType());
113 foundLists.add( child.getNodeType() );
114 writeList(writer, parent, (CompositeNode) child, (ListSchemaNode) childSchema);
116 } else if (childSchema instanceof LeafListSchemaNode) {
117 if (!foundLists.contains( child.getNodeType() ) ) {
118 Preconditions.checkState(child instanceof SimpleNode<?>,
119 "Data representation of LeafList should be SimpleNode - " + child.getNodeType());
120 foundLists.add( child.getNodeType() );
121 writeLeafList(writer, parent, (SimpleNode<?>) child, (LeafListSchemaNode) childSchema);
123 } else if (childSchema instanceof LeafSchemaNode) {
124 Preconditions.checkState(child instanceof SimpleNode<?>,
125 "Data representation of LeafList should be SimpleNode - " + child.getNodeType());
126 writeLeaf(writer, (SimpleNode<?>) child, (LeafSchemaNode) childSchema);
127 } else if (childSchema instanceof AnyXmlSchemaNode) {
128 if( child instanceof CompositeNode ) {
129 writeContainer(writer, (CompositeNode) child, null);
132 handleNoSchemaFound( writer, child, parent );
135 throw new UnsupportedDataTypeException("Schema can be ContainerSchemaNode, ListSchemaNode, "
136 + "LeafListSchemaNode, or LeafSchemaNode. Other types are not supported yet.");
141 private void writeValue( final JsonWriter writer, Object value ) throws IOException {
142 if( value != null ) {
143 writer.value( String.valueOf( value ) );
150 private void handleNoSchemaFound( final JsonWriter writer, final Node<?> node,
151 final CompositeNode parent ) throws IOException {
152 if( node instanceof SimpleNode<?> ) {
153 List<SimpleNode<?>> nodeLeafList = parent.getSimpleNodesByName( node.getNodeType() );
154 if( nodeLeafList.size() == 1 ) {
155 writeName( node, null, writer );
156 writeValue( writer, node.getValue() );
158 else { // more than 1, write as a json array
159 writeName( node, null, writer );
161 for( SimpleNode<?> leafNode: nodeLeafList ) {
162 writeValue( writer, leafNode.getValue() );
167 } else { // CompositeNode
168 Preconditions.checkState( node instanceof CompositeNode,
169 "Data representation of Container should be CompositeNode - " + node.getNodeType() );
171 List<CompositeNode> nodeList = parent.getCompositesByName( node.getNodeType() );
172 if( nodeList.size() == 1 ) {
173 writeContainer( writer, (CompositeNode) node, null );
175 else { // more than 1, write as a json array
176 writeList( writer, parent, (CompositeNode) node, null );
181 private DataSchemaNode findFirstSchemaForNode(final Node<?> node, final Set<DataSchemaNode> dataSchemaNode) {
182 for (DataSchemaNode dsn : dataSchemaNode) {
183 if (node.getNodeType().equals(dsn.getQName())) {
185 } else if (dsn instanceof ChoiceNode) {
186 for (ChoiceCaseNode choiceCase : ((ChoiceNode) dsn).getCases()) {
187 DataSchemaNode foundDsn = findFirstSchemaForNode(node, choiceCase.getChildNodes());
188 if (foundDsn != null) {
197 private void writeContainer(final JsonWriter writer, final CompositeNode node, final ContainerSchemaNode schema) throws IOException {
198 writeName(node, schema, writer);
199 writer.beginObject();
200 writeChildrenOfParent(writer, node, schema);
204 private void writeList(final JsonWriter writer, final CompositeNode nodeParent, final CompositeNode node, final ListSchemaNode schema)
206 writeName(node, schema, writer);
209 if (nodeParent != null) {
210 List<CompositeNode> nodeLists = nodeParent.getCompositesByName(node.getNodeType());
211 for (CompositeNode nodeList : nodeLists) {
212 writer.beginObject();
213 writeChildrenOfParent(writer, nodeList, schema);
217 writer.beginObject();
218 writeChildrenOfParent(writer, node, schema);
225 private void writeLeafList(final JsonWriter writer, final CompositeNode nodeParent, final SimpleNode<?> node,
226 final LeafListSchemaNode schema) throws IOException {
227 writeName(node, schema, writer);
230 List<SimpleNode<?>> nodeLeafLists = nodeParent.getSimpleNodesByName(node.getNodeType());
231 for (SimpleNode<?> nodeLeafList : nodeLeafLists) {
232 writeValueOfNodeByType(writer, nodeLeafList, schema.getType(), schema);
237 private void writeLeaf(final JsonWriter writer, final SimpleNode<?> node, final LeafSchemaNode schema) throws IOException {
238 writeName(node, schema, writer);
239 writeValueOfNodeByType(writer, node, schema.getType(), schema);
242 private void writeValueOfNodeByType(final JsonWriter writer, final SimpleNode<?> node, final TypeDefinition<?> type,
243 final DataSchemaNode schema) throws IOException {
245 TypeDefinition<?> baseType = RestUtil.resolveBaseTypeFrom(type);
247 if (node.getValue() == null && !(baseType instanceof EmptyTypeDefinition)) {
248 logger.debug("While generationg JSON output null value was found for type "
249 + baseType.getClass().getSimpleName() + ".");
252 if (baseType instanceof IdentityrefTypeDefinition) {
253 if (node.getValue() instanceof QName) {
254 IdentityValuesDTO valueDTO = (IdentityValuesDTO) RestCodec.from(baseType, mountPoint).serialize(
256 IdentityValue valueFromDTO = valueDTO.getValuesWithNamespaces().get(0);
258 if (mountPoint != null) {
259 moduleName = ControllerContext.getInstance().findModuleNameByNamespace(mountPoint,
260 URI.create(valueFromDTO.getNamespace()));
262 moduleName = ControllerContext.getInstance().findModuleNameByNamespace(
263 URI.create(valueFromDTO.getNamespace()));
265 writer.value(moduleName + ":" + valueFromDTO.getValue());
267 writeStringRepresentation(writer, node, baseType, QName.class);
269 } else if (baseType instanceof InstanceIdentifierTypeDefinition) {
270 if (node.getValue() instanceof InstanceIdentifier) {
271 IdentityValuesDTO valueDTO = (IdentityValuesDTO) RestCodec.from(baseType, mountPoint).serialize(
273 writeIdentityValuesDTOToJson(writer, valueDTO);
275 writeStringRepresentation(writer, node, baseType, InstanceIdentifier.class);
277 } else if (baseType instanceof DecimalTypeDefinition || baseType instanceof IntegerTypeDefinition
278 || baseType instanceof UnsignedIntegerTypeDefinition) {
279 writer.value(new NumberForJsonWriter((String) RestCodec.from(baseType, mountPoint).serialize(
281 } else if (baseType instanceof BooleanTypeDefinition) {
282 writer.value(Boolean.parseBoolean((String) RestCodec.from(baseType, mountPoint).serialize(node.getValue())));
283 } else if (baseType instanceof EmptyTypeDefinition) {
284 writeEmptyDataTypeToJson(writer);
286 String value = String.valueOf(RestCodec.from(baseType, mountPoint).serialize(node.getValue()));
288 value = String.valueOf(node.getValue());
290 writer.value(value.equals("null") ? "" : value);
294 private void writeIdentityValuesDTOToJson(final JsonWriter writer, final IdentityValuesDTO valueDTO) throws IOException {
295 StringBuilder result = new StringBuilder();
296 for (IdentityValue identityValue : valueDTO.getValuesWithNamespaces()) {
299 writeModuleNameAndIdentifier(result, identityValue);
300 if (identityValue.getPredicates() != null && !identityValue.getPredicates().isEmpty()) {
301 for (Predicate predicate : identityValue.getPredicates()) {
302 IdentityValue identityValuePredicate = predicate.getName();
304 if (identityValuePredicate == null) {
307 writeModuleNameAndIdentifier(result, identityValuePredicate);
310 result.append(predicate.getValue());
317 writer.value(result.toString());
320 private void writeModuleNameAndIdentifier(final StringBuilder result, final IdentityValue identityValue) {
321 String moduleName = ControllerContext.getInstance().findModuleNameByNamespace(
322 URI.create(identityValue.getNamespace()));
323 if (moduleName != null && !moduleName.isEmpty()) {
324 result.append(moduleName);
327 result.append(identityValue.getValue());
330 private void writeStringRepresentation(final JsonWriter writer, final SimpleNode<?> node, final TypeDefinition<?> baseType,
331 final Class<?> requiredType) throws IOException {
332 Object value = node.getValue();
333 logger.debug("Value of " + baseType.getQName().getNamespace() + ":" + baseType.getQName().getLocalName()
334 + " is not instance of " + requiredType.getClass() + " but is " + node.getValue().getClass());
338 writer.value(String.valueOf(value));
342 private void writeEmptyDataTypeToJson(final JsonWriter writer) throws IOException {
348 private void writeName(final Node<?> node, final DataSchemaNode schema, final JsonWriter writer) throws IOException {
349 String nameForOutput = node.getNodeType().getLocalName();
350 if ( schema != null && schema.isAugmenting()) {
351 ControllerContext contContext = ControllerContext.getInstance();
352 CharSequence moduleName = null;
353 if (mountPoint == null) {
354 moduleName = contContext.toRestconfIdentifier(schema.getQName());
356 moduleName = contContext.toRestconfIdentifier(mountPoint, schema.getQName());
358 if (moduleName != null) {
359 nameForOutput = moduleName.toString();
361 logger.info("Module '{}' was not found in schema from mount point", schema.getQName());
364 writer.name(nameForOutput);
367 private static final class NumberForJsonWriter extends Number {
369 private static final long serialVersionUID = -3147729419814417666L;
370 private final String value;
372 public NumberForJsonWriter(final String value) {
377 public int intValue() {
378 throw new IllegalStateException("Should not be invoked");
382 public long longValue() {
383 throw new IllegalStateException("Should not be invoked");
387 public float floatValue() {
388 throw new IllegalStateException("Should not be invoked");
392 public double doubleValue() {
393 throw new IllegalStateException("Should not be invoked");
397 public String toString() {