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.ActorPath;
11 import akka.actor.ActorRef;
12 import akka.actor.ActorSelection;
13 import akka.actor.Props;
14 import com.google.common.base.Preconditions;
17 * Base class for factories instantiating delegates which are local to the
20 * @param <D> delegate type
21 * @param <M> message type
23 abstract class LeaderLocalDelegateFactory<M> {
24 private final Shard shard;
26 protected LeaderLocalDelegateFactory(final Shard shard) {
27 this.shard = Preconditions.checkNotNull(shard);
30 protected final ActorRef getSelf() {
31 return shard.getSelf();
34 protected final Shard getShard() {
38 protected final String persistenceId() {
39 return shard.persistenceId();
42 protected final void tellSender(final Object message) {
43 shard.getSender().tell(message, getSelf());
46 protected final ActorRef createActor(final Props props) {
47 return shard.getContext().actorOf(props);
50 protected final ActorSelection selectActor(ActorRef ref) {
51 return shard.getContext().system().actorSelection(ref.path());
54 protected final ActorSelection selectActor(ActorPath path) {
55 return shard.getContext().system().actorSelection(path);
59 * Invoked whenever the local shard's leadership role changes.
61 * @param isLeader true if the shard has become leader, false if it has become a follower.
62 * @param hasLeader true if the shard knows about leader ID
64 abstract void onLeadershipChange(boolean isLeader, boolean hasLeader);
66 abstract void onMessage(M message, boolean isLeader, boolean hasLeader);