2 * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.transactions;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.collect.ImmutableList;
13 import com.google.common.util.concurrent.FluentFuture;
14 import com.google.common.util.concurrent.FutureCallback;
15 import com.google.common.util.concurrent.Futures;
16 import com.google.common.util.concurrent.ListenableFuture;
17 import com.google.common.util.concurrent.MoreExecutors;
18 import com.google.common.util.concurrent.SettableFuture;
19 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
20 import java.util.ArrayList;
21 import java.util.Collection;
22 import java.util.Collections;
23 import java.util.List;
24 import java.util.Optional;
25 import java.util.StringJoiner;
26 import java.util.function.Supplier;
27 import java.util.stream.Collectors;
28 import org.eclipse.jdt.annotation.NonNull;
29 import org.opendaylight.mdsal.common.api.CommitInfo;
30 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
31 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
32 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
33 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
34 import org.opendaylight.netconf.api.DocumentedException;
35 import org.opendaylight.netconf.api.NetconfDocumentedException;
36 import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
37 import org.opendaylight.yangtools.yang.common.RpcError;
38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
39 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
40 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
41 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
42 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
43 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
44 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
45 import org.slf4j.Logger;
46 import org.slf4j.LoggerFactory;
48 final class NetconfRestconfTransaction extends RestconfTransaction {
50 private static final Logger LOG = LoggerFactory.getLogger(NetconfRestconfTransaction.class);
52 private final NetconfDataTreeService netconfService;
53 private final List<ListenableFuture<? extends DOMRpcResult>> resultsFutures =
54 Collections.synchronizedList(new ArrayList<>());
55 private volatile boolean isLocked = false;
57 NetconfRestconfTransaction(final NetconfDataTreeService netconfService) {
58 this.netconfService = requireNonNull(netconfService);
59 final ListenableFuture<? extends DOMRpcResult> lockResult = netconfService.lock();
60 Futures.addCallback(lockResult, lockOperationCallback, MoreExecutors.directExecutor());
61 resultsFutures.add(lockResult);
65 public void cancel() {
66 resultsFutures.clear();
67 executeWithLogging(netconfService::discardChanges);
68 executeWithLogging(netconfService::unlock);
72 public void delete(final LogicalDatastoreType store, final YangInstanceIdentifier path) {
73 enqueueOperation(() -> netconfService.delete(store, path));
77 public void remove(final LogicalDatastoreType store, final YangInstanceIdentifier path) {
78 enqueueOperation(() -> netconfService.remove(store, path));
82 public void merge(final LogicalDatastoreType store, final YangInstanceIdentifier path, final NormalizedNode data) {
83 enqueueOperation(() -> netconfService.merge(store, path, data, Optional.empty()));
87 public void create(final LogicalDatastoreType store, final YangInstanceIdentifier path,
88 final NormalizedNode data, final SchemaContext schemaContext) {
89 if (data instanceof MapNode || data instanceof LeafSetNode) {
90 final NormalizedNode emptySubTree = ImmutableNodes.fromInstanceId(schemaContext, path);
91 merge(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier.create(emptySubTree.getIdentifier()),
94 for (final NormalizedNode child : ((NormalizedNodeContainer<?>) data).body()) {
95 final YangInstanceIdentifier childPath = path.node(child.getIdentifier());
96 enqueueOperation(() -> netconfService.create(store, childPath, child, Optional.empty()));
99 enqueueOperation(() -> netconfService.create(store, path, data, Optional.empty()));
104 public void replace(final LogicalDatastoreType store, final YangInstanceIdentifier path, final NormalizedNode data,
105 final SchemaContext schemaContext) {
106 if (data instanceof MapNode || data instanceof LeafSetNode) {
107 final NormalizedNode emptySubTree = ImmutableNodes.fromInstanceId(schemaContext, path);
108 merge(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier.create(emptySubTree.getIdentifier()),
111 for (final NormalizedNode child : ((NormalizedNodeContainer<?>) data).body()) {
112 final YangInstanceIdentifier childPath = path.node(child.getIdentifier());
113 enqueueOperation(() -> netconfService.replace(store, childPath, child, Optional.empty()));
116 enqueueOperation(() -> netconfService.replace(store, path, data, Optional.empty()));
121 public FluentFuture<? extends @NonNull CommitInfo> commit() {
122 final SettableFuture<CommitInfo> commitResult = SettableFuture.create();
124 // First complete all resultsFutures and merge them ...
125 final ListenableFuture<DOMRpcResult> resultErrors = mergeFutures(resultsFutures);
127 // ... then evaluate if there are any problems
128 Futures.addCallback(resultErrors, new FutureCallback<>() {
130 public void onSuccess(final DOMRpcResult result) {
131 final Collection<? extends RpcError> errors = result.getErrors();
132 if (!allWarnings(errors)) {
133 Futures.whenAllComplete(discardAndUnlock()).run(
134 () -> commitResult.setException(toCommitFailedException(errors)),
135 MoreExecutors.directExecutor());
139 // ... no problems so far, initiate commit
140 Futures.addCallback(netconfService.commit(), new FutureCallback<DOMRpcResult>() {
142 public void onSuccess(final DOMRpcResult rpcResult) {
143 final Collection<? extends RpcError> errors = result.getErrors();
144 if (errors.isEmpty()) {
145 Futures.whenAllComplete(netconfService.unlock()).run(
146 () -> commitResult.set(CommitInfo.empty()),
147 MoreExecutors.directExecutor());
148 } else if (allWarnings(errors)) {
149 LOG.info("Commit successful with warnings {}", errors);
150 Futures.whenAllComplete(netconfService.unlock()).run(
151 () -> commitResult.set(CommitInfo.empty()),
152 MoreExecutors.directExecutor());
154 Futures.whenAllComplete(discardAndUnlock()).run(
155 () -> commitResult.setException(toCommitFailedException(errors)),
156 MoreExecutors.directExecutor());
161 public void onFailure(final Throwable throwable) {
162 Futures.whenAllComplete(discardAndUnlock()).run(
163 () -> commitResult.setException(throwable),
164 MoreExecutors.directExecutor());
166 }, MoreExecutors.directExecutor());
170 public void onFailure(final Throwable throwable) {
171 Futures.whenAllComplete(discardAndUnlock()).run(() -> commitResult.setException(throwable),
172 MoreExecutors.directExecutor());
174 }, MoreExecutors.directExecutor());
176 return FluentFuture.from(commitResult);
179 @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
180 justification = "https://github.com/spotbugs/spotbugs/issues/811")
181 private List<ListenableFuture<?>> discardAndUnlock() {
182 // execute discard & unlock operations only if lock operation was completed successfully
184 return List.of(netconfService.discardChanges(), netconfService.unlock());
186 return Collections.emptyList();
190 private final FutureCallback<DOMRpcResult> lockOperationCallback = new FutureCallback<>() {
192 public void onSuccess(final DOMRpcResult rpcResult) {
193 if (rpcResult != null && allWarnings(rpcResult.getErrors())) {
199 public void onFailure(final Throwable throwable) {
204 private void enqueueOperation(final Supplier<ListenableFuture<? extends DOMRpcResult>> operation) {
205 final ListenableFuture<? extends DOMRpcResult> operationFuture;
206 synchronized (resultsFutures) {
207 // if we only have result for the lock operation ...
208 if (resultsFutures.size() == 1) {
209 operationFuture = Futures.transformAsync(resultsFutures.get(0),
211 // ... then add new operation to the chain if lock was successful
212 if (result != null && (result.getErrors().isEmpty() || allWarnings(result.getErrors()))) {
213 return operation.get();
215 return Futures.immediateFailedFuture(new NetconfDocumentedException("Lock operation failed",
216 DocumentedException.ErrorType.APPLICATION, DocumentedException.ErrorTag.LOCK_DENIED,
217 DocumentedException.ErrorSeverity.ERROR));
220 MoreExecutors.directExecutor());
222 // ... otherwise just add operation to the execution chain
223 operationFuture = Futures.transformAsync(resultsFutures.get(resultsFutures.size() - 1),
224 future -> operation.get(),
225 MoreExecutors.directExecutor());
227 // ... finally save operation related future to the list
228 resultsFutures.add(operationFuture);
232 // Transform list of futures related to RPC operation into a single Future
233 private static ListenableFuture<DOMRpcResult> mergeFutures(
234 final List<ListenableFuture<? extends DOMRpcResult>> futures) {
235 return Futures.whenAllComplete(futures).call(() -> {
236 if (futures.size() == 1) {
238 return Futures.getDone(futures.get(0));
241 final var builder = ImmutableList.<RpcError>builder();
242 for (ListenableFuture<? extends DOMRpcResult> future : futures) {
243 builder.addAll(Futures.getDone(future).getErrors());
245 return new DefaultDOMRpcResult(null, builder.build());
246 }, MoreExecutors.directExecutor());
249 @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
250 justification = "https://github.com/spotbugs/spotbugs/issues/811")
251 private static TransactionCommitFailedException toCommitFailedException(
252 final Collection<? extends RpcError> errors) {
253 DocumentedException.ErrorType errType = DocumentedException.ErrorType.APPLICATION;
254 DocumentedException.ErrorSeverity errSeverity = DocumentedException.ErrorSeverity.ERROR;
255 StringJoiner msgBuilder = new StringJoiner(" ");
256 String errorTag = "operation-failed";
257 for (final RpcError error : errors) {
258 switch (error.getErrorType()) {
260 errType = DocumentedException.ErrorType.RPC;
263 errType = DocumentedException.ErrorType.PROTOCOL;
266 errType = DocumentedException.ErrorType.TRANSPORT;
270 errType = DocumentedException.ErrorType.APPLICATION;
273 switch (error.getSeverity()) {
275 errSeverity = DocumentedException.ErrorSeverity.WARNING;
279 errSeverity = DocumentedException.ErrorSeverity.ERROR;
282 msgBuilder.add(error.getMessage());
283 msgBuilder.add(error.getInfo());
284 errorTag = error.getTag();
287 return new TransactionCommitFailedException("Netconf transaction commit failed",
288 new NetconfDocumentedException("RPC during tx failed. " + msgBuilder.toString(), errType,
289 DocumentedException.ErrorTag.from(errorTag), errSeverity));
292 private static void executeWithLogging(final Supplier<ListenableFuture<? extends DOMRpcResult>> operation) {
293 final ListenableFuture<? extends DOMRpcResult> operationResult = operation.get();
294 Futures.addCallback(operationResult, new FutureCallback<DOMRpcResult>() {
296 public void onSuccess(final DOMRpcResult rpcResult) {
297 if (rpcResult != null && !rpcResult.getErrors().isEmpty()) {
298 LOG.error("Errors occurred during processing of the RPC operation: {}",
299 rpcResult.getErrors().stream().map(Object::toString).collect(Collectors.joining(",")));
304 public void onFailure(final Throwable throwable) {
305 LOG.error("Error processing operation", throwable);
307 }, MoreExecutors.directExecutor());
310 @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
311 justification = "https://github.com/spotbugs/spotbugs/issues/811")
312 private static boolean allWarnings(final Collection<? extends @NonNull RpcError> errors) {
313 return errors.stream().allMatch(error -> error.getSeverity() == RpcError.ErrorSeverity.WARNING);