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