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

   1 /*
   2  * Copyright (c) 2015 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.mdsal.binding.dom.adapter;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static java.util.Objects.requireNonNull;
  12 import static org.opendaylight.mdsal.binding.dom.adapter.StaticConfiguration.ENABLE_CODEC_SHORTCUT;
  13
  14 import com.google.common.collect.ImmutableBiMap;
  15 import com.google.common.collect.ImmutableMap;
  16 import com.google.common.collect.ImmutableMap.Builder;
  17 import com.google.common.util.concurrent.Futures;
  18 import com.google.common.util.concurrent.ListenableFuture;
  19 import com.google.common.util.concurrent.MoreExecutors;
  20 import java.lang.reflect.InvocationHandler;
  21 import java.lang.reflect.Method;
  22 import java.lang.reflect.Proxy;
  23 import java.util.Map.Entry;
  24 import java.util.Optional;
  25 import org.eclipse.jdt.annotation.NonNull;
  26 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  27 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  28 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  29 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  30 import org.opendaylight.mdsal.dom.spi.RpcRoutingStrategy;
  31 import org.opendaylight.yangtools.yang.binding.DataContainer;
  32 import org.opendaylight.yangtools.yang.binding.DataObject;
  33 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  34 import org.opendaylight.yangtools.yang.binding.RpcService;
  35 import org.opendaylight.yangtools.yang.common.QName;
  36 import org.opendaylight.yangtools.yang.common.RpcResult;
  37 import org.opendaylight.yangtools.yang.common.YangConstants;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  40 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  44 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  45 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  46
  47 class RpcServiceAdapter implements InvocationHandler {
  48     private final ImmutableMap<Method, RpcInvocationStrategy> rpcNames;
  49     private final Class<? extends RpcService> type;
  50     private final AdapterContext adapterContext;
  51     private final DOMRpcService delegate;
  52     private final RpcService proxy;
  53
  54     RpcServiceAdapter(final Class<? extends RpcService> type, final AdapterContext adapterContext,
  55             final DOMRpcService domService) {
  56         this.type = requireNonNull(type);
  57         this.adapterContext = requireNonNull(adapterContext);
  58         delegate = requireNonNull(domService);
  59
  60         final ImmutableBiMap<Method, RpcDefinition> methods = adapterContext.currentSerializer()
  61                 .getRpcMethodToSchema(type);
  62         final Builder<Method, RpcInvocationStrategy> rpcBuilder = ImmutableMap.builderWithExpectedSize(methods.size());
  63         for (final Entry<Method, RpcDefinition> rpc : methods.entrySet()) {
  64             rpcBuilder.put(rpc.getKey(), createStrategy(rpc.getKey(), rpc.getValue()));
  65         }
  66         rpcNames = rpcBuilder.build();
  67         proxy = (RpcService) Proxy.newProxyInstance(type.getClassLoader(), new Class[] {type}, this);
  68     }
  69
  70     private RpcInvocationStrategy createStrategy(final Method method, final RpcDefinition schema) {
  71         final QName rpcType = schema.getQName();
  72         final RpcRoutingStrategy strategy = RpcRoutingStrategy.from(schema);
  73         return strategy.isContextBasedRouted() ? new RoutedStrategy(rpcType, method, strategy.getLeaf())
  74                 : new NonRoutedStrategy(rpcType);
  75     }
  76
  77     RpcService getProxy() {
  78         return proxy;
  79     }
  80
  81     @Override
  82     @SuppressWarnings("checkstyle:hiddenField")
  83     public Object invoke(final Object proxy, final Method method, final Object[] args) {
  84         final RpcInvocationStrategy rpc = rpcNames.get(method);
  85         if (rpc != null) {
  86             if (args.length != 1) {
  87                 throw new IllegalArgumentException("Input must be provided.");
  88             }
  89             return rpc.invoke((DataObject) requireNonNull(args[0]));
  90         }
  91
  92         switch (method.getName()) {
  93             case "toString":
  94                 if (method.getReturnType().equals(String.class) && method.getParameterCount() == 0) {
  95                     return type.getName() + "$Adapter{delegate=" + delegate.toString() + "}";
  96                 }
  97                 break;
  98             case "hashCode":
  99                 if (method.getReturnType().equals(int.class) && method.getParameterCount() == 0) {
 100                     return System.identityHashCode(proxy);
 101                 }
 102                 break;
 103             case "equals":
 104                 if (method.getReturnType().equals(boolean.class) && method.getParameterCount() == 1
 105                         && method.getParameterTypes()[0] == Object.class) {
 106                     return proxy == args[0];
 107                 }
 108                 break;
 109             default:
 110                 break;
 111         }
 112
 113         throw new UnsupportedOperationException("Method " + method.toString() + "is unsupported.");
 114     }
 115
 116     private abstract class RpcInvocationStrategy {
 117         private final @NonNull NodeIdentifier inputIdentifier;
 118         private final @NonNull Absolute outputPath;
 119
 120         RpcInvocationStrategy(final QName rpcName) {
 121             final var namespace = rpcName.getModule();
 122             outputPath = Absolute.of(rpcName, YangConstants.operationOutputQName(namespace).intern()).intern();
 123             inputIdentifier = NodeIdentifier.create(YangConstants.operationInputQName(namespace.intern()));
 124         }
 125
 126         final ListenableFuture<RpcResult<?>> invoke(final DataObject input) {
 127             return invoke0(serialize(input));
 128         }
 129
 130         abstract ContainerNode serialize(DataObject input);
 131
 132         final @NonNull NodeIdentifier inputIdentifier() {
 133             return inputIdentifier;
 134         }
 135
 136         private ListenableFuture<RpcResult<?>> invoke0(final ContainerNode input) {
 137             final ListenableFuture<? extends DOMRpcResult> result =
 138                     delegate.invokeRpc(outputPath.firstNodeIdentifier(), input);
 139             if (ENABLE_CODEC_SHORTCUT && result instanceof BindingRpcFutureAware) {
 140                 return ((BindingRpcFutureAware) result).getBindingFuture();
 141             }
 142
 143             return transformFuture(result, adapterContext.currentSerializer());
 144         }
 145
 146         private ListenableFuture<RpcResult<?>> transformFuture(final ListenableFuture<? extends DOMRpcResult> domFuture,
 147                 final BindingNormalizedNodeSerializer resultCodec) {
 148             return Futures.transform(domFuture, input -> {
 149                 final NormalizedNode domData = input.getResult();
 150                 final DataObject bindingResult;
 151                 if (domData != null) {
 152                     bindingResult = resultCodec.fromNormalizedNodeRpcData(outputPath, (ContainerNode) domData);
 153                 } else {
 154                     bindingResult = null;
 155                 }
 156
 157                 return RpcResultUtil.rpcResultFromDOM(input.getErrors(), bindingResult);
 158             }, MoreExecutors.directExecutor());
 159         }
 160     }
 161
 162     private final class NonRoutedStrategy extends RpcInvocationStrategy {
 163         NonRoutedStrategy(final QName rpcName) {
 164             super(rpcName);
 165         }
 166
 167         @Override
 168         ContainerNode serialize(final DataObject input) {
 169             return LazySerializedContainerNode.create(inputIdentifier(), input, adapterContext.currentSerializer());
 170         }
 171     }
 172
 173     private final class RoutedStrategy extends RpcInvocationStrategy {
 174         private final ContextReferenceExtractor refExtractor;
 175         private final NodeIdentifier contextName;
 176
 177         RoutedStrategy(final QName rpcName, final Method rpcMethod, final QName leafName) {
 178             super(rpcName);
 179             final Optional<Class<? extends DataContainer>> maybeInputType =
 180                     BindingReflections.resolveRpcInputClass(rpcMethod);
 181             checkState(maybeInputType.isPresent(), "RPC method %s has no input", rpcMethod.getName());
 182             final Class<? extends DataContainer> inputType = maybeInputType.get();
 183             refExtractor = ContextReferenceExtractor.from(inputType);
 184             contextName = new NodeIdentifier(leafName);
 185         }
 186
 187         @Override
 188         ContainerNode serialize(final DataObject input) {
 189             final InstanceIdentifier<?> bindingII = refExtractor.extract(input);
 190             final CurrentAdapterSerializer serializer = adapterContext.currentSerializer();
 191
 192             if (bindingII != null) {
 193                 final YangInstanceIdentifier yangII = serializer.toCachedYangInstanceIdentifier(bindingII);
 194                 final LeafNode<?> contextRef = ImmutableNodes.leafNode(contextName, yangII);
 195                 return LazySerializedContainerNode.withContextRef(inputIdentifier(), input, contextRef, serializer);
 196             }
 197             return LazySerializedContainerNode.create(inputIdentifier(), input, serializer);
 198         }
 199
 200     }
 201 }