opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/RpcInvoker.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 akka.actor.ActorRef;
  12 import akka.actor.Props;
  13 import com.google.common.base.Preconditions;
  14 import com.google.common.base.Throwables;
  15 import com.google.common.util.concurrent.CheckedFuture;
  16 import com.google.common.util.concurrent.FutureCallback;
  17 import com.google.common.util.concurrent.Futures;
  18 import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActor;
  19 import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
  20 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  21 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  22 import org.opendaylight.controller.remote.rpc.messages.ExecuteRpc;
  23 import org.opendaylight.controller.remote.rpc.messages.RpcResponse;
  24 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  25 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  26
  27 /**
  28  * Actor receiving invocation requests from remote nodes, routing them to
  29  * {@link DOMRpcService#invokeRpc(SchemaPath, NormalizedNode)}.
  30  */
  31 final class RpcInvoker extends AbstractUntypedActor {
  32     private final DOMRpcService rpcService;
  33
  34     private RpcInvoker(final DOMRpcService rpcService) {
  35         this.rpcService = Preconditions.checkNotNull(rpcService);
  36     }
  37
  38     public static Props props(final DOMRpcService rpcService) {
  39         Preconditions.checkNotNull(rpcService, "DOMRpcService can not be null");
  40         return Props.create(RpcInvoker.class, rpcService);
  41     }
  42
  43     @Override
  44     protected void handleReceive(final Object message) {
  45         if (message instanceof ExecuteRpc) {
  46             executeRpc((ExecuteRpc) message);
  47         } else {
  48             unknownMessage(message);
  49         }
  50     }
  51
  52     @SuppressWarnings("checkstyle:IllegalCatch")
  53     private void executeRpc(final ExecuteRpc msg) {
  54         LOG.debug("Executing rpc {}", msg.getRpc());
  55         final SchemaPath schemaPath = SchemaPath.create(true, msg.getRpc());
  56         final ActorRef sender = getSender();
  57         final ActorRef self = self();
  58
  59         final CheckedFuture<DOMRpcResult, DOMRpcException> future;
  60         try {
  61             future = rpcService.invokeRpc(schemaPath, msg.getInputNormalizedNode());
  62         } catch (final RuntimeException e) {
  63             LOG.debug("Failed to invoke RPC {}", msg.getRpc(), e);
  64             sender.tell(new akka.actor.Status.Failure(e), sender);
  65             return;
  66         }
  67
  68         Futures.addCallback(future, new FutureCallback<DOMRpcResult>() {
  69             @Override
  70             public void onSuccess(final DOMRpcResult result) {
  71                 if (result == null) {
  72                     // This shouldn't happen but the FutureCallback annotates the result param with Nullable so
  73                     // handle null here to avoid FindBugs warning.
  74                     LOG.debug("Got null DOMRpcResult - sending null response for execute rpc : {}", msg.getRpc());
  75                     sender.tell(new RpcResponse(null), self);
  76                     return;
  77                 }
  78
  79                 if (!result.getErrors().isEmpty()) {
  80                     final String message = String.format("Execution of RPC %s failed", msg.getRpc());
  81                     sender.tell(new akka.actor.Status.Failure(new RpcErrorsException(message, result.getErrors())),
  82                         self);
  83                 } else {
  84                     LOG.debug("Sending response for execute rpc : {}", msg.getRpc());
  85                     sender.tell(new RpcResponse(result.getResult()), self);
  86                 }
  87             }
  88
  89             @Override
  90             public void onFailure(final Throwable failure) {
  91                 LOG.debug("Failed to execute RPC {}", msg.getRpc(), failure);
  92                 LOG.error("Failed to execute RPC {} due to {}. More details are available on DEBUG level.",
  93                     msg.getRpc(), Throwables.getRootCause(failure));
  94                 sender.tell(new akka.actor.Status.Failure(failure), self);
  95             }
  96         });
  97     }
  98 }