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