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.SchemaContext;
  50 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  51 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 @Provider
  56 @Consumes({
  57     Draft02.MediaTypes.DATA + RestconfService.JSON,
  58     Draft02.MediaTypes.OPERATION + RestconfService.JSON,
  59     MediaType.APPLICATION_JSON
  60 })
  61 public class JsonNormalizedNodeBodyReader
  62         extends AbstractIdentifierAwareJaxRsProvider implements MessageBodyReader<NormalizedNodeContext> {
  63
  64     private static final Logger LOG = LoggerFactory.getLogger(JsonNormalizedNodeBodyReader.class);
  65
  66     public JsonNormalizedNodeBodyReader(final ControllerContext controllerContext) {
  67         super(controllerContext);
  68     }
  69
  70     @Override
  71     public boolean isReadable(final Class<?> type, final Type genericType, final Annotation[] annotations,
  72             final MediaType mediaType) {
  73         return true;
  74     }
  75
  76     @SuppressWarnings("checkstyle:IllegalCatch")
  77     @Override
  78     public NormalizedNodeContext readFrom(final Class<NormalizedNodeContext> type, final Type genericType,
  79             final Annotation[] annotations, final MediaType mediaType,
  80             final MultivaluedMap<String, String> httpHeaders, final InputStream entityStream) throws
  81         WebApplicationException {
  82         try {
  83             return readFrom(getInstanceIdentifierContext(), entityStream, isPost());
  84         } catch (final Exception e) {
  85             propagateExceptionAs(e);
  86             return null; // no-op
  87         }
  88     }
  89
  90     @SuppressWarnings("checkstyle:IllegalCatch")
  91     public static NormalizedNodeContext readFrom(final String uriPath, final InputStream entityStream,
  92             final boolean isPost, final ControllerContext controllerContext) throws RestconfDocumentedException {
  93
  94         try {
  95             return readFrom(controllerContext.toInstanceIdentifier(uriPath), entityStream, isPost);
  96         } catch (final Exception e) {
  97             propagateExceptionAs(e);
  98             return null; // no-op
  99         }
 100     }
 101
 102     private static NormalizedNodeContext readFrom(final InstanceIdentifierContext path,
 103                                                   final InputStream entityStream, final boolean isPost)
 104             throws IOException {
 105         final Optional<InputStream> nonEmptyInputStreamOptional = RestUtil.isInputStreamEmpty(entityStream);
 106         if (nonEmptyInputStreamOptional.isEmpty()) {
 107             return new NormalizedNodeContext(path, null);
 108         }
 109         final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
 110         final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
 111
 112         final SchemaInferenceStack parentSchema;
 113         if (isPost) {
 114             // FIXME: We need dispatch for RPC.
 115             parentSchema = SchemaInferenceStack.ofSchemaPath(path.getSchemaContext(), path.getSchemaNode().getPath());
 116         } else if (path.getSchemaNode() instanceof SchemaContext
 117                 || SchemaPath.ROOT.equals(path.getSchemaNode().getPath().getParent())) {
 118             parentSchema = SchemaInferenceStack.of(path.getSchemaContext());
 119         } else {
 120             parentSchema = SchemaInferenceStack.ofSchemaPath(path.getSchemaContext(),
 121                 path.getSchemaNode().getPath().getParent());
 122         }
 123
 124         final JsonParserStream jsonParser = JsonParserStream.create(writer,
 125             JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02.getShared(path.getSchemaContext()),
 126             parentSchema.toInference());
 127         final JsonReader reader = new JsonReader(new InputStreamReader(nonEmptyInputStreamOptional.get(),
 128                 StandardCharsets.UTF_8));
 129         jsonParser.parse(reader);
 130
 131         NormalizedNode result = resultHolder.getResult();
 132         final List<YangInstanceIdentifier.PathArgument> iiToDataList = new ArrayList<>();
 133         InstanceIdentifierContext newIIContext;
 134
 135         while (result instanceof AugmentationNode || result instanceof ChoiceNode) {
 136             final Object childNode = ((DataContainerNode) result).body().iterator().next();
 137             if (isPost) {
 138                 iiToDataList.add(result.getIdentifier());
 139             }
 140             result = (NormalizedNode) childNode;
 141         }
 142
 143         if (isPost) {
 144             if (result instanceof MapEntryNode) {
 145                 iiToDataList.add(new YangInstanceIdentifier.NodeIdentifier(result.getIdentifier().getNodeType()));
 146                 iiToDataList.add(result.getIdentifier());
 147             } else {
 148                 iiToDataList.add(result.getIdentifier());
 149             }
 150         } else {
 151             if (result instanceof MapNode) {
 152                 result = Iterables.getOnlyElement(((MapNode) result).body());
 153             }
 154         }
 155
 156         final YangInstanceIdentifier fullIIToData = YangInstanceIdentifier.create(Iterables.concat(
 157                 path.getInstanceIdentifier().getPathArguments(), iiToDataList));
 158
 159         newIIContext = new InstanceIdentifierContext(fullIIToData, path.getSchemaNode(), path.getMountPoint(),
 160                 path.getSchemaContext());
 161
 162         return new NormalizedNodeContext(newIIContext, result);
 163     }
 164
 165     private static void propagateExceptionAs(final Exception exception) throws RestconfDocumentedException {
 166         Throwables.throwIfInstanceOf(exception, RestconfDocumentedException.class);
 167         LOG.debug("Error parsing json input", exception);
 168
 169         if (exception instanceof ResultAlreadySetException) {
 170             throw new RestconfDocumentedException("Error parsing json input: Failed to create new parse result data. "
 171                     + "Are you creating multiple resources/subresources in POST request?", exception);
 172         }
 173
 174         RestconfDocumentedException.throwIfYangError(exception);
 175         throw new RestconfDocumentedException("Error parsing input: " + exception.getMessage(), ErrorType.PROTOCOL,
 176                 ErrorTag.MALFORMED_MESSAGE, exception);
 177     }
 178 }
 179