netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/sal/tx/WriteRunningTx.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.netconf.sal.connect.netconf.sal.tx;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.util.concurrent.ListenableFuture;
  13 import java.util.ArrayList;
  14 import java.util.List;
  15 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  16 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfBaseOps;
  17 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfRpcFutureCallback;
  18 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  19 import org.opendaylight.yangtools.yang.common.RpcResult;
  20 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  22 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  23 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  24 import org.slf4j.Logger;
  25 import org.slf4j.LoggerFactory;
  26
  27 /**
  28  * Tx implementation for netconf devices that support only writable-running with no candidate.
  29  * The sequence goes as:
  30  * <ol>
  31  *   <li>Lock running datastore on tx construction
  32  *     <ul>
  33  *       <li> Lock has to succeed, if it does not, transaction is failed</li>
  34  *     </ul>
  35  *   </li>
  36  *   <li>Edit-config in running N times
  37  *     <ul>
  38  *       <li>If any issue occurs during edit, datastore is unlocked and an exception is thrown</li>
  39  *     </ul>
  40  *   </li>
  41  *   <li>Unlock running datastore on tx commit</li>
  42  * </ol>
  43  */
  44 public class WriteRunningTx extends AbstractWriteTx {
  45
  46     private static final Logger LOG  = LoggerFactory.getLogger(WriteRunningTx.class);
  47     private final List<Change> changes = new ArrayList<>();
  48
  49     public WriteRunningTx(final RemoteDeviceId id, final NetconfBaseOps netOps,
  50                           final boolean rollbackSupport) {
  51         super(netOps, id, rollbackSupport);
  52     }
  53
  54     @Override
  55     protected synchronized void init() {
  56         lock();
  57     }
  58
  59     private void lock() {
  60         resultsFutures.add(netOps.lockRunning(new NetconfRpcFutureCallback("Lock running", id)));
  61     }
  62
  63     @Override
  64     protected void cleanup() {
  65         unlock();
  66     }
  67
  68     @Override
  69     public synchronized ListenableFuture<RpcResult<Void>> performCommit() {
  70         for (final Change change : changes) {
  71             resultsFutures.add(change.execute(id, netOps, rollbackSupport));
  72         }
  73         unlock();
  74         return resultsToTxStatus();
  75     }
  76
  77     @Override
  78     protected void editConfig(final YangInstanceIdentifier path,
  79                               final Optional<NormalizedNode<?, ?>> data,
  80                               final DataContainerChild<?, ?> editStructure,
  81                               final Optional<ModifyAction> defaultOperation,
  82                               final String operation) {
  83         changes.add(new Change(editStructure, defaultOperation));
  84     }
  85
  86     private void unlock() {
  87         netOps.unlockRunning(new NetconfRpcFutureCallback("Unlock running", id));
  88     }
  89
  90     private static final class Change {
  91
  92         private final DataContainerChild<?, ?> editStructure;
  93         private final Optional<ModifyAction> defaultOperation;
  94
  95         Change(final DataContainerChild<?, ?> editStructure, final Optional<ModifyAction> defaultOperation) {
  96             this.editStructure = editStructure;
  97             this.defaultOperation = defaultOperation;
  98         }
  99
 100         private ListenableFuture<DOMRpcResult> execute(final RemoteDeviceId id, final NetconfBaseOps netOps,
 101                                                        final boolean rollbackSupport) {
 102             final NetconfRpcFutureCallback editConfigCallback = new NetconfRpcFutureCallback("Edit running", id);
 103             if (defaultOperation.isPresent()) {
 104                 return netOps.editConfigRunning(editConfigCallback, editStructure, defaultOperation.get(),
 105                     rollbackSupport);
 106             } else {
 107                 return netOps.editConfigRunning(editConfigCallback, editStructure, rollbackSupport);
 108             }
 109         }
 110     }
 111 }