restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/rest/impl/XmlNormalizedNodeBodyReader.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.netconf.sal.rest.impl;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11
  12 import java.io.IOException;
  13 import java.io.InputStream;
  14 import java.lang.annotation.Annotation;
  15 import java.lang.reflect.Type;
  16 import java.net.URISyntaxException;
  17 import java.util.ArrayList;
  18 import java.util.List;
  19 import java.util.Optional;
  20 import javax.ws.rs.Consumes;
  21 import javax.ws.rs.WebApplicationException;
  22 import javax.ws.rs.core.MediaType;
  23 import javax.ws.rs.core.MultivaluedMap;
  24 import javax.ws.rs.ext.MessageBodyReader;
  25 import javax.ws.rs.ext.Provider;
  26 import javax.xml.parsers.ParserConfigurationException;
  27 import javax.xml.stream.XMLStreamException;
  28 import javax.xml.transform.dom.DOMSource;
  29 import org.opendaylight.netconf.sal.rest.api.Draft02;
  30 import org.opendaylight.netconf.sal.rest.api.RestconfService;
  31 import org.opendaylight.netconf.sal.restconf.impl.ControllerContext;
  32 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  33 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  34 import org.opendaylight.restconf.common.util.RestUtil;
  35 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  36 import org.opendaylight.yangtools.yang.common.ErrorTag;
  37 import org.opendaylight.yangtools.yang.common.ErrorType;
  38 import org.opendaylight.yangtools.yang.common.QName;
  39 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  41 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  43 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  44 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  47 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
  48 import org.opendaylight.yangtools.yang.model.api.ContainerLike;
  49 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  50 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  51 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  52 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  53 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  54 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
  55 import org.slf4j.Logger;
  56 import org.slf4j.LoggerFactory;
  57 import org.w3c.dom.Document;
  58 import org.xml.sax.SAXException;
  59
  60 @Provider
  61 @Consumes({
  62     Draft02.MediaTypes.DATA + RestconfService.XML,
  63     Draft02.MediaTypes.OPERATION + RestconfService.XML,
  64     MediaType.APPLICATION_XML,
  65     MediaType.TEXT_XML
  66 })
  67 public class XmlNormalizedNodeBodyReader extends AbstractIdentifierAwareJaxRsProvider
  68         implements MessageBodyReader<NormalizedNodeContext> {
  69
  70     private static final Logger LOG = LoggerFactory.getLogger(XmlNormalizedNodeBodyReader.class);
  71
  72     public XmlNormalizedNodeBodyReader(final ControllerContext controllerContext) {
  73         super(controllerContext);
  74     }
  75
  76     @Override
  77     public boolean isReadable(final Class<?> type, final Type genericType, final Annotation[] annotations,
  78             final MediaType mediaType) {
  79         return true;
  80     }
  81
  82     @SuppressWarnings("checkstyle:IllegalCatch")
  83     @Override
  84     public NormalizedNodeContext readFrom(final Class<NormalizedNodeContext> type, final Type genericType,
  85             final Annotation[] annotations, final MediaType mediaType,
  86             final MultivaluedMap<String, String> httpHeaders, final InputStream entityStream) throws
  87         WebApplicationException {
  88         try {
  89             return readFrom(entityStream);
  90         } catch (final RestconfDocumentedException e) {
  91             throw e;
  92         } catch (final Exception e) {
  93             LOG.debug("Error parsing xml input", e);
  94             RestconfDocumentedException.throwIfYangError(e);
  95             throw new RestconfDocumentedException("Error parsing input: " + e.getMessage(), ErrorType.PROTOCOL,
  96                     ErrorTag.MALFORMED_MESSAGE, e);
  97         }
  98     }
  99
 100     private NormalizedNodeContext readFrom(final InputStream entityStream) throws IOException, SAXException,
 101             XMLStreamException, ParserConfigurationException, URISyntaxException {
 102         final InstanceIdentifierContext path = getInstanceIdentifierContext();
 103         final Optional<InputStream> nonEmptyInputStreamOptional = RestUtil.isInputStreamEmpty(entityStream);
 104         if (nonEmptyInputStreamOptional.isEmpty()) {
 105             // represent empty nopayload input
 106             return new NormalizedNodeContext(path, null);
 107         }
 108
 109         final Document doc = UntrustedXML.newDocumentBuilder().parse(nonEmptyInputStreamOptional.get());
 110         return parse(path, doc);
 111     }
 112
 113     private NormalizedNodeContext parse(final InstanceIdentifierContext pathContext,final Document doc)
 114             throws XMLStreamException, IOException, SAXException, URISyntaxException {
 115         final SchemaNode schemaNodeContext = pathContext.getSchemaNode();
 116         DataSchemaNode schemaNode;
 117         final List<PathArgument> iiToDataList = new ArrayList<>();
 118         Inference inference;
 119         if (schemaNodeContext instanceof RpcDefinition) {
 120             schemaNode = ((RpcDefinition) schemaNodeContext).getInput();
 121             inference = pathContext.inference();
 122         } else if (schemaNodeContext instanceof DataSchemaNode) {
 123             schemaNode = (DataSchemaNode) schemaNodeContext;
 124
 125             final String docRootElm = doc.getDocumentElement().getLocalName();
 126             final XMLNamespace docRootNamespace = XMLNamespace.of(doc.getDocumentElement().getNamespaceURI());
 127
 128             if (isPost()) {
 129                 final var context = pathContext.getSchemaContext();
 130                 final var it = context.findModuleStatements(docRootNamespace).iterator();
 131                 checkState(it.hasNext(), "Failed to find module for %s", docRootNamespace);
 132                 final var qname = QName.create(it.next().localQNameModule(), docRootElm);
 133
 134                 final var nodeAndStack = DataSchemaContextTree.from(context)
 135                     .enterPath(pathContext.getInstanceIdentifier()).orElseThrow();
 136
 137                 final var stack = nodeAndStack.stack();
 138                 var current = nodeAndStack.node();
 139                 do {
 140                     final var next = current.enterChild(stack, qname);
 141                     checkState(next != null, "Child \"%s\" was not found in parent schema node \"%s\"", qname,
 142                         schemaNode);
 143                     iiToDataList.add(next.getIdentifier());
 144                     schemaNode = next.getDataSchemaNode();
 145                     current = next;
 146                 } while (current.isMixin());
 147
 148                 inference = stack.toInference();
 149
 150             } else {
 151                 // PUT
 152                 final QName scQName = schemaNode.getQName();
 153                 checkState(docRootElm.equals(scQName.getLocalName()) && docRootNamespace.equals(scQName.getNamespace()),
 154                     "Not correct message root element \"%s\", should be \"%s\"", docRootElm, scQName);
 155                 inference = pathContext.inference();
 156             }
 157         } else {
 158             throw new IllegalStateException("Unknown SchemaNode");
 159         }
 160
 161
 162         NormalizedNode parsed;
 163         final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
 164         final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
 165
 166         if (schemaNode instanceof ContainerLike || schemaNode instanceof ListSchemaNode
 167                 || schemaNode instanceof LeafSchemaNode) {
 168             final XmlParserStream xmlParser = XmlParserStream.create(writer, inference);
 169             xmlParser.traverse(new DOMSource(doc.getDocumentElement()));
 170             parsed = resultHolder.getResult();
 171
 172             // When parsing an XML source with a list root node
 173             // the new XML parser always returns a MapNode with one MapEntryNode inside.
 174             // However, the old XML parser returned a MapEntryNode directly in this place.
 175             // Therefore we now have to extract the MapEntryNode from the parsed MapNode.
 176             if (parsed instanceof MapNode) {
 177                 final MapNode mapNode = (MapNode) parsed;
 178                 // extracting the MapEntryNode
 179                 parsed = mapNode.body().iterator().next();
 180             }
 181
 182             if (schemaNode instanceof ListSchemaNode && isPost()) {
 183                 iiToDataList.add(parsed.getIdentifier());
 184             }
 185         } else {
 186             LOG.warn("Unknown schema node extension {} was not parsed", schemaNode.getClass());
 187             parsed = null;
 188         }
 189
 190         return new NormalizedNodeContext(pathContext.withConcatenatedArgs(iiToDataList), parsed);
 191     }
 192 }
 193