restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/rest/impl/JsonNormalizedNodeBodyReader.java

   1 /*
   2  * Copyright (c) 2014 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.netconf.sal.rest.impl;
   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.IOException;
  14 import java.io.InputStream;
  15 import java.io.InputStreamReader;
  16 import java.lang.annotation.Annotation;
  17 import java.lang.reflect.Type;
  18 import java.nio.charset.StandardCharsets;
  19 import java.util.ArrayList;
  20 import java.util.List;
  21 import java.util.Optional;
  22 import javax.ws.rs.Consumes;
  23 import javax.ws.rs.WebApplicationException;
  24 import javax.ws.rs.core.MediaType;
  25 import javax.ws.rs.core.MultivaluedMap;
  26 import javax.ws.rs.ext.MessageBodyReader;
  27 import javax.ws.rs.ext.Provider;
  28 import org.opendaylight.netconf.sal.rest.api.Draft02;
  29 import org.opendaylight.netconf.sal.rest.api.RestconfService;
  30 import org.opendaylight.netconf.sal.restconf.impl.ControllerContext;
  31 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  32 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  33 import org.opendaylight.restconf.common.util.RestUtil;
  34 import org.opendaylight.yangtools.yang.common.ErrorTag;
  35 import org.opendaylight.yangtools.yang.common.ErrorType;
  36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  37 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  38 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  39 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  43 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  44 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactorySupplier;
  45 import org.opendaylight.yangtools.yang.data.codec.gson.JsonParserStream;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  47 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  48 import org.opendaylight.yangtools.yang.data.impl.schema.ResultAlreadySetException;
  49 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  50 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53
  54 @Provider
  55 @Consumes({
  56     Draft02.MediaTypes.DATA + RestconfService.JSON,
  57     Draft02.MediaTypes.OPERATION + RestconfService.JSON,
  58     MediaType.APPLICATION_JSON
  59 })
  60 public class JsonNormalizedNodeBodyReader
  61         extends AbstractIdentifierAwareJaxRsProvider implements MessageBodyReader<NormalizedNodeContext> {
  62
  63     private static final Logger LOG = LoggerFactory.getLogger(JsonNormalizedNodeBodyReader.class);
  64
  65     public JsonNormalizedNodeBodyReader(final ControllerContext controllerContext) {
  66         super(controllerContext);
  67     }
  68
  69     @Override
  70     public boolean isReadable(final Class<?> type, final Type genericType, final Annotation[] annotations,
  71             final MediaType mediaType) {
  72         return true;
  73     }
  74
  75     @SuppressWarnings("checkstyle:IllegalCatch")
  76     @Override
  77     public NormalizedNodeContext readFrom(final Class<NormalizedNodeContext> type, final Type genericType,
  78             final Annotation[] annotations, final MediaType mediaType,
  79             final MultivaluedMap<String, String> httpHeaders, final InputStream entityStream) throws
  80         WebApplicationException {
  81         try {
  82             return readFrom(getInstanceIdentifierContext(), entityStream, isPost());
  83         } catch (final Exception e) {
  84             propagateExceptionAs(e);
  85             return null; // no-op
  86         }
  87     }
  88
  89     @SuppressWarnings("checkstyle:IllegalCatch")
  90     public static NormalizedNodeContext readFrom(final String uriPath, final InputStream entityStream,
  91             final boolean isPost, final ControllerContext controllerContext) throws RestconfDocumentedException {
  92
  93         try {
  94             return readFrom(controllerContext.toInstanceIdentifier(uriPath), entityStream, isPost);
  95         } catch (final Exception e) {
  96             propagateExceptionAs(e);
  97             return null; // no-op
  98         }
  99     }
 100
 101     private static NormalizedNodeContext readFrom(final InstanceIdentifierContext path,
 102                                                   final InputStream entityStream, final boolean isPost)
 103             throws IOException {
 104         final Optional<InputStream> nonEmptyInputStreamOptional = RestUtil.isInputStreamEmpty(entityStream);
 105         if (nonEmptyInputStreamOptional.isEmpty()) {
 106             return new NormalizedNodeContext(path, null);
 107         }
 108         final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
 109         final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
 110
 111         final Inference parentInference;
 112         if (isPost && !(path.getSchemaNode() instanceof RpcDefinition)) {
 113             parentInference = path.inference();
 114         } else {
 115             final var inference = path.inference();
 116             if (!inference.statementPath().isEmpty()) {
 117                 final var stack = inference.toSchemaInferenceStack();
 118                 stack.exit();
 119                 parentInference = stack.toInference();
 120             } else {
 121                 parentInference = inference;
 122             }
 123         }
 124
 125         final JsonParserStream jsonParser = JsonParserStream.create(writer,
 126             JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02.getShared(path.getSchemaContext()),
 127             parentInference);
 128         final JsonReader reader = new JsonReader(new InputStreamReader(nonEmptyInputStreamOptional.get(),
 129                 StandardCharsets.UTF_8));
 130         jsonParser.parse(reader);
 131
 132         NormalizedNode result = resultHolder.getResult();
 133         final List<YangInstanceIdentifier.PathArgument> iiToDataList = new ArrayList<>();
 134         InstanceIdentifierContext newIIContext;
 135
 136         while (result instanceof AugmentationNode || result instanceof ChoiceNode) {
 137             final Object childNode = ((DataContainerNode) result).body().iterator().next();
 138             if (isPost) {
 139                 iiToDataList.add(result.getIdentifier());
 140             }
 141             result = (NormalizedNode) childNode;
 142         }
 143
 144         if (isPost) {
 145             if (result instanceof MapEntryNode) {
 146                 iiToDataList.add(new YangInstanceIdentifier.NodeIdentifier(result.getIdentifier().getNodeType()));
 147                 iiToDataList.add(result.getIdentifier());
 148             } else {
 149                 iiToDataList.add(result.getIdentifier());
 150             }
 151         } else {
 152             if (result instanceof MapNode) {
 153                 result = Iterables.getOnlyElement(((MapNode) result).body());
 154             }
 155         }
 156
 157         return new NormalizedNodeContext(path.withConcatenatedArgs(iiToDataList), result);
 158     }
 159
 160     private static void propagateExceptionAs(final Exception exception) throws RestconfDocumentedException {
 161         Throwables.throwIfInstanceOf(exception, RestconfDocumentedException.class);
 162         LOG.debug("Error parsing json input", exception);
 163
 164         if (exception instanceof ResultAlreadySetException) {
 165             throw new RestconfDocumentedException("Error parsing json input: Failed to create new parse result data. "
 166                     + "Are you creating multiple resources/subresources in POST request?", exception);
 167         }
 168
 169         RestconfDocumentedException.throwIfYangError(exception);
 170         throw new RestconfDocumentedException("Error parsing input: " + exception.getMessage(), ErrorType.PROTOCOL,
 171                 ErrorTag.MALFORMED_MESSAGE, exception);
 172     }
 173 }
 174