netconf/netconf-topology-singleton/src/main/java/org/opendaylight/netconf/topology/singleton/impl/actors/WriteTransactionActor.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 package org.opendaylight.netconf.topology.singleton.impl.actors;
   9
  10 import akka.actor.Props;
  11 import akka.actor.ReceiveTimeout;
  12 import akka.actor.UntypedAbstractActor;
  13 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  14 import org.opendaylight.netconf.topology.singleton.messages.transactions.WriteActorMessage;
  15 import org.slf4j.Logger;
  16 import org.slf4j.LoggerFactory;
  17 import scala.concurrent.duration.Duration;
  18
  19 /**
  20  * WriteTransactionActor is an interface to device's {@link DOMDataTreeWriteTransaction} for cluster nodes.
  21  */
  22 public final class WriteTransactionActor extends UntypedAbstractActor {
  23
  24     private static final Logger LOG = LoggerFactory.getLogger(WriteTransactionActor.class);
  25
  26     private final DOMDataTreeWriteTransaction tx;
  27     private final long idleTimeout;
  28     private final WriteAdapter writeAdapter;
  29
  30     private WriteTransactionActor(final DOMDataTreeWriteTransaction tx, final Duration idleTimeout) {
  31         this.tx = tx;
  32         this.idleTimeout = idleTimeout.toSeconds();
  33         if (this.idleTimeout > 0) {
  34             context().setReceiveTimeout(idleTimeout);
  35         }
  36         writeAdapter = new WriteAdapter(tx);
  37     }
  38
  39     /**
  40      * Creates new actor Props.
  41      *
  42      * @param tx          delegate device write transaction
  43      * @param idleTimeout idle time in seconds, after which transaction is closed automatically
  44      * @return props
  45      */
  46     static Props props(final DOMDataTreeWriteTransaction tx, final Duration idleTimeout) {
  47         return Props.create(WriteTransactionActor.class, () -> new WriteTransactionActor(tx, idleTimeout));
  48     }
  49
  50     @Override
  51     public void onReceive(final Object message) {
  52         if (message instanceof WriteActorMessage) {
  53             writeAdapter.handle(message, sender(), context(), self());
  54         } else if (message instanceof ReceiveTimeout) {
  55             LOG.warn("Haven't received any message for {} seconds, cancelling transaction and stopping actor",
  56                     idleTimeout);
  57             tx.cancel();
  58             context().stop(self());
  59         } else {
  60             unhandled(message);
  61         }
  62     }
  63 }