restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/jersey/providers/JsonNormalizedNodeBodyReader.java

   1 /*
   2  * Copyright (c) 2016 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.restconf.nb.rfc8040.jersey.providers;
   9
  10 import com.google.common.base.Throwables;
  11 import com.google.common.collect.Iterables;
  12 import com.google.gson.stream.JsonReader;
  13 import java.io.InputStream;
  14 import java.io.InputStreamReader;
  15 import java.nio.charset.StandardCharsets;
  16 import java.util.ArrayList;
  17 import java.util.List;
  18 import javax.ws.rs.Consumes;
  19 import javax.ws.rs.WebApplicationException;
  20 import javax.ws.rs.core.MediaType;
  21 import javax.ws.rs.ext.Provider;
  22 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  23 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  24 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  25 import org.opendaylight.restconf.nb.rfc8040.MediaTypes;
  26 import org.opendaylight.restconf.nb.rfc8040.databind.DatabindProvider;
  27 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  28 import org.opendaylight.yangtools.yang.common.ErrorTag;
  29 import org.opendaylight.yangtools.yang.common.ErrorType;
  30 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  32 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  33 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  34 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  35 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  36 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  37 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactorySupplier;
  38 import org.opendaylight.yangtools.yang.data.codec.gson.JsonParserStream;
  39 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizationResultHolder;
  41 import org.opendaylight.yangtools.yang.data.impl.schema.ResultAlreadySetException;
  42 import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
  43 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
  44 import org.slf4j.Logger;
  45 import org.slf4j.LoggerFactory;
  46
  47 @Provider
  48 @Consumes({ MediaTypes.APPLICATION_YANG_DATA_JSON, MediaType.APPLICATION_JSON })
  49 public class JsonNormalizedNodeBodyReader extends AbstractNormalizedNodeBodyReader {
  50     private static final Logger LOG = LoggerFactory.getLogger(JsonNormalizedNodeBodyReader.class);
  51
  52     public JsonNormalizedNodeBodyReader(final DatabindProvider databindProvider,
  53             final DOMMountPointService mountPointService) {
  54         super(databindProvider, mountPointService);
  55     }
  56
  57     @SuppressWarnings("checkstyle:IllegalCatch")
  58     @Override
  59     protected NormalizedNodePayload readBody(final InstanceIdentifierContext path, final InputStream entityStream)
  60             throws WebApplicationException {
  61         try {
  62             return readFrom(path, entityStream, isPost());
  63         } catch (final Exception e) {
  64             propagateExceptionAs(e);
  65             return null;
  66         }
  67     }
  68
  69     public static NormalizedNodePayload readFrom(
  70             final InstanceIdentifierContext path, final InputStream entityStream, final boolean isPost) {
  71         final NormalizationResultHolder resultHolder = new NormalizationResultHolder();
  72         final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
  73
  74         final Inference parentSchema;
  75         if (isPost) {
  76             parentSchema = path.inference();
  77         } else {
  78             final var stack = path.inference().toSchemaInferenceStack();
  79             if (!stack.isEmpty()) {
  80                 stack.exit();
  81             }
  82             parentSchema = stack.toInference();
  83         }
  84
  85         final JsonParserStream jsonParser = JsonParserStream.create(writer,
  86             JSONCodecFactorySupplier.RFC7951.getShared(path.getSchemaContext()), parentSchema);
  87
  88         final JsonReader reader = new JsonReader(new InputStreamReader(entityStream, StandardCharsets.UTF_8));
  89         jsonParser.parse(reader);
  90
  91         NormalizedNode result = resultHolder.getResult().data();
  92         final List<YangInstanceIdentifier.PathArgument> iiToDataList = new ArrayList<>();
  93
  94         while (result instanceof ChoiceNode choice) {
  95             final var childNode = choice.body().iterator().next();
  96             if (isPost) {
  97                 iiToDataList.add(result.name());
  98             }
  99             result = childNode;
 100         }
 101
 102         if (isPost) {
 103             if (result instanceof MapEntryNode) {
 104                 iiToDataList.add(new NodeIdentifier(result.name().getNodeType()));
 105                 iiToDataList.add(result.name());
 106             } else {
 107                 final var parentPath = parentSchema.statementPath();
 108                 if (parentPath.isEmpty() || !(parentPath.get(parentPath.size() - 1) instanceof OperationDefinition)) {
 109                     iiToDataList.add(result.name());
 110                 }
 111             }
 112         } else if (result instanceof MapNode map) {
 113             result = Iterables.getOnlyElement(map.body());
 114         }
 115
 116         // FIXME: can result really be null?
 117         return NormalizedNodePayload.ofNullable(path.withConcatenatedArgs(iiToDataList), result);
 118     }
 119
 120     private static void propagateExceptionAs(final Exception exception) throws RestconfDocumentedException {
 121         Throwables.throwIfInstanceOf(exception, RestconfDocumentedException.class);
 122         LOG.debug("Error parsing json input", exception);
 123
 124         if (exception instanceof ResultAlreadySetException) {
 125             throw new RestconfDocumentedException("Error parsing json input: Failed to create new parse result data. "
 126                     + "Are you creating multiple resources/subresources in POST request?", exception);
 127         }
 128
 129         RestconfDocumentedException.throwIfYangError(exception);
 130         throw new RestconfDocumentedException("Error parsing input: " + exception.getMessage(), ErrorType.PROTOCOL,
 131             ErrorTag.MALFORMED_MESSAGE, exception);
 132     }
 133 }