opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/RpcBroker.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.controller.remote.rpc;
  10
  11 import static akka.pattern.Patterns.ask;
  12
  13 import akka.actor.ActorRef;
  14 import akka.actor.Props;
  15 import akka.dispatch.OnComplete;
  16 import akka.japi.Creator;
  17 import akka.japi.Pair;
  18 import com.google.common.base.Preconditions;
  19 import com.google.common.util.concurrent.CheckedFuture;
  20 import com.google.common.util.concurrent.FutureCallback;
  21 import com.google.common.util.concurrent.Futures;
  22 import com.google.common.util.concurrent.JdkFutureAdapters;
  23 import com.google.common.util.concurrent.ListenableFuture;
  24 import java.util.Arrays;
  25 import java.util.Collection;
  26 import java.util.List;
  27 import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActor;
  28 import org.opendaylight.controller.cluster.datastore.node.utils.serialization.NormalizedNodeSerializer;
  29 import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
  30 import org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementationNotAvailableException;
  31 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  32 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  33 import org.opendaylight.controller.protobuff.messages.common.NormalizedNodeMessages.Node;
  34 import org.opendaylight.controller.remote.rpc.messages.ExecuteRpc;
  35 import org.opendaylight.controller.remote.rpc.messages.InvokeRpc;
  36 import org.opendaylight.controller.remote.rpc.messages.RpcResponse;
  37 import org.opendaylight.controller.remote.rpc.registry.RpcRegistry;
  38 import org.opendaylight.controller.remote.rpc.utils.LatestEntryRoutingLogic;
  39 import org.opendaylight.controller.remote.rpc.utils.RoutingLogic;
  40 import org.opendaylight.controller.sal.connector.api.RpcRouter;
  41 import org.opendaylight.yangtools.yang.common.RpcError;
  42 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
  43 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  44 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  45 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  46 import org.slf4j.Logger;
  47 import org.slf4j.LoggerFactory;
  48
  49 /**
  50  * Actor to initiate execution of remote RPC on other nodes of the cluster.
  51  */
  52
  53 public class RpcBroker extends AbstractUntypedActor {
  54
  55     private static final Logger LOG = LoggerFactory.getLogger(RpcBroker.class);
  56     private final ActorRef rpcRegistry;
  57     private final RemoteRpcProviderConfig config;
  58     private final DOMRpcService rpcService;
  59
  60     private RpcBroker(final DOMRpcService rpcService, final ActorRef rpcRegistry) {
  61         this.rpcService = rpcService;
  62         this.rpcRegistry = rpcRegistry;
  63         config = new RemoteRpcProviderConfig(getContext().system().settings().config());
  64     }
  65
  66     public static Props props(final DOMRpcService rpcService, final ActorRef rpcRegistry) {
  67         Preconditions.checkNotNull(rpcRegistry, "ActorRef can not be null!");
  68         Preconditions.checkNotNull(rpcService, "DOMRpcService can not be null");
  69         return Props.create(new RpcBrokerCreator(rpcService, rpcRegistry));
  70     }
  71
  72     @Override
  73     protected void handleReceive(final Object message) throws Exception {
  74         if(message instanceof InvokeRpc) {
  75             invokeRemoteRpc((InvokeRpc) message);
  76         } else if(message instanceof ExecuteRpc) {
  77             executeRpc((ExecuteRpc) message);
  78         }
  79     }
  80
  81     private void invokeRemoteRpc(final InvokeRpc msg) {
  82         if(LOG.isDebugEnabled()) {
  83             LOG.debug("Looking up the remote actor for rpc {}", msg.getRpc());
  84         }
  85         final RpcRouter.RouteIdentifier<?,?,?> routeId = new RouteIdentifierImpl(
  86                 null, msg.getRpc(), msg.getIdentifier());
  87         final RpcRegistry.Messages.FindRouters findMsg = new RpcRegistry.Messages.FindRouters(routeId);
  88
  89         final scala.concurrent.Future<Object> future = ask(rpcRegistry, findMsg, config.getAskDuration());
  90
  91         final ActorRef sender = getSender();
  92         final ActorRef self = self();
  93
  94         final OnComplete<Object> onComplete = new OnComplete<Object>() {
  95             @Override
  96             public void onComplete(final Throwable failure, final Object reply) throws Throwable {
  97                 if(failure != null) {
  98                     LOG.error("FindRouters failed", failure);
  99                     sender.tell(new akka.actor.Status.Failure(failure), self);
 100                     return;
 101                 }
 102
 103                 final RpcRegistry.Messages.FindRoutersReply findReply =
 104                                                 (RpcRegistry.Messages.FindRoutersReply)reply;
 105
 106                 final List<Pair<ActorRef, Long>> actorRefList = findReply.getRouterWithUpdateTime();
 107
 108                 if(actorRefList == null || actorRefList.isEmpty()) {
 109                     sender.tell(new akka.actor.Status.Failure(new DOMRpcImplementationNotAvailableException(
 110                             "No remote implementation available for rpc %s", msg.getRpc())), self);
 111                     return;
 112                 }
 113                 finishInvokeRpc(actorRefList, msg, sender, self);
 114             }
 115         };
 116
 117         future.onComplete(onComplete, getContext().dispatcher());
 118     }
 119
 120     protected void finishInvokeRpc(final List<Pair<ActorRef, Long>> actorRefList,
 121             final InvokeRpc msg, final ActorRef sender, final ActorRef self) {
 122
 123         final RoutingLogic logic = new LatestEntryRoutingLogic(actorRefList);
 124
 125         final Node serializedNode = NormalizedNodeSerializer.serialize(msg.getInput());
 126         final ExecuteRpc executeMsg = new ExecuteRpc(serializedNode, msg.getRpc());
 127
 128         final scala.concurrent.Future<Object> future = ask(logic.select(), executeMsg, config.getAskDuration());
 129
 130         final OnComplete<Object> onComplete = new OnComplete<Object>() {
 131             @Override
 132             public void onComplete(final Throwable failure, final Object reply) throws Throwable {
 133                 if(failure != null) {
 134                     LOG.error("ExecuteRpc failed", failure);
 135                     sender.tell(new akka.actor.Status.Failure(failure), self);
 136                     return;
 137                 }
 138
 139                 LOG.debug("Execute Rpc response received for rpc : {}, responding to sender : {}", msg.getRpc(), sender);
 140
 141                 sender.tell(reply, self);
 142             }
 143         };
 144
 145         future.onComplete(onComplete, getContext().dispatcher());
 146     }
 147
 148     private void executeRpc(final ExecuteRpc msg) {
 149         if(LOG.isDebugEnabled()) {
 150             LOG.debug("Executing rpc {}", msg.getRpc());
 151         }
 152         final NormalizedNode<?, ?> input = NormalizedNodeSerializer.deSerialize(msg.getInputNormalizedNode());
 153         final SchemaPath schemaPath = SchemaPath.create(true, msg.getRpc());
 154
 155         final CheckedFuture<DOMRpcResult, DOMRpcException> future = rpcService.invokeRpc(schemaPath, input);
 156
 157         final ListenableFuture<DOMRpcResult> listenableFuture =
 158                 JdkFutureAdapters.listenInPoolThread(future);
 159
 160         final ActorRef sender = getSender();
 161         final ActorRef self = self();
 162
 163         Futures.addCallback(listenableFuture, new FutureCallback<DOMRpcResult>() {
 164             @Override
 165             public void onSuccess(final DOMRpcResult result) {
 166                 if (result.getErrors() != null && ( ! result.getErrors().isEmpty())) {
 167                     final String message = String.format("Execution of RPC %s failed",  msg.getRpc());
 168                     Collection<RpcError> errors = result.getErrors();
 169                     if(errors == null || errors.size() == 0) {
 170                         errors = Arrays.asList(RpcResultBuilder.newError(ErrorType.RPC,
 171                                 null, message));
 172                     }
 173
 174                     sender.tell(new akka.actor.Status.Failure(new RpcErrorsException(
 175                             message, errors)), self);
 176                 } else {
 177                     final Node serializedResultNode;
 178                     if(result.getResult() == null){
 179                         serializedResultNode = null;
 180                     } else {
 181                         serializedResultNode = NormalizedNodeSerializer.serialize(result.getResult());
 182                     }
 183
 184                     LOG.debug("Sending response for execute rpc : {}", msg.getRpc());
 185
 186                     sender.tell(new RpcResponse(serializedResultNode), self);
 187                 }
 188             }
 189
 190             @Override
 191             public void onFailure(final Throwable t) {
 192                 LOG.error("executeRpc for {} failed: {}", msg.getRpc(), t);
 193                 sender.tell(new akka.actor.Status.Failure(t), self);
 194             }
 195         });
 196     }
 197
 198     private static class RpcBrokerCreator implements Creator<RpcBroker> {
 199         private static final long serialVersionUID = 1L;
 200
 201         final DOMRpcService rpcService;
 202         final ActorRef rpcRegistry;
 203
 204         RpcBrokerCreator(final DOMRpcService rpcService, final ActorRef rpcRegistry) {
 205             this.rpcService = rpcService;
 206             this.rpcRegistry = rpcRegistry;
 207         }
 208
 209         @Override
 210         public RpcBroker create() throws Exception {
 211             return new RpcBroker(rpcService, rpcRegistry);
 212         }
 213     }
 214 }