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