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