X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-rest-connector%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Frest%2Fimpl%2FJsonMapper.java;h=34aa829b6f5a50e7511583485d33693155d123d8;hp=627e2a9ce158083b192abc4c92827c91619be8ad;hb=0eb621d29daaf08979c356e2148e99c48458e169;hpb=d3230a844c5c0c6ca6ae774672fcb97a0c5a3951 diff --git a/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/rest/impl/JsonMapper.java b/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/rest/impl/JsonMapper.java index 627e2a9ce1..34aa829b6f 100644 --- a/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/rest/impl/JsonMapper.java +++ b/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/rest/impl/JsonMapper.java @@ -1,24 +1,36 @@ +/* + * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + */ package org.opendaylight.controller.sal.rest.impl; import static com.google.common.base.Preconditions.checkNotNull; +import com.google.common.base.Preconditions; +import com.google.gson.stream.JsonWriter; import java.io.IOException; import java.net.URI; +import java.util.Collection; +import java.util.Collections; import java.util.HashSet; import java.util.List; import java.util.Set; - import javax.activation.UnsupportedDataTypeException; - import org.opendaylight.controller.sal.core.api.mount.MountInstance; import org.opendaylight.controller.sal.restconf.impl.ControllerContext; import org.opendaylight.controller.sal.restconf.impl.IdentityValuesDTO; import org.opendaylight.controller.sal.restconf.impl.IdentityValuesDTO.IdentityValue; +import org.opendaylight.controller.sal.restconf.impl.IdentityValuesDTO.Predicate; import org.opendaylight.controller.sal.restconf.impl.RestCodec; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.data.api.CompositeNode; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.Node; import org.opendaylight.yangtools.yang.data.api.SimpleNode; +import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode; import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode; import org.opendaylight.yangtools.yang.model.api.ChoiceNode; import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode; @@ -32,27 +44,26 @@ import org.opendaylight.yangtools.yang.model.api.type.BooleanTypeDefinition; import org.opendaylight.yangtools.yang.model.api.type.DecimalTypeDefinition; import org.opendaylight.yangtools.yang.model.api.type.EmptyTypeDefinition; import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition; +import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition; import org.opendaylight.yangtools.yang.model.api.type.IntegerTypeDefinition; import org.opendaylight.yangtools.yang.model.api.type.UnsignedIntegerTypeDefinition; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import com.google.common.base.Preconditions; -import com.google.gson.stream.JsonWriter; - class JsonMapper { + private static final Logger LOG = LoggerFactory.getLogger(JsonMapper.class); + private final MountInstance mountPoint; - private final Set foundLeafLists = new HashSet<>(); - private final Set foundLists = new HashSet<>(); - private MountInstance mountPoint; - private final Logger logger = LoggerFactory.getLogger(JsonMapper.class); + public JsonMapper(final MountInstance mountPoint) { + this.mountPoint = mountPoint; + } - public void write(JsonWriter writer, CompositeNode data, DataNodeContainer schema, MountInstance mountPoint) throws IOException { + public void write(final JsonWriter writer, final CompositeNode data, final DataNodeContainer schema) + throws IOException { Preconditions.checkNotNull(writer); Preconditions.checkNotNull(data); Preconditions.checkNotNull(schema); - this.mountPoint = mountPoint; - + writer.beginObject(); if (schema instanceof ContainerSchemaNode) { @@ -65,67 +76,107 @@ class JsonMapper { } writer.endObject(); - - foundLeafLists.clear(); - foundLists.clear(); } - private void writeChildrenOfParent(JsonWriter writer, CompositeNode parent, DataNodeContainer parentSchema) - throws IOException { + private void writeChildrenOfParent(final JsonWriter writer, final CompositeNode parent, + final DataNodeContainer parentSchema) throws IOException { checkNotNull(parent); - checkNotNull(parentSchema); - for (Node child : parent.getChildren()) { - DataSchemaNode childSchema = findFirstSchemaForNode(child, parentSchema.getChildNodes()); + final Set foundLists = new HashSet<>(); + + Collection parentSchemaChildNodes = parentSchema == null ? Collections. emptySet() + : parentSchema.getChildNodes(); + + for (Node child : parent.getValue()) { + DataSchemaNode childSchema = findFirstSchemaForNode(child, parentSchemaChildNodes); if (childSchema == null) { - throw new UnsupportedDataTypeException("Probably the data node \"" + child.getNodeType().getLocalName() - + "\" is not conform to schema"); - } + // Node may not conform to schema or allows "anyxml" - we'll process it. + + LOG.debug("No schema found for data node \"{}\"", child.getNodeType()); + + if (!foundLists.contains(child.getNodeType())) { + handleNoSchemaFound(writer, child, parent); - if (childSchema instanceof ContainerSchemaNode) { + // Since we don't have a schema, we don't know which nodes are supposed to be + // lists so treat every one as a potential list to avoid outputting duplicates. + + foundLists.add(child.getNodeType()); + } + } else if (childSchema instanceof ContainerSchemaNode) { Preconditions.checkState(child instanceof CompositeNode, - "Data representation of Container should be CompositeNode - " + child.getNodeType()); + "Data representation of Container should be CompositeNode - %s", child.getNodeType()); writeContainer(writer, (CompositeNode) child, (ContainerSchemaNode) childSchema); } else if (childSchema instanceof ListSchemaNode) { - if (!foundLists.contains(childSchema)) { + if (!foundLists.contains(child.getNodeType())) { Preconditions.checkState(child instanceof CompositeNode, - "Data representation of List should be CompositeNode - " + child.getNodeType()); - foundLists.add((ListSchemaNode) childSchema); + "Data representation of List should be CompositeNode - %s", child.getNodeType()); + foundLists.add(child.getNodeType()); writeList(writer, parent, (CompositeNode) child, (ListSchemaNode) childSchema); } } else if (childSchema instanceof LeafListSchemaNode) { - if (!foundLeafLists.contains(childSchema)) { + if (!foundLists.contains(child.getNodeType())) { Preconditions.checkState(child instanceof SimpleNode, - "Data representation of LeafList should be SimpleNode - " + child.getNodeType()); - foundLeafLists.add((LeafListSchemaNode) childSchema); + "Data representation of LeafList should be SimpleNode - %s", child.getNodeType()); + foundLists.add(child.getNodeType()); writeLeafList(writer, parent, (SimpleNode) child, (LeafListSchemaNode) childSchema); } } else if (childSchema instanceof LeafSchemaNode) { Preconditions.checkState(child instanceof SimpleNode, - "Data representation of LeafList should be SimpleNode - " + child.getNodeType()); + "Data representation of LeafList should be SimpleNode - %s", child.getNodeType()); writeLeaf(writer, (SimpleNode) child, (LeafSchemaNode) childSchema); + } else if (childSchema instanceof AnyXmlSchemaNode) { + if (child instanceof CompositeNode) { + writeContainer(writer, (CompositeNode) child, null); + } else { + handleNoSchemaFound(writer, child, parent); + } } else { throw new UnsupportedDataTypeException("Schema can be ContainerSchemaNode, ListSchemaNode, " + "LeafListSchemaNode, or LeafSchemaNode. Other types are not supported yet."); } } + } - for (Node child : parent.getChildren()) { - DataSchemaNode childSchema = findFirstSchemaForNode(child, parentSchema.getChildNodes()); - if (childSchema instanceof LeafListSchemaNode) { - foundLeafLists.remove((LeafListSchemaNode) childSchema); - } else if (childSchema instanceof ListSchemaNode) { - foundLists.remove((ListSchemaNode) childSchema); + private static void writeValue(final JsonWriter writer, final Object value) throws IOException { + writer.value(value == null ? "" : String.valueOf(value)); + } + + private void handleNoSchemaFound(final JsonWriter writer, final Node node, final CompositeNode parent) + throws IOException { + if (node instanceof SimpleNode) { + List> nodeLeafList = parent.getSimpleNodesByName(node.getNodeType()); + if (nodeLeafList.size() == 1) { + writeName(node, null, writer); + writeValue(writer, node.getValue()); + } else { // more than 1, write as a json array + writeName(node, null, writer); + writer.beginArray(); + for (SimpleNode leafNode : nodeLeafList) { + writeValue(writer, leafNode.getValue()); + } + + writer.endArray(); + } + } else { // CompositeNode + Preconditions.checkState(node instanceof CompositeNode, + "Data representation of Container should be CompositeNode - %s", node.getNodeType()); + + List nodeList = parent.getCompositesByName(node.getNodeType()); + if (nodeList.size() == 1) { + writeContainer(writer, (CompositeNode) node, null); + } else { // more than 1, write as a json array + writeList(writer, parent, (CompositeNode) node, null); } } } - private DataSchemaNode findFirstSchemaForNode(Node node, Set dataSchemaNode) { + private static DataSchemaNode findFirstSchemaForNode(final Node node, final Iterable dataSchemaNode) { for (DataSchemaNode dsn : dataSchemaNode) { - if (node.getNodeType().getLocalName().equals(dsn.getQName().getLocalName())) { + if (node.getNodeType().equals(dsn.getQName())) { return dsn; - } else if (dsn instanceof ChoiceNode) { + } + if (dsn instanceof ChoiceNode) { for (ChoiceCaseNode choiceCase : ((ChoiceNode) dsn).getCases()) { DataSchemaNode foundDsn = findFirstSchemaForNode(node, choiceCase.getChildNodes()); if (foundDsn != null) { @@ -137,15 +188,16 @@ class JsonMapper { return null; } - private void writeContainer(JsonWriter writer, CompositeNode node, ContainerSchemaNode schema) throws IOException { + private void writeContainer(final JsonWriter writer, final CompositeNode node, final ContainerSchemaNode schema) + throws IOException { writeName(node, schema, writer); writer.beginObject(); writeChildrenOfParent(writer, node, schema); writer.endObject(); } - private void writeList(JsonWriter writer, CompositeNode nodeParent, CompositeNode node, ListSchemaNode schema) - throws IOException { + private void writeList(final JsonWriter writer, final CompositeNode nodeParent, final CompositeNode node, + final ListSchemaNode schema) throws IOException { writeName(node, schema, writer); writer.beginArray(); @@ -165,8 +217,8 @@ class JsonMapper { writer.endArray(); } - private void writeLeafList(JsonWriter writer, CompositeNode nodeParent, SimpleNode node, - LeafListSchemaNode schema) throws IOException { + private void writeLeafList(final JsonWriter writer, final CompositeNode nodeParent, final SimpleNode node, + final LeafListSchemaNode schema) throws IOException { writeName(node, schema, writer); writer.beginArray(); @@ -177,25 +229,26 @@ class JsonMapper { writer.endArray(); } - private void writeLeaf(JsonWriter writer, SimpleNode node, LeafSchemaNode schema) throws IOException { + private void writeLeaf(final JsonWriter writer, final SimpleNode node, final LeafSchemaNode schema) + throws IOException { writeName(node, schema, writer); writeValueOfNodeByType(writer, node, schema.getType(), schema); } - private void writeValueOfNodeByType(JsonWriter writer, SimpleNode node, TypeDefinition type, - DataSchemaNode schema) throws IOException { + private void writeValueOfNodeByType(final JsonWriter writer, final SimpleNode node, + final TypeDefinition type, final DataSchemaNode schema) throws IOException { TypeDefinition baseType = RestUtil.resolveBaseTypeFrom(type); if (node.getValue() == null && !(baseType instanceof EmptyTypeDefinition)) { - logger.debug("While generationg JSON output null value was found for type " - + baseType.getClass().getSimpleName() + "."); + LOG.debug("While generationg JSON output null value was found for type {}.", baseType.getClass() + .getSimpleName()); } - // TODO check InstanceIdentifierTypeDefinition if (baseType instanceof IdentityrefTypeDefinition) { if (node.getValue() instanceof QName) { - IdentityValuesDTO valueDTO = (IdentityValuesDTO) RestCodec.from(baseType, mountPoint).serialize(node.getValue()); + IdentityValuesDTO valueDTO = (IdentityValuesDTO) RestCodec.from(baseType, mountPoint).serialize( + node.getValue()); IdentityValue valueFromDTO = valueDTO.getValuesWithNamespaces().get(0); String moduleName; if (mountPoint != null) { @@ -207,19 +260,20 @@ class JsonMapper { } writer.value(moduleName + ":" + valueFromDTO.getValue()); } else { - Object value = node.getValue(); - logger.debug("Value of " + baseType.getQName().getNamespace() + ":" - + baseType.getQName().getLocalName() + " is not instance of " + QName.class + " but is " - + (value != null ? value.getClass() : "null")); - if (value == null) { - writer.value(""); - } else { - writer.value(String.valueOf(value)); - } + writeStringRepresentation(writer, node, baseType, QName.class); + } + } else if (baseType instanceof InstanceIdentifierTypeDefinition) { + if (node.getValue() instanceof YangInstanceIdentifier) { + IdentityValuesDTO valueDTO = (IdentityValuesDTO) RestCodec.from(baseType, mountPoint).serialize( + node.getValue()); + writeIdentityValuesDTOToJson(writer, valueDTO); + } else { + writeStringRepresentation(writer, node, baseType, YangInstanceIdentifier.class); } } else if (baseType instanceof DecimalTypeDefinition || baseType instanceof IntegerTypeDefinition || baseType instanceof UnsignedIntegerTypeDefinition) { - writer.value(new NumberForJsonWriter((String) RestCodec.from(baseType, mountPoint).serialize(node.getValue()))); + writer.value(new NumberForJsonWriter((String) RestCodec.from(baseType, mountPoint).serialize( + node.getValue()))); } else if (baseType instanceof BooleanTypeDefinition) { writer.value(Boolean.parseBoolean((String) RestCodec.from(baseType, mountPoint).serialize(node.getValue()))); } else if (baseType instanceof EmptyTypeDefinition) { @@ -233,20 +287,74 @@ class JsonMapper { } } - private void writeEmptyDataTypeToJson(JsonWriter writer) throws IOException { + private static void writeIdentityValuesDTOToJson(final JsonWriter writer, final IdentityValuesDTO valueDTO) + throws IOException { + StringBuilder result = new StringBuilder(); + for (IdentityValue identityValue : valueDTO.getValuesWithNamespaces()) { + result.append('/'); + + writeModuleNameAndIdentifier(result, identityValue); + if (identityValue.getPredicates() != null && !identityValue.getPredicates().isEmpty()) { + for (Predicate predicate : identityValue.getPredicates()) { + IdentityValue identityValuePredicate = predicate.getName(); + result.append('['); + if (identityValuePredicate == null) { + result.append('.'); + } else { + writeModuleNameAndIdentifier(result, identityValuePredicate); + } + result.append("='"); + result.append(predicate.getValue()); + result.append("']"); + } + } + } + + writer.value(result.toString()); + } + + private static void writeModuleNameAndIdentifier(final StringBuilder result, final IdentityValue identityValue) { + String moduleName = ControllerContext.getInstance().findModuleNameByNamespace( + URI.create(identityValue.getNamespace())); + if (moduleName != null && !moduleName.isEmpty()) { + result.append(moduleName); + result.append(':'); + } + result.append(identityValue.getValue()); + } + + private static void writeStringRepresentation(final JsonWriter writer, final SimpleNode node, + final TypeDefinition baseType, final Class requiredType) throws IOException { + Object value = node.getValue(); + LOG.debug("Value of {}:{} is not instance of {} but is {}", baseType.getQName().getNamespace(), baseType + .getQName().getLocalName(), requiredType.getClass(), node.getValue().getClass()); + if (value == null) { + writer.value(""); + } else { + writer.value(String.valueOf(value)); + } + } + + private void writeEmptyDataTypeToJson(final JsonWriter writer) throws IOException { writer.beginArray(); writer.nullValue(); writer.endArray(); } - private void writeName(Node node, DataSchemaNode schema, JsonWriter writer) throws IOException { + private void writeName(final Node node, final DataSchemaNode schema, final JsonWriter writer) throws IOException { String nameForOutput = node.getNodeType().getLocalName(); - if (schema.isAugmenting()) { + if (schema != null && schema.isAugmenting()) { ControllerContext contContext = ControllerContext.getInstance(); - CharSequence moduleName; - moduleName = contContext.toRestconfIdentifier(schema.getQName()); + CharSequence moduleName = null; + if (mountPoint == null) { + moduleName = contContext.toRestconfIdentifier(schema.getQName()); + } else { + moduleName = contContext.toRestconfIdentifier(mountPoint, schema.getQName()); + } if (moduleName != null) { nameForOutput = moduleName.toString(); + } else { + LOG.info("Module '{}' was not found in schema from mount point", schema.getQName()); } } writer.name(nameForOutput); @@ -257,7 +365,7 @@ class JsonMapper { private static final long serialVersionUID = -3147729419814417666L; private final String value; - public NumberForJsonWriter(String value) { + public NumberForJsonWriter(final String value) { this.value = value; }