binding/mdsal-binding-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/dom/adapter/RpcInvocationStrategy.java

   1 /*
   2  * Copyright (c) 2022 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.mdsal.binding.dom.adapter;
   9
  10 import static java.util.Objects.requireNonNull;
  11 import static org.opendaylight.mdsal.binding.dom.adapter.StaticConfiguration.ENABLE_CODEC_SHORTCUT;
  12
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import com.google.common.util.concurrent.MoreExecutors;
  16 import java.lang.reflect.Method;
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  19 import org.opendaylight.mdsal.binding.runtime.api.RpcRuntimeType;
  20 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  21 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  22 import org.opendaylight.mdsal.dom.spi.ContentRoutedRpcContext;
  23 import org.opendaylight.yangtools.yang.binding.DataObject;
  24 import org.opendaylight.yangtools.yang.common.QName;
  25 import org.opendaylight.yangtools.yang.common.RpcResult;
  26 import org.opendaylight.yangtools.yang.common.YangConstants;
  27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  28 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  29 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  30 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  31
  32 sealed class RpcInvocationStrategy {
  33     private static final class ContentRouted extends RpcInvocationStrategy {
  34         private final ContextReferenceExtractor refExtractor;
  35         private final NodeIdentifier contextName;
  36
  37         ContentRouted(final RpcServiceAdapter adapter, final QName rpcName, final QName leafName,
  38                 final ContextReferenceExtractor refExtractor) {
  39             super(adapter, rpcName);
  40             contextName = NodeIdentifier.create(leafName);
  41             this.refExtractor = requireNonNull(refExtractor);
  42         }
  43
  44         @Override
  45         ContainerNode serialize(final NodeIdentifier inputIdentifier, final CurrentAdapterSerializer serializer,
  46                 final DataObject input) {
  47             final var bindingII = refExtractor.extract(input);
  48             if (bindingII == null) {
  49                 return super.serialize(inputIdentifier, serializer, input);
  50             }
  51
  52             final var yangII = serializer.toCachedYangInstanceIdentifier(bindingII);
  53             final var contextRef = ImmutableNodes.leafNode(contextName, yangII);
  54             return LazySerializedContainerNode.withContextRef(inputIdentifier, input, contextRef, serializer);
  55         }
  56     }
  57
  58     private final @NonNull RpcServiceAdapter adapter;
  59     private final @NonNull NodeIdentifier inputIdentifier;
  60     private final @NonNull Absolute outputPath;
  61
  62     private RpcInvocationStrategy(final RpcServiceAdapter adapter, final QName rpcName) {
  63         this.adapter = requireNonNull(adapter);
  64         final var namespace = rpcName.getModule();
  65         outputPath = Absolute.of(rpcName, YangConstants.operationOutputQName(namespace).intern()).intern();
  66         inputIdentifier = NodeIdentifier.create(YangConstants.operationInputQName(namespace.intern()));
  67     }
  68
  69     static @NonNull RpcInvocationStrategy of(final RpcServiceAdapter adapter, final Method method,
  70             final RpcRuntimeType type) {
  71         final var schema = type.statement();
  72         final var contentContext = ContentRoutedRpcContext.forRpc(schema);
  73         if (contentContext == null) {
  74             return new RpcInvocationStrategy(adapter, schema.argument());
  75         }
  76
  77         return new ContentRouted(adapter, schema.argument(), contentContext.leaf(), ContextReferenceExtractor.from(
  78             // FIXME: do not use BindingReflections here
  79             BindingReflections.resolveRpcInputClass(method).orElseThrow(
  80                 () -> new IllegalArgumentException("RPC method " + method.getName() + " has no input"))));
  81     }
  82
  83     final ListenableFuture<RpcResult<?>> invoke(final DataObject input) {
  84         return invoke(serialize(inputIdentifier, adapter.currentSerializer(), input));
  85     }
  86
  87     private ListenableFuture<RpcResult<?>> invoke(final ContainerNode input) {
  88         final var domFuture = adapter.delegate().invokeRpc(outputPath.firstNodeIdentifier(), input);
  89         if (ENABLE_CODEC_SHORTCUT && domFuture instanceof BindingRpcFutureAware bindingAware) {
  90             return bindingAware.getBindingFuture();
  91         }
  92         return transformFuture(domFuture, adapter.currentSerializer());
  93     }
  94
  95     ContainerNode serialize(final @NonNull NodeIdentifier identifier,
  96             final @NonNull CurrentAdapterSerializer serializer, final DataObject input) {
  97         return LazySerializedContainerNode.create(inputIdentifier, input, serializer);
  98     }
  99
 100     private ListenableFuture<RpcResult<?>> transformFuture(final ListenableFuture<? extends DOMRpcResult> domFuture,
 101             final BindingNormalizedNodeSerializer resultCodec) {
 102         return Futures.transform(domFuture, input -> {
 103             final ContainerNode domData = input.value();
 104             final DataObject bindingResult;
 105             if (domData != null) {
 106                 bindingResult = resultCodec.fromNormalizedNodeRpcData(outputPath, domData);
 107             } else {
 108                 bindingResult = null;
 109             }
 110
 111             return RpcResultUtil.rpcResultFromDOM(input.errors(), bindingResult);
 112         }, MoreExecutors.directExecutor());
 113     }
 114 }