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.remote.rpc.registry;
10 import akka.actor.ActorRef;
11 import akka.actor.Cancellable;
12 import akka.actor.Props;
13 import akka.japi.Creator;
14 import akka.japi.Option;
15 import akka.japi.Pair;
16 import com.google.common.base.Preconditions;
17 import java.util.ArrayList;
18 import java.util.Collections;
19 import java.util.HashSet;
20 import java.util.List;
22 import java.util.concurrent.atomic.AtomicReference;
23 import org.opendaylight.controller.remote.rpc.RemoteRpcProviderConfig;
24 import org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.AddOrUpdateRoutes;
25 import org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.FindRouters;
26 import org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.RemoveRoutes;
27 import org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.SetLocalRouter;
28 import org.opendaylight.controller.remote.rpc.registry.gossip.Bucket;
29 import org.opendaylight.controller.remote.rpc.registry.gossip.BucketStore;
30 import org.opendaylight.controller.remote.rpc.registry.mbeans.RemoteRpcRegistryMXBeanImpl;
31 import org.opendaylight.controller.sal.connector.api.RpcRouter;
32 import org.opendaylight.controller.sal.connector.api.RpcRouter.RouteIdentifier;
33 import scala.concurrent.duration.FiniteDuration;
36 * Registry to look up cluster nodes that have registered for a given rpc.
39 * It uses {@link org.opendaylight.controller.remote.rpc.registry.gossip.BucketStore} to maintain this
40 * cluster wide information.
42 public class RpcRegistry extends BucketStore<RoutingTable> {
43 private final Set<Runnable> routesUpdatedCallbacks = new HashSet<>();
44 private final FiniteDuration findRouterTimeout;
46 public RpcRegistry(RemoteRpcProviderConfig config) {
48 getLocalBucket().setData(new RoutingTable());
49 findRouterTimeout = getConfig().getGossipTickInterval().$times(10);
52 public static Props props(RemoteRpcProviderConfig config) {
53 return Props.create(new RpcRegistryCreator(config));
57 protected void handleReceive(Object message) throws Exception {
58 //TODO: if sender is remote, reject message
60 if (message instanceof SetLocalRouter) {
61 receiveSetLocalRouter((SetLocalRouter) message);
62 } else if (message instanceof AddOrUpdateRoutes) {
63 receiveAddRoutes((AddOrUpdateRoutes) message);
64 } else if (message instanceof RemoveRoutes) {
65 receiveRemoveRoutes((RemoveRoutes) message);
66 } else if (message instanceof Messages.FindRouters) {
67 receiveGetRouter((FindRouters) message);
68 } else if (message instanceof Runnable) {
69 ((Runnable)message).run();
71 super.handleReceive(message);
76 * Registers a rpc broker.
78 * @param message contains {@link akka.actor.ActorRef} for rpc broker
80 private void receiveSetLocalRouter(SetLocalRouter message) {
81 getLocalBucket().getData().setRouter(message.getRouter());
84 private void receiveAddRoutes(AddOrUpdateRoutes msg) {
86 log.debug("AddOrUpdateRoutes: {}", msg.getRouteIdentifiers());
88 RoutingTable table = getLocalBucket().getData().copy();
89 for (RpcRouter.RouteIdentifier<?, ?, ?> routeId : msg.getRouteIdentifiers()) {
90 table.addRoute(routeId);
93 updateLocalBucket(table);
99 * Processes a RemoveRoutes message.
101 * @param msg contains list of route ids to remove
103 private void receiveRemoveRoutes(RemoveRoutes msg) {
105 RoutingTable table = getLocalBucket().getData().copy();
106 for (RpcRouter.RouteIdentifier<?, ?, ?> routeId : msg.getRouteIdentifiers()) {
107 table.removeRoute(routeId);
110 updateLocalBucket(table);
114 * Finds routers for the given rpc.
116 * @param findRouters the FindRouters request
118 private void receiveGetRouter(final FindRouters findRouters) {
119 log.debug("receiveGetRouter for {}", findRouters.getRouteIdentifier());
121 final ActorRef sender = getSender();
122 if (!findRouters(findRouters, sender)) {
123 log.debug("No routers found for {} - scheduling {} ms timer", findRouters.getRouteIdentifier(),
124 findRouterTimeout.toMillis());
126 final AtomicReference<Cancellable> timer = new AtomicReference<>();
127 final Runnable routesUpdatedRunnable = new Runnable() {
130 if (findRouters(findRouters, sender)) {
131 routesUpdatedCallbacks.remove(this);
132 timer.get().cancel();
137 routesUpdatedCallbacks.add(routesUpdatedRunnable);
139 Runnable timerRunnable = () -> {
140 log.warn("Timed out finding routers for {}", findRouters.getRouteIdentifier());
142 routesUpdatedCallbacks.remove(routesUpdatedRunnable);
143 sender.tell(new Messages.FindRoutersReply(
144 Collections.<Pair<ActorRef, Long>>emptyList()), self());
147 timer.set(getContext().system().scheduler().scheduleOnce(findRouterTimeout, self(), timerRunnable,
148 getContext().dispatcher(), self()));
152 private boolean findRouters(FindRouters findRouters, ActorRef sender) {
153 List<Pair<ActorRef, Long>> routers = new ArrayList<>();
155 RouteIdentifier<?, ?, ?> routeId = findRouters.getRouteIdentifier();
156 findRoutes(getLocalBucket().getData(), routeId, routers);
158 for (Bucket<RoutingTable> bucket : getRemoteBuckets().values()) {
159 findRoutes(bucket.getData(), routeId, routers);
162 log.debug("Found {} routers for {}", routers.size(), findRouters.getRouteIdentifier());
164 boolean foundRouters = !routers.isEmpty();
166 sender.tell(new Messages.FindRoutersReply(routers), getSelf());
172 private void findRoutes(RoutingTable table, RpcRouter.RouteIdentifier<?, ?, ?> routeId,
173 List<Pair<ActorRef, Long>> routers) {
178 Option<Pair<ActorRef, Long>> routerWithUpdateTime = table.getRouterFor(routeId);
179 if (!routerWithUpdateTime.isEmpty()) {
180 routers.add(routerWithUpdateTime.get());
185 protected void onBucketsUpdated() {
186 if (routesUpdatedCallbacks.isEmpty()) {
190 for (Runnable callBack: routesUpdatedCallbacks.toArray(new Runnable[routesUpdatedCallbacks.size()])) {
196 * All messages used by the RpcRegistry.
198 public static class Messages {
201 public static class ContainsRoute {
202 final List<RpcRouter.RouteIdentifier<?, ?, ?>> routeIdentifiers;
204 public ContainsRoute(List<RpcRouter.RouteIdentifier<?, ?, ?>> routeIdentifiers) {
205 Preconditions.checkArgument(routeIdentifiers != null && !routeIdentifiers.isEmpty(),
206 "Route Identifiers must be supplied");
207 this.routeIdentifiers = routeIdentifiers;
210 public List<RpcRouter.RouteIdentifier<?, ?, ?>> getRouteIdentifiers() {
211 return this.routeIdentifiers;
215 public String toString() {
216 return "ContainsRoute{" + "routeIdentifiers=" + routeIdentifiers + '}';
220 public static class AddOrUpdateRoutes extends ContainsRoute {
222 public AddOrUpdateRoutes(List<RpcRouter.RouteIdentifier<?, ?, ?>> routeIdentifiers) {
223 super(routeIdentifiers);
227 public static class RemoveRoutes extends ContainsRoute {
229 public RemoveRoutes(List<RpcRouter.RouteIdentifier<?, ?, ?>> routeIdentifiers) {
230 super(routeIdentifiers);
234 public static class SetLocalRouter {
235 private final ActorRef router;
237 public SetLocalRouter(ActorRef router) {
238 Preconditions.checkArgument(router != null, "Router must not be null");
239 this.router = router;
242 public ActorRef getRouter() {
247 public String toString() {
248 return "SetLocalRouter{" + "router=" + router + '}';
252 public static class FindRouters {
253 private final RpcRouter.RouteIdentifier<?, ?, ?> routeIdentifier;
255 public FindRouters(RpcRouter.RouteIdentifier<?, ?, ?> routeIdentifier) {
256 Preconditions.checkArgument(routeIdentifier != null, "Route must not be null");
257 this.routeIdentifier = routeIdentifier;
260 public RpcRouter.RouteIdentifier<?, ?, ?> getRouteIdentifier() {
261 return routeIdentifier;
265 public String toString() {
266 return "FindRouters{" + "routeIdentifier=" + routeIdentifier + '}';
270 public static class FindRoutersReply {
271 final List<Pair<ActorRef, Long>> routerWithUpdateTime;
273 public FindRoutersReply(List<Pair<ActorRef, Long>> routerWithUpdateTime) {
274 Preconditions.checkArgument(routerWithUpdateTime != null, "List of routers found must not be null");
275 this.routerWithUpdateTime = routerWithUpdateTime;
278 public List<Pair<ActorRef, Long>> getRouterWithUpdateTime() {
279 return routerWithUpdateTime;
283 public String toString() {
284 return "FindRoutersReply{" + "routerWithUpdateTime=" + routerWithUpdateTime + '}';
289 private static class RpcRegistryCreator implements Creator<RpcRegistry> {
290 private static final long serialVersionUID = 1L;
291 private final RemoteRpcProviderConfig config;
293 private RpcRegistryCreator(RemoteRpcProviderConfig config) {
294 this.config = config;
298 public RpcRegistry create() throws Exception {
299 RpcRegistry registry = new RpcRegistry(config);
300 new RemoteRpcRegistryMXBeanImpl(registry);