import java.io.IOException;
import java.io.OutputStream;
-import java.lang.annotation.Annotation;
-import java.lang.reflect.Type;
-import java.nio.charset.StandardCharsets;
-import java.util.List;
-import java.util.Set;
-import javanet.staxutils.IndentingXMLStreamWriter;
import javax.ws.rs.Produces;
-import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.MediaType;
-import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.ext.Provider;
import javax.xml.XMLConstants;
-import javax.xml.stream.FactoryConfigurationError;
-import javax.xml.stream.XMLOutputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
-import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
-import org.opendaylight.restconf.nb.rfc8040.DepthParam;
-import org.opendaylight.restconf.nb.rfc8040.MediaTypes;
+import org.opendaylight.restconf.api.FormatParameters;
+import org.opendaylight.restconf.api.MediaTypes;
import org.opendaylight.restconf.nb.rfc8040.jersey.providers.api.RestconfNormalizedNodeWriter;
-import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
+import org.opendaylight.restconf.nb.rfc8040.legacy.WriterParameters;
+import org.opendaylight.restconf.server.spi.FormattableBodySupport;
import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
-import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
-import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
-import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
-import org.opendaylight.yangtools.yang.model.api.SchemaNode;
+import org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes;
import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
@Provider
@Produces({ MediaTypes.APPLICATION_YANG_DATA_XML, MediaType.APPLICATION_XML, MediaType.TEXT_XML })
-public class XmlNormalizedNodeBodyWriter extends AbstractNormalizedNodeBodyWriter {
- private static final XMLOutputFactory XML_FACTORY;
-
- static {
- XML_FACTORY = XMLOutputFactory.newFactory();
- XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
- }
-
+public final class XmlNormalizedNodeBodyWriter extends AbstractNormalizedNodeBodyWriter {
@Override
- public void writeTo(final NormalizedNodePayload context,
- final Class<?> type,
- final Type genericType,
- final Annotation[] annotations,
- final MediaType mediaType,
- final MultivaluedMap<String, Object> httpHeaders,
- final OutputStream entityStream) throws IOException, WebApplicationException {
- final InstanceIdentifierContext pathContext = context.getInstanceIdentifierContext();
- if (context.getData() == null) {
- return;
- }
- if (httpHeaders != null) {
- for (var entry : context.getNewHeaders().entrySet()) {
- httpHeaders.add(entry.getKey(), entry.getValue());
- }
- }
-
- XMLStreamWriter xmlWriter;
- try {
- xmlWriter = XML_FACTORY.createXMLStreamWriter(entityStream, StandardCharsets.UTF_8.name());
-
- final var prettyPrint = context.getWriterParameters().prettyPrint();
- if (prettyPrint != null && prettyPrint.value()) {
- xmlWriter = new IndentingXMLStreamWriter(xmlWriter);
- }
- } catch (final XMLStreamException | FactoryConfigurationError e) {
- throw new IllegalStateException(e);
- }
- final NormalizedNode data = context.getData();
-
- writeNormalizedNode(xmlWriter, pathContext, data, context.getWriterParameters().depth(),
- context.getWriterParameters().fields());
- }
-
- private static void writeNormalizedNode(final XMLStreamWriter xmlWriter,
- final InstanceIdentifierContext pathContext, final NormalizedNode data, final DepthParam depth,
- final List<Set<QName>> fields) throws IOException {
- final RestconfNormalizedNodeWriter nnWriter;
- final SchemaNode schemaNode = pathContext.getSchemaNode();
-
- if (schemaNode instanceof RpcDefinition rpc) {
- // RpcDefinition is not supported as initial codec in XMLStreamWriter, so we need to emit initial output
- // declaration.
- final var stack = SchemaInferenceStack.of(pathContext.getSchemaContext());
- stack.enterSchemaTree(rpc.getQName());
- stack.enterSchemaTree(rpc.getOutput().getQName());
-
- nnWriter = createNormalizedNodeWriter(xmlWriter, stack.toInference(), depth, fields);
- writeElements(xmlWriter, nnWriter, (ContainerNode) data);
- } else if (schemaNode instanceof ActionDefinition action) {
- // ActionDefinition is not supported as initial codec in XMLStreamWriter, so we need to emit initial output
- // declaration.
- final var stack = pathContext.inference().toSchemaInferenceStack();
- stack.enterSchemaTree(action.getOutput().getQName());
-
- nnWriter = createNormalizedNodeWriter(xmlWriter, stack.toInference(), depth, fields);
- writeElements(xmlWriter, nnWriter, (ContainerNode) data);
+ void writeData(final SchemaInferenceStack stack, final NormalizedNode data, final WriterParameters writerParameters,
+ final FormatParameters format, final OutputStream out) throws IOException {
+ final boolean isRoot;
+ if (!stack.isEmpty()) {
+ stack.exit();
+ isRoot = false;
} else {
- final var stack = pathContext.inference().toSchemaInferenceStack();
- final boolean isRoot;
- if (!stack.isEmpty()) {
- stack.exit();
- isRoot = false;
- } else {
- isRoot = true;
- }
- nnWriter = createNormalizedNodeWriter(xmlWriter, stack.toInference(), depth, fields);
+ isRoot = true;
+ }
- if (data instanceof MapEntryNode mapEntry) {
- // Restconf allows returning one list item. We need to wrap it
- // in map node in order to serialize it properly
- nnWriter.write(ImmutableNodes.mapNodeBuilder(data.getIdentifier().getNodeType())
- .addChild(mapEntry)
- .build());
- } else if (isRoot) {
- if (data instanceof ContainerNode container && container.isEmpty()) {
- writeEmptyDataNode(xmlWriter, container);
- } else {
- writeAndWrapInDataNode(xmlWriter, nnWriter, data);
- }
+ final var xmlWriter = FormattableBodySupport.createXmlWriter(out, format);
+ final var nnWriter = createNormalizedNodeWriter(xmlWriter, stack.toInference(), writerParameters);
+ if (data instanceof MapEntryNode mapEntry) {
+ // Restconf allows returning one list item. We need to wrap it
+ // in map node in order to serialize it properly
+ nnWriter.write(ImmutableNodes.newSystemMapBuilder()
+ .withNodeIdentifier(new NodeIdentifier(data.name().getNodeType()))
+ .addChild(mapEntry)
+ .build());
+ } else if (isRoot) {
+ if (data instanceof ContainerNode container && container.isEmpty()) {
+ writeEmptyDataNode(xmlWriter, container);
} else {
- nnWriter.write(data);
+ writeAndWrapInDataNode(xmlWriter, nnWriter, data);
}
+ } else {
+ nnWriter.write(data);
}
-
nnWriter.flush();
}
private static RestconfNormalizedNodeWriter createNormalizedNodeWriter(final XMLStreamWriter xmlWriter,
- final Inference inference, final DepthParam depth,
- final List<Set<QName>> fields) {
+ final Inference inference, final WriterParameters writerParameters) {
return ParameterAwareNormalizedNodeWriter.forStreamWriter(
- XMLStreamNormalizedNodeStreamWriter.create(xmlWriter, inference), depth, fields);
+ XMLStreamNormalizedNodeStreamWriter.create(xmlWriter, inference),
+ writerParameters.depth(), writerParameters.fields());
}
private static void writeAndWrapInDataNode(final XMLStreamWriter xmlWriter,
final RestconfNormalizedNodeWriter nnWriter, final NormalizedNode data) throws IOException {
- final QName nodeType = data.getIdentifier().getNodeType();
+ final QName nodeType = data.name().getNodeType();
final String namespace = nodeType.getNamespace().toString();
try {
xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, nodeType.getLocalName(), namespace);
private static void writeEmptyDataNode(final XMLStreamWriter xmlWriter, final ContainerNode data)
throws IOException {
- final QName nodeType = data.getIdentifier().getNodeType();
+ final QName nodeType = data.name().getNodeType();
final String namespace = nodeType.getNamespace().toString();
try {
xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, nodeType.getLocalName(), namespace);
throw new IOException("Failed to write elements", e);
}
}
-
- private static void writeElements(final XMLStreamWriter xmlWriter, final RestconfNormalizedNodeWriter nnWriter,
- final ContainerNode data) throws IOException {
- final QName nodeType = data.getIdentifier().getNodeType();
- final String namespace = nodeType.getNamespace().toString();
- try {
- xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, nodeType.getLocalName(), namespace);
- xmlWriter.writeDefaultNamespace(namespace);
- for (var child : data.body()) {
- nnWriter.write(child);
- }
- nnWriter.flush();
- xmlWriter.writeEndElement();
- xmlWriter.flush();
- } catch (final XMLStreamException e) {
- throw new IOException("Failed to write elements", e);
- }
- }
}