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.ListenableFuture;
  16 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
  17 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  18 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  19 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  20 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  21 import org.opendaylight.yangtools.yang.common.RpcResult;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  23 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  24
  25 /**
  26  * ProxyWriteTransaction uses provided {@link ActorRef} to delegate method calls to master
  27  * {@link org.opendaylight.netconf.topology.singleton.impl.actors.WriteTransactionActor}.
  28  */
  29 public class ProxyWriteTransaction implements DOMDataWriteTransaction {
  30
  31     private final ProxyWriteAdapter proxyWriteAdapter;
  32
  33     /**
  34      * Constructor for {@code ProxyWriteTransaction}.
  35      *
  36      * @param masterTxActor {@link org.opendaylight.netconf.topology.singleton.impl.actors.WriteTransactionActor} ref
  37      * @param id            device id
  38      * @param actorSystem   system
  39      * @param askTimeout    timeout
  40      */
  41     public ProxyWriteTransaction(final ActorRef masterTxActor, final RemoteDeviceId id, final ActorSystem actorSystem,
  42                                  final Timeout askTimeout) {
  43         proxyWriteAdapter = new ProxyWriteAdapter(masterTxActor, id, actorSystem, askTimeout);
  44     }
  45
  46     @SuppressWarnings("checkstyle:IllegalCatch")
  47     @Override
  48     public boolean cancel() {
  49         return proxyWriteAdapter.cancel();
  50     }
  51
  52     @Override
  53     public CheckedFuture<Void, TransactionCommitFailedException> submit() {
  54         return proxyWriteAdapter.submit(getIdentifier());
  55     }
  56
  57     @Override
  58     public ListenableFuture<RpcResult<TransactionStatus>> commit() {
  59         return proxyWriteAdapter.commit(getIdentifier());
  60     }
  61
  62     @Override
  63     public void delete(final LogicalDatastoreType store, final YangInstanceIdentifier identifier) {
  64         proxyWriteAdapter.delete(store, identifier);
  65     }
  66
  67     @Override
  68     public void put(final LogicalDatastoreType store, final YangInstanceIdentifier identifier,
  69                     final NormalizedNode<?, ?> data) {
  70         proxyWriteAdapter.put(store, identifier, data, getIdentifier());
  71     }
  72
  73     @Override
  74     public void merge(final LogicalDatastoreType store, final YangInstanceIdentifier identifier,
  75                       final NormalizedNode<?, ?> data) {
  76         proxyWriteAdapter.merge(store, identifier, data, getIdentifier());
  77     }
  78
  79     @Override
  80     public Object getIdentifier() {
  81         return this;
  82     }
  83 }