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