restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/utils/PostDataTransactionUtil.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.rests.utils;
   9
  10 import com.google.common.util.concurrent.FluentFuture;
  11 import java.net.URI;
  12 import java.util.Collection;
  13 import java.util.Optional;
  14 import javax.ws.rs.core.Response;
  15 import javax.ws.rs.core.Response.Status;
  16 import javax.ws.rs.core.UriInfo;
  17 import org.opendaylight.mdsal.common.api.CommitInfo;
  18 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  19 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  20 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  21 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
  22 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  23 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy;
  24 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfTransaction;
  25 import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant.PostPutQueryParameters.Insert;
  26 import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier;
  27 import org.opendaylight.yangtools.yang.common.ErrorTag;
  28 import org.opendaylight.yangtools.yang.common.ErrorType;
  29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  30 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  31 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  32 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  33 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
  34 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  35 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  36 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 /**
  41  * Util class to post data to DS.
  42  *
  43  */
  44 public final class PostDataTransactionUtil {
  45     private static final Logger LOG = LoggerFactory.getLogger(PostDataTransactionUtil.class);
  46     // FIXME: why is this being reused from other places?
  47     static final String POST_TX_TYPE = "POST";
  48
  49     private PostDataTransactionUtil() {
  50         // Hidden on purpose
  51     }
  52
  53     /**
  54      * Check mount point and prepare variables for post data. Close {@link DOMTransactionChain} if any inside of object
  55      * {@link RestconfStrategy} provided as a parameter.
  56      *
  57      * @param uriInfo       uri info
  58      * @param payload       data
  59      * @param strategy      Object that perform the actual DS operations
  60      * @param schemaContext reference to actual {@link EffectiveModelContext}
  61      * @param point         point
  62      * @param insert        insert
  63      * @return {@link Response}
  64      */
  65     public static Response postData(final UriInfo uriInfo, final NormalizedNodeContext payload,
  66                                     final RestconfStrategy strategy,
  67                                     final EffectiveModelContext schemaContext, final Insert insert,
  68                                     final String point) {
  69         final YangInstanceIdentifier path = payload.getInstanceIdentifierContext().getInstanceIdentifier();
  70         final FluentFuture<? extends CommitInfo> future = submitData(path, payload.getData(),
  71                 strategy, schemaContext, insert, point);
  72         final URI location = resolveLocation(uriInfo, path, schemaContext, payload.getData());
  73         final ResponseFactory dataFactory = new ResponseFactory(Status.CREATED).location(location);
  74         //This method will close transactionChain if any
  75         FutureCallbackTx.addCallback(future, POST_TX_TYPE, dataFactory, strategy, path);
  76         return dataFactory.build();
  77     }
  78
  79     /**
  80      * Post data by type.
  81      *
  82      * @param path          path
  83      * @param data          data
  84      * @param strategy      object that perform the actual DS operations
  85      * @param schemaContext schema context of data
  86      * @param point         query parameter
  87      * @param insert        query parameter
  88      * @return {@link FluentFuture}
  89      */
  90     private static FluentFuture<? extends CommitInfo> submitData(final YangInstanceIdentifier path,
  91                                                                  final NormalizedNode data,
  92                                                                  final RestconfStrategy strategy,
  93                                                                  final EffectiveModelContext schemaContext,
  94                                                                  final Insert insert, final String point) {
  95         final RestconfTransaction transaction = strategy.prepareWriteExecution();
  96         if (insert == null) {
  97             makePost(path, data, schemaContext, transaction);
  98             return transaction.commit();
  99         }
 100
 101         PutDataTransactionUtil.checkListAndOrderedType(schemaContext, path);
 102         final NormalizedNode readData;
 103         switch (insert) {
 104             case FIRST:
 105                 readData = PutDataTransactionUtil.readList(strategy, path.getParent().getParent());
 106                 if (readData == null || ((NormalizedNodeContainer<?>) readData).isEmpty()) {
 107                     transaction.replace(path, data, schemaContext);
 108                     return transaction.commit();
 109                 }
 110                 checkItemDoesNotExists(strategy.exists(LogicalDatastoreType.CONFIGURATION, path), path);
 111                 transaction.remove(path.getParent().getParent());
 112                 transaction.replace(path, data, schemaContext);
 113                 transaction.replace(path.getParent().getParent(), readData, schemaContext);
 114                 return transaction.commit();
 115             case LAST:
 116                 makePost(path, data, schemaContext, transaction);
 117                 return transaction.commit();
 118             case BEFORE:
 119                 readData = PutDataTransactionUtil.readList(strategy, path.getParent().getParent());
 120                 if (readData == null || ((NormalizedNodeContainer<?>) readData).isEmpty()) {
 121                     transaction.replace(path, data, schemaContext);
 122                     return transaction.commit();
 123                 }
 124                 checkItemDoesNotExists(strategy.exists(LogicalDatastoreType.CONFIGURATION, path), path);
 125                 insertWithPointPost(path, data, schemaContext, point,
 126                     (NormalizedNodeContainer<?>) readData, true, transaction);
 127                 return transaction.commit();
 128             case AFTER:
 129                 readData = PutDataTransactionUtil.readList(strategy, path.getParent().getParent());
 130                 if (readData == null || ((NormalizedNodeContainer<?>) readData).isEmpty()) {
 131                     transaction.replace(path, data, schemaContext);
 132                     return transaction.commit();
 133                 }
 134                 checkItemDoesNotExists(strategy.exists(LogicalDatastoreType.CONFIGURATION, path), path);
 135                 insertWithPointPost(path, data, schemaContext, point,
 136                     (NormalizedNodeContainer<?>) readData, false, transaction);
 137                 return transaction.commit();
 138             default:
 139                 throw new RestconfDocumentedException(
 140                     "Used bad value of insert parameter. Possible values are first, last, before or after, but was: "
 141                         + insert, ErrorType.PROTOCOL, ErrorTag.BAD_ATTRIBUTE);
 142         }
 143     }
 144
 145     private static void insertWithPointPost(final YangInstanceIdentifier path, final NormalizedNode data,
 146                                             final EffectiveModelContext schemaContext, final String point,
 147                                             final NormalizedNodeContainer<?> readList, final boolean before,
 148                                             final RestconfTransaction transaction) {
 149         final YangInstanceIdentifier parent = path.getParent().getParent();
 150         transaction.remove(parent);
 151         final InstanceIdentifierContext<?> instanceIdentifier =
 152             ParserIdentifier.toInstanceIdentifier(point, schemaContext, Optional.empty());
 153         int lastItemPosition = 0;
 154         for (final NormalizedNode nodeChild : readList.body()) {
 155             if (nodeChild.getIdentifier().equals(instanceIdentifier.getInstanceIdentifier().getLastPathArgument())) {
 156                 break;
 157             }
 158             lastItemPosition++;
 159         }
 160         if (!before) {
 161             lastItemPosition++;
 162         }
 163         int lastInsertedPosition = 0;
 164         final NormalizedNode emptySubtree = ImmutableNodes.fromInstanceId(schemaContext, parent);
 165         transaction.merge(YangInstanceIdentifier.create(emptySubtree.getIdentifier()), emptySubtree);
 166         for (final NormalizedNode nodeChild : readList.body()) {
 167             if (lastInsertedPosition == lastItemPosition) {
 168                 transaction.replace(path, data, schemaContext);
 169             }
 170             final YangInstanceIdentifier childPath = parent.node(nodeChild.getIdentifier());
 171             transaction.replace(childPath, nodeChild, schemaContext);
 172             lastInsertedPosition++;
 173         }
 174     }
 175
 176     private static void makePost(final YangInstanceIdentifier path, final NormalizedNode data,
 177                                  final SchemaContext schemaContext, final RestconfTransaction transaction) {
 178         try {
 179             transaction.create(path, data, schemaContext);
 180         } catch (RestconfDocumentedException e) {
 181             // close transaction if any and pass exception further
 182             transaction.cancel();
 183             throw e;
 184         }
 185     }
 186
 187     /**
 188      * Get location from {@link YangInstanceIdentifier} and {@link UriInfo}.
 189      *
 190      * @param uriInfo       uri info
 191      * @param initialPath   data path
 192      * @param schemaContext reference to {@link SchemaContext}
 193      * @return {@link URI}
 194      */
 195     private static URI resolveLocation(final UriInfo uriInfo, final YangInstanceIdentifier initialPath,
 196                                        final EffectiveModelContext schemaContext, final NormalizedNode data) {
 197         if (uriInfo == null) {
 198             return null;
 199         }
 200
 201         YangInstanceIdentifier path = initialPath;
 202         if (data instanceof MapNode) {
 203             final Collection<MapEntryNode> children = ((MapNode) data).body();
 204             if (!children.isEmpty()) {
 205                 path = path.node(children.iterator().next().getIdentifier());
 206             }
 207         }
 208
 209         return uriInfo.getBaseUriBuilder()
 210                 .path("data")
 211                 .path(ParserIdentifier.stringFromYangInstanceIdentifier(path, schemaContext))
 212                 .build();
 213     }
 214
 215     /**
 216      * Check if items do NOT already exists at specified {@code path}. Throws {@link RestconfDocumentedException} if
 217      * data already exists.
 218      *
 219      * @param isExistsFuture if checked data exists
 220      * @param path           Path to be checked
 221      */
 222     public static void checkItemDoesNotExists(final FluentFuture<Boolean> isExistsFuture,
 223                                               final YangInstanceIdentifier path) {
 224         final FutureDataFactory<Boolean> response = new FutureDataFactory<>();
 225         FutureCallbackTx.addCallback(isExistsFuture, POST_TX_TYPE, response);
 226
 227         if (response.result) {
 228             LOG.trace("Operation via Restconf was not executed because data at {} already exists", path);
 229             throw new RestconfDocumentedException(
 230                 "Data already exists", ErrorType.PROTOCOL, ErrorTag.DATA_EXISTS, path);
 231         }
 232     }
 233 }