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