2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.restconf.nb.rfc8040.rests.utils;
10 import com.google.common.util.concurrent.FluentFuture;
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;
41 * Util class to post data to DS.
43 public final class PostDataTransactionUtil {
44 private static final Logger LOG = LoggerFactory.getLogger(PostDataTransactionUtil.class);
45 private static final String POST_TX_TYPE = "POST";
47 private PostDataTransactionUtil() {
52 * Check mount point and prepare variables for post data. Close {@link DOMTransactionChain} if any inside of object
53 * {@link RestconfStrategy} provided as a parameter.
55 * @param uriInfo uri info
57 * @param strategy Object that perform the actual DS operations
58 * @param schemaContext reference to actual {@link EffectiveModelContext}
60 * @param insert insert
61 * @return {@link Response}
63 public static Response postData(final UriInfo uriInfo, final NormalizedNodeContext payload,
64 final RestconfStrategy strategy,
65 final EffectiveModelContext schemaContext, final Insert insert,
67 final YangInstanceIdentifier path = payload.getInstanceIdentifierContext().getInstanceIdentifier();
68 final FluentFuture<? extends CommitInfo> future = submitData(path, payload.getData(),
69 strategy, schemaContext, insert, point);
70 final URI location = resolveLocation(uriInfo, path, schemaContext, payload.getData());
71 final ResponseFactory dataFactory = new ResponseFactory(Status.CREATED).location(location);
72 //This method will close transactionChain if any
73 FutureCallbackTx.addCallback(future, POST_TX_TYPE, dataFactory, path);
74 return dataFactory.build();
82 * @param strategy object that perform the actual DS operations
83 * @param schemaContext schema context of data
84 * @param point query parameter
85 * @param insert query parameter
86 * @return {@link FluentFuture}
88 private static FluentFuture<? extends CommitInfo> submitData(final YangInstanceIdentifier path,
89 final NormalizedNode data,
90 final RestconfStrategy strategy,
91 final EffectiveModelContext schemaContext,
92 final Insert insert, final String point) {
93 final RestconfTransaction transaction = strategy.prepareWriteExecution();
95 makePost(path, data, schemaContext, transaction);
96 return transaction.commit();
99 PutDataTransactionUtil.checkListAndOrderedType(schemaContext, path);
100 final NormalizedNode readData;
103 readData = PutDataTransactionUtil.readList(strategy, path.getParent().getParent());
104 if (readData == null || ((NormalizedNodeContainer<?>) readData).isEmpty()) {
105 transaction.replace(path, data, schemaContext);
106 return transaction.commit();
108 checkItemDoesNotExists(strategy.exists(LogicalDatastoreType.CONFIGURATION, path), path);
109 transaction.remove(path.getParent().getParent());
110 transaction.replace(path, data, schemaContext);
111 transaction.replace(path.getParent().getParent(), readData, schemaContext);
112 return transaction.commit();
114 makePost(path, data, schemaContext, transaction);
115 return transaction.commit();
117 readData = PutDataTransactionUtil.readList(strategy, path.getParent().getParent());
118 if (readData == null || ((NormalizedNodeContainer<?>) readData).isEmpty()) {
119 transaction.replace(path, data, schemaContext);
120 return transaction.commit();
122 checkItemDoesNotExists(strategy.exists(LogicalDatastoreType.CONFIGURATION, path), path);
123 insertWithPointPost(path, data, schemaContext, point,
124 (NormalizedNodeContainer<?>) readData, true, transaction);
125 return transaction.commit();
127 readData = PutDataTransactionUtil.readList(strategy, path.getParent().getParent());
128 if (readData == null || ((NormalizedNodeContainer<?>) readData).isEmpty()) {
129 transaction.replace(path, data, schemaContext);
130 return transaction.commit();
132 checkItemDoesNotExists(strategy.exists(LogicalDatastoreType.CONFIGURATION, path), path);
133 insertWithPointPost(path, data, schemaContext, point,
134 (NormalizedNodeContainer<?>) readData, false, transaction);
135 return transaction.commit();
137 throw new RestconfDocumentedException(
138 "Used bad value of insert parameter. Possible values are first, last, before or after, but was: "
139 + insert, ErrorType.PROTOCOL, ErrorTag.BAD_ATTRIBUTE);
143 private static void insertWithPointPost(final YangInstanceIdentifier path, final NormalizedNode data,
144 final EffectiveModelContext schemaContext, final String point,
145 final NormalizedNodeContainer<?> readList, final boolean before,
146 final RestconfTransaction transaction) {
147 final YangInstanceIdentifier parent = path.getParent().getParent();
148 transaction.remove(parent);
149 final InstanceIdentifierContext<?> instanceIdentifier =
150 ParserIdentifier.toInstanceIdentifier(point, schemaContext, Optional.empty());
151 int lastItemPosition = 0;
152 for (final NormalizedNode nodeChild : readList.body()) {
153 if (nodeChild.getIdentifier().equals(instanceIdentifier.getInstanceIdentifier().getLastPathArgument())) {
161 int lastInsertedPosition = 0;
162 final NormalizedNode emptySubtree = ImmutableNodes.fromInstanceId(schemaContext, parent);
163 transaction.merge(YangInstanceIdentifier.create(emptySubtree.getIdentifier()), emptySubtree);
164 for (final NormalizedNode nodeChild : readList.body()) {
165 if (lastInsertedPosition == lastItemPosition) {
166 transaction.replace(path, data, schemaContext);
168 final YangInstanceIdentifier childPath = parent.node(nodeChild.getIdentifier());
169 transaction.replace(childPath, nodeChild, schemaContext);
170 lastInsertedPosition++;
174 private static void makePost(final YangInstanceIdentifier path, final NormalizedNode data,
175 final SchemaContext schemaContext, final RestconfTransaction transaction) {
177 transaction.create(path, data, schemaContext);
178 } catch (RestconfDocumentedException e) {
179 // close transaction if any and pass exception further
180 transaction.cancel();
186 * Get location from {@link YangInstanceIdentifier} and {@link UriInfo}.
188 * @param uriInfo uri info
189 * @param initialPath data path
190 * @param schemaContext reference to {@link SchemaContext}
191 * @return {@link URI}
193 private static URI resolveLocation(final UriInfo uriInfo, final YangInstanceIdentifier initialPath,
194 final EffectiveModelContext schemaContext, final NormalizedNode data) {
195 if (uriInfo == null) {
199 YangInstanceIdentifier path = initialPath;
200 if (data instanceof MapNode) {
201 final Collection<MapEntryNode> children = ((MapNode) data).body();
202 if (!children.isEmpty()) {
203 path = path.node(children.iterator().next().getIdentifier());
207 return uriInfo.getBaseUriBuilder()
209 .path(ParserIdentifier.stringFromYangInstanceIdentifier(path, schemaContext))
214 * Check if items do NOT already exists at specified {@code path}. Throws {@link RestconfDocumentedException} if
215 * data already exists.
217 * @param isExistsFuture if checked data exists
218 * @param path Path to be checked
220 public static void checkItemDoesNotExists(final FluentFuture<Boolean> isExistsFuture,
221 final YangInstanceIdentifier path) {
222 final FutureDataFactory<Boolean> response = new FutureDataFactory<>();
223 FutureCallbackTx.addCallback(isExistsFuture, POST_TX_TYPE, response);
225 if (response.result) {
226 LOG.trace("Operation via Restconf was not executed because data at {} already exists", path);
227 throw new RestconfDocumentedException(
228 "Data already exists", ErrorType.PROTOCOL, ErrorTag.DATA_EXISTS, path);