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