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