plugins/netconf-client-mdsal/src/main/java/org/opendaylight/netconf/client/mdsal/spi/NetconfDeviceRpc.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 package org.opendaylight.netconf.client.mdsal.spi;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.Collections2;
  13 import com.google.common.util.concurrent.FutureCallback;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import com.google.common.util.concurrent.MoreExecutors;
  17 import com.google.common.util.concurrent.SettableFuture;
  18 import org.opendaylight.mdsal.dom.api.DOMRpcAvailabilityListener;
  19 import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
  20 import org.opendaylight.mdsal.dom.api.DOMRpcImplementationNotAvailableException;
  21 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  22 import org.opendaylight.mdsal.dom.api.DefaultDOMRpcException;
  23 import org.opendaylight.netconf.api.messages.NetconfMessage;
  24 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceCommunicator;
  25 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceServices.Rpcs;
  26 import org.opendaylight.netconf.client.mdsal.api.RpcTransformer;
  27 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  28 import org.opendaylight.yangtools.concepts.NoOpListenerRegistration;
  29 import org.opendaylight.yangtools.yang.common.QName;
  30 import org.opendaylight.yangtools.yang.common.RpcResult;
  31 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  32 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  33
  34 /**
  35  * Invokes RPC by sending netconf message via listener. Also transforms result from NetconfMessage to
  36  * {@link ContainerNode}.
  37  */
  38 public final class NetconfDeviceRpc implements Rpcs.Normalized {
  39     private final RemoteDeviceCommunicator communicator;
  40     private final RpcTransformer<ContainerNode, DOMRpcResult> transformer;
  41     private final EffectiveModelContext modelContext;
  42
  43     public NetconfDeviceRpc(final EffectiveModelContext modelContext, final RemoteDeviceCommunicator communicator,
  44             final RpcTransformer<ContainerNode, DOMRpcResult> transformer) {
  45         this.modelContext = requireNonNull(modelContext);
  46         this.communicator = communicator;
  47         this.transformer = transformer;
  48     }
  49
  50     @Override
  51     @SuppressWarnings("checkstyle:IllegalCatch")
  52     public ListenableFuture<DOMRpcResult> invokeRpc(final QName type, final ContainerNode input) {
  53         final var delegateFuture = communicator.sendRequest(transformer.toRpcRequest(type, input), type);
  54
  55         final var ret = SettableFuture.<DOMRpcResult>create();
  56         Futures.addCallback(delegateFuture, new FutureCallback<>() {
  57             @Override
  58             public void onSuccess(final RpcResult<NetconfMessage> result) {
  59                 final DOMRpcResult rpcResult;
  60                 try {
  61                     rpcResult = transformer.toRpcResult(result, type);
  62                 } catch (Exception cause) {
  63                     ret.setException(new DefaultDOMRpcException(
  64                         "Unable to parse rpc reply. type: " + type + " input: " + input, cause));
  65                     return;
  66                 }
  67
  68                 ret.set(rpcResult);
  69             }
  70
  71             @Override
  72             public void onFailure(final Throwable cause) {
  73                 ret.setException(new DOMRpcImplementationNotAvailableException(cause, "Unable to invoke rpc %s", type));
  74             }
  75
  76         }, MoreExecutors.directExecutor());
  77         return ret;
  78     }
  79
  80     @Override
  81     public <T extends DOMRpcAvailabilityListener> ListenerRegistration<T> registerRpcListener(final T listener) {
  82         listener.onRpcAvailable(Collections2.transform(modelContext.getOperations(),
  83             input -> DOMRpcIdentifier.create(input.getQName())));
  84
  85         // NOOP, no rpcs appear and disappear in this implementation
  86         return NoOpListenerRegistration.of(listener);
  87     }
  88 }