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

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. 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;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import akka.actor.ActorRef;
  13 import akka.cluster.Cluster;
  14 import akka.dispatch.OnComplete;
  15 import akka.pattern.Patterns;
  16 import akka.util.Timeout;
  17 import com.google.common.util.concurrent.ListenableFuture;
  18 import java.util.concurrent.atomic.AtomicBoolean;
  19 import org.eclipse.jdt.annotation.NonNull;
  20 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  21 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService;
  22 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
  23 import org.opendaylight.netconf.sal.connect.api.DeviceActionFactory;
  24 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  25 import org.opendaylight.netconf.topology.singleton.api.RemoteDeviceConnector;
  26 import org.opendaylight.netconf.topology.singleton.impl.actors.NetconfNodeActor;
  27 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
  28 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
  29 import org.opendaylight.netconf.topology.singleton.messages.RefreshSetupMasterActorData;
  30 import org.opendaylight.netconf.topology.spi.NetconfNodeUtils;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  32 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
  33 import org.slf4j.Logger;
  34 import org.slf4j.LoggerFactory;
  35 import scala.concurrent.Future;
  36
  37 class NetconfTopologyContext implements ClusterSingletonService, AutoCloseable {
  38
  39     private static final Logger LOG = LoggerFactory.getLogger(NetconfTopologyContext.class);
  40
  41     private final ServiceGroupIdentifier serviceGroupIdent;
  42     private final Timeout actorResponseWaitTime;
  43     private final DOMMountPointService mountService;
  44     private final DeviceActionFactory deviceActionFactory;
  45
  46     private NetconfTopologySetup netconfTopologyDeviceSetup;
  47     private RemoteDeviceId remoteDeviceId;
  48     private RemoteDeviceConnector remoteDeviceConnector;
  49     private NetconfNodeManager netconfNodeManager;
  50     private ActorRef masterActorRef;
  51     private final AtomicBoolean closed = new AtomicBoolean(false);
  52     private final AtomicBoolean stopped = new AtomicBoolean(false);
  53     private volatile boolean isMaster;
  54
  55     NetconfTopologyContext(final NetconfTopologySetup netconfTopologyDeviceSetup,
  56             final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime,
  57             final DOMMountPointService mountService, final DeviceActionFactory deviceActionFactory) {
  58         this.netconfTopologyDeviceSetup = requireNonNull(netconfTopologyDeviceSetup);
  59         this.serviceGroupIdent = serviceGroupIdent;
  60         this.actorResponseWaitTime = actorResponseWaitTime;
  61         this.mountService = mountService;
  62         this.deviceActionFactory = deviceActionFactory;
  63
  64         final var node = netconfTopologyDeviceSetup.getNode();
  65         remoteDeviceId = NetconfNodeUtils.toRemoteDeviceId(node.getNodeId(), node.augmentation(NetconfNode.class));
  66         remoteDeviceConnector = new RemoteDeviceConnectorImpl(netconfTopologyDeviceSetup, remoteDeviceId,
  67             deviceActionFactory);
  68         netconfNodeManager = createNodeDeviceManager();
  69     }
  70
  71     @Override
  72     public void instantiateServiceInstance() {
  73         LOG.info("Master was selected: {}", remoteDeviceId.getHost().getIpAddress());
  74
  75         isMaster = true;
  76
  77         // master should not listen on netconf-node operational datastore
  78         if (netconfNodeManager != null) {
  79             netconfNodeManager.close();
  80             netconfNodeManager = null;
  81         }
  82
  83         if (!closed.get()) {
  84             final String masterAddress =
  85                     Cluster.get(netconfTopologyDeviceSetup.getActorSystem()).selfAddress().toString();
  86             masterActorRef = netconfTopologyDeviceSetup.getActorSystem().actorOf(NetconfNodeActor.props(
  87                     netconfTopologyDeviceSetup, remoteDeviceId, actorResponseWaitTime, mountService),
  88                     NetconfTopologyUtils.createMasterActorName(remoteDeviceId.getName(), masterAddress));
  89
  90             remoteDeviceConnector.startRemoteDeviceConnection(newMasterSalFacade());
  91         }
  92
  93     }
  94
  95     // called when master is down/changed to slave
  96     @Override
  97     public ListenableFuture<?> closeServiceInstance() {
  98
  99         if (!closed.get()) {
 100             // in case that master changes role to slave, new NodeDeviceManager must be created and listener registered
 101             netconfNodeManager = createNodeDeviceManager();
 102         }
 103         stopDeviceConnectorAndActor();
 104
 105         return FluentFutures.immediateNullFluentFuture();
 106     }
 107
 108     @Override
 109     public ServiceGroupIdentifier getIdentifier() {
 110         return serviceGroupIdent;
 111     }
 112
 113     private NetconfNodeManager createNodeDeviceManager() {
 114         final NetconfNodeManager ndm =
 115                 new NetconfNodeManager(netconfTopologyDeviceSetup, remoteDeviceId, actorResponseWaitTime, mountService);
 116         ndm.registerDataTreeChangeListener(netconfTopologyDeviceSetup.getTopologyId(),
 117                 netconfTopologyDeviceSetup.getNode().key());
 118
 119         return ndm;
 120     }
 121
 122     @Override
 123     public void close() {
 124         if (!closed.compareAndSet(false, true)) {
 125             return;
 126         }
 127
 128         if (netconfNodeManager != null) {
 129             netconfNodeManager.close();
 130         }
 131         stopDeviceConnectorAndActor();
 132
 133     }
 134
 135     /**
 136      * Refresh, if configuration data was changed.
 137      * @param setup new setup
 138      */
 139     void refresh(final @NonNull NetconfTopologySetup setup) {
 140         netconfTopologyDeviceSetup = requireNonNull(setup);
 141         final var node = netconfTopologyDeviceSetup.getNode();
 142         remoteDeviceId = NetconfNodeUtils.toRemoteDeviceId(node.getNodeId(), node.augmentation(NetconfNode.class));
 143
 144         if (isMaster) {
 145             remoteDeviceConnector.stopRemoteDeviceConnection();
 146         }
 147         if (!isMaster) {
 148             netconfNodeManager.refreshDevice(netconfTopologyDeviceSetup, remoteDeviceId);
 149         }
 150         remoteDeviceConnector = new RemoteDeviceConnectorImpl(netconfTopologyDeviceSetup, remoteDeviceId,
 151             deviceActionFactory);
 152
 153         if (isMaster) {
 154             final Future<Object> future = Patterns.ask(masterActorRef, new RefreshSetupMasterActorData(
 155                 netconfTopologyDeviceSetup, remoteDeviceId), actorResponseWaitTime);
 156             future.onComplete(new OnComplete<Object>() {
 157                 @Override
 158                 public void onComplete(final Throwable failure, final Object success) {
 159                     if (failure != null) {
 160                         LOG.error("Failed to refresh master actor data", failure);
 161                         return;
 162                     }
 163                     remoteDeviceConnector.startRemoteDeviceConnection(newMasterSalFacade());
 164                 }
 165             }, netconfTopologyDeviceSetup.getActorSystem().dispatcher());
 166         }
 167     }
 168
 169     private void stopDeviceConnectorAndActor() {
 170         if (!stopped.compareAndSet(false, true)) {
 171             return;
 172         }
 173         if (remoteDeviceConnector != null) {
 174             remoteDeviceConnector.stopRemoteDeviceConnection();
 175         }
 176
 177         if (masterActorRef != null) {
 178             netconfTopologyDeviceSetup.getActorSystem().stop(masterActorRef);
 179             masterActorRef = null;
 180         }
 181     }
 182
 183     protected MasterSalFacade newMasterSalFacade() {
 184         return new MasterSalFacade(remoteDeviceId, netconfTopologyDeviceSetup.getActorSystem(), masterActorRef,
 185                 actorResponseWaitTime, mountService, netconfTopologyDeviceSetup.getDataBroker());
 186     }
 187 }