binding2/mdsal-binding2-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/adapter/impl/operation/RpcServiceAdapter.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies 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.javav2.dom.adapter.impl.operation;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.base.Function;
  12 import com.google.common.base.Optional;
  13 import com.google.common.base.Preconditions;
  14 import com.google.common.collect.ImmutableMap;
  15 import com.google.common.util.concurrent.Futures;
  16 import com.google.common.util.concurrent.JdkFutureAdapters;
  17 import com.google.common.util.concurrent.ListenableFuture;
  18 import com.google.common.util.concurrent.MoreExecutors;
  19 import java.lang.reflect.InvocationHandler;
  20 import java.lang.reflect.Method;
  21 import java.lang.reflect.Proxy;
  22 import java.util.Map.Entry;
  23 import org.opendaylight.mdsal.binding.javav2.dom.adapter.extractor.ContextReferenceExtractor;
  24 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
  25 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.BindingToNormalizedNodeCodec;
  26 import org.opendaylight.mdsal.binding.javav2.dom.codec.serialized.LazySerializedContainerNode;
  27 import org.opendaylight.mdsal.binding.javav2.runtime.reflection.BindingReflections;
  28 import org.opendaylight.mdsal.binding.javav2.spec.base.InstanceIdentifier;
  29 import org.opendaylight.mdsal.binding.javav2.spec.base.Instantiable;
  30 import org.opendaylight.mdsal.binding.javav2.spec.base.Rpc;
  31 import org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode;
  32 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  33 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  34 import org.opendaylight.mdsal.dom.spi.RpcRoutingStrategy;
  35 import org.opendaylight.yangtools.yang.common.QName;
  36 import org.opendaylight.yangtools.yang.common.RpcResult;
  37 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  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.OperationDefinition;
  45 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  46 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  47
  48 @Beta
  49 class RpcServiceAdapter implements InvocationHandler {
  50
  51     private final ImmutableMap<Method, RpcInvocationStrategy> rpcNames;
  52     private final Class<? extends Rpc<?, ?>> type;
  53     private final BindingToNormalizedNodeCodec codec;
  54     private final DOMRpcService delegate;
  55     private final Rpc<?, ?> proxy;
  56
  57     RpcServiceAdapter(final Class<? extends Rpc<?, ?>> type, final BindingToNormalizedNodeCodec codec,
  58             final DOMRpcService domService) {
  59         this.type = Preconditions.checkNotNull(type);
  60         this.codec = Preconditions.checkNotNull(codec);
  61         this.delegate = Preconditions.checkNotNull(domService);
  62         final ImmutableMap.Builder<Method, RpcInvocationStrategy> rpcBuilder = ImmutableMap.builder();
  63         for (final Entry<Method, OperationDefinition> rpc : codec.getRPCMethodToSchema(type).entrySet()) {
  64             rpcBuilder.put(rpc.getKey(), createStrategy(rpc.getKey(), (RpcDefinition) rpc.getValue()));
  65         }
  66         rpcNames = rpcBuilder.build();
  67         proxy = (Rpc<?, ?>) Proxy.newProxyInstance(type.getClassLoader(), new Class[] { type }, this);
  68     }
  69
  70     private RpcInvocationStrategy createStrategy(final Method method, final RpcDefinition schema) {
  71         final RpcRoutingStrategy strategy = RpcRoutingStrategy.from(schema);
  72         if (strategy.isContextBasedRouted()) {
  73             return new RoutedStrategy(schema.getPath(), method, strategy.getLeaf());
  74         }
  75         return new NonRoutedStrategy(schema.getPath());
  76     }
  77
  78     Rpc<?, ?> getProxy() {
  79         return proxy;
  80     }
  81
  82     @Override
  83     @SuppressWarnings("checkstyle:hiddenField")
  84     public Object invoke(final Object proxy, final Method method, final Object[] args) throws Throwable {
  85
  86         final RpcInvocationStrategy rpc = rpcNames.get(method);
  87         if (rpc != null) {
  88             if (method.getParameterTypes().length == 0) {
  89                 return rpc.invokeEmpty();
  90             }
  91             if (args.length != 1) {
  92                 throw new IllegalArgumentException("Input must be provided.");
  93             }
  94             return rpc.invoke((TreeNode) args[0]);
  95         }
  96
  97         if (isObjectMethod(method)) {
  98             return callObjectMethod(proxy, method, args);
  99         }
 100         throw new UnsupportedOperationException("Method " + method.toString() + "is unsupported.");
 101     }
 102
 103     private static boolean isObjectMethod(final Method method) {
 104         switch (method.getName()) {
 105             case "toString":
 106                 return method.getReturnType().equals(String.class) && method.getParameterTypes().length == 0;
 107             case "hashCode":
 108                 return method.getReturnType().equals(int.class) && method.getParameterTypes().length == 0;
 109             case "equals":
 110                 return method.getReturnType().equals(boolean.class) && method.getParameterTypes().length == 1
 111                         && method.getParameterTypes()[0] == Object.class;
 112             default:
 113                 return false;
 114         }
 115     }
 116
 117     private Object callObjectMethod(final Object self, final Method method, final Object[] args) {
 118         switch (method.getName()) {
 119             case "toString":
 120                 return type.getName() + "$Adapter{delegate=" + delegate.toString() + "}";
 121             case "hashCode":
 122                 return System.identityHashCode(self);
 123             case "equals":
 124                 return self == args[0];
 125             default:
 126                 return null;
 127         }
 128     }
 129
 130     private abstract class RpcInvocationStrategy {
 131
 132         private final SchemaPath rpcName;
 133
 134         protected RpcInvocationStrategy(final SchemaPath path) {
 135             rpcName = path;
 136         }
 137
 138         final ListenableFuture<RpcResult<?>> invoke(final TreeNode input) {
 139             return invoke0(rpcName, serialize(input));
 140         }
 141
 142         abstract NormalizedNode<?, ?> serialize(TreeNode input);
 143
 144         final ListenableFuture<RpcResult<?>> invokeEmpty() {
 145             return invoke0(rpcName, null);
 146         }
 147
 148         final SchemaPath getRpcName() {
 149             return rpcName;
 150         }
 151
 152         private ListenableFuture<RpcResult<?>> invoke0(final SchemaPath schemaPath, final NormalizedNode<?, ?> input) {
 153             final ListenableFuture<DOMRpcResult> listenInPoolThread =
 154                     JdkFutureAdapters.listenInPoolThread(delegate.invokeRpc(schemaPath, input));
 155             if (listenInPoolThread instanceof LazyDOMOperationResultFuture) {
 156                 return ((LazyDOMOperationResultFuture) listenInPoolThread).getBindingFuture();
 157             }
 158
 159             return transformFuture(schemaPath, listenInPoolThread, codec.getCodecFactory());
 160         }
 161
 162         private ListenableFuture<RpcResult<?>> transformFuture(final SchemaPath rpc,
 163                 final ListenableFuture<DOMRpcResult> domFuture, final BindingNormalizedNodeCodecRegistry resultCodec) {
 164             return Futures.transform(domFuture, (Function<DOMRpcResult, RpcResult<?>>) input -> {
 165                 final NormalizedNode<?, ?> domData = input.getResult();
 166                 final TreeNode bindingResult;
 167                 if (domData != null) {
 168                     final SchemaPath rpcOutput = rpc.createChild(QName.create(rpc.getLastComponent(), "output"));
 169                     bindingResult = resultCodec.fromNormalizedNodeOperationData(rpcOutput, (ContainerNode) domData);
 170                 } else {
 171                     bindingResult = null;
 172                 }
 173                 return RpcResult.class.cast(RpcResultBuilder.success(bindingResult).build());
 174             }, MoreExecutors.directExecutor());
 175         }
 176
 177     }
 178
 179     private final class NonRoutedStrategy extends RpcInvocationStrategy {
 180
 181         protected NonRoutedStrategy(final SchemaPath path) {
 182             super(path);
 183         }
 184
 185         @Override
 186         NormalizedNode<?, ?> serialize(final TreeNode input) {
 187             return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());
 188         }
 189
 190     }
 191
 192     private final class RoutedStrategy extends RpcInvocationStrategy {
 193
 194         private final ContextReferenceExtractor refExtractor;
 195         private final NodeIdentifier contextName;
 196
 197         protected RoutedStrategy(final SchemaPath path, final Method rpcMethod, final QName leafName) {
 198             super(path);
 199             final Optional<Class<? extends Instantiable<?>>> maybeInputType =
 200                     BindingReflections.resolveOperationInputClass(rpcMethod);
 201             Preconditions.checkState(maybeInputType.isPresent(), "RPC method %s has no input", rpcMethod.getName());
 202             final Class<? extends Instantiable<?>> inputType = maybeInputType.get();
 203             refExtractor = ContextReferenceExtractor.from(inputType);
 204             this.contextName = new NodeIdentifier(leafName);
 205         }
 206
 207         @SuppressWarnings("rawtypes")
 208         @Override
 209         NormalizedNode<?, ?> serialize(final TreeNode input) {
 210             final InstanceIdentifier<?> bindingII = refExtractor.extract(input);
 211             if (bindingII != null) {
 212                 final YangInstanceIdentifier yangII = codec.toYangInstanceIdentifierCached(bindingII);
 213                 final LeafNode contextRef = ImmutableNodes.leafNode(contextName, yangII);
 214                 return LazySerializedContainerNode.withContextRef(getRpcName(), input, contextRef,
 215                         codec.getCodecRegistry());
 216             }
 217             return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());
 218         }
 219
 220     }
 221 }