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.errors.RestconfDocumentedException;
  22 import org.opendaylight.restconf.nb.rfc8040.InsertParam;
  23 import org.opendaylight.restconf.nb.rfc8040.PointParam;
  24 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  25 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy;
  26 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfTransaction;
  27 import org.opendaylight.restconf.nb.rfc8040.utils.parser.IdentifierCodec;
  28 import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier;
  29 import org.opendaylight.yangtools.yang.common.ErrorTag;
  30 import org.opendaylight.yangtools.yang.common.ErrorType;
  31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  32 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  33 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  34 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  35 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
  36 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  37 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  38 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41
  42 /**
  43  * Util class to post data to DS.
  44  */
  45 public final class PostDataTransactionUtil {
  46     private static final Logger LOG = LoggerFactory.getLogger(PostDataTransactionUtil.class);
  47     private 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 NormalizedNodePayload payload,
  66                                     final RestconfStrategy strategy,
  67                                     final EffectiveModelContext schemaContext, final InsertParam insert,
  68                                     final PointParam 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, 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 InsertParam insert,
  95                                                                  final PointParam point) {
  96         final RestconfTransaction transaction = strategy.prepareWriteExecution();
  97         if (insert == null) {
  98             makePost(path, data, schemaContext, transaction);
  99             return transaction.commit();
 100         }
 101
 102         PutDataTransactionUtil.checkListAndOrderedType(schemaContext, path);
 103         final NormalizedNode readData;
 104         switch (insert) {
 105             case FIRST:
 106                 readData = PutDataTransactionUtil.readList(strategy, path.getParent().getParent());
 107                 if (readData == null || ((NormalizedNodeContainer<?>) readData).isEmpty()) {
 108                     transaction.replace(path, data, schemaContext);
 109                     return transaction.commit();
 110                 }
 111                 checkItemDoesNotExists(strategy.exists(LogicalDatastoreType.CONFIGURATION, path), path);
 112                 transaction.remove(path.getParent().getParent());
 113                 transaction.replace(path, data, schemaContext);
 114                 transaction.replace(path.getParent().getParent(), readData, schemaContext);
 115                 return transaction.commit();
 116             case LAST:
 117                 makePost(path, data, schemaContext, transaction);
 118                 return transaction.commit();
 119             case BEFORE:
 120                 readData = PutDataTransactionUtil.readList(strategy, path.getParent().getParent());
 121                 if (readData == null || ((NormalizedNodeContainer<?>) readData).isEmpty()) {
 122                     transaction.replace(path, data, schemaContext);
 123                     return transaction.commit();
 124                 }
 125                 checkItemDoesNotExists(strategy.exists(LogicalDatastoreType.CONFIGURATION, path), path);
 126                 insertWithPointPost(path, data, schemaContext, point,
 127                     (NormalizedNodeContainer<?>) readData, true, transaction);
 128                 return transaction.commit();
 129             case AFTER:
 130                 readData = PutDataTransactionUtil.readList(strategy, path.getParent().getParent());
 131                 if (readData == null || ((NormalizedNodeContainer<?>) readData).isEmpty()) {
 132                     transaction.replace(path, data, schemaContext);
 133                     return transaction.commit();
 134                 }
 135                 checkItemDoesNotExists(strategy.exists(LogicalDatastoreType.CONFIGURATION, path), path);
 136                 insertWithPointPost(path, data, schemaContext, point,
 137                     (NormalizedNodeContainer<?>) readData, false, transaction);
 138                 return transaction.commit();
 139             default:
 140                 throw new RestconfDocumentedException(
 141                     "Used bad value of insert parameter. Possible values are first, last, before or after, but was: "
 142                         + insert, ErrorType.PROTOCOL, ErrorTag.BAD_ATTRIBUTE);
 143         }
 144     }
 145
 146     private static void insertWithPointPost(final YangInstanceIdentifier path, final NormalizedNode data,
 147                                             final EffectiveModelContext schemaContext, final PointParam point,
 148                                             final NormalizedNodeContainer<?> readList, final boolean before,
 149                                             final RestconfTransaction transaction) {
 150         final YangInstanceIdentifier parent = path.getParent().getParent();
 151         transaction.remove(parent);
 152         final InstanceIdentifierContext<?> instanceIdentifier =
 153             // FIXME: Point should be able to give us this method
 154             ParserIdentifier.toInstanceIdentifier(point.value(), schemaContext, Optional.empty());
 155         int lastItemPosition = 0;
 156         for (final NormalizedNode nodeChild : readList.body()) {
 157             if (nodeChild.getIdentifier().equals(instanceIdentifier.getInstanceIdentifier().getLastPathArgument())) {
 158                 break;
 159             }
 160             lastItemPosition++;
 161         }
 162         if (!before) {
 163             lastItemPosition++;
 164         }
 165         int lastInsertedPosition = 0;
 166         final NormalizedNode emptySubtree = ImmutableNodes.fromInstanceId(schemaContext, parent);
 167         transaction.merge(YangInstanceIdentifier.create(emptySubtree.getIdentifier()), emptySubtree);
 168         for (final NormalizedNode nodeChild : readList.body()) {
 169             if (lastInsertedPosition == lastItemPosition) {
 170                 transaction.replace(path, data, schemaContext);
 171             }
 172             final YangInstanceIdentifier childPath = parent.node(nodeChild.getIdentifier());
 173             transaction.replace(childPath, nodeChild, schemaContext);
 174             lastInsertedPosition++;
 175         }
 176     }
 177
 178     private static void makePost(final YangInstanceIdentifier path, final NormalizedNode data,
 179                                  final SchemaContext schemaContext, final RestconfTransaction transaction) {
 180         try {
 181             transaction.create(path, data, schemaContext);
 182         } catch (RestconfDocumentedException e) {
 183             // close transaction if any and pass exception further
 184             transaction.cancel();
 185             throw e;
 186         }
 187     }
 188
 189     /**
 190      * Get location from {@link YangInstanceIdentifier} and {@link UriInfo}.
 191      *
 192      * @param uriInfo       uri info
 193      * @param initialPath   data path
 194      * @param schemaContext reference to {@link SchemaContext}
 195      * @return {@link URI}
 196      */
 197     private static URI resolveLocation(final UriInfo uriInfo, final YangInstanceIdentifier initialPath,
 198                                        final EffectiveModelContext schemaContext, final NormalizedNode data) {
 199         if (uriInfo == null) {
 200             return null;
 201         }
 202
 203         YangInstanceIdentifier path = initialPath;
 204         if (data instanceof MapNode) {
 205             final Collection<MapEntryNode> children = ((MapNode) data).body();
 206             if (!children.isEmpty()) {
 207                 path = path.node(children.iterator().next().getIdentifier());
 208             }
 209         }
 210
 211         return uriInfo.getBaseUriBuilder().path("data").path(IdentifierCodec.serialize(path, schemaContext)).build();
 212     }
 213
 214     /**
 215      * Check if items do NOT already exists at specified {@code path}. Throws {@link RestconfDocumentedException} if
 216      * data already exists.
 217      *
 218      * @param isExistsFuture if checked data exists
 219      * @param path           Path to be checked
 220      */
 221     public static void checkItemDoesNotExists(final FluentFuture<Boolean> isExistsFuture,
 222                                               final YangInstanceIdentifier path) {
 223         final FutureDataFactory<Boolean> response = new FutureDataFactory<>();
 224         FutureCallbackTx.addCallback(isExistsFuture, POST_TX_TYPE, response);
 225
 226         if (response.result) {
 227             LOG.trace("Operation via Restconf was not executed because data at {} already exists", path);
 228             throw new RestconfDocumentedException(
 229                 "Data already exists", ErrorType.PROTOCOL, ErrorTag.DATA_EXISTS, path);
 230         }
 231     }
 232 }