2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.notifications;
10 import akka.actor.ActorPath;
11 import akka.actor.ActorRef;
12 import akka.actor.Props;
13 import akka.serialization.Serialization;
14 import java.util.HashMap;
16 import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActor;
19 * The RoleChangeNotifier is responsible for receiving Raft role and leader state change messages and notifying
20 * the listeners (within the same node), which are registered with it.
23 * The RoleChangeNotifier is instantiated by the Shard and injected into the RaftActor.
25 public class RoleChangeNotifier extends AbstractUntypedActor implements AutoCloseable {
27 private final String memberId;
28 private final Map<ActorPath, ActorRef> registeredListeners = new HashMap<>();
29 private RoleChangeNotification latestRoleChangeNotification = null;
30 private LeaderStateChanged latestLeaderStateChanged;
32 public RoleChangeNotifier(final String memberId) {
33 this.memberId = memberId;
36 public static Props getProps(final String memberId) {
37 return Props.create(RoleChangeNotifier.class, memberId);
41 public void preStart() throws Exception {
43 LOG.info("RoleChangeNotifier:{} created and ready for shard:{}",
44 Serialization.serializedActorPath(getSelf()), memberId);
48 protected void handleReceive(final Object message) {
49 if (message instanceof RegisterRoleChangeListener) {
50 // register listeners for this shard
52 ActorRef curRef = registeredListeners.get(getSender().path());
54 // ActorPaths would pass equal even if the unique id of the actors are different
55 // if a listener actor is re-registering after reincarnation, then removing the existing
56 // entry so the actor path with correct unique id is registered.
57 registeredListeners.remove(getSender().path());
59 registeredListeners.put(getSender().path(), getSender());
61 LOG.info("RoleChangeNotifier for {} , registered listener {}", memberId,
62 getSender().path().toString());
64 getSender().tell(new RegisterRoleChangeListenerReply(), getSelf());
66 if (latestLeaderStateChanged != null) {
67 getSender().tell(latestLeaderStateChanged, getSelf());
70 if (latestRoleChangeNotification != null) {
71 getSender().tell(latestRoleChangeNotification, getSelf());
75 } else if (message instanceof RoleChanged) {
76 // this message is sent by RaftActor. Notify registered listeners when this message is received.
77 RoleChanged roleChanged = (RoleChanged) message;
79 LOG.info("RoleChangeNotifier for {} , received role change from {} to {}", memberId,
80 roleChanged.getOldRole(), roleChanged.getNewRole());
82 latestRoleChangeNotification =
83 new RoleChangeNotification(roleChanged.getMemberId(),
84 roleChanged.getOldRole(), roleChanged.getNewRole());
86 for (ActorRef listener: registeredListeners.values()) {
87 listener.tell(latestRoleChangeNotification, getSelf());
89 } else if (message instanceof LeaderStateChanged) {
90 latestLeaderStateChanged = (LeaderStateChanged)message;
92 for (ActorRef listener: registeredListeners.values()) {
93 listener.tell(latestLeaderStateChanged, getSelf());
96 unknownMessage(message);
101 public void close() {
102 registeredListeners.clear();