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.yangtools.yang.data.codec.gson;
10 import com.google.common.annotations.Beta;
11 import com.google.common.base.Preconditions;
12 import com.google.gson.JsonIOException;
13 import com.google.gson.JsonParseException;
14 import com.google.gson.JsonSyntaxException;
15 import com.google.gson.stream.JsonReader;
16 import com.google.gson.stream.MalformedJsonException;
17 import java.io.Closeable;
18 import java.io.EOFException;
19 import java.io.Flushable;
20 import java.io.IOException;
22 import java.util.ArrayDeque;
23 import java.util.Collections;
24 import java.util.Deque;
25 import java.util.HashSet;
27 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
28 import org.opendaylight.yangtools.yang.data.util.AbstractNodeDataWithSchema;
29 import org.opendaylight.yangtools.yang.data.util.AnyXmlNodeDataWithSchema;
30 import org.opendaylight.yangtools.yang.data.util.CompositeNodeDataWithSchema;
31 import org.opendaylight.yangtools.yang.data.util.LeafListEntryNodeDataWithSchema;
32 import org.opendaylight.yangtools.yang.data.util.LeafListNodeDataWithSchema;
33 import org.opendaylight.yangtools.yang.data.util.LeafNodeDataWithSchema;
34 import org.opendaylight.yangtools.yang.data.util.ListEntryNodeDataWithSchema;
35 import org.opendaylight.yangtools.yang.data.util.ListNodeDataWithSchema;
36 import org.opendaylight.yangtools.yang.data.util.ParserStreamUtils;
37 import org.opendaylight.yangtools.yang.data.util.RpcAsContainer;
38 import org.opendaylight.yangtools.yang.data.util.SimpleNodeDataWithSchema;
39 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
40 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
41 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
42 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
43 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
44 import org.opendaylight.yangtools.yang.model.api.Module;
45 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
46 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
47 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
48 import org.opendaylight.yangtools.yang.model.api.YangModeledAnyXmlSchemaNode;
51 * This class parses JSON elements from a GSON JsonReader. It disallows multiple elements of the same name unlike the
52 * default GSON JsonParser.
55 public final class JsonParserStream implements Closeable, Flushable {
56 private final Deque<URI> namespaces = new ArrayDeque<>();
57 private final NormalizedNodeStreamWriter writer;
58 private final JSONCodecFactory codecs;
59 private final SchemaContext schema;
60 private final DataSchemaNode parentNode;
62 private JsonParserStream(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext,
63 final DataSchemaNode parentNode) {
64 this.schema = Preconditions.checkNotNull(schemaContext);
65 this.writer = Preconditions.checkNotNull(writer);
66 this.codecs = JSONCodecFactory.create(schemaContext);
67 this.parentNode = parentNode;
70 public static JsonParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext,
71 final SchemaNode parentNode ) {
72 if (parentNode instanceof RpcDefinition) {
73 return new JsonParserStream(writer, schemaContext, new RpcAsContainer((RpcDefinition) parentNode));
75 Preconditions.checkArgument(parentNode instanceof DataSchemaNode, "Instance of DataSchemaNode class awaited.");
76 return new JsonParserStream(writer, schemaContext, (DataSchemaNode) parentNode);
79 public static JsonParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext) {
80 return new JsonParserStream(writer, schemaContext, schemaContext);
83 public JsonParserStream parse(final JsonReader reader) {
84 // code copied from gson's JsonParser and Stream classes
86 final boolean lenient = reader.isLenient();
87 reader.setLenient(true);
88 boolean isEmpty = true;
92 final CompositeNodeDataWithSchema compositeNodeDataWithSchema = new CompositeNodeDataWithSchema(parentNode);
93 read(reader, compositeNodeDataWithSchema);
94 compositeNodeDataWithSchema.write(writer);
97 } catch (final EOFException e) {
101 // The stream ended prematurely so it is likely a syntax error.
102 throw new JsonSyntaxException(e);
103 } catch (final MalformedJsonException | NumberFormatException e) {
104 throw new JsonSyntaxException(e);
105 } catch (final IOException e) {
106 throw new JsonIOException(e);
107 } catch (StackOverflowError | OutOfMemoryError e) {
108 throw new JsonParseException("Failed parsing JSON source: " + reader + " to Json", e);
110 reader.setLenient(lenient);
114 private void setValue(final AbstractNodeDataWithSchema parent, final String value) {
115 Preconditions.checkArgument(parent instanceof SimpleNodeDataWithSchema, "Node %s is not a simple type",
116 parent.getSchema().getQName());
117 final SimpleNodeDataWithSchema parentSimpleNode = (SimpleNodeDataWithSchema) parent;
118 Preconditions.checkArgument(parentSimpleNode.getValue() == null, "Node '%s' has already set its value to '%s'",
119 parentSimpleNode.getSchema().getQName(), parentSimpleNode.getValue());
121 final Object translatedValue = translateValueByType(value, parentSimpleNode.getSchema());
122 parentSimpleNode.setValue(translatedValue);
125 public void read(final JsonReader in, AbstractNodeDataWithSchema parent) throws IOException {
129 setValue(parent, in.nextString());
132 setValue(parent, Boolean.toString(in.nextBoolean()));
136 setValue(parent, null);
140 while (in.hasNext()) {
141 if (parent instanceof LeafNodeDataWithSchema) {
144 final AbstractNodeDataWithSchema newChild = newArrayEntry(parent);
151 final Set<String> namesakes = new HashSet<>();
154 * This allows parsing of incorrectly /as showcased/
155 * in testconf nesting of list items - eg.
156 * lists with one value are sometimes serialized
157 * without wrapping array.
160 if (isArray(parent)) {
161 parent = newArrayEntry(parent);
163 while (in.hasNext()) {
164 final String jsonElementName = in.nextName();
165 DataSchemaNode parentSchema = parent.getSchema();
166 if (parentSchema instanceof YangModeledAnyXmlSchemaNode) {
167 parentSchema = ((YangModeledAnyXmlSchemaNode) parentSchema).getSchemaOfAnyXmlData();
169 final NamespaceAndName namespaceAndName = resolveNamespace(jsonElementName, parentSchema);
170 final String localName = namespaceAndName.getName();
171 addNamespace(namespaceAndName.getUri());
172 if (namesakes.contains(jsonElementName)) {
173 throw new JsonSyntaxException("Duplicate name " + jsonElementName + " in JSON input.");
175 namesakes.add(jsonElementName);
177 final Deque<DataSchemaNode> childDataSchemaNodes =
178 ParserStreamUtils.findSchemaNodeByNameAndNamespace(parentSchema, localName, getCurrentNamespace());
179 if (childDataSchemaNodes.isEmpty()) {
180 throw new IllegalStateException("Schema for node with name " + localName + " and namespace "
181 + getCurrentNamespace() + " doesn't exist.");
184 final AbstractNodeDataWithSchema newChild = ((CompositeNodeDataWithSchema) parent).addChild(childDataSchemaNodes);
186 * FIXME:anyxml data shouldn't be skipped but should be loaded somehow.
187 * will be able to load anyxml which conforms to YANG data using these
188 * parser, for other anyxml will be harder.
190 if (newChild instanceof AnyXmlNodeDataWithSchema) {
207 private static boolean isArray(final AbstractNodeDataWithSchema parent) {
208 return parent instanceof ListNodeDataWithSchema || parent instanceof LeafListNodeDataWithSchema;
211 private static AbstractNodeDataWithSchema newArrayEntry(final AbstractNodeDataWithSchema parent) {
212 AbstractNodeDataWithSchema newChild;
213 if (parent instanceof ListNodeDataWithSchema) {
214 newChild = new ListEntryNodeDataWithSchema(parent.getSchema());
215 } else if (parent instanceof LeafListNodeDataWithSchema) {
216 newChild = new LeafListEntryNodeDataWithSchema(parent.getSchema());
218 throw new IllegalStateException("Found an unexpected array nested under "+ parent.getSchema().getQName());
220 ((CompositeNodeDataWithSchema) parent).addChild(newChild);
224 private Object translateValueByType(final String value, final DataSchemaNode node) {
225 if (node instanceof AnyXmlSchemaNode) {
227 * FIXME: Figure out some YANG extension dispatch, which will
228 * reuse JSON parsing or XML parsing - anyxml is not well-defined in
233 return codecs.codecFor(node).deserialize(value);
236 private void removeNamespace() {
240 private void addNamespace(final URI namespace) {
241 namespaces.push(namespace);
244 private NamespaceAndName resolveNamespace(final String childName, final DataSchemaNode dataSchemaNode) {
245 final int lastIndexOfColon = childName.lastIndexOf(':');
246 String moduleNamePart = null;
247 String nodeNamePart = null;
248 URI namespace = null;
249 if (lastIndexOfColon != -1) {
250 moduleNamePart = childName.substring(0, lastIndexOfColon);
251 nodeNamePart = childName.substring(lastIndexOfColon + 1);
253 final Module m = schema.findModuleByName(moduleNamePart, null);
254 namespace = m == null ? null : m.getNamespace();
256 nodeNamePart = childName;
259 if (namespace == null) {
260 Set<URI> potentialUris = Collections.emptySet();
261 potentialUris = resolveAllPotentialNamespaces(nodeNamePart, dataSchemaNode);
262 if (potentialUris.contains(getCurrentNamespace())) {
263 namespace = getCurrentNamespace();
264 } else if (potentialUris.size() == 1) {
265 namespace = potentialUris.iterator().next();
266 } else if (potentialUris.size() > 1) {
267 throw new IllegalStateException("Choose suitable module name for element "+nodeNamePart+":"+toModuleNames(potentialUris));
268 } else if (potentialUris.isEmpty()) {
269 throw new IllegalStateException("Schema node with name "+nodeNamePart+" wasn't found under "+dataSchemaNode.getQName()+".");
273 return new NamespaceAndName(nodeNamePart, namespace);
276 private String toModuleNames(final Set<URI> potentialUris) {
277 final StringBuilder builder = new StringBuilder();
278 for (final URI potentialUri : potentialUris) {
279 builder.append("\n");
280 //FIXME how to get information about revision from JSON input? currently first available is used.
281 builder.append(schema.findModuleByNamespace(potentialUri).iterator().next().getName());
283 return builder.toString();
286 private Set<URI> resolveAllPotentialNamespaces(final String elementName, final DataSchemaNode dataSchemaNode) {
287 final Set<URI> potentialUris = new HashSet<>();
288 final Set<ChoiceSchemaNode> choices = new HashSet<>();
289 if (dataSchemaNode instanceof DataNodeContainer) {
290 for (final DataSchemaNode childSchemaNode : ((DataNodeContainer) dataSchemaNode).getChildNodes()) {
291 if (childSchemaNode instanceof ChoiceSchemaNode) {
292 choices.add((ChoiceSchemaNode)childSchemaNode);
293 } else if (childSchemaNode.getQName().getLocalName().equals(elementName)) {
294 potentialUris.add(childSchemaNode.getQName().getNamespace());
298 for (final ChoiceSchemaNode choiceNode : choices) {
299 for (final ChoiceCaseNode concreteCase : choiceNode.getCases()) {
300 potentialUris.addAll(resolveAllPotentialNamespaces(elementName, concreteCase));
304 return potentialUris;
307 private URI getCurrentNamespace() {
308 return namespaces.peek();
313 private static class NamespaceAndName {
314 private final URI uri;
315 private final String name;
317 public NamespaceAndName(final String name, final URI uri) {
322 public String getName() {
326 public URI getUri() {
332 public void flush() throws IOException {
337 public void close() throws IOException {