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.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.EffectiveStatementInference;
  45 import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
  46 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  47 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  48 import org.opendaylight.yangtools.yang.model.api.stmt.RpcEffectiveStatement;
  49 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  50 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53
  54 @Provider
  55 @Consumes({ MediaTypes.APPLICATION_YANG_DATA_JSON, MediaType.APPLICATION_JSON })
  56 public class JsonNormalizedNodeBodyReader extends AbstractNormalizedNodeBodyReader {
  57     private static final Logger LOG = LoggerFactory.getLogger(JsonNormalizedNodeBodyReader.class);
  58
  59     public JsonNormalizedNodeBodyReader(final SchemaContextHandler schemaContextHandler,
  60             final DOMMountPointService mountPointService) {
  61         super(schemaContextHandler, mountPointService);
  62     }
  63
  64     @SuppressWarnings("checkstyle:IllegalCatch")
  65     @Override
  66     protected NormalizedNodePayload readBody(final InstanceIdentifierContext<?> path, final InputStream entityStream)
  67             throws WebApplicationException {
  68         try {
  69             return readFrom(path, entityStream, isPost());
  70         } catch (final Exception e) {
  71             propagateExceptionAs(e);
  72             return null;
  73         }
  74     }
  75
  76     public static NormalizedNodePayload readFrom(
  77             final InstanceIdentifierContext<?> path, final InputStream entityStream, final boolean isPost) {
  78         final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
  79         final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
  80
  81         final EffectiveStatementInference parentSchema;
  82         final SchemaInferenceStack stack;
  83         if (path.getSchemaNode() instanceof RpcEffectiveStatement) {
  84             stack = SchemaInferenceStack.of(path.getSchemaContext(), Absolute.of(path.getSchemaNode().getQName()));
  85         } else {
  86             stack = SchemaInferenceStack.of(path.getSchemaContext());
  87             path.getInstanceIdentifier().getPathArguments().stream()
  88                     .filter(arg -> !(arg instanceof YangInstanceIdentifier.NodeIdentifierWithPredicates))
  89                     .filter(arg -> !(arg instanceof YangInstanceIdentifier.AugmentationIdentifier))
  90                     .forEach(p -> stack.enterSchemaTree(p.getNodeType()));
  91         }
  92         if (!isPost) {
  93             stack.exit();
  94         }
  95         parentSchema = stack.toInference();
  96
  97         final JsonParserStream jsonParser = JsonParserStream.create(writer,
  98             JSONCodecFactorySupplier.RFC7951.getShared(path.getSchemaContext()), parentSchema);
  99
 100         final JsonReader reader = new JsonReader(new InputStreamReader(entityStream, StandardCharsets.UTF_8));
 101         jsonParser.parse(reader);
 102
 103         NormalizedNode result = resultHolder.getResult();
 104         final List<YangInstanceIdentifier.PathArgument> iiToDataList = new ArrayList<>();
 105         InstanceIdentifierContext<? extends SchemaNode> newIIContext;
 106
 107         while (result instanceof AugmentationNode || result instanceof ChoiceNode) {
 108             final Object childNode = ((DataContainerNode) result).body().iterator().next();
 109             if (isPost) {
 110                 iiToDataList.add(result.getIdentifier());
 111             }
 112             result = (NormalizedNode) childNode;
 113         }
 114
 115         if (isPost) {
 116             if (result instanceof MapEntryNode) {
 117                 iiToDataList.add(new YangInstanceIdentifier.NodeIdentifier(result.getIdentifier().getNodeType()));
 118                 iiToDataList.add(result.getIdentifier());
 119             } else {
 120                 final List<? extends @NonNull EffectiveStatement<?, ?>> parentPath = parentSchema.statementPath();
 121                 if (parentPath.isEmpty() || !(parentPath.get(parentPath.size() - 1) instanceof OperationDefinition)) {
 122                     iiToDataList.add(result.getIdentifier());
 123                 }
 124             }
 125         } else {
 126             if (result instanceof MapNode) {
 127                 result = Iterables.getOnlyElement(((MapNode) result).body());
 128             }
 129         }
 130
 131         final YangInstanceIdentifier fullIIToData = YangInstanceIdentifier.create(Iterables.concat(
 132                 path.getInstanceIdentifier().getPathArguments(), iiToDataList));
 133
 134         newIIContext = new InstanceIdentifierContext<>(fullIIToData, path.getSchemaNode(), path.getMountPoint(),
 135                 path.getSchemaContext());
 136
 137         // FIXME: can result really be null?
 138         return NormalizedNodePayload.ofNullable(newIIContext, result);
 139     }
 140
 141     private static void propagateExceptionAs(final Exception exception) throws RestconfDocumentedException {
 142         Throwables.throwIfInstanceOf(exception, RestconfDocumentedException.class);
 143         LOG.debug("Error parsing json input", exception);
 144
 145         if (exception instanceof ResultAlreadySetException) {
 146             throw new RestconfDocumentedException("Error parsing json input: Failed to create new parse result data. "
 147                     + "Are you creating multiple resources/subresources in POST request?", exception);
 148         }
 149
 150         RestconfDocumentedException.throwIfYangError(exception);
 151         throw new RestconfDocumentedException("Error parsing input: " + exception.getMessage(), ErrorType.PROTOCOL,
 152             ErrorTag.MALFORMED_MESSAGE, exception);
 153     }
 154 }