2 * Copyright (c) 2021 PANTHEON.tech, s.r.o. 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.eos.akka.owner.supervisor;
10 import static java.util.Objects.requireNonNull;
12 import akka.actor.typed.ActorRef;
13 import akka.actor.typed.Behavior;
14 import akka.actor.typed.javadsl.ActorContext;
15 import akka.actor.typed.javadsl.Behaviors;
16 import akka.actor.typed.javadsl.Receive;
17 import akka.cluster.ddata.LWWRegister;
18 import akka.cluster.ddata.LWWRegisterKey;
19 import akka.cluster.ddata.ORMap;
20 import akka.cluster.ddata.ORSet;
21 import akka.cluster.ddata.typed.javadsl.DistributedData;
22 import akka.cluster.ddata.typed.javadsl.Replicator;
23 import akka.cluster.ddata.typed.javadsl.ReplicatorMessageAdapter;
24 import akka.pattern.StatusReply;
25 import java.time.Duration;
26 import java.util.HashMap;
27 import java.util.HashSet;
30 import org.eclipse.jdt.annotation.Nullable;
31 import org.opendaylight.controller.eos.akka.owner.supervisor.command.ClearCandidates;
32 import org.opendaylight.controller.eos.akka.owner.supervisor.command.ClearCandidatesForMember;
33 import org.opendaylight.controller.eos.akka.owner.supervisor.command.DataCenterActivated;
34 import org.opendaylight.controller.eos.akka.owner.supervisor.command.GetEntitiesBackendRequest;
35 import org.opendaylight.controller.eos.akka.owner.supervisor.command.GetEntityBackendRequest;
36 import org.opendaylight.controller.eos.akka.owner.supervisor.command.GetEntityOwnerBackendRequest;
37 import org.opendaylight.controller.eos.akka.owner.supervisor.command.InitialCandidateSync;
38 import org.opendaylight.controller.eos.akka.owner.supervisor.command.InitialOwnerSync;
39 import org.opendaylight.controller.eos.akka.owner.supervisor.command.OwnerSupervisorCommand;
40 import org.opendaylight.controller.eos.akka.owner.supervisor.command.OwnerSupervisorReply;
41 import org.opendaylight.controller.eos.akka.owner.supervisor.command.OwnerSupervisorRequest;
42 import org.opendaylight.controller.eos.akka.registry.candidate.CandidateRegistry;
43 import org.opendaylight.mdsal.binding.dom.codec.api.BindingInstanceIdentifierCodec;
44 import org.opendaylight.mdsal.eos.dom.api.DOMEntity;
45 import org.slf4j.Logger;
46 import org.slf4j.LoggerFactory;
49 * Behavior that retrieves current candidates/owners from distributed-data and switches to OwnerSupervisor when the
52 public final class OwnerSyncer extends AbstractSupervisor {
53 private static final Logger LOG = LoggerFactory.getLogger(OwnerSyncer.class);
55 private final ReplicatorMessageAdapter<OwnerSupervisorCommand, LWWRegister<String>> ownerReplicator;
56 private final Map<DOMEntity, Set<String>> currentCandidates = new HashMap<>();
57 private final Map<DOMEntity, String> currentOwners = new HashMap<>();
59 // String representation of Entity to DOMEntity
60 private final Map<String, DOMEntity> entityLookup = new HashMap<>();
61 private final BindingInstanceIdentifierCodec iidCodec;
63 private int toSync = -1;
65 private OwnerSyncer(final ActorContext<OwnerSupervisorCommand> context,
66 final @Nullable ActorRef<OwnerSupervisorReply> notifyDatacenterStarted,
67 final BindingInstanceIdentifierCodec iidCodec) {
69 this.iidCodec = requireNonNull(iidCodec);
70 LOG.debug("Starting candidate and owner sync");
72 final ActorRef<Replicator.Command> replicator = DistributedData.get(context.getSystem()).replicator();
74 ownerReplicator = new ReplicatorMessageAdapter<>(context, replicator, Duration.ofSeconds(5));
76 candidateReplicator.askGet(
77 askReplyTo -> new Replicator.Get<>(CandidateRegistry.KEY, Replicator.readLocal(), askReplyTo),
78 InitialCandidateSync::new);
80 if (notifyDatacenterStarted != null) {
81 notifyDatacenterStarted.tell(DataCenterActivated.INSTANCE);
85 public static Behavior<OwnerSupervisorCommand> create(final ActorRef<OwnerSupervisorReply> notifyDatacenterStarted,
86 final BindingInstanceIdentifierCodec iidCodec) {
87 return Behaviors.setup(ctx -> new OwnerSyncer(ctx, notifyDatacenterStarted, iidCodec));
91 public Receive<OwnerSupervisorCommand> createReceive() {
92 return newReceiveBuilder()
93 .onMessage(InitialCandidateSync.class, this::onInitialCandidateSync)
94 .onMessage(InitialOwnerSync.class, this::onInitialOwnerSync)
95 .onMessage(GetEntitiesBackendRequest.class, this::onFailEntityRpc)
96 .onMessage(GetEntityBackendRequest.class, this::onFailEntityRpc)
97 .onMessage(GetEntityOwnerBackendRequest.class, this::onFailEntityRpc)
98 .onMessage(ClearCandidatesForMember.class, this::onClearCandidatesForMember)
99 .onMessage(ClearCandidates.class, this::finishClearCandidates)
103 private Behavior<OwnerSupervisorCommand> onFailEntityRpc(final OwnerSupervisorRequest message) {
104 LOG.debug("Failing rpc request. {}", message);
105 message.getReplyTo().tell(StatusReply.error(
106 "OwnerSupervisor is inactive so it cannot handle entity rpc requests."));
110 private Behavior<OwnerSupervisorCommand> onInitialCandidateSync(final InitialCandidateSync rsp) {
111 final Replicator.GetResponse<ORMap<DOMEntity, ORSet<String>>> response = rsp.getResponse();
112 if (response instanceof Replicator.GetSuccess) {
113 return doInitialSync((Replicator.GetSuccess<ORMap<DOMEntity, ORSet<String>>>) response);
114 } else if (response instanceof Replicator.NotFound) {
115 LOG.debug("No candidates found switching to supervisor");
116 return switchToSupervisor();
118 LOG.debug("Initial candidate sync failed, switching to supervisor. Sync reply: {}", response);
119 return switchToSupervisor();
123 private Behavior<OwnerSupervisorCommand> doInitialSync(
124 final Replicator.GetSuccess<ORMap<DOMEntity, ORSet<String>>> response) {
126 final ORMap<DOMEntity, ORSet<String>> candidates = response.get(CandidateRegistry.KEY);
127 candidates.getEntries().entrySet().forEach(entry -> {
128 currentCandidates.put(entry.getKey(), new HashSet<>(entry.getValue().getElements()));
131 toSync = candidates.keys().size();
132 for (final DOMEntity entity : candidates.keys().getElements()) {
133 entityLookup.put(entity.toString(), entity);
135 ownerReplicator.askGet(
136 askReplyTo -> new Replicator.Get<>(
137 new LWWRegisterKey<>(entity.toString()),
138 Replicator.readLocal(),
140 InitialOwnerSync::new);
146 private Behavior<OwnerSupervisorCommand> onInitialOwnerSync(final InitialOwnerSync rsp) {
147 final Replicator.GetResponse<LWWRegister<String>> response = rsp.getResponse();
148 if (response instanceof Replicator.GetSuccess) {
149 handleOwnerRsp((Replicator.GetSuccess<LWWRegister<String>>) response);
150 } else if (response instanceof Replicator.NotFound) {
151 handleNotFoundOwnerRsp((Replicator.NotFound<LWWRegister<String>>) response);
153 LOG.debug("Initial sync failed response: {}", response);
156 // count the responses, on last switch behaviors
159 return switchToSupervisor();
165 private Behavior<OwnerSupervisorCommand> switchToSupervisor() {
166 LOG.debug("Initial sync done, switching to supervisor. candidates: {}, owners: {}",
167 currentCandidates, currentOwners);
168 return Behaviors.setup(ctx -> OwnerSupervisor.create(currentCandidates, currentOwners, iidCodec));
171 private void handleOwnerRsp(final Replicator.GetSuccess<LWWRegister<String>> rsp) {
172 final DOMEntity entity = entityLookup.get(rsp.key().id());
173 final String owner = rsp.get(rsp.key()).getValue();
175 currentOwners.put(entity, owner);
178 private static void handleNotFoundOwnerRsp(final Replicator.NotFound<LWWRegister<String>> rsp) {
179 LOG.debug("Owner not found. {}", rsp);