restconf/sal-rest-connector/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.util.ArrayList;
  18 import java.util.List;
  19 import javax.ws.rs.Consumes;
  20 import javax.ws.rs.WebApplicationException;
  21 import javax.ws.rs.core.MediaType;
  22 import javax.ws.rs.core.MultivaluedMap;
  23 import javax.ws.rs.ext.MessageBodyReader;
  24 import javax.ws.rs.ext.Provider;
  25 import org.opendaylight.netconf.sal.rest.api.Draft02;
  26 import org.opendaylight.netconf.sal.rest.api.RestconfService;
  27 import org.opendaylight.netconf.sal.restconf.impl.ControllerContext;
  28 import org.opendaylight.netconf.sal.restconf.impl.InstanceIdentifierContext;
  29 import org.opendaylight.netconf.sal.restconf.impl.NormalizedNodeContext;
  30 import org.opendaylight.netconf.sal.restconf.impl.RestconfDocumentedException;
  31 import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorTag;
  32 import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorType;
  33 import org.opendaylight.restconf.Rfc8040;
  34 import org.opendaylight.restconf.utils.RestconfConstants;
  35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  36 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  37 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  38 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  39 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  43 import org.opendaylight.yangtools.yang.data.codec.gson.JsonParserStream;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.ResultAlreadySetException;
  47 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  48 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  49 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  50 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53
  54 @Provider
  55 @Consumes({ Draft02.MediaTypes.DATA + RestconfService.JSON, Draft02.MediaTypes.OPERATION + RestconfService.JSON,
  56         Rfc8040.MediaTypes.DATA + RestconfConstants.JSON, MediaType.APPLICATION_JSON })
  57 public class JsonNormalizedNodeBodyReader
  58         extends AbstractIdentifierAwareJaxRsProvider implements MessageBodyReader<NormalizedNodeContext> {
  59
  60     private static final Logger LOG = LoggerFactory.getLogger(JsonNormalizedNodeBodyReader.class);
  61
  62     @Override
  63     public boolean isReadable(final Class<?> type, final Type genericType, final Annotation[] annotations,
  64             final MediaType mediaType) {
  65         return true;
  66     }
  67
  68     @SuppressWarnings("checkstyle:IllegalCatch")
  69     @Override
  70     public NormalizedNodeContext readFrom(final Class<NormalizedNodeContext> type, final Type genericType,
  71             final Annotation[] annotations, final MediaType mediaType,
  72             final MultivaluedMap<String, String> httpHeaders, final InputStream entityStream) throws IOException,
  73             WebApplicationException {
  74         try {
  75             if (getUriInfo().getAbsolutePath().getPath().contains(RestconfConstants.DRAFT_PATTERN)) {
  76                 final org.opendaylight.restconf.jersey.providers.JsonNormalizedNodeBodyReader jsonReaderNewRest =
  77                         new org.opendaylight.restconf.jersey.providers.JsonNormalizedNodeBodyReader();
  78                 jsonReaderNewRest.injectParams(getUriInfo(), getRequest());
  79                 return jsonReaderNewRest.readFrom(type, genericType, annotations, mediaType, httpHeaders, entityStream);
  80             }
  81
  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) throws RestconfDocumentedException {
  92
  93         try {
  94             return readFrom(ControllerContext.getInstance().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         if (entityStream.available() < 1) {
 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, path.getSchemaContext(), parentSchema);
 126         final JsonReader reader = new JsonReader(new InputStreamReader(entityStream));
 127         jsonParser.parse(reader);
 128
 129         NormalizedNode<?, ?> result = resultHolder.getResult();
 130         final List<YangInstanceIdentifier.PathArgument> iiToDataList = new ArrayList<>();
 131         InstanceIdentifierContext<? extends SchemaNode> newIIContext;
 132
 133         while (result instanceof AugmentationNode || result instanceof ChoiceNode) {
 134             final Object childNode = ((DataContainerNode<?>) result).getValue().iterator().next();
 135             if (isPost) {
 136                 iiToDataList.add(result.getIdentifier());
 137             }
 138             result = (NormalizedNode<?, ?>) childNode;
 139         }
 140
 141         if (isPost) {
 142             if (result instanceof MapEntryNode) {
 143                 iiToDataList.add(new YangInstanceIdentifier.NodeIdentifier(result.getNodeType()));
 144                 iiToDataList.add(result.getIdentifier());
 145             } else {
 146                 iiToDataList.add(result.getIdentifier());
 147             }
 148         } else {
 149             if (result instanceof MapNode) {
 150                 result = Iterables.getOnlyElement(((MapNode) result).getValue());
 151             }
 152         }
 153
 154         final YangInstanceIdentifier fullIIToData = YangInstanceIdentifier.create(Iterables.concat(
 155                 path.getInstanceIdentifier().getPathArguments(), iiToDataList));
 156
 157         newIIContext = new InstanceIdentifierContext<>(fullIIToData, path.getSchemaNode(), path.getMountPoint(),
 158                 path.getSchemaContext());
 159
 160         return new NormalizedNodeContext(newIIContext, result);
 161     }
 162
 163     private static void propagateExceptionAs(final Exception exception) throws RestconfDocumentedException {
 164         if (exception instanceof RestconfDocumentedException) {
 165             throw (RestconfDocumentedException)exception;
 166         }
 167
 168         if (exception instanceof ResultAlreadySetException) {
 169             LOG.debug("Error parsing json input:", exception);
 170
 171             throw new RestconfDocumentedException("Error parsing json input: Failed to create new parse result data. "
 172                     + "Are you creating multiple resources/subresources in POST request?");
 173         }
 174
 175         LOG.debug("Error parsing json input", exception);
 176
 177         throw new RestconfDocumentedException("Error parsing input: " + exception.getMessage(), ErrorType.PROTOCOL,
 178                 ErrorTag.MALFORMED_MESSAGE, exception);
 179     }
 180 }
 181