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.Preconditions;
  18 import com.google.common.collect.ImmutableMap;
  19 import com.google.common.util.concurrent.CheckedFuture;
  20 import com.google.common.util.concurrent.Futures;
  21 import com.google.common.util.concurrent.ListenableFuture;
  22 import java.lang.reflect.InvocationHandler;
  23 import java.lang.reflect.Method;
  24 import java.lang.reflect.Proxy;
  25 import java.util.Map.Entry;
  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 ListenableFuture<RpcResult<?>> invoke0(final SchemaPath schemaPath, final NormalizedNode<?, ?> input) {
  66         final CheckedFuture<DOMRpcResult, DOMRpcException> result = delegate.invokeRpc(schemaPath, input);
  67         if(result instanceof LazyDOMRpcResultFuture) {
  68             return ((LazyDOMRpcResultFuture) result).getBindingFuture();
  69         }
  70
  71         return transformFuture(schemaPath, result, codec.getCodecFactory());
  72     }
  73
  74     private RpcInvocationStrategy createStrategy(final Method method, final RpcDefinition schema) {
  75         final RpcRoutingStrategy strategy = RpcRoutingStrategy.from(schema);
  76         if (strategy.isContextBasedRouted()) {
  77             return new RoutedStrategy(schema.getPath(), method, strategy.getLeaf());
  78         }
  79         return new NonRoutedStrategy(schema.getPath());
  80     }
  81
  82     RpcService getProxy() {
  83         return proxy;
  84     }
  85
  86     @Override
  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((DataObject) 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 m) {
 107         switch (m.getName()) {
 108             case "toString":
 109                 return (m.getReturnType().equals(String.class) && m.getParameterTypes().length == 0);
 110             case "hashCode":
 111                 return (m.getReturnType().equals(int.class) && m.getParameterTypes().length == 0);
 112             case "equals":
 113                 return (m.getReturnType().equals(boolean.class) && m.getParameterTypes().length == 1 && m
 114                         .getParameterTypes()[0] == Object.class);
 115             default:
 116                 return false;
 117         }
 118     }
 119
 120     private Object callObjectMethod(final Object self, final Method m, final Object[] args) {
 121         switch (m.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 static ListenableFuture<RpcResult<?>> transformFuture(final SchemaPath rpc,
 134             final ListenableFuture<DOMRpcResult> domFuture, final BindingNormalizedNodeCodecRegistry codec) {
 135         return Futures.transform(domFuture, new Function<DOMRpcResult, RpcResult<?>>() {
 136             @Override
 137             public RpcResult<?> apply(final DOMRpcResult input) {
 138                 final NormalizedNode<?, ?> domData = input.getResult();
 139                 final DataObject bindingResult;
 140                 if (domData != null) {
 141                     final SchemaPath rpcOutput = rpc.createChild(QName.create(rpc.getLastComponent(), "output"));
 142                     bindingResult = codec.fromNormalizedNodeRpcData(rpcOutput, (ContainerNode) domData);
 143                 } else {
 144                     bindingResult = null;
 145                 }
 146                 return RpcResult.class.cast(RpcResultBuilder.success(bindingResult).build());
 147             }
 148         });
 149     }
 150
 151     private abstract class RpcInvocationStrategy {
 152
 153         private final SchemaPath rpcName;
 154
 155         protected RpcInvocationStrategy(final SchemaPath path) {
 156             rpcName = path;
 157         }
 158
 159         final ListenableFuture<RpcResult<?>> invoke(final DataObject input) {
 160             return invoke0(rpcName, serialize(input));
 161         }
 162
 163         abstract NormalizedNode<?, ?> serialize(DataObject input);
 164
 165         final ListenableFuture<RpcResult<?>> invokeEmpty() {
 166             return invoke0(rpcName, null);
 167         }
 168
 169         final SchemaPath getRpcName() {
 170             return rpcName;
 171         }
 172
 173     }
 174
 175     private final class NonRoutedStrategy extends RpcInvocationStrategy {
 176
 177         protected NonRoutedStrategy(final SchemaPath path) {
 178             super(path);
 179         }
 180
 181         @Override
 182         NormalizedNode<?, ?> serialize(final DataObject input) {
 183             return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());
 184         }
 185
 186     }
 187
 188     private final class RoutedStrategy extends RpcInvocationStrategy {
 189
 190         private final ContextReferenceExtractor refExtractor;
 191         private final NodeIdentifier contextName;
 192
 193         protected RoutedStrategy(final SchemaPath path, final Method rpcMethod, final QName leafName) {
 194             super(path);
 195             final Class<? extends DataContainer> inputType = BindingReflections.resolveRpcInputClass(rpcMethod).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 }