netconf/netconf-topology-singleton/src/main/java/org/opendaylight/netconf/topology/singleton/impl/ProxyDOMDataBroker.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;
  10
  11 import akka.actor.ActorRef;
  12 import akka.actor.ActorSystem;
  13 import akka.pattern.Patterns;
  14 import akka.util.Timeout;
  15 import com.google.common.base.Preconditions;
  16 import java.util.Collections;
  17 import java.util.Map;
  18 import javax.annotation.Nonnull;
  19 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  20 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  21 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  22 import org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension;
  23 import org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener;
  24 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
  25 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
  26 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  27 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  28 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  29 import org.opendaylight.netconf.topology.singleton.impl.tx.ProxyReadTransaction;
  30 import org.opendaylight.netconf.topology.singleton.impl.tx.ProxyReadWriteTransaction;
  31 import org.opendaylight.netconf.topology.singleton.impl.tx.ProxyWriteTransaction;
  32 import org.opendaylight.netconf.topology.singleton.messages.transactions.NewReadTransactionReply;
  33 import org.opendaylight.netconf.topology.singleton.messages.transactions.NewReadTransactionRequest;
  34 import org.opendaylight.netconf.topology.singleton.messages.transactions.NewReadWriteTransactionReply;
  35 import org.opendaylight.netconf.topology.singleton.messages.transactions.NewReadWriteTransactionRequest;
  36 import org.opendaylight.netconf.topology.singleton.messages.transactions.NewWriteTransactionReply;
  37 import org.opendaylight.netconf.topology.singleton.messages.transactions.NewWriteTransactionRequest;
  38 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  40 import scala.concurrent.Await;
  41 import scala.concurrent.Future;
  42
  43 public class ProxyDOMDataBroker implements DOMDataBroker {
  44
  45     private final Timeout askTimeout;
  46     private final RemoteDeviceId id;
  47     private final ActorRef masterNode;
  48     private final ActorSystem actorSystem;
  49
  50     /**
  51      * Constructor for {@code ProxyDOMDataBroker}.
  52      *
  53      * @param actorSystem system
  54      * @param id          id
  55      * @param masterNode  {@link org.opendaylight.netconf.topology.singleton.impl.actors.NetconfNodeActor} ref
  56      * @param askTimeout  ask timeout
  57      */
  58     public ProxyDOMDataBroker(final ActorSystem actorSystem, final RemoteDeviceId id,
  59                               final ActorRef masterNode, final Timeout askTimeout) {
  60         this.id = id;
  61         this.masterNode = masterNode;
  62         this.actorSystem = actorSystem;
  63         this.askTimeout = askTimeout;
  64     }
  65
  66     @SuppressWarnings("checkstyle:IllegalCatch")
  67     @Override
  68     public DOMDataReadOnlyTransaction newReadOnlyTransaction() {
  69         final Future<Object> txActorFuture = Patterns.ask(masterNode, new NewReadTransactionRequest(), askTimeout);
  70         try {
  71             final Object msg = Await.result(txActorFuture, askTimeout.duration());
  72             if (msg instanceof Throwable) {
  73                 throw (Throwable) msg;
  74             }
  75             Preconditions.checkState(msg instanceof NewReadTransactionReply);
  76             final NewReadTransactionReply reply = (NewReadTransactionReply) msg;
  77             return new ProxyReadTransaction(reply.getTxActor(), id, actorSystem, askTimeout);
  78         } catch (final Throwable t) {
  79             throw new IllegalStateException("Can't create ProxyReadTransaction", t);
  80         }
  81     }
  82
  83     @SuppressWarnings("checkstyle:IllegalCatch")
  84     @Override
  85     public DOMDataReadWriteTransaction newReadWriteTransaction() {
  86         final Future<Object> txActorFuture = Patterns.ask(masterNode, new NewReadWriteTransactionRequest(), askTimeout);
  87         try {
  88             final Object msg = Await.result(txActorFuture, askTimeout.duration());
  89             if (msg instanceof Throwable) {
  90                 throw (Throwable) msg;
  91             }
  92             Preconditions.checkState(msg instanceof NewReadWriteTransactionReply);
  93             final NewReadWriteTransactionReply reply = (NewReadWriteTransactionReply) msg;
  94             return new ProxyReadWriteTransaction(reply.getTxActor(), id, actorSystem, askTimeout);
  95         } catch (final Throwable t) {
  96             throw new IllegalStateException("Can't create ProxyReadTransaction", t);
  97         }
  98     }
  99
 100     @SuppressWarnings("checkstyle:IllegalCatch")
 101     @Override
 102     public DOMDataWriteTransaction newWriteOnlyTransaction() {
 103         final Future<Object> txActorFuture = Patterns.ask(masterNode, new NewWriteTransactionRequest(), askTimeout);
 104         try {
 105             final Object msg = Await.result(txActorFuture, askTimeout.duration());
 106             if (msg instanceof Throwable) {
 107                 throw (Throwable) msg;
 108             }
 109             Preconditions.checkState(msg instanceof NewWriteTransactionReply);
 110             final NewWriteTransactionReply reply = (NewWriteTransactionReply) msg;
 111             return new ProxyWriteTransaction(reply.getTxActor(), id, actorSystem, askTimeout);
 112         } catch (final Throwable t) {
 113             throw new IllegalStateException("Can't create ProxyWriteTransaction", t);
 114         }
 115     }
 116
 117     @Override
 118     public ListenerRegistration<DOMDataChangeListener> registerDataChangeListener(
 119             final LogicalDatastoreType store, final YangInstanceIdentifier path, final DOMDataChangeListener listener,
 120             final DataChangeScope triggeringScope) {
 121         throw new UnsupportedOperationException(id + ": Data change listeners not supported for netconf mount point");
 122     }
 123
 124     @Override
 125     public DOMTransactionChain createTransactionChain(final TransactionChainListener listener) {
 126         throw new UnsupportedOperationException(id + ": Transaction chains not supported for netconf mount point");
 127     }
 128
 129     @Nonnull
 130     @Override
 131     public Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> getSupportedExtensions() {
 132         return Collections.emptyMap();
 133     }
 134 }