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