2 * Copyright (c) 2015 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.datastore;
10 import akka.actor.ActorRef;
11 import akka.actor.ActorSelection;
12 import java.util.ArrayList;
13 import java.util.Collection;
14 import java.util.concurrent.ConcurrentHashMap;
15 import org.opendaylight.controller.cluster.datastore.actors.DataTreeNotificationListenerRegistrationActor;
16 import org.opendaylight.controller.cluster.datastore.messages.EnableNotification;
17 import org.opendaylight.controller.cluster.datastore.messages.RegisterDataTreeChangeListener;
18 import org.opendaylight.controller.cluster.datastore.messages.RegisterDataTreeNotificationListenerReply;
19 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener;
20 import org.slf4j.Logger;
21 import org.slf4j.LoggerFactory;
23 final class DataTreeChangeListenerSupport extends LeaderLocalDelegateFactory<RegisterDataTreeChangeListener> {
24 private static final Logger LOG = LoggerFactory.getLogger(DataTreeChangeListenerSupport.class);
26 private final Collection<DelayedDataTreeChangeListenerRegistration<DOMDataTreeChangeListener>>
27 delayedDataTreeChangeListenerRegistrations = ConcurrentHashMap.newKeySet();
28 private final Collection<DelayedDataTreeChangeListenerRegistration<DOMDataTreeChangeListener>>
29 delayedListenerOnAllRegistrations = ConcurrentHashMap.newKeySet();
30 private final Collection<ActorSelection> leaderOnlyListenerActors = ConcurrentHashMap.newKeySet();
31 private final Collection<ActorSelection> allListenerActors = ConcurrentHashMap.newKeySet();
33 DataTreeChangeListenerSupport(final Shard shard) {
37 void doRegistration(final RegisterDataTreeChangeListener message, final ActorRef registrationActor) {
38 final ActorSelection listenerActor = processListenerRegistrationMessage(message);
40 final DOMDataTreeChangeListener listener = new ForwardingDataTreeChangeListener(listenerActor);
42 LOG.debug("{}: Registering listenerActor {} for path {}", persistenceId(), listenerActor, message.getPath());
44 final ShardDataTree shardDataTree = getShard().getDataStore();
45 shardDataTree.registerTreeChangeListener(message.getPath(),
46 listener, shardDataTree.readCurrentData(), registration -> registrationActor.tell(
47 new DataTreeNotificationListenerRegistrationActor.SetRegistration(registration, () ->
48 removeListenerActor(listenerActor)), ActorRef.noSender()));
51 Collection<ActorSelection> getListenerActors() {
52 return new ArrayList<>(allListenerActors);
56 void onLeadershipChange(final boolean isLeader, final boolean hasLeader) {
57 LOG.debug("{}: onLeadershipChange, isLeader: {}, hasLeader : {}", persistenceId(), isLeader, hasLeader);
59 final EnableNotification msg = new EnableNotification(isLeader, persistenceId());
60 for (ActorSelection dataChangeListener : leaderOnlyListenerActors) {
61 dataChangeListener.tell(msg, getSelf());
65 for (DelayedDataTreeChangeListenerRegistration<DOMDataTreeChangeListener> reg :
66 delayedListenerOnAllRegistrations) {
67 reg.doRegistration(this);
70 delayedListenerOnAllRegistrations.clear();
74 for (DelayedDataTreeChangeListenerRegistration<DOMDataTreeChangeListener> reg :
75 delayedDataTreeChangeListenerRegistrations) {
76 reg.doRegistration(this);
79 delayedDataTreeChangeListenerRegistrations.clear();
84 void onMessage(final RegisterDataTreeChangeListener message, final boolean isLeader, final boolean hasLeader) {
85 LOG.debug("{}: onMessage {}, isLeader: {}, hasLeader: {}", persistenceId(), message, isLeader, hasLeader);
87 final ActorRef registrationActor = createActor(DataTreeNotificationListenerRegistrationActor.props());
89 if (hasLeader && message.isRegisterOnAllInstances() || isLeader) {
90 doRegistration(message, registrationActor);
92 LOG.debug("{}: Shard does not have a leader - delaying registration", persistenceId());
94 final DelayedDataTreeChangeListenerRegistration<DOMDataTreeChangeListener> delayedReg =
95 new DelayedDataTreeChangeListenerRegistration<>(message, registrationActor);
96 final Collection<DelayedDataTreeChangeListenerRegistration<DOMDataTreeChangeListener>> delayedRegList;
97 if (message.isRegisterOnAllInstances()) {
98 delayedRegList = delayedListenerOnAllRegistrations;
100 delayedRegList = delayedDataTreeChangeListenerRegistrations;
103 delayedRegList.add(delayedReg);
104 registrationActor.tell(new DataTreeNotificationListenerRegistrationActor.SetRegistration(
105 delayedReg, () -> delayedRegList.remove(delayedReg)), ActorRef.noSender());
108 LOG.debug("{}: sending RegisterDataTreeNotificationListenerReply, listenerRegistrationPath = {} ",
109 persistenceId(), registrationActor.path());
111 tellSender(new RegisterDataTreeNotificationListenerReply(registrationActor));
114 private ActorSelection processListenerRegistrationMessage(final RegisterDataTreeChangeListener message) {
115 final ActorSelection listenerActor = selectActor(message.getListenerActorPath());
117 // We have a leader so enable the listener.
118 listenerActor.tell(new EnableNotification(true, persistenceId()), getSelf());
120 if (!message.isRegisterOnAllInstances()) {
121 // This is a leader-only registration so store a reference to the listener actor so it can be notified
122 // at a later point if notifications should be enabled or disabled.
123 leaderOnlyListenerActors.add(listenerActor);
126 allListenerActors.add(listenerActor);
128 return listenerActor;
131 private void removeListenerActor(final ActorSelection listenerActor) {
132 allListenerActors.remove(listenerActor);
133 leaderOnlyListenerActors.remove(listenerActor);