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.impl.codec.xml;
10 import static javax.xml.XMLConstants.DEFAULT_NS_PREFIX;
12 import com.google.common.base.Preconditions;
13 import java.io.IOException;
14 import javax.xml.stream.XMLStreamException;
15 import javax.xml.stream.XMLStreamWriter;
16 import org.opendaylight.yangtools.yang.common.QName;
17 import org.opendaylight.yangtools.yang.data.api.Node;
18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
19 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
22 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
23 import org.opendaylight.yangtools.yang.data.impl.codec.SchemaTracker;
24 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
25 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
26 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
27 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
28 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
29 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
30 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
31 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
32 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
35 * A {@link NormalizedNodeStreamWriter} which translates the events into an
36 * {@link XMLStreamWriter}, resulting in a RFC 6020 XML encoding.
38 public final class XMLStreamNormalizedNodeStreamWriter implements NormalizedNodeStreamWriter {
39 private static final XmlStreamUtils UTILS = XmlStreamUtils.create(XmlUtils.DEFAULT_XML_CODEC_PROVIDER);
41 private final XMLStreamWriter writer;
42 private final SchemaTracker tracker;
44 private XMLStreamNormalizedNodeStreamWriter(final XMLStreamWriter writer, final SchemaContext context, final SchemaPath path) {
45 this.writer = Preconditions.checkNotNull(writer);
46 this.tracker = SchemaTracker.create(context, path);
50 * Create a new writer with the specified context as its root.
52 * @param writer Output {@link XMLStreamWriter}
53 * @param context Associated {@link SchemaContext}.
54 * @return A new {@link NormalizedNodeStreamWriter}
56 public static NormalizedNodeStreamWriter create(final XMLStreamWriter writer, final SchemaContext context) {
57 return create( writer, context, SchemaPath.ROOT);
61 * Create a new writer with the specified context and rooted in the specified schema path
63 * @param writer Output {@link XMLStreamWriter}
64 * @param context Associated {@link SchemaContext}.
66 * @return A new {@link NormalizedNodeStreamWriter}
68 public static NormalizedNodeStreamWriter create(final XMLStreamWriter writer, final SchemaContext context, final SchemaPath path) {
69 return new XMLStreamNormalizedNodeStreamWriter(writer, context, path);
72 private void writeStartElement( QName qname) throws XMLStreamException {
73 String ns = qname.getNamespace().toString();
74 String parentNs = writer.getNamespaceContext().getNamespaceURI(DEFAULT_NS_PREFIX);
75 writer.writeStartElement(DEFAULT_NS_PREFIX, qname.getLocalName(), ns);
76 if (!ns.equals(parentNs)) {
77 writer.writeDefaultNamespace(ns);
81 private void writeElement(final QName qname, final TypeDefinition<?> type, final Object value) throws IOException {
83 writeStartElement(qname);
85 UTILS.writeValue(writer, type, value);
87 writer.writeEndElement();
88 } catch (XMLStreamException e) {
89 throw new IOException("Failed to emit element", e);
93 private void startElement(final QName qname) throws IOException {
95 writeStartElement(qname);
96 } catch (XMLStreamException e) {
97 throw new IOException("Failed to start element", e);
101 private void startList(final NodeIdentifier name) {
102 tracker.startList(name);
105 private void startListItem(final PathArgument name) throws IOException {
106 tracker.startListItem(name);
107 startElement(name.getNodeType());
111 public void leafNode(final NodeIdentifier name, final Object value) throws IOException {
112 final LeafSchemaNode schema = tracker.leafNode(name);
114 writeElement(schema.getQName(), schema.getType(), value);
118 public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
119 tracker.startLeafSet(name);
123 public void leafSetEntryNode(final Object value) throws IOException {
124 final LeafListSchemaNode schema = tracker.leafSetEntryNode();
125 writeElement(schema.getQName(), schema.getType(), value);
129 public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
130 final SchemaNode schema = tracker.startContainerNode(name);
131 startElement(schema.getQName());
135 public void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) {
140 public void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) throws IOException {
145 public void startMapNode(final NodeIdentifier name, final int childSizeHint) {
150 public void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint) throws IOException {
151 startListItem(identifier);
155 public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) {
160 public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
161 tracker.startChoiceNode(name);
165 public void startAugmentationNode(final AugmentationIdentifier identifier) {
166 tracker.startAugmentationNode(identifier);
170 public void anyxmlNode(final NodeIdentifier name, final Object value) throws IOException {
171 final AnyXmlSchemaNode schema = tracker.anyxmlNode(name);
172 final QName qname = schema.getQName();
174 writeStartElement(qname);
176 UTILS.writeValue(writer, (Node<?>)value, schema);
178 writer.writeEndElement();
179 } catch (XMLStreamException e) {
180 throw new IOException("Failed to emit element", e);
185 public void endNode() throws IOException {
186 final Object schema = tracker.endNode();
189 if (schema instanceof ListSchemaNode) {
190 // For lists, we only emit end element on the inner frame
191 final Object parent = tracker.getParent();
192 if (parent == schema) {
193 writer.writeEndElement();
195 } else if (schema instanceof ContainerSchemaNode) {
196 // Emit container end element
197 writer.writeEndElement();
199 } catch (XMLStreamException e) {
200 throw new IOException("Failed to end element", e);
205 public void close() throws IOException {
208 } catch (XMLStreamException e) {
209 throw new IOException("Failed to close writer", e);
214 public void flush() throws IOException {
217 } catch (XMLStreamException e) {
218 throw new IOException("Failed to flush writer", e);