BUG 3566 : Get remote-rpc working again
[controller.git] / opendaylight / md-sal / sal-remoterpc-connector / src / main / java / org / opendaylight / controller / remote / rpc / RemoteRpcImplementation.java
index 0f84abb22e8e6ca92d36e5486dac0f08ba699720..23d1e85e23c355721c31e22bda7d6e7232c9cfd1 100644 (file)
 package org.opendaylight.controller.remote.rpc;
 
+import static akka.pattern.Patterns.ask;
 import akka.actor.ActorRef;
 import akka.dispatch.OnComplete;
+import com.google.common.util.concurrent.CheckedFuture;
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.JdkFutureAdapters;
 import com.google.common.util.concurrent.ListenableFuture;
 import com.google.common.util.concurrent.SettableFuture;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.concurrent.ExecutionException;
+import org.opendaylight.controller.cluster.datastore.node.utils.serialization.NormalizedNodeSerializer;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcIdentifier;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementation;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementationNotAvailableException;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
+import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
 import org.opendaylight.controller.remote.rpc.messages.InvokeRpc;
 import org.opendaylight.controller.remote.rpc.messages.RpcResponse;
-import org.opendaylight.controller.sal.core.api.RoutedRpcDefaultImplementation;
-import org.opendaylight.controller.sal.core.api.RpcImplementation;
-import org.opendaylight.controller.xml.codec.XmlUtils;
-import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.RpcError;
 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
-import org.opendaylight.yangtools.yang.common.RpcResult;
 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
-import org.opendaylight.yangtools.yang.data.api.CompositeNode;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import scala.concurrent.ExecutionContext;
 
-import java.util.Collections;
-import java.util.Set;
-
-import static akka.pattern.Patterns.ask;
-
-public class RemoteRpcImplementation implements RpcImplementation, RoutedRpcDefaultImplementation {
+public class RemoteRpcImplementation implements DOMRpcImplementation {
     private static final Logger LOG = LoggerFactory.getLogger(RemoteRpcImplementation.class);
     private final ActorRef rpcBroker;
-    private final SchemaContext schemaContext;
     private final RemoteRpcProviderConfig config;
 
-    public RemoteRpcImplementation(ActorRef rpcBroker, SchemaContext schemaContext, RemoteRpcProviderConfig config) {
+    public RemoteRpcImplementation(final ActorRef rpcBroker, final RemoteRpcProviderConfig config) {
         this.rpcBroker = rpcBroker;
-        this.schemaContext = schemaContext;
         this.config = config;
     }
 
     @Override
-    public ListenableFuture<RpcResult<CompositeNode>> invokeRpc(QName rpc,
-            YangInstanceIdentifier identifier, CompositeNode input) {
-        InvokeRpc rpcMsg = new InvokeRpc(rpc, identifier, input);
+    public CheckedFuture<DOMRpcResult, DOMRpcException> invokeRpc(final DOMRpcIdentifier rpc, final NormalizedNode<?, ?> input) {
+        final InvokeRpc rpcMsg = new InvokeRpc(rpc.getType().getLastComponent(), rpc.getContextReference(), input);
 
-        return executeMsg(rpcMsg);
-    }
+        final SettableFuture<DOMRpcResult> settableFuture = SettableFuture.create();
 
-    @Override
-    public Set<QName> getSupportedRpcs() {
-        // TODO : check if we need to get this from routing registry
-        return Collections.emptySet();
-    }
+        final ListenableFuture<DOMRpcResult> listenableFuture =
+                JdkFutureAdapters.listenInPoolThread(settableFuture);
 
-    @Override
-    public ListenableFuture<RpcResult<CompositeNode>> invokeRpc(QName rpc, CompositeNode input) {
-        InvokeRpc rpcMsg = new InvokeRpc(rpc, null, input);
-        return executeMsg(rpcMsg);
-    }
+        final scala.concurrent.Future<Object> future = ask(rpcBroker, rpcMsg, config.getAskDuration());
+
+        final OnComplete<Object> onComplete = new OnComplete<Object>() {
+            @Override
+            public void onComplete(final Throwable failure, final Object reply) throws Throwable {
+                if(failure != null) {
 
-    private ListenableFuture<RpcResult<CompositeNode>> executeMsg(InvokeRpc rpcMsg) {
+                    // When we return a failure to the caller they can choose to log it if they like
+                    // so here we just do basic warn logging by default and log the stack trace only when debug
+                    // is enabled
 
-        final SettableFuture<RpcResult<CompositeNode>> listenableFuture = SettableFuture.create();
+                    LOG.warn("InvokeRpc failed rpc = {}, identifier = {}", rpcMsg.getRpc(), rpcMsg.getIdentifier());
 
-        scala.concurrent.Future<Object> future = ask(rpcBroker, rpcMsg, config.getAskDuration());
+                    if(LOG.isDebugEnabled()){
+                        LOG.debug("Detailed Error", failure);
+                    }
 
-        OnComplete<Object> onComplete = new OnComplete<Object>() {
-            @Override
-            public void onComplete(Throwable failure, Object reply) throws Throwable {
-                if(failure != null) {
-                    LOG.error("InvokeRpc failed", failure);
-
-                    RpcResult<CompositeNode> rpcResult;
-                    if(failure instanceof RpcErrorsException) {
-                        rpcResult = RpcResultBuilder.<CompositeNode>failed().withRpcErrors(
-                                ((RpcErrorsException)failure).getRpcErrors()).build();
-                    } else {
-                        rpcResult = RpcResultBuilder.<CompositeNode>failed().withError(
-                                ErrorType.RPC, failure.getMessage(), failure).build();
+                    final String message = String.format("Execution of RPC %s failed",  rpcMsg.getRpc());
+                    Collection<RpcError> errors = ((RpcErrorsException)failure).getRpcErrors();
+                    if(errors == null || errors.size() == 0) {
+                        errors = Arrays.asList(RpcResultBuilder.newError(ErrorType.RPC, null, message));
                     }
+                    final DOMRpcResult rpcResult = new DefaultDOMRpcResult(errors);
 
-                    listenableFuture.set(rpcResult);
+                    settableFuture.set(rpcResult);
                     return;
                 }
 
-                RpcResponse rpcReply = (RpcResponse)reply;
-                CompositeNode result = XmlUtils.xmlToCompositeNode(rpcReply.getResultCompositeNode());
-                listenableFuture.set(RpcResultBuilder.success(result).build());
+                final RpcResponse rpcReply = (RpcResponse)reply;
+                final NormalizedNode<?, ?> result;
+
+                if(rpcReply.getResultNormalizedNode() == null){
+                    result = null;
+                    LOG.debug("Received response for invoke rpc : {} result is null", rpcMsg.getRpc());
+                } else {
+                    result = NormalizedNodeSerializer.deSerialize(rpcReply.getResultNormalizedNode());
+                    LOG.debug("Received response for invoke rpc : {} result : {}", rpcMsg.getRpc(), result);
+                }
+
+                settableFuture.set(new DefaultDOMRpcResult(result));
             }
         };
 
-        future.onComplete(onComplete, ExecutionContext.Implicits$.MODULE$.global());
 
-        return listenableFuture;
+        future.onComplete(onComplete, ExecutionContext.Implicits$.MODULE$.global());
+        // FIXME find non blocking way for implementation
+        try {
+            return Futures.immediateCheckedFuture(listenableFuture.get());
+        }
+        catch (InterruptedException | ExecutionException e) {
+            LOG.debug("Unexpected remote RPC exception.", e);
+            return Futures.immediateFailedCheckedFuture((DOMRpcException) new DOMRpcImplementationNotAvailableException(e, "Unexpected remote RPC exception"));
+        }
     }
 }