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.CheckedFuture;
  16 import com.google.common.util.concurrent.Futures;
  17 import com.google.common.util.concurrent.ListenableFuture;
  18 import java.lang.reflect.InvocationHandler;
  19 import java.lang.reflect.Method;
  20 import java.lang.reflect.Proxy;
  21 import java.util.Map.Entry;
  22 import org.opendaylight.mdsal.binding.javav2.dom.adapter.extractor.ContextReferenceExtractor;
  23 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
  24 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.BindingToNormalizedNodeCodec;
  25 import org.opendaylight.mdsal.binding.javav2.dom.codec.serialized.LazySerializedContainerNode;
  26 import org.opendaylight.mdsal.binding.javav2.runtime.reflection.BindingReflections;
  27 import org.opendaylight.mdsal.binding.javav2.spec.base.InstanceIdentifier;
  28 import org.opendaylight.mdsal.binding.javav2.spec.base.Instantiable;
  29 import org.opendaylight.mdsal.binding.javav2.spec.base.Rpc;
  30 import org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode;
  31 import org.opendaylight.mdsal.dom.api.DOMRpcException;
  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     public Object invoke(final Object proxy, final Method method, final Object[] args) throws Throwable {
  84
  85         final RpcInvocationStrategy rpc = rpcNames.get(method);
  86         if (rpc != null) {
  87             if (method.getParameterTypes().length == 0) {
  88                 return rpc.invokeEmpty();
  89             }
  90             if (args.length != 1) {
  91                 throw new IllegalArgumentException("Input must be provided.");
  92             }
  93             return rpc.invoke((TreeNode) args[0]);
  94         }
  95
  96         if (isObjectMethod(method)) {
  97             return callObjectMethod(proxy, method, args);
  98         }
  99         throw new UnsupportedOperationException("Method " + method.toString() + "is unsupported.");
 100     }
 101
 102     private static boolean isObjectMethod(final Method method) {
 103         switch (method.getName()) {
 104             case "toString":
 105                 return method.getReturnType().equals(String.class) && method.getParameterTypes().length == 0;
 106             case "hashCode":
 107                 return method.getReturnType().equals(int.class) && method.getParameterTypes().length == 0;
 108             case "equals":
 109                 return method.getReturnType().equals(boolean.class) && method.getParameterTypes().length == 1
 110                         && method.getParameterTypes()[0] == Object.class;
 111             default:
 112                 return false;
 113         }
 114     }
 115
 116     private Object callObjectMethod(final Object self, final Method method, final Object[] args) {
 117         switch (method.getName()) {
 118             case "toString":
 119                 return type.getName() + "$Adapter{delegate=" + delegate.toString() + "}";
 120             case "hashCode":
 121                 return System.identityHashCode(self);
 122             case "equals":
 123                 return self == args[0];
 124             default:
 125                 return null;
 126         }
 127     }
 128
 129     private abstract class RpcInvocationStrategy {
 130
 131         private final SchemaPath rpcName;
 132
 133         protected RpcInvocationStrategy(final SchemaPath path) {
 134             rpcName = path;
 135         }
 136
 137         final ListenableFuture<RpcResult<?>> invoke(final TreeNode input) {
 138             return invoke0(rpcName, serialize(input));
 139         }
 140
 141         abstract NormalizedNode<?, ?> serialize(TreeNode input);
 142
 143         final ListenableFuture<RpcResult<?>> invokeEmpty() {
 144             return invoke0(rpcName, null);
 145         }
 146
 147         final SchemaPath getRpcName() {
 148             return rpcName;
 149         }
 150
 151         private ListenableFuture<RpcResult<?>> invoke0(final SchemaPath schemaPath, final NormalizedNode<?, ?> input) {
 152             final CheckedFuture<DOMRpcResult, DOMRpcException> result = delegate.invokeRpc(schemaPath, input);
 153
 154             if (result instanceof LazyDOMOperationResultFuture) {
 155                 return ((LazyDOMOperationResultFuture) result).getBindingFuture();
 156             }
 157
 158             return transformFuture(schemaPath, result, codec.getCodecFactory());
 159         }
 160
 161         private ListenableFuture<RpcResult<?>> transformFuture(final SchemaPath rpc,
 162                 final ListenableFuture<DOMRpcResult> domFuture, final BindingNormalizedNodeCodecRegistry codec) {
 163             return Futures.transform(domFuture, (Function<DOMRpcResult, RpcResult<?>>) input -> {
 164                 final NormalizedNode<?, ?> domData = input.getResult();
 165                 final TreeNode bindingResult;
 166                 if (domData != null) {
 167                     final SchemaPath rpcOutput = rpc.createChild(QName.create(rpc.getLastComponent(), "output"));
 168                     bindingResult = codec.fromNormalizedNodeOperationData(rpcOutput, (ContainerNode) domData);
 169                 } else {
 170                     bindingResult = null;
 171                 }
 172                 return RpcResult.class.cast(RpcResultBuilder.success(bindingResult).build());
 173             });
 174         }
 175
 176     }
 177
 178     private final class NonRoutedStrategy extends RpcInvocationStrategy {
 179
 180         protected NonRoutedStrategy(final SchemaPath path) {
 181             super(path);
 182         }
 183
 184         @Override
 185         NormalizedNode<?, ?> serialize(final TreeNode input) {
 186             return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());
 187         }
 188
 189     }
 190
 191     private final class RoutedStrategy extends RpcInvocationStrategy {
 192
 193         private final ContextReferenceExtractor refExtractor;
 194         private final NodeIdentifier contextName;
 195
 196         protected RoutedStrategy(final SchemaPath path, final Method rpcMethod, final QName leafName) {
 197             super(path);
 198             final Optional<Class<? extends Instantiable<?>>> maybeInputType =
 199                     BindingReflections.resolveOperationInputClass(rpcMethod);
 200             Preconditions.checkState(maybeInputType.isPresent(), "RPC method %s has no input", rpcMethod.getName());
 201             final Class<? extends Instantiable<?>> inputType = maybeInputType.get();
 202             refExtractor = ContextReferenceExtractor.from(inputType);
 203             this.contextName = new NodeIdentifier(leafName);
 204         }
 205
 206         @SuppressWarnings("rawtypes")
 207         @Override
 208         NormalizedNode<?, ?> serialize(final TreeNode input) {
 209             final InstanceIdentifier<?> bindingII = refExtractor.extract(input);
 210             if (bindingII != null) {
 211                 final YangInstanceIdentifier yangII = codec.toYangInstanceIdentifierCached(bindingII);
 212                 final LeafNode contextRef = ImmutableNodes.leafNode(contextName, yangII);
 213                 return LazySerializedContainerNode.withContextRef(getRpcName(), input, contextRef,
 214                         codec.getCodecRegistry());
 215             }
 216             return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());
 217         }
 218
 219     }
 220 }