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.common.errors.RestconfError;
24 import org.opendaylight.restconf.common.errors.RestconfError.ErrorTag;
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.rests.utils.RestconfDataServiceConstant.PostPutQueryParameters.Insert;
28 import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier;
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;
42 * Util class to post data to DS.
45 public final class PostDataTransactionUtil {
46 private static final Logger LOG = LoggerFactory.getLogger(PostDataTransactionUtil.class);
47 // FIXME: why is this being reused from other places?
48 static final String POST_TX_TYPE = "POST";
50 private PostDataTransactionUtil() {
55 * Check mount point and prepare variables for post data. Close {@link DOMTransactionChain} if any inside of object
56 * {@link RestconfStrategy} provided as a parameter.
58 * @param uriInfo uri info
60 * @param strategy Object that perform the actual DS operations
61 * @param schemaContext reference to actual {@link EffectiveModelContext}
63 * @param insert insert
64 * @return {@link Response}
66 public static Response postData(final UriInfo uriInfo, final NormalizedNodeContext payload,
67 final RestconfStrategy strategy,
68 final EffectiveModelContext schemaContext, final Insert insert,
70 final YangInstanceIdentifier path = payload.getInstanceIdentifierContext().getInstanceIdentifier();
71 final FluentFuture<? extends CommitInfo> future = submitData(path, payload.getData(),
72 strategy, schemaContext, insert, point);
73 final URI location = resolveLocation(uriInfo, path, schemaContext, payload.getData());
74 final ResponseFactory dataFactory = new ResponseFactory(Status.CREATED).location(location);
75 //This method will close transactionChain if any
76 FutureCallbackTx.addCallback(future, POST_TX_TYPE, dataFactory, strategy, path);
77 return dataFactory.build();
85 * @param strategy object that perform the actual DS operations
86 * @param schemaContext schema context of data
87 * @param point query parameter
88 * @param insert query parameter
89 * @return {@link FluentFuture}
91 private static FluentFuture<? extends CommitInfo> submitData(final YangInstanceIdentifier path,
92 final NormalizedNode data,
93 final RestconfStrategy strategy,
94 final EffectiveModelContext schemaContext,
95 final Insert insert, final String point) {
96 final RestconfTransaction transaction = strategy.prepareWriteExecution();
98 makePost(path, data, schemaContext, transaction);
99 return transaction.commit();
102 PutDataTransactionUtil.checkListAndOrderedType(schemaContext, path);
103 final NormalizedNode readData;
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();
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();
117 makePost(path, data, schemaContext, transaction);
118 return transaction.commit();
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();
125 checkItemDoesNotExists(strategy.exists(LogicalDatastoreType.CONFIGURATION, path), path);
126 insertWithPointPost(path, data, schemaContext, point,
127 (NormalizedNodeContainer<?>) readData, true, transaction);
128 return transaction.commit();
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();
135 checkItemDoesNotExists(strategy.exists(LogicalDatastoreType.CONFIGURATION, path), path);
136 insertWithPointPost(path, data, schemaContext, point,
137 (NormalizedNodeContainer<?>) readData, false, transaction);
138 return transaction.commit();
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, RestconfError.ErrorTag.BAD_ATTRIBUTE);
146 private static void insertWithPointPost(final YangInstanceIdentifier path, final NormalizedNode data,
147 final EffectiveModelContext schemaContext, final String 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 ParserIdentifier.toInstanceIdentifier(point, schemaContext, Optional.empty());
154 int lastItemPosition = 0;
155 for (final NormalizedNode nodeChild : readList.body()) {
156 if (nodeChild.getIdentifier().equals(instanceIdentifier.getInstanceIdentifier().getLastPathArgument())) {
164 int lastInsertedPosition = 0;
165 final NormalizedNode emptySubtree = ImmutableNodes.fromInstanceId(schemaContext, parent);
166 transaction.merge(YangInstanceIdentifier.create(emptySubtree.getIdentifier()), emptySubtree);
167 for (final NormalizedNode nodeChild : readList.body()) {
168 if (lastInsertedPosition == lastItemPosition) {
169 transaction.replace(path, data, schemaContext);
171 final YangInstanceIdentifier childPath = parent.node(nodeChild.getIdentifier());
172 transaction.replace(childPath, nodeChild, schemaContext);
173 lastInsertedPosition++;
177 private static void makePost(final YangInstanceIdentifier path, final NormalizedNode data,
178 final SchemaContext schemaContext, final RestconfTransaction transaction) {
180 transaction.create(path, data, schemaContext);
181 } catch (RestconfDocumentedException e) {
182 // close transaction if any and pass exception further
183 transaction.cancel();
189 * Get location from {@link YangInstanceIdentifier} and {@link UriInfo}.
191 * @param uriInfo uri info
192 * @param initialPath data path
193 * @param schemaContext reference to {@link SchemaContext}
194 * @return {@link URI}
196 private static URI resolveLocation(final UriInfo uriInfo, final YangInstanceIdentifier initialPath,
197 final EffectiveModelContext schemaContext, final NormalizedNode data) {
198 if (uriInfo == null) {
202 YangInstanceIdentifier path = initialPath;
203 if (data instanceof MapNode) {
204 final Collection<MapEntryNode> children = ((MapNode) data).body();
205 if (!children.isEmpty()) {
206 path = path.node(children.iterator().next().getIdentifier());
210 return uriInfo.getBaseUriBuilder()
212 .path(ParserIdentifier.stringFromYangInstanceIdentifier(path, schemaContext))
217 * Check if items do NOT already exists at specified {@code path}. Throws {@link RestconfDocumentedException} if
218 * data already exists.
220 * @param isExistsFuture if checked data exists
221 * @param path Path to be checked
223 public static void checkItemDoesNotExists(final FluentFuture<Boolean> isExistsFuture,
224 final YangInstanceIdentifier path) {
225 final FutureDataFactory<Boolean> response = new FutureDataFactory<>();
226 FutureCallbackTx.addCallback(isExistsFuture, POST_TX_TYPE, response);
228 if (response.result) {
229 LOG.trace("Operation via Restconf was not executed because data at {} already exists", path);
230 throw new RestconfDocumentedException(
231 "Data already exists", ErrorType.PROTOCOL, ErrorTag.DATA_EXISTS, path);