restconf/sal-rest-connector/src/main/java/org/opendaylight/netconf/sal/rest/impl/JsonNormalizedNodeBodyReader.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 com.google.common.collect.Iterables;
  11 import com.google.gson.stream.JsonReader;
  12 import java.io.IOException;
  13 import java.io.InputStream;
  14 import java.io.InputStreamReader;
  15 import java.lang.annotation.Annotation;
  16 import java.lang.reflect.Type;
  17 import java.util.ArrayList;
  18 import java.util.List;
  19 import javax.ws.rs.Consumes;
  20 import javax.ws.rs.WebApplicationException;
  21 import javax.ws.rs.core.MediaType;
  22 import javax.ws.rs.core.MultivaluedMap;
  23 import javax.ws.rs.ext.MessageBodyReader;
  24 import javax.ws.rs.ext.Provider;
  25 import org.opendaylight.netconf.sal.rest.api.Draft02;
  26 import org.opendaylight.netconf.sal.rest.api.RestconfService;
  27 import org.opendaylight.netconf.sal.restconf.impl.ControllerContext;
  28 import org.opendaylight.netconf.sal.restconf.impl.InstanceIdentifierContext;
  29 import org.opendaylight.netconf.sal.restconf.impl.NormalizedNodeContext;
  30 import org.opendaylight.netconf.sal.restconf.impl.RestconfDocumentedException;
  31 import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorTag;
  32 import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorType;
  33 import org.opendaylight.restconf.Draft15;
  34 import org.opendaylight.restconf.utils.RestconfConstants;
  35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  36 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  37 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  38 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  39 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  43 import org.opendaylight.yangtools.yang.data.codec.gson.JsonParserStream;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.ResultAlreadySetException;
  47 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  48 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  49 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  50 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53
  54 @Provider
  55 @Consumes({ Draft02.MediaTypes.DATA + RestconfService.JSON, Draft15.MediaTypes.DATA + RestconfConstants.JSON,
  56         Draft02.MediaTypes.OPERATION + RestconfService.JSON, Draft15.MediaTypes.OPERATION + RestconfConstants.JSON,
  57         MediaType.APPLICATION_JSON })
  58 public class JsonNormalizedNodeBodyReader extends AbstractIdentifierAwareJaxRsProvider implements MessageBodyReader<NormalizedNodeContext> {
  59
  60     private final static Logger LOG = LoggerFactory.getLogger(JsonNormalizedNodeBodyReader.class);
  61
  62     @Override
  63     public boolean isReadable(final Class<?> type, final Type genericType, final Annotation[] annotations,
  64             final MediaType mediaType) {
  65         return true;
  66     }
  67
  68     @Override
  69     public NormalizedNodeContext readFrom(final Class<NormalizedNodeContext> type, final Type genericType,
  70             final Annotation[] annotations, final MediaType mediaType,
  71             final MultivaluedMap<String, String> httpHeaders, final InputStream entityStream) throws IOException,
  72             WebApplicationException {
  73         try {
  74             return readFrom(getInstanceIdentifierContext(), entityStream, isPost());
  75         } catch (final Exception e) {
  76             propagateExceptionAs(e);
  77             return null; // no-op
  78         }
  79     }
  80
  81     private static void propagateExceptionAs(final Exception e) throws RestconfDocumentedException {
  82         if(e instanceof RestconfDocumentedException) {
  83             throw (RestconfDocumentedException)e;
  84         }
  85
  86         if(e instanceof ResultAlreadySetException) {
  87             LOG.debug("Error parsing json input:", e);
  88
  89             throw new RestconfDocumentedException("Error parsing json input: Failed to create new parse result data. " +
  90                     "Are you creating multiple resources/subresources in POST request?");
  91         }
  92
  93         LOG.debug("Error parsing json input", e);
  94
  95         throw new RestconfDocumentedException("Error parsing input: " + e.getMessage(), ErrorType.PROTOCOL,
  96                 ErrorTag.MALFORMED_MESSAGE, e);
  97     }
  98
  99     public static NormalizedNodeContext readFrom(final String uriPath, final InputStream entityStream,
 100             final boolean isPost) throws RestconfDocumentedException {
 101
 102         try {
 103             return readFrom(ControllerContext.getInstance().toInstanceIdentifier(uriPath), entityStream, isPost);
 104         } catch (final Exception e) {
 105             propagateExceptionAs(e);
 106             return null; // no-op
 107         }
 108     }
 109
 110     private static NormalizedNodeContext readFrom(final InstanceIdentifierContext<?> path, final InputStream entityStream,
 111             final boolean isPost) throws IOException {
 112         if (entityStream.available() < 1) {
 113             return new NormalizedNodeContext(path, null);
 114         }
 115         final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
 116         final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
 117
 118         final SchemaNode parentSchema;
 119         if(isPost) {
 120             // FIXME: We need dispatch for RPC.
 121             parentSchema = path.getSchemaNode();
 122         } else if(path.getSchemaNode() instanceof SchemaContext) {
 123             parentSchema = path.getSchemaContext();
 124         } else {
 125             if (SchemaPath.ROOT.equals(path.getSchemaNode().getPath().getParent())) {
 126                 parentSchema = path.getSchemaContext();
 127             } else {
 128                 parentSchema = SchemaContextUtil.findDataSchemaNode(path.getSchemaContext(), path.getSchemaNode().getPath().getParent());
 129             }
 130         }
 131
 132         final JsonParserStream jsonParser = JsonParserStream.create(writer, path.getSchemaContext(), parentSchema);
 133         final JsonReader reader = new JsonReader(new InputStreamReader(entityStream));
 134         jsonParser.parse(reader);
 135
 136         NormalizedNode<?, ?> result = resultHolder.getResult();
 137         final List<YangInstanceIdentifier.PathArgument> iiToDataList = new ArrayList<>();
 138         InstanceIdentifierContext<? extends SchemaNode> newIIContext;
 139
 140         while ((result instanceof AugmentationNode) || (result instanceof ChoiceNode)) {
 141             final Object childNode = ((DataContainerNode) result).getValue().iterator().next();
 142             if (isPost) {
 143                 iiToDataList.add(result.getIdentifier());
 144             }
 145             result = (NormalizedNode<?, ?>) childNode;
 146         }
 147
 148         if (isPost) {
 149             if (result instanceof MapEntryNode) {
 150                 iiToDataList.add(new YangInstanceIdentifier.NodeIdentifier(result.getNodeType()));
 151                 iiToDataList.add(result.getIdentifier());
 152             } else {
 153                 iiToDataList.add(result.getIdentifier());
 154             }
 155         } else {
 156             if (result instanceof MapNode) {
 157                 result = Iterables.getOnlyElement(((MapNode) result).getValue());
 158             }
 159         }
 160
 161         final YangInstanceIdentifier fullIIToData = YangInstanceIdentifier.create(Iterables.concat(
 162                 path.getInstanceIdentifier().getPathArguments(), iiToDataList));
 163
 164         newIIContext = new InstanceIdentifierContext<>(fullIIToData, path.getSchemaNode(), path.getMountPoint(),
 165                 path.getSchemaContext());
 166
 167         return new NormalizedNodeContext(newIIContext, result);
 168     }
 169 }
 170