plugins/netconf-client-mdsal/src/main/java/org/opendaylight/netconf/client/mdsal/spi/NetconfDeviceDOMRpcService.java

   1 /*
   2  * Copyright (c) 2024 PANTHEON.tech, s.r.o. 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.DOMRpcService;
  23 import org.opendaylight.mdsal.dom.api.DefaultDOMRpcException;
  24 import org.opendaylight.netconf.api.messages.NetconfMessage;
  25 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceCommunicator;
  26 import org.opendaylight.netconf.client.mdsal.api.RpcTransformer;
  27 import org.opendaylight.yangtools.concepts.Registration;
  28 import org.opendaylight.yangtools.yang.common.QName;
  29 import org.opendaylight.yangtools.yang.common.RpcResult;
  30 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  31 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  32
  33 record NetconfDeviceDOMRpcService(
  34         EffectiveModelContext modelContext,
  35         RemoteDeviceCommunicator communicator,
  36         RpcTransformer<ContainerNode, DOMRpcResult> transformer) implements DOMRpcService {
  37     NetconfDeviceDOMRpcService {
  38         requireNonNull(modelContext);
  39     }
  40
  41     @Override
  42     @SuppressWarnings("checkstyle:IllegalCatch")
  43     public ListenableFuture<DOMRpcResult> invokeRpc(final QName type, final ContainerNode input) {
  44         final var delegateFuture = communicator.sendRequest(transformer.toRpcRequest(type, input), type);
  45
  46         final var ret = SettableFuture.<DOMRpcResult>create();
  47         Futures.addCallback(delegateFuture, new FutureCallback<>() {
  48             @Override
  49             public void onSuccess(final RpcResult<NetconfMessage> result) {
  50                 final DOMRpcResult rpcResult;
  51                 try {
  52                     rpcResult = transformer.toRpcResult(result, type);
  53                 } catch (Exception cause) {
  54                     ret.setException(new DefaultDOMRpcException(
  55                         "Unable to parse rpc reply. type: " + type + " input: " + input, cause));
  56                     return;
  57                 }
  58
  59                 ret.set(rpcResult);
  60             }
  61
  62             @Override
  63             public void onFailure(final Throwable cause) {
  64                 ret.setException(new DOMRpcImplementationNotAvailableException(cause, "Unable to invoke rpc %s",
  65                     type));
  66             }
  67
  68         }, MoreExecutors.directExecutor());
  69         return ret;
  70     }
  71
  72     @Override
  73     public Registration registerRpcListener(final DOMRpcAvailabilityListener listener) {
  74         listener.onRpcAvailable(Collections2.transform(modelContext.getOperations(),
  75             input -> DOMRpcIdentifier.create(input.getQName())));
  76         return () -> {
  77             // No-op
  78         };
  79     }
  80 }