2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
3 * Copyright (c) 2016 Brocade Communications Systems, Inc. and others. All rights reserved.
5 * This program and the accompanying materials are made available under the
6 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
7 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.yangtools.yang.data.codec.xml;
11 import static com.google.common.base.Preconditions.checkArgument;
12 import static com.google.common.base.Preconditions.checkState;
13 import static java.util.Objects.requireNonNull;
15 import java.io.IOException;
16 import javax.xml.stream.XMLStreamException;
17 import javax.xml.stream.XMLStreamWriter;
18 import javax.xml.transform.dom.DOMSource;
19 import org.eclipse.jdt.annotation.NonNull;
20 import org.opendaylight.yangtools.rfc7952.model.api.AnnotationSchemaNode;
21 import org.opendaylight.yangtools.yang.common.QName;
22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
25 import org.opendaylight.yangtools.yang.data.util.NormalizedNodeStreamWriterStack;
26 import org.opendaylight.yangtools.yang.model.api.AnydataSchemaNode;
27 import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
28 import org.opendaylight.yangtools.yang.model.api.ContainerLike;
29 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
30 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextProvider;
31 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
32 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
33 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
34 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
35 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
36 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
37 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
39 final class SchemaAwareXMLStreamNormalizedNodeStreamWriter
40 extends XMLStreamNormalizedNodeStreamWriter<TypedDataSchemaNode> implements EffectiveModelContextProvider {
41 private final NormalizedNodeStreamWriterStack tracker;
42 private final SchemaAwareXMLStreamWriterUtils streamUtils;
44 SchemaAwareXMLStreamNormalizedNodeStreamWriter(final XMLStreamWriter writer, final EffectiveModelContext context,
45 final NormalizedNodeStreamWriterStack tracker) {
47 this.tracker = requireNonNull(tracker);
48 streamUtils = new SchemaAwareXMLStreamWriterUtils(context);
52 String encodeValue(final ValueWriter xmlWriter, final Object value, final TypedDataSchemaNode schemaNode)
53 throws XMLStreamException {
54 return streamUtils.encodeValue(xmlWriter, resolveType(schemaNode.getType()), value,
55 schemaNode.getQName().getModule());
59 String encodeAnnotationValue(final ValueWriter xmlWriter, final QName qname, final Object value)
60 throws XMLStreamException {
61 final var optAnnotation = AnnotationSchemaNode.find(streamUtils.getEffectiveModelContext(), qname);
62 if (optAnnotation.isPresent()) {
63 return streamUtils.encodeValue(xmlWriter, resolveType(optAnnotation.orElseThrow().getType()), value,
67 checkArgument(!qname.getRevision().isPresent(), "Failed to find bound annotation %s", qname);
68 checkArgument(value instanceof String, "Invalid non-string value %s for unbound annotation %s", value, qname);
69 return (String) value;
73 void startList(final NodeIdentifier name) {
74 tracker.startList(name);
78 void startListItem(final PathArgument name) throws IOException {
79 tracker.startListItem(name);
80 startElement(name.getNodeType());
84 public void endNode() throws IOException {
85 final Object schema = tracker.endNode();
86 if (schema instanceof ListSchemaNode || schema instanceof LeafListSchemaNode) {
87 // For lists, we only emit end element on the inner frame
88 final Object parent = tracker.getParent();
89 if (parent == schema) {
92 } else if (schema instanceof ContainerLike || schema instanceof LeafSchemaNode
93 || schema instanceof AnydataSchemaNode || schema instanceof AnyxmlSchemaNode) {
99 public void startLeafNode(final NodeIdentifier name) throws IOException {
100 tracker.startLeafNode(name);
101 startElement(name.getNodeType());
105 public void startLeafSetEntryNode(final NodeWithValue<?> name) throws IOException {
106 tracker.startLeafSetEntryNode(name);
107 startElement(name.getNodeType());
111 public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
112 tracker.startLeafSet(name);
116 public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) {
117 tracker.startLeafSet(name);
121 public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
122 final SchemaNode schema = tracker.startContainerNode(name);
123 startElement(schema.getQName());
127 public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
128 tracker.startChoiceNode(name);
132 public boolean startAnyxmlNode(final NodeIdentifier name, final Class<?> objectModel) throws IOException {
133 if (DOMSource.class.isAssignableFrom(objectModel)) {
134 tracker.startAnyxmlNode(name);
135 startElement(name.getNodeType());
142 public EffectiveModelContext getEffectiveModelContext() {
143 return streamUtils.getEffectiveModelContext();
147 public void scalarValue(final Object value) throws IOException {
148 final Object current = tracker.getParent();
149 if (current instanceof TypedDataSchemaNode) {
150 writeValue(value, (TypedDataSchemaNode) current);
151 } else if (current instanceof AnydataSchemaNode) {
154 throw new IllegalStateException("Unexpected scalar value " + value + " with " + current);
159 public void domSourceValue(final DOMSource value) throws IOException {
160 final Object current = tracker.getParent();
161 checkState(current instanceof AnyxmlSchemaNode, "Unexpected value %s with %s", value, current);
166 void startAnydata(final NodeIdentifier name) {
167 tracker.startAnydataNode(name);
170 private @NonNull TypeDefinition<?> resolveType(final @NonNull TypeDefinition<?> type) throws XMLStreamException {
171 if (type instanceof LeafrefTypeDefinition) {
173 return tracker.resolveLeafref((LeafrefTypeDefinition) type);
174 } catch (IllegalArgumentException e) {
175 throw new XMLStreamException("Cannot resolve type " + type, e);