opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/notifications/RoleChangeNotifier.java

   1 /*
   2  * Copyright (c) 2014 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.controller.cluster.notifications;
  10
  11 import akka.actor.ActorPath;
  12 import akka.actor.ActorRef;
  13 import akka.actor.Props;
  14 import akka.serialization.Serialization;
  15 import com.google.common.collect.Maps;
  16 import java.util.Map;
  17 import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActor;
  18
  19 /**
  20  * The RoleChangeNotifier is responsible for receiving Raft role and leader state change messages and notifying
  21  * the listeners (within the same node), which are registered with it.
  22  *
  23  * <p>
  24  * The RoleChangeNotifier is instantiated by the Shard and injected into the RaftActor.
  25  */
  26 public class RoleChangeNotifier extends AbstractUntypedActor implements AutoCloseable {
  27
  28     private final String memberId;
  29     private final Map<ActorPath, ActorRef> registeredListeners = Maps.newHashMap();
  30     private RoleChangeNotification latestRoleChangeNotification = null;
  31     private LeaderStateChanged latestLeaderStateChanged;
  32
  33     public RoleChangeNotifier(String memberId) {
  34         this.memberId = memberId;
  35     }
  36
  37     public static Props getProps(final String memberId) {
  38         return Props.create(RoleChangeNotifier.class, memberId);
  39     }
  40
  41     @Override
  42     public void preStart() throws Exception {
  43         super.preStart();
  44         LOG.info("RoleChangeNotifier:{} created and ready for shard:{}",
  45             Serialization.serializedActorPath(getSelf()), memberId);
  46     }
  47
  48     @Override
  49     protected void handleReceive(Object message) {
  50         if (message instanceof RegisterRoleChangeListener) {
  51             // register listeners for this shard
  52
  53             ActorRef curRef = registeredListeners.get(getSender().path());
  54             if (curRef != null) {
  55                 // ActorPaths would pass equal even if the unique id of the actors are different
  56                 // if a listener actor is re-registering after reincarnation, then removing the existing
  57                 // entry so the actor path with correct unique id is registered.
  58                 registeredListeners.remove(getSender().path());
  59             }
  60             registeredListeners.put(getSender().path(), getSender());
  61
  62             LOG.info("RoleChangeNotifier for {} , registered listener {}", memberId,
  63                 getSender().path().toString());
  64
  65             getSender().tell(new RegisterRoleChangeListenerReply(), getSelf());
  66
  67             if (latestLeaderStateChanged != null) {
  68                 getSender().tell(latestLeaderStateChanged, getSelf());
  69             }
  70
  71             if (latestRoleChangeNotification != null) {
  72                 getSender().tell(latestRoleChangeNotification, getSelf());
  73             }
  74
  75
  76         } else if (message instanceof RoleChanged) {
  77             // this message is sent by RaftActor. Notify registered listeners when this message is received.
  78             RoleChanged roleChanged = (RoleChanged) message;
  79
  80             LOG.info("RoleChangeNotifier for {} , received role change from {} to {}", memberId,
  81                 roleChanged.getOldRole(), roleChanged.getNewRole());
  82
  83             latestRoleChangeNotification =
  84                 new RoleChangeNotification(roleChanged.getMemberId(),
  85                     roleChanged.getOldRole(), roleChanged.getNewRole());
  86
  87             for (ActorRef listener: registeredListeners.values()) {
  88                 listener.tell(latestRoleChangeNotification, getSelf());
  89             }
  90         } else if (message instanceof LeaderStateChanged) {
  91             latestLeaderStateChanged = (LeaderStateChanged)message;
  92
  93             for (ActorRef listener: registeredListeners.values()) {
  94                 listener.tell(latestLeaderStateChanged, getSelf());
  95             }
  96         } else {
  97             unknownMessage(message);
  98         }
  99     }
 100
 101     @Override
 102     public void close() {
 103         registeredListeners.clear();
 104     }
 105 }
 106