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 akka.actor.ActorRef;
  12 import akka.actor.Props;
  13 import akka.japi.Creator;
  14 import com.google.common.base.Preconditions;
  15 import com.google.common.base.Throwables;
  16 import com.google.common.util.concurrent.CheckedFuture;
  17 import com.google.common.util.concurrent.FutureCallback;
  18 import com.google.common.util.concurrent.Futures;
  19 import java.util.Arrays;
  20 import java.util.Collection;
  21 import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActor;
  22 import org.opendaylight.controller.cluster.datastore.node.utils.serialization.NormalizedNodeSerializer;
  23 import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
  24 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  25 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  26 import org.opendaylight.controller.protobuff.messages.common.NormalizedNodeMessages.Node;
  27 import org.opendaylight.controller.remote.rpc.messages.ExecuteRpc;
  28 import org.opendaylight.controller.remote.rpc.messages.RpcResponse;
  29 import org.opendaylight.yangtools.yang.common.RpcError;
  30 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
  31 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  32 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  33 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 /**
  38  * Actor to initiate execution of remote RPC on other nodes of the cluster.
  39  */
  40
  41 public class RpcBroker extends AbstractUntypedActor {
  42
  43     private static final Logger LOG = LoggerFactory.getLogger(RpcBroker.class);
  44     private final DOMRpcService rpcService;
  45
  46     private RpcBroker(final DOMRpcService rpcService) {
  47         this.rpcService = rpcService;
  48     }
  49
  50     public static Props props(final DOMRpcService rpcService) {
  51         Preconditions.checkNotNull(rpcService, "DOMRpcService can not be null");
  52         return Props.create(new RpcBrokerCreator(rpcService));
  53     }
  54
  55     @Override
  56     protected void handleReceive(final Object message) throws Exception {
  57         if (message instanceof ExecuteRpc) {
  58             executeRpc((ExecuteRpc) message);
  59         }
  60     }
  61
  62     private void executeRpc(final ExecuteRpc msg) {
  63         LOG.debug("Executing rpc {}", msg.getRpc());
  64         final NormalizedNode<?, ?> input = RemoteRpcInput.from(msg.getInputNormalizedNode());
  65         final SchemaPath schemaPath = SchemaPath.create(true, msg.getRpc());
  66         final ActorRef sender = getSender();
  67         final ActorRef self = self();
  68
  69         try {
  70             final CheckedFuture<DOMRpcResult, DOMRpcException> future = rpcService.invokeRpc(schemaPath, input);
  71
  72             Futures.addCallback(future, new FutureCallback<DOMRpcResult>() {
  73                 @Override
  74                 public void onSuccess(final DOMRpcResult result) {
  75                     if (result.getErrors() != null && (!result.getErrors().isEmpty())) {
  76                         final String message = String.format("Execution of RPC %s failed", msg.getRpc());
  77                         Collection<RpcError> errors = result.getErrors();
  78                         if (errors == null || errors.size() == 0) {
  79                             errors = Arrays.asList(RpcResultBuilder.newError(ErrorType.RPC, null, message));
  80                         }
  81
  82                         sender.tell(new akka.actor.Status.Failure(new RpcErrorsException(message, errors)), self);
  83                     } else {
  84                         final Node serializedResultNode;
  85                         if (result.getResult() == null) {
  86                             serializedResultNode = null;
  87                         } else {
  88                             serializedResultNode = NormalizedNodeSerializer.serialize(result.getResult());
  89                         }
  90
  91                         LOG.debug("Sending response for execute rpc : {}", msg.getRpc());
  92
  93                         sender.tell(new RpcResponse(serializedResultNode), self);
  94                     }
  95                 }
  96
  97                 @Override
  98                 public void onFailure(final Throwable t) {
  99                     LOG.error("executeRpc for {} failed with root cause: {}. For exception details, enable Debug logging.",
 100                         msg.getRpc(), Throwables.getRootCause(t));
 101                     if(LOG.isDebugEnabled()) {
 102                         LOG.debug("Detailed exception for execute RPC failure :{}", t);
 103                     }
 104                     sender.tell(new akka.actor.Status.Failure(t), self);
 105                 }
 106             });
 107         } catch (final Exception e) {
 108             sender.tell(new akka.actor.Status.Failure(e), sender);
 109         }
 110     }
 111
 112     private static class RpcBrokerCreator implements Creator<RpcBroker> {
 113         private static final long serialVersionUID = 1L;
 114
 115         final DOMRpcService rpcService;
 116
 117         RpcBrokerCreator(final DOMRpcService rpcService) {
 118             this.rpcService = rpcService;
 119         }
 120
 121         @Override
 122         public RpcBroker create() throws Exception {
 123             return new RpcBroker(rpcService);
 124         }
 125     }
 126 }