2 * Copyright (c) 2014, 2015 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.netconf.sal.connect.netconf.sal.tx;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static com.google.common.base.Preconditions.checkState;
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.List;
23 import java.util.Optional;
24 import java.util.concurrent.CopyOnWriteArrayList;
25 import org.opendaylight.mdsal.common.api.CommitInfo;
26 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
27 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
28 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
29 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
30 import org.opendaylight.netconf.api.DocumentedException;
31 import org.opendaylight.netconf.api.ModifyAction;
32 import org.opendaylight.netconf.api.NetconfDocumentedException;
33 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfBaseOps;
34 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
35 import org.opendaylight.yangtools.yang.common.RpcError;
36 import org.opendaylight.yangtools.yang.common.RpcResult;
37 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
39 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
40 import org.opendaylight.yangtools.yang.data.api.schema.MixinNode;
41 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
45 public abstract class AbstractWriteTx implements DOMDataTreeWriteTransaction {
47 private static final Logger LOG = LoggerFactory.getLogger(AbstractWriteTx.class);
49 protected final RemoteDeviceId id;
50 protected final NetconfBaseOps netOps;
51 protected final boolean rollbackSupport;
52 protected final List<ListenableFuture<? extends DOMRpcResult>> resultsFutures = new ArrayList<>();
53 private final List<TxListener> listeners = new CopyOnWriteArrayList<>();
54 // Allow commit to be called only once
55 protected volatile boolean finished = false;
56 protected final boolean isLockAllowed;
58 public AbstractWriteTx(final RemoteDeviceId id, final NetconfBaseOps netconfOps, final boolean rollbackSupport,
59 final boolean isLockAllowed) {
60 this.netOps = netconfOps;
62 this.rollbackSupport = rollbackSupport;
63 this.isLockAllowed = isLockAllowed;
67 protected static boolean isSuccess(final DOMRpcResult result) {
68 return result.getErrors().isEmpty();
71 protected void checkNotFinished() {
72 checkState(!isFinished(), "%s: Transaction %s already finished", id, getIdentifier());
75 protected boolean isFinished() {
80 public synchronized boolean cancel() {
84 listeners.forEach(listener -> listener.onTransactionCancelled(this));
90 protected abstract void init();
92 protected abstract void cleanup();
95 public Object getIdentifier() {
100 public synchronized void put(final LogicalDatastoreType store, final YangInstanceIdentifier path,
101 final NormalizedNode data) {
102 checkEditable(store);
104 // Trying to write only mixin nodes (not visible when serialized).
105 // Ignoring. Some devices cannot handle empty edit-config rpc
106 if (containsOnlyNonVisibleData(path, data)) {
107 LOG.debug("Ignoring put for {} and data {}. Resulting data structure is empty.", path, data);
111 final DataContainerChild editStructure = netOps.createEditConfigStrcture(Optional.ofNullable(data),
112 Optional.of(ModifyAction.REPLACE), path);
113 editConfig(path, Optional.ofNullable(data), editStructure, Optional.empty(), "put");
117 public synchronized void merge(final LogicalDatastoreType store, final YangInstanceIdentifier path,
118 final NormalizedNode data) {
119 checkEditable(store);
121 // Trying to write only mixin nodes (not visible when serialized).
122 // Ignoring. Some devices cannot handle empty edit-config rpc
123 if (containsOnlyNonVisibleData(path, data)) {
124 LOG.debug("Ignoring merge for {} and data {}. Resulting data structure is empty.", path, data);
128 final DataContainerChild editStructure = netOps.createEditConfigStrcture(Optional.ofNullable(data),
129 Optional.empty(), path);
130 editConfig(path, Optional.ofNullable(data), editStructure, Optional.empty(), "merge");
134 * Check whether the data to be written consists only from mixins.
136 private static boolean containsOnlyNonVisibleData(final YangInstanceIdentifier path, final NormalizedNode data) {
137 // There's only one such case:top level list (pathArguments == 1 && data is Mixin)
138 // any other mixin nodes are contained by a "regular" node thus visible when serialized
139 return path.getPathArguments().size() == 1 && data instanceof MixinNode;
143 public synchronized void delete(final LogicalDatastoreType store, final YangInstanceIdentifier path) {
144 checkEditable(store);
145 final DataContainerChild editStructure = netOps.createEditConfigStrcture(Optional.empty(),
146 Optional.of(ModifyAction.DELETE), path);
147 editConfig(path, Optional.empty(), editStructure, Optional.of(ModifyAction.NONE), "delete");
151 public FluentFuture<? extends CommitInfo> commit() {
152 final SettableFuture<CommitInfo> resultFuture = SettableFuture.create();
153 Futures.addCallback(commitConfiguration(), new FutureCallback<RpcResult<Void>>() {
155 public void onSuccess(final RpcResult<Void> result) {
156 if (!result.isSuccessful()) {
157 final Collection<RpcError> errors = result.getErrors();
158 resultFuture.setException(new TransactionCommitFailedException(
159 String.format("Commit of transaction %s failed", getIdentifier()),
160 errors.toArray(new RpcError[errors.size()])));
164 resultFuture.set(CommitInfo.empty());
168 public void onFailure(final Throwable failure) {
169 resultFuture.setException(new TransactionCommitFailedException(
170 String.format("Commit of transaction %s failed", getIdentifier()), failure));
172 }, MoreExecutors.directExecutor());
174 return FluentFuture.from(resultFuture);
177 protected final ListenableFuture<RpcResult<Void>> commitConfiguration() {
178 listeners.forEach(listener -> listener.onTransactionSubmitted(this));
181 final ListenableFuture<RpcResult<Void>> result = performCommit();
182 Futures.addCallback(result, new FutureCallback<RpcResult<Void>>() {
184 public void onSuccess(final RpcResult<Void> rpcResult) {
185 if (rpcResult.isSuccessful()) {
186 listeners.forEach(txListener -> txListener.onTransactionSuccessful(AbstractWriteTx.this));
188 final TransactionCommitFailedException cause =
189 new TransactionCommitFailedException("Transaction failed",
190 rpcResult.getErrors().toArray(new RpcError[rpcResult.getErrors().size()]));
191 listeners.forEach(listener -> listener.onTransactionFailed(AbstractWriteTx.this, cause));
196 public void onFailure(final Throwable throwable) {
197 listeners.forEach(listener -> listener.onTransactionFailed(AbstractWriteTx.this, throwable));
199 }, MoreExecutors.directExecutor());
203 protected abstract ListenableFuture<RpcResult<Void>> performCommit();
205 private void checkEditable(final LogicalDatastoreType store) {
207 checkArgument(store == LogicalDatastoreType.CONFIGURATION,
208 "Can edit only configuration data, not %s", store);
211 protected abstract void editConfig(YangInstanceIdentifier path, Optional<NormalizedNode> data,
212 DataContainerChild editStructure,
213 Optional<ModifyAction> defaultOperation, String operation);
215 protected ListenableFuture<RpcResult<Void>> resultsToTxStatus() {
216 final SettableFuture<RpcResult<Void>> transformed = SettableFuture.create();
218 Futures.addCallback(Futures.allAsList(resultsFutures), new FutureCallback<List<DOMRpcResult>>() {
220 public void onSuccess(final List<DOMRpcResult> domRpcResults) {
221 if (!transformed.isDone()) {
222 extractResult(domRpcResults, transformed);
227 public void onFailure(final Throwable throwable) {
228 final NetconfDocumentedException exception =
229 new NetconfDocumentedException(
230 id + ":RPC during tx returned an exception" + throwable.getMessage(),
231 new Exception(throwable),
232 DocumentedException.ErrorType.APPLICATION,
233 DocumentedException.ErrorTag.OPERATION_FAILED,
234 DocumentedException.ErrorSeverity.ERROR);
235 transformed.setException(exception);
237 }, MoreExecutors.directExecutor());
242 @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
243 justification = "https://github.com/spotbugs/spotbugs/issues/811")
244 private void extractResult(final List<DOMRpcResult> domRpcResults,
245 final SettableFuture<RpcResult<Void>> transformed) {
246 DocumentedException.ErrorType errType = DocumentedException.ErrorType.APPLICATION;
247 DocumentedException.ErrorSeverity errSeverity = DocumentedException.ErrorSeverity.ERROR;
248 StringBuilder msgBuilder = new StringBuilder();
249 boolean errorsEncouneterd = false;
250 String errorTag = "operation-failed";
252 for (final DOMRpcResult domRpcResult : domRpcResults) {
253 if (!domRpcResult.getErrors().isEmpty()) {
254 errorsEncouneterd = true;
255 final RpcError error = domRpcResult.getErrors().iterator().next();
256 final RpcError.ErrorType errorType = error.getErrorType();
259 errType = DocumentedException.ErrorType.RPC;
262 errType = DocumentedException.ErrorType.PROTOCOL;
265 errType = DocumentedException.ErrorType.TRANSPORT;
268 errType = DocumentedException.ErrorType.APPLICATION;
271 errType = DocumentedException.ErrorType.APPLICATION;
274 final RpcError.ErrorSeverity severity = error.getSeverity();
277 errSeverity = DocumentedException.ErrorSeverity.ERROR;
280 errSeverity = DocumentedException.ErrorSeverity.WARNING;
283 errSeverity = DocumentedException.ErrorSeverity.ERROR;
286 msgBuilder.append(error.getMessage());
287 msgBuilder.append(error.getInfo());
288 errorTag = error.getTag();
291 if (errorsEncouneterd) {
292 final NetconfDocumentedException exception = new NetconfDocumentedException(id
293 + ":RPC during tx failed. " + msgBuilder.toString(),
295 DocumentedException.ErrorTag.from(errorTag),
297 transformed.setException(exception);
300 transformed.set(RpcResultBuilder.<Void>success().build());
303 AutoCloseable addListener(final TxListener listener) {
304 listeners.add(listener);
305 return () -> listeners.remove(listener);