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.collect.Iterables;
  11 import com.google.gson.stream.JsonReader;
  12 import java.io.IOException;
  13 import java.io.InputStream;
  14 import java.io.InputStreamReader;
  15 import java.lang.annotation.Annotation;
  16 import java.lang.reflect.Type;
  17 import java.nio.charset.StandardCharsets;
  18 import java.util.ArrayList;
  19 import java.util.List;
  20 import java.util.Optional;
  21 import javax.ws.rs.Consumes;
  22 import javax.ws.rs.WebApplicationException;
  23 import javax.ws.rs.core.MediaType;
  24 import javax.ws.rs.core.MultivaluedMap;
  25 import javax.ws.rs.ext.MessageBodyReader;
  26 import javax.ws.rs.ext.Provider;
  27 import org.opendaylight.netconf.sal.rest.api.Draft02;
  28 import org.opendaylight.netconf.sal.rest.api.RestconfService;
  29 import org.opendaylight.netconf.sal.restconf.impl.ControllerContext;
  30 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  31 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
  32 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  33 import org.opendaylight.restconf.common.errors.RestconfError.ErrorTag;
  34 import org.opendaylight.restconf.common.errors.RestconfError.ErrorType;
  35 import org.opendaylight.restconf.common.util.RestUtil;
  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.SchemaNode;
  51 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  52 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55
  56 @Provider
  57 @Consumes({ Draft02.MediaTypes.DATA + RestconfService.JSON, Draft02.MediaTypes.OPERATION + RestconfService.JSON,
  58         MediaType.APPLICATION_JSON })
  59 public class JsonNormalizedNodeBodyReader
  60         extends AbstractIdentifierAwareJaxRsProvider implements MessageBodyReader<NormalizedNodeContext> {
  61
  62     private static final Logger LOG = LoggerFactory.getLogger(JsonNormalizedNodeBodyReader.class);
  63
  64     public JsonNormalizedNodeBodyReader(ControllerContext controllerContext) {
  65         super(controllerContext);
  66     }
  67
  68     @Override
  69     public boolean isReadable(final Class<?> type, final Type genericType, final Annotation[] annotations,
  70             final MediaType mediaType) {
  71         return true;
  72     }
  73
  74     @SuppressWarnings("checkstyle:IllegalCatch")
  75     @Override
  76     public NormalizedNodeContext readFrom(final Class<NormalizedNodeContext> type, final Type genericType,
  77             final Annotation[] annotations, final MediaType mediaType,
  78             final MultivaluedMap<String, String> httpHeaders, final InputStream entityStream) throws IOException,
  79             WebApplicationException {
  80         try {
  81             return readFrom(getInstanceIdentifierContext(), entityStream, isPost());
  82         } catch (final Exception e) {
  83             propagateExceptionAs(e);
  84             return null; // no-op
  85         }
  86     }
  87
  88     @SuppressWarnings("checkstyle:IllegalCatch")
  89     public static NormalizedNodeContext readFrom(final String uriPath, final InputStream entityStream,
  90             final boolean isPost, final ControllerContext controllerContext) throws RestconfDocumentedException {
  91
  92         try {
  93             return readFrom(controllerContext.toInstanceIdentifier(uriPath), entityStream, isPost);
  94         } catch (final Exception e) {
  95             propagateExceptionAs(e);
  96             return null; // no-op
  97         }
  98     }
  99
 100     private static NormalizedNodeContext readFrom(final InstanceIdentifierContext<?> path,
 101                                                   final InputStream entityStream, final boolean isPost)
 102             throws IOException {
 103         final Optional<InputStream> nonEmptyInputStreamOptional = RestUtil.isInputStreamEmpty(entityStream);
 104         if (!nonEmptyInputStreamOptional.isPresent()) {
 105             return new NormalizedNodeContext(path, null);
 106         }
 107         final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
 108         final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
 109
 110         final SchemaNode parentSchema;
 111         if (isPost) {
 112             // FIXME: We need dispatch for RPC.
 113             parentSchema = path.getSchemaNode();
 114         } else if (path.getSchemaNode() instanceof SchemaContext) {
 115             parentSchema = path.getSchemaContext();
 116         } else {
 117             if (SchemaPath.ROOT.equals(path.getSchemaNode().getPath().getParent())) {
 118                 parentSchema = path.getSchemaContext();
 119             } else {
 120                 parentSchema = SchemaContextUtil
 121                         .findDataSchemaNode(path.getSchemaContext(), path.getSchemaNode().getPath().getParent());
 122             }
 123         }
 124
 125         final JsonParserStream jsonParser = JsonParserStream.create(writer,
 126             JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02.getShared(path.getSchemaContext()), parentSchema);
 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<? extends SchemaNode> newIIContext;
 134
 135         while (result instanceof AugmentationNode || result instanceof ChoiceNode) {
 136             final Object childNode = ((DataContainerNode<?>) result).getValue().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.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).getValue());
 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         if (exception instanceof RestconfDocumentedException) {
 167             throw (RestconfDocumentedException)exception;
 168         }
 169
 170         if (exception instanceof ResultAlreadySetException) {
 171             LOG.debug("Error parsing json input:", exception);
 172
 173             throw new RestconfDocumentedException("Error parsing json input: Failed to create new parse result data. "
 174                     + "Are you creating multiple resources/subresources in POST request?", exception);
 175         }
 176
 177         LOG.debug("Error parsing json input", exception);
 178
 179         throw new RestconfDocumentedException("Error parsing input: " + exception.getMessage(), ErrorType.PROTOCOL,
 180                 ErrorTag.MALFORMED_MESSAGE, exception);
 181     }
 182 }
 183