restconf/sal-rest-connector/src/main/java/org/opendaylight/restconf/restful/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.restful.utils;
   9
  10 import com.google.common.util.concurrent.CheckedFuture;
  11 import java.net.URI;
  12 import javax.ws.rs.core.Response;
  13 import javax.ws.rs.core.UriBuilder;
  14 import javax.ws.rs.core.UriInfo;
  15 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  16 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  17 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
  18 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  19 import org.opendaylight.netconf.sal.restconf.impl.NormalizedNodeContext;
  20 import org.opendaylight.restconf.common.references.SchemaContextRef;
  21 import org.opendaylight.restconf.restful.transaction.TransactionVarsWrapper;
  22 import org.opendaylight.restconf.utils.parser.ParserIdentifier;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  25 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  26 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  29 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  30 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  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.impl.schema.ImmutableNodes;
  35 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 /**
  40  * Util class to post data to DS
  41  *
  42  */
  43 public final class PostDataTransactionUtil {
  44
  45     private static final Logger LOG = LoggerFactory.getLogger(PostDataTransactionUtil.class);
  46
  47     private PostDataTransactionUtil() {
  48         throw new UnsupportedOperationException("Util class.");
  49     }
  50
  51     /**
  52      * Check mount point and prepare variables for post data
  53      *
  54      * @param uriInfo
  55      *
  56      * @param payload
  57      *            - data
  58      * @param transactionNode
  59      *            - wrapper for transaction data
  60      * @param schemaContextRef
  61      *            - reference to actual {@link SchemaContext}
  62      * @return {@link CheckedFuture}
  63      */
  64     public static Response postData(final UriInfo uriInfo, final NormalizedNodeContext payload,
  65             final TransactionVarsWrapper transactionNode, final SchemaContextRef schemaContextRef) {
  66         final CheckedFuture<Void, TransactionCommitFailedException> future = submitData(
  67                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(),
  68                 transactionNode, schemaContextRef.get());
  69         final URI location = PostDataTransactionUtil.resolveLocation(uriInfo, transactionNode, schemaContextRef);
  70         final ResponseFactory dataFactory = new ResponseFactory(
  71                 ReadDataTransactionUtil.readData(RestconfDataServiceConstant.ReadData.CONFIG, transactionNode),
  72                 location);
  73         FutureCallbackTx.addCallback(future, RestconfDataServiceConstant.PostData.POST_TX_TYPE, dataFactory);
  74         return dataFactory.build();
  75     }
  76
  77     /**
  78      * Post data by type
  79      *
  80      * @param path
  81      *            - path
  82      * @param data
  83      *            - data
  84      * @param transactionNode
  85      *            - wrapper for data to transaction
  86      * @param schemaContext
  87      *            - schema context of data
  88      * @return {@link CheckedFuture}
  89      */
  90     private static CheckedFuture<Void, TransactionCommitFailedException> submitData(final YangInstanceIdentifier path,
  91             final NormalizedNode<?, ?> data, final TransactionVarsWrapper transactionNode,
  92             final SchemaContext schemaContext) {
  93         final DOMTransactionChain transactionChain = transactionNode.getTransactionChain();
  94         final DOMDataReadWriteTransaction transaction = transactionChain.newReadWriteTransaction();
  95         final NormalizedNode<?, ?> node = ImmutableNodes.fromInstanceId(schemaContext, path);
  96         transaction.put(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier.create(node.getIdentifier()), node);
  97         TransactionUtil.ensureParentsByMerge(path, schemaContext, transaction);
  98
  99         if (data instanceof MapNode) {
 100             for (final MapEntryNode child : ((MapNode) data).getValue()) {
 101                 putChild(child, transactionChain, transaction, path);
 102             }
 103         } else if (data instanceof AugmentationNode) {
 104             for (final DataContainerChild<? extends PathArgument, ?> child : ((AugmentationNode) data).getValue()) {
 105                 putChild(child, transactionChain, transaction, path);
 106             }
 107         } else if (data instanceof ChoiceNode) {
 108             for (final DataContainerChild<? extends PathArgument, ?> child : ((ChoiceNode) data).getValue()) {
 109                 putChild(child, transactionChain, transaction, path);
 110             }
 111         } else if (data instanceof LeafSetNode<?>) {
 112             for (final LeafSetEntryNode<?> child : ((LeafSetNode<?>) data).getValue()) {
 113                 putChild(child, transactionChain, transaction, path);
 114             }
 115         } else if (data instanceof ContainerNode) {
 116             for (final DataContainerChild<? extends PathArgument, ?> child : ((ContainerNode) data).getValue()) {
 117                 putChild(child, transactionChain, transaction, path);
 118             }
 119         }
 120
 121         return transaction.submit();
 122     }
 123
 124     /**
 125      * Prepare data for submit
 126      *
 127      * @param child
 128      *            - data
 129      * @param transactionChain
 130      *            - transaction chain
 131      * @param readWriteTx
 132      *            - transaction
 133      * @param path
 134      *            - path to data
 135      */
 136     private static void putChild(final NormalizedNode<?, ?> child, final DOMTransactionChain transactionChain,
 137                                  final DOMDataReadWriteTransaction readWriteTx, final YangInstanceIdentifier path) {
 138         final YangInstanceIdentifier childPath = path.node(child.getIdentifier());
 139         TransactionUtil.checkItemDoesNotExists(
 140                 transactionChain, readWriteTx, LogicalDatastoreType.CONFIGURATION, childPath,
 141                 RestconfDataServiceConstant.PostData.POST_TX_TYPE);
 142         readWriteTx.put(LogicalDatastoreType.CONFIGURATION, childPath, child);
 143     }
 144
 145     /**
 146      * Get location from {@link YangInstanceIdentifier} and {@link UriInfo}
 147      *
 148      * @param uriInfo
 149      *            - uri info
 150      * @param transactionNode
 151      *            - wrapper for data of transaction
 152      * @param schemaContextRef
 153      *            -reference to {@link SchemaContext}
 154      * @return {@link URI}
 155      */
 156     private static URI resolveLocation(final UriInfo uriInfo, final TransactionVarsWrapper transactionNode,
 157             final SchemaContextRef schemaContextRef) {
 158         if (uriInfo == null) {
 159             return null;
 160         }
 161
 162         final UriBuilder uriBuilder = uriInfo.getBaseUriBuilder();
 163         uriBuilder.path("data");
 164         uriBuilder.path(ParserIdentifier.stringFromYangInstanceIdentifier(transactionNode.getInstanceIdentifier().getInstanceIdentifier(),
 165                 schemaContextRef.get()));
 166
 167         return uriBuilder.build();
 168     }
 169 }