2 * Copyright (c) 2014 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
9 package org.opendaylight.netconf.sal.connect.netconf.sal.tx;
11 import com.google.common.base.Function;
12 import com.google.common.base.Optional;
13 import com.google.common.util.concurrent.CheckedFuture;
14 import com.google.common.util.concurrent.Futures;
15 import com.google.common.util.concurrent.ListenableFuture;
16 import java.util.ArrayList;
17 import java.util.List;
18 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
19 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
20 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
21 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfBaseOps;
22 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfRpcFutureCallback;
23 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
24 import org.opendaylight.yangtools.yang.common.RpcResult;
25 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
27 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
28 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
29 import org.slf4j.Logger;
30 import org.slf4j.LoggerFactory;
33 * Tx implementation for netconf devices that support only writable-running with no candidate.
34 * The sequence goes as:
36 * <li>Lock running datastore on tx construction
38 * <li> Lock has to succeed, if it does not, transaction is failed</li>
41 * <li>Edit-config in running N times
43 * <li>If any issue occurs during edit, datastore is unlocked and an exception is thrown</li>
46 * <li>Unlock running datastore on tx commit</li>
49 public class WriteRunningTx extends AbstractWriteTx {
51 private static final Logger LOG = LoggerFactory.getLogger(WriteRunningTx.class);
52 private final List<Change> changes = new ArrayList<>();
54 public WriteRunningTx(final RemoteDeviceId id, final NetconfBaseOps netOps,
55 final boolean rollbackSupport) {
56 super(netOps, id, rollbackSupport);
60 protected synchronized void init() {
65 resultsFutures.add(netOps.lockRunning(new NetconfRpcFutureCallback("Lock running", id)));
69 protected void cleanup() {
74 public synchronized CheckedFuture<Void, TransactionCommitFailedException> submit() {
75 final ListenableFuture<Void> commmitFutureAsVoid = Futures.transform(commit(),
76 (Function<RpcResult<TransactionStatus>, Void>) input -> null);
78 return Futures.makeChecked(commmitFutureAsVoid,
79 input -> new TransactionCommitFailedException("Submit of transaction " + getIdentifier() + " failed",
84 public synchronized ListenableFuture<RpcResult<TransactionStatus>> performCommit() {
85 for (final Change change : changes) {
86 resultsFutures.add(change.execute(id, netOps, rollbackSupport));
89 return resultsToTxStatus();
93 protected void editConfig(final YangInstanceIdentifier path,
94 final Optional<NormalizedNode<?, ?>> data,
95 final DataContainerChild<?, ?> editStructure,
96 final Optional<ModifyAction> defaultOperation,
97 final String operation) {
98 changes.add(new Change(editStructure, defaultOperation));
101 private void unlock() {
102 netOps.unlockRunning(new NetconfRpcFutureCallback("Unlock running", id));
105 private static class Change {
107 private final DataContainerChild<?, ?> editStructure;
108 private final Optional<ModifyAction> defaultOperation;
110 private Change(final DataContainerChild<?, ?> editStructure, final Optional<ModifyAction> defaultOperation) {
111 this.editStructure = editStructure;
112 this.defaultOperation = defaultOperation;
115 private ListenableFuture<DOMRpcResult> execute(final RemoteDeviceId id, final NetconfBaseOps netOps,
116 final boolean rollbackSupport) {
117 final NetconfRpcFutureCallback editConfigCallback = new NetconfRpcFutureCallback("Edit running", id);
118 if (defaultOperation.isPresent()) {
119 return netOps.editConfigRunning(editConfigCallback, editStructure, defaultOperation.get(),
122 return netOps.editConfigRunning(editConfigCallback, editStructure, rollbackSupport);