org.opendaylight.controller.remote.rpc.registry.RpcRegistry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of controller-docs Show documentation
Controller documentation
There is a newer version: 10.0.4
/*
 * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.controller.remote.rpc.registry;

import static com.google.common.base.Preconditions.checkArgument;
import static java.util.Objects.requireNonNull;

import akka.actor.ActorRef;
import akka.actor.Address;
import akka.actor.Props;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Optional;
import java.util.Set;
import org.opendaylight.controller.remote.rpc.RemoteOpsProviderConfig;
import org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.AddOrUpdateRoutes;
import org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.RemoveRoutes;
import org.opendaylight.controller.remote.rpc.registry.gossip.Bucket;
import org.opendaylight.controller.remote.rpc.registry.gossip.BucketStoreAccess;
import org.opendaylight.controller.remote.rpc.registry.gossip.BucketStoreActor;
import org.opendaylight.controller.remote.rpc.registry.mbeans.RemoteRpcRegistryMXBeanImpl;
import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;

/**
 * Registry to look up cluster nodes that have registered for a given RPC.
 *
 * 
 * It uses {@link org.opendaylight.controller.remote.rpc.registry.gossip.BucketStoreActor} to maintain this
 * cluster wide information.
 */
public class RpcRegistry extends BucketStoreActor {
    private final ActorRef rpcRegistrar;
    private RemoteRpcRegistryMXBeanImpl mxBean;

    public RpcRegistry(final RemoteOpsProviderConfig config, final ActorRef rpcInvoker, final ActorRef rpcRegistrar) {
        super(config, config.getRpcRegistryPersistenceId(), new RoutingTable(rpcInvoker, ImmutableSet.of()));
        this.rpcRegistrar = requireNonNull(rpcRegistrar);

    }

    /**
     * Create a new props instance for instantiating an RpcRegistry actor.
     *
     * @param config Provider configuration
     * @param rpcRegistrar Local RPC provider interface, used to register routers to remote nodes
     * @param rpcInvoker Actor handling RPC invocation requests from remote nodes
     * @return A new {@link Props} instance
     */
    public static Props props(final RemoteOpsProviderConfig config, final ActorRef rpcInvoker,
                              final ActorRef rpcRegistrar) {
        return Props.create(RpcRegistry.class, config, rpcInvoker, rpcRegistrar);
    }

    @Override
    public void preStart() {
        super.preStart();
        mxBean = new RemoteRpcRegistryMXBeanImpl(new BucketStoreAccess(self(), getContext().dispatcher(),
            getConfig().getAskDuration()), getConfig().getAskDuration());
    }

    @Override
    public void postStop() throws Exception {
        if (mxBean != null) {
            mxBean.unregister();
            mxBean = null;
        }
        super.postStop();
    }

    @Override
    protected void handleCommand(final Object message) throws Exception {
        if (message instanceof AddOrUpdateRoutes addRoutes) {
            receiveAddRoutes(addRoutes);
        } else if (message instanceof RemoveRoutes removeRoutes) {
            receiveRemoveRoutes(removeRoutes);
        } else {
            super.handleCommand(message);
        }
    }

    private void receiveAddRoutes(final AddOrUpdateRoutes msg) {
        LOG.debug("AddOrUpdateRoutes: {}", msg.getRouteIdentifiers());
        updateLocalBucket(getLocalData().addRpcs(msg.getRouteIdentifiers()));
    }

    /**
     * Processes a RemoveRoutes message.
     *
     * @param msg contains list of route ids to remove
     */
    private void receiveRemoveRoutes(final RemoveRoutes msg) {
        LOG.debug("RemoveRoutes: {}", msg.getRouteIdentifiers());
        updateLocalBucket(getLocalData().removeRpcs(msg.getRouteIdentifiers()));
    }

    @Override
    protected void onBucketRemoved(final Address address, final Bucket bucket) {
        rpcRegistrar.tell(new Messages.UpdateRemoteEndpoints(ImmutableMap.of(address, Optional.empty())),
                ActorRef.noSender());
    }

    @Override
    protected void onBucketsUpdated(final Map> buckets) {
        final Map> endpoints = new HashMap<>(buckets.size());

        for (Entry> e : buckets.entrySet()) {
            final RoutingTable table = e.getValue().getData();

            final Collection rpcs = table.getItems();
            endpoints.put(e.getKey(), rpcs.isEmpty() ? Optional.empty()
                    : Optional.of(new RemoteRpcEndpoint(table.getInvoker(), rpcs)));
        }

        if (!endpoints.isEmpty()) {
            rpcRegistrar.tell(new Messages.UpdateRemoteEndpoints(endpoints), ActorRef.noSender());
        }
    }

    public static final class RemoteRpcEndpoint {
        private final Set rpcs;
        private final ActorRef router;

        @VisibleForTesting
        public RemoteRpcEndpoint(final ActorRef router, final Collection rpcs) {
            this.router = requireNonNull(router);
            this.rpcs = ImmutableSet.copyOf(rpcs);
        }

        public ActorRef getRouter() {
            return router;
        }

        public Set getRpcs() {
            return rpcs;
        }
    }

    /**
     * All messages used by the RpcRegistry.
     */
    public static class Messages {
        abstract static class AbstractRouteMessage {
            final List rpcRouteIdentifiers;

            AbstractRouteMessage(final Collection rpcRouteIdentifiers) {
                checkArgument(rpcRouteIdentifiers != null && !rpcRouteIdentifiers.isEmpty(),
                        "Route Identifiers must be supplied");
                this.rpcRouteIdentifiers = ImmutableList.copyOf(rpcRouteIdentifiers);
            }

            List getRouteIdentifiers() {
                return rpcRouteIdentifiers;
            }

            @Override
            public String toString() {
                return "ContainsRoute{" + "routeIdentifiers=" + rpcRouteIdentifiers + '}';
            }
        }

        public static final class AddOrUpdateRoutes extends Messages.AbstractRouteMessage {
            public AddOrUpdateRoutes(final Collection rpcRouteIdentifiers) {
                super(rpcRouteIdentifiers);
            }

        }

        public static final class RemoveRoutes extends AbstractRouteMessage {
            public RemoveRoutes(final Collection rpcRouteIdentifiers) {
                super(rpcRouteIdentifiers);
            }
        }

        public static final class UpdateRemoteEndpoints {
            private final Map> rpcEndpoints;


            @VisibleForTesting
            public UpdateRemoteEndpoints(final Map> rpcEndpoints) {
                this.rpcEndpoints = ImmutableMap.copyOf(rpcEndpoints);
            }

            public Map> getRpcEndpoints() {
                return rpcEndpoints;
            }
        }
    }
}