2 * Copyright (c) 2015 Brocade Communications 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 com.google.common.base.Optional;
13 import java.util.ArrayList;
14 import java.util.Collection;
15 import java.util.EventListener;
16 import java.util.Map.Entry;
17 import org.opendaylight.controller.cluster.datastore.messages.EnableNotification;
18 import org.opendaylight.controller.cluster.datastore.messages.ListenerRegistrationMessage;
19 import org.opendaylight.yangtools.concepts.ListenerRegistration;
20 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
21 import org.slf4j.Logger;
22 import org.slf4j.LoggerFactory;
24 abstract class AbstractDataListenerSupport<L extends EventListener, M extends ListenerRegistrationMessage,
25 D extends DelayedListenerRegistration<L, M>, R extends ListenerRegistration<L>>
26 extends LeaderLocalDelegateFactory<M, R, Optional<DataTreeCandidate>> {
27 private final Logger log = LoggerFactory.getLogger(getClass());
29 private final ArrayList<D> delayedListenerRegistrations = new ArrayList<>();
30 private final ArrayList<D> delayedListenerOnAllRegistrations = new ArrayList<>();
31 private final Collection<ActorSelection> actors = new ArrayList<>();
33 protected AbstractDataListenerSupport(Shard shard) {
38 void onLeadershipChange(boolean isLeader, boolean hasLeader) {
39 log.debug("{}: onLeadershipChange, isLeader: {}, hasLeader : {}", persistenceId(), isLeader, hasLeader);
41 final EnableNotification msg = new EnableNotification(isLeader);
42 for (ActorSelection dataChangeListener : actors) {
43 dataChangeListener.tell(msg, getSelf());
47 for (D reg : delayedListenerOnAllRegistrations) {
48 reg.createDelegate(this);
51 delayedListenerOnAllRegistrations.clear();
52 delayedListenerOnAllRegistrations.trimToSize();
56 for (D reg : delayedListenerRegistrations) {
57 reg.createDelegate(this);
60 delayedListenerRegistrations.clear();
61 delayedListenerRegistrations.trimToSize();
66 void onMessage(M message, boolean isLeader, boolean hasLeader) {
67 log.debug("{}: {} for {}, leader: {}", persistenceId(), logName(), message.getPath(), isLeader);
69 final ListenerRegistration<L> registration;
70 if (hasLeader && message.isRegisterOnAllInstances() || isLeader) {
71 final Entry<R, Optional<DataTreeCandidate>> res = createDelegate(message);
72 registration = res.getKey();
74 log.debug("{}: Shard is not the leader - delaying registration", persistenceId());
76 D delayedReg = newDelayedListenerRegistration(message);
77 if (message.isRegisterOnAllInstances()) {
78 delayedListenerOnAllRegistrations.add(delayedReg);
80 delayedListenerRegistrations.add(delayedReg);
83 registration = delayedReg;
86 ActorRef registrationActor = newRegistrationActor(registration);
88 log.debug("{}: {} sending reply, listenerRegistrationPath = {} ", persistenceId(), logName(),
89 registrationActor.path());
91 tellSender(newRegistrationReplyMessage(registrationActor));
94 protected Logger log() {
98 protected void addListenerActor(ActorSelection actor) {
102 protected abstract D newDelayedListenerRegistration(M message);
104 protected abstract ActorRef newRegistrationActor(ListenerRegistration<L> registration);
106 protected abstract Object newRegistrationReplyMessage(ActorRef registrationActor);
108 protected abstract String logName();