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

   1 /*
   2  * Copyright (c) 2014, 2015 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 package org.opendaylight.netconf.sal.connect.netconf.sal.tx;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12
  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.ErrorSeverity;
  36 import org.opendaylight.yangtools.yang.common.RpcError;
  37 import org.opendaylight.yangtools.yang.common.RpcResult;
  38 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  40 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  41 import org.opendaylight.yangtools.yang.data.api.schema.MixinNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  43 import org.slf4j.Logger;
  44 import org.slf4j.LoggerFactory;
  45
  46 public abstract class AbstractWriteTx implements DOMDataTreeWriteTransaction {
  47
  48     private static final Logger LOG  = LoggerFactory.getLogger(AbstractWriteTx.class);
  49
  50     protected final RemoteDeviceId id;
  51     protected final NetconfBaseOps netOps;
  52     protected final boolean rollbackSupport;
  53     protected final List<ListenableFuture<? extends DOMRpcResult>> resultsFutures = new ArrayList<>();
  54     private final List<TxListener> listeners = new CopyOnWriteArrayList<>();
  55     // Allow commit to be called only once
  56     protected volatile boolean finished = false;
  57     protected final boolean isLockAllowed;
  58
  59     public AbstractWriteTx(final RemoteDeviceId id, final NetconfBaseOps netconfOps, final boolean rollbackSupport,
  60             final boolean isLockAllowed) {
  61         this.netOps = netconfOps;
  62         this.id = id;
  63         this.rollbackSupport = rollbackSupport;
  64         this.isLockAllowed = isLockAllowed;
  65         init();
  66     }
  67
  68     protected static boolean isSuccess(final DOMRpcResult result) {
  69         return result.getErrors().isEmpty();
  70     }
  71
  72     protected void checkNotFinished() {
  73         checkState(!isFinished(), "%s: Transaction %s already finished", id, getIdentifier());
  74     }
  75
  76     protected boolean isFinished() {
  77         return finished;
  78     }
  79
  80     @Override
  81     public synchronized boolean cancel() {
  82         if (isFinished()) {
  83             return false;
  84         }
  85         listeners.forEach(listener -> listener.onTransactionCancelled(this));
  86         finished = true;
  87         cleanup();
  88         return true;
  89     }
  90
  91     protected abstract void init();
  92
  93     protected abstract void cleanup();
  94
  95     @Override
  96     public Object getIdentifier() {
  97         return this;
  98     }
  99
 100     @Override
 101     public synchronized void put(final LogicalDatastoreType store, final YangInstanceIdentifier path,
 102                                  final NormalizedNode data) {
 103         checkEditable(store);
 104
 105         // Trying to write only mixin nodes (not visible when serialized).
 106         // Ignoring. Some devices cannot handle empty edit-config rpc
 107         if (containsOnlyNonVisibleData(path, data)) {
 108             LOG.debug("Ignoring put for {} and data {}. Resulting data structure is empty.", path, data);
 109             return;
 110         }
 111
 112         final DataContainerChild editStructure = netOps.createEditConfigStrcture(Optional.ofNullable(data),
 113                         Optional.of(ModifyAction.REPLACE), path);
 114         editConfig(path, Optional.ofNullable(data), editStructure, Optional.empty(), "put");
 115     }
 116
 117     @Override
 118     public synchronized void merge(final LogicalDatastoreType store, final YangInstanceIdentifier path,
 119                                    final NormalizedNode data) {
 120         checkEditable(store);
 121
 122         // Trying to write only mixin nodes (not visible when serialized).
 123         // Ignoring. Some devices cannot handle empty edit-config rpc
 124         if (containsOnlyNonVisibleData(path, data)) {
 125             LOG.debug("Ignoring merge for {} and data {}. Resulting data structure is empty.", path, data);
 126             return;
 127         }
 128
 129         final DataContainerChild editStructure =  netOps.createEditConfigStrcture(Optional.ofNullable(data),
 130             Optional.empty(), path);
 131         editConfig(path, Optional.ofNullable(data), editStructure, Optional.empty(), "merge");
 132     }
 133
 134     /**
 135      * Check whether the data to be written consists only from mixins.
 136      */
 137     private static boolean containsOnlyNonVisibleData(final YangInstanceIdentifier path, final NormalizedNode data) {
 138         // There's only one such case:top level list (pathArguments == 1 && data is Mixin)
 139         // any other mixin nodes are contained by a "regular" node thus visible when serialized
 140         return path.getPathArguments().size() == 1 && data instanceof MixinNode;
 141     }
 142
 143     @Override
 144     public synchronized void delete(final LogicalDatastoreType store, final YangInstanceIdentifier path) {
 145         checkEditable(store);
 146         final DataContainerChild editStructure = netOps.createEditConfigStrcture(Optional.empty(),
 147                         Optional.of(ModifyAction.DELETE), path);
 148         editConfig(path, Optional.empty(), editStructure, Optional.of(ModifyAction.NONE), "delete");
 149     }
 150
 151     @Override
 152     public FluentFuture<? extends CommitInfo> commit() {
 153         final SettableFuture<CommitInfo> resultFuture = SettableFuture.create();
 154         Futures.addCallback(commitConfiguration(), new FutureCallback<RpcResult<Void>>() {
 155             @Override
 156             public void onSuccess(final RpcResult<Void> result) {
 157                 if (!result.isSuccessful()) {
 158                     final Collection<RpcError> errors = result.getErrors();
 159                     resultFuture.setException(new TransactionCommitFailedException(
 160                         String.format("Commit of transaction %s failed", getIdentifier()),
 161                             errors.toArray(new RpcError[errors.size()])));
 162                     return;
 163                 }
 164
 165                 resultFuture.set(CommitInfo.empty());
 166             }
 167
 168             @Override
 169             public void onFailure(final Throwable failure) {
 170                 resultFuture.setException(new TransactionCommitFailedException(
 171                         String.format("Commit of transaction %s failed", getIdentifier()), failure));
 172             }
 173         }, MoreExecutors.directExecutor());
 174
 175         return FluentFuture.from(resultFuture);
 176     }
 177
 178     protected final ListenableFuture<RpcResult<Void>> commitConfiguration() {
 179         listeners.forEach(listener -> listener.onTransactionSubmitted(this));
 180         checkNotFinished();
 181         finished = true;
 182         final ListenableFuture<RpcResult<Void>> result = performCommit();
 183         Futures.addCallback(result, new FutureCallback<RpcResult<Void>>() {
 184             @Override
 185             public void onSuccess(final RpcResult<Void> rpcResult) {
 186                 if (rpcResult.isSuccessful()) {
 187                     listeners.forEach(txListener -> txListener.onTransactionSuccessful(AbstractWriteTx.this));
 188                 } else {
 189                     final TransactionCommitFailedException cause =
 190                             new TransactionCommitFailedException("Transaction failed",
 191                                     rpcResult.getErrors().toArray(new RpcError[rpcResult.getErrors().size()]));
 192                     listeners.forEach(listener -> listener.onTransactionFailed(AbstractWriteTx.this, cause));
 193                 }
 194             }
 195
 196             @Override
 197             public void onFailure(final Throwable throwable) {
 198                 listeners.forEach(listener -> listener.onTransactionFailed(AbstractWriteTx.this, throwable));
 199             }
 200         }, MoreExecutors.directExecutor());
 201         return result;
 202     }
 203
 204     protected abstract ListenableFuture<RpcResult<Void>> performCommit();
 205
 206     private void checkEditable(final LogicalDatastoreType store) {
 207         checkNotFinished();
 208         checkArgument(store == LogicalDatastoreType.CONFIGURATION,
 209                 "Can edit only configuration data, not %s", store);
 210     }
 211
 212     protected abstract void editConfig(YangInstanceIdentifier path, Optional<NormalizedNode> data,
 213                                        DataContainerChild editStructure,
 214                                        Optional<ModifyAction> defaultOperation, String operation);
 215
 216     protected ListenableFuture<RpcResult<Void>> resultsToTxStatus() {
 217         final SettableFuture<RpcResult<Void>> transformed = SettableFuture.create();
 218
 219         Futures.addCallback(Futures.allAsList(resultsFutures), new FutureCallback<List<DOMRpcResult>>() {
 220             @Override
 221             public void onSuccess(final List<DOMRpcResult> domRpcResults) {
 222                 if (!transformed.isDone()) {
 223                     extractResult(domRpcResults, transformed);
 224                 }
 225             }
 226
 227             @Override
 228             public void onFailure(final Throwable throwable) {
 229                 final NetconfDocumentedException exception =
 230                         new NetconfDocumentedException(
 231                                 id + ":RPC during tx returned an exception" + throwable.getMessage(),
 232                                 new Exception(throwable),
 233                                 DocumentedException.ErrorType.APPLICATION,
 234                                 DocumentedException.ErrorTag.OPERATION_FAILED,
 235                                 ErrorSeverity.ERROR);
 236                 transformed.setException(exception);
 237             }
 238         }, MoreExecutors.directExecutor());
 239
 240         return transformed;
 241     }
 242
 243     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 244             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 245     private void extractResult(final List<DOMRpcResult> domRpcResults,
 246                                final SettableFuture<RpcResult<Void>> transformed) {
 247         DocumentedException.ErrorType errType = DocumentedException.ErrorType.APPLICATION;
 248         ErrorSeverity errSeverity = ErrorSeverity.ERROR;
 249         StringBuilder msgBuilder = new StringBuilder();
 250         boolean errorsEncouneterd = false;
 251         String errorTag = "operation-failed";
 252
 253         for (final DOMRpcResult domRpcResult : domRpcResults) {
 254             if (!domRpcResult.getErrors().isEmpty()) {
 255                 errorsEncouneterd = true;
 256                 final RpcError error = domRpcResult.getErrors().iterator().next();
 257                 final RpcError.ErrorType errorType = error.getErrorType();
 258                 switch (errorType) {
 259                     case RPC:
 260                         errType = DocumentedException.ErrorType.RPC;
 261                         break;
 262                     case PROTOCOL:
 263                         errType = DocumentedException.ErrorType.PROTOCOL;
 264                         break;
 265                     case TRANSPORT:
 266                         errType = DocumentedException.ErrorType.TRANSPORT;
 267                         break;
 268                     case APPLICATION:
 269                         errType = DocumentedException.ErrorType.APPLICATION;
 270                         break;
 271                     default:
 272                         errType = DocumentedException.ErrorType.APPLICATION;
 273                         break;
 274                 }
 275
 276                 errSeverity = error.getSeverity().toNetconf();
 277                 msgBuilder.append(error.getMessage());
 278                 msgBuilder.append(error.getInfo());
 279                 errorTag = error.getTag();
 280             }
 281         }
 282         if (errorsEncouneterd) {
 283             final NetconfDocumentedException exception = new NetconfDocumentedException(id
 284                     + ":RPC during tx failed. " + msgBuilder.toString(),
 285                     errType,
 286                     DocumentedException.ErrorTag.from(errorTag),
 287                     errSeverity);
 288             transformed.setException(exception);
 289             return;
 290         }
 291         transformed.set(RpcResultBuilder.<Void>success().build());
 292     }
 293
 294     AutoCloseable addListener(final TxListener listener) {
 295         listeners.add(listener);
 296         return () -> listeners.remove(listener);
 297     }
 298 }