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