netconf/netconf-topology-singleton/src/main/java/org/opendaylight/netconf/topology/singleton/impl/tx/ProxyWriteTransaction.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies s.r.o. 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.topology.singleton.impl.tx;
  10
  11 import akka.actor.ActorRef;
  12 import akka.actor.ActorSystem;
  13 import akka.util.Timeout;
  14 import com.google.common.util.concurrent.CheckedFuture;
  15 import com.google.common.util.concurrent.FluentFuture;
  16 import com.google.common.util.concurrent.MoreExecutors;
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  19 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  20 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  21 import org.opendaylight.mdsal.common.api.CommitInfo;
  22 import org.opendaylight.mdsal.common.api.MappingCheckedFuture;
  23 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  24 import org.opendaylight.yangtools.util.concurrent.ExceptionMapper;
  25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  26 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  27
  28 /**
  29  * ProxyWriteTransaction uses provided {@link ActorRef} to delegate method calls to master
  30  * {@link org.opendaylight.netconf.topology.singleton.impl.actors.WriteTransactionActor}.
  31  */
  32 public class ProxyWriteTransaction implements DOMDataWriteTransaction {
  33
  34     private final ProxyWriteAdapter proxyWriteAdapter;
  35
  36     /**
  37      * Constructor for {@code ProxyWriteTransaction}.
  38      *
  39      * @param masterTxActor {@link org.opendaylight.netconf.topology.singleton.impl.actors.WriteTransactionActor} ref
  40      * @param id            device id
  41      * @param actorSystem   system
  42      * @param askTimeout    timeout
  43      */
  44     public ProxyWriteTransaction(final ActorRef masterTxActor, final RemoteDeviceId id, final ActorSystem actorSystem,
  45                                  final Timeout askTimeout) {
  46         proxyWriteAdapter = new ProxyWriteAdapter(masterTxActor, id, actorSystem, askTimeout);
  47     }
  48
  49     @SuppressWarnings("checkstyle:IllegalCatch")
  50     @Override
  51     public boolean cancel() {
  52         return proxyWriteAdapter.cancel();
  53     }
  54
  55     @Override
  56     public CheckedFuture<Void, TransactionCommitFailedException> submit() {
  57         return MappingCheckedFuture.create(commit().transform(ignored -> null, MoreExecutors.directExecutor()),
  58             new ExceptionMapper<TransactionCommitFailedException>("commit", TransactionCommitFailedException.class) {
  59                 @Override
  60                 protected TransactionCommitFailedException newWithCause(String message, Throwable cause) {
  61                     return new TransactionCommitFailedException(message, cause);
  62                 }
  63             });
  64     }
  65
  66     @Override
  67     public @NonNull FluentFuture<? extends @NonNull CommitInfo> commit() {
  68         return proxyWriteAdapter.commit(getIdentifier());
  69     }
  70
  71     @Override
  72     public void delete(final LogicalDatastoreType store, final YangInstanceIdentifier identifier) {
  73         proxyWriteAdapter.delete(store, identifier);
  74     }
  75
  76     @Override
  77     public void put(final LogicalDatastoreType store, final YangInstanceIdentifier identifier,
  78                     final NormalizedNode<?, ?> data) {
  79         proxyWriteAdapter.put(store, identifier, data, getIdentifier());
  80     }
  81
  82     @Override
  83     public void merge(final LogicalDatastoreType store, final YangInstanceIdentifier identifier,
  84                       final NormalizedNode<?, ?> data) {
  85         proxyWriteAdapter.merge(store, identifier, data, getIdentifier());
  86     }
  87
  88     @Override
  89     public Object getIdentifier() {
  90         return this;
  91     }
  92 }