opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/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.controller.md.sal.binding.impl;
  10
  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.CheckedFuture;
  15 import com.google.common.util.concurrent.Futures;
  16 import com.google.common.util.concurrent.ListenableFuture;
  17 import java.lang.reflect.InvocationHandler;
  18 import java.lang.reflect.Method;
  19 import java.lang.reflect.Proxy;
  20 import java.util.Map.Entry;
  21 import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
  22 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  23 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  24 import org.opendaylight.controller.md.sal.dom.broker.spi.rpc.RpcRoutingStrategy;
  25 import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
  26 import org.opendaylight.yangtools.yang.binding.DataContainer;
  27 import org.opendaylight.yangtools.yang.binding.DataObject;
  28 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  29 import org.opendaylight.yangtools.yang.binding.RpcService;
  30 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
  31 import org.opendaylight.yangtools.yang.common.QName;
  32 import org.opendaylight.yangtools.yang.common.RpcResult;
  33 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  36 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  37 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  38 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  39 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  40 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  41 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  42
  43 class RpcServiceAdapter implements InvocationHandler {
  44
  45     private final ImmutableMap<Method, RpcInvocationStrategy> rpcNames;
  46     private final Class<? extends RpcService> type;
  47     private final BindingToNormalizedNodeCodec codec;
  48     private final DOMRpcService delegate;
  49     private final RpcService proxy;
  50
  51     RpcServiceAdapter(final Class<? extends RpcService> type, final BindingToNormalizedNodeCodec codec,
  52             final DOMRpcService domService) {
  53         this.type = Preconditions.checkNotNull(type);
  54         this.codec = Preconditions.checkNotNull(codec);
  55         this.delegate = Preconditions.checkNotNull(domService);
  56         final ImmutableMap.Builder<Method, RpcInvocationStrategy> rpcBuilder = ImmutableMap.builder();
  57         for (final Entry<Method, RpcDefinition> rpc : codec.getRpcMethodToSchema(type).entrySet()) {
  58             rpcBuilder.put(rpc.getKey(), createStrategy(rpc.getKey(), rpc.getValue()));
  59         }
  60         rpcNames = rpcBuilder.build();
  61         proxy = (RpcService) Proxy.newProxyInstance(type.getClassLoader(), new Class[] {type}, this);
  62     }
  63
  64     private final ListenableFuture<RpcResult<?>> invoke0(final SchemaPath schemaPath, final NormalizedNode<?, ?> input) {
  65         final CheckedFuture<DOMRpcResult, DOMRpcException> result = delegate.invokeRpc(schemaPath, input);
  66         if(result instanceof LazyDOMRpcResultFuture) {
  67             return ((LazyDOMRpcResultFuture) result).getBindingFuture();
  68         }
  69
  70         return transformFuture(schemaPath, result, codec.getCodecFactory());
  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     RpcService getProxy() {
  82         return proxy;
  83     }
  84
  85     @Override
  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((DataObject) 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 m) {
 106         switch (m.getName()) {
 107             case "toString":
 108                 return (m.getReturnType() == String.class && m.getParameterTypes().length == 0);
 109             case "hashCode":
 110                 return (m.getReturnType() == int.class && m.getParameterTypes().length == 0);
 111             case "equals":
 112                 return (m.getReturnType() == boolean.class && m.getParameterTypes().length == 1 && m
 113                         .getParameterTypes()[0] == Object.class);
 114         }
 115         return false;
 116     }
 117
 118     private Object callObjectMethod(final Object self, final Method m, final Object[] args) {
 119         switch (m.getName()) {
 120             case "toString":
 121                 return type.getName() + "$Adapter{delegate=" + delegate.toString() + "}";
 122             case "hashCode":
 123                 return System.identityHashCode(self);
 124             case "equals":
 125                 return (self == args[0]);
 126         }
 127         return null;
 128     }
 129
 130     private static ListenableFuture<RpcResult<?>> transformFuture(final SchemaPath rpc,
 131             final ListenableFuture<DOMRpcResult> domFuture, final BindingNormalizedNodeCodecRegistry codec) {
 132         return Futures.transform(domFuture, new Function<DOMRpcResult, RpcResult<?>>() {
 133             @Override
 134             public RpcResult<?> apply(final DOMRpcResult input) {
 135                 final NormalizedNode<?, ?> domData = input.getResult();
 136                 final DataObject bindingResult;
 137                 if (domData != null) {
 138                     final SchemaPath rpcOutput = rpc.createChild(QName.create(rpc.getLastComponent(), "output"));
 139                     bindingResult = codec.fromNormalizedNodeRpcData(rpcOutput, (ContainerNode) domData);
 140                 } else {
 141                     bindingResult = null;
 142                 }
 143                 return RpcResult.class.cast(RpcResultBuilder.success(bindingResult).build());
 144             }
 145         });
 146     }
 147
 148     private abstract class RpcInvocationStrategy {
 149
 150         private final SchemaPath rpcName;
 151
 152         protected RpcInvocationStrategy(final SchemaPath path) {
 153             rpcName = path;
 154         }
 155
 156         final ListenableFuture<RpcResult<?>> invoke(final DataObject input) {
 157             return invoke0(rpcName, serialize(input));
 158         }
 159
 160         abstract NormalizedNode<?, ?> serialize(DataObject input);
 161
 162         final ListenableFuture<RpcResult<?>> invokeEmpty() {
 163             return invoke0(rpcName, null);
 164         }
 165
 166         final SchemaPath getRpcName() {
 167             return rpcName;
 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 Class<? extends DataContainer> inputType = BindingReflections.resolveRpcInputClass(rpcMethod).get();
 193             refExtractor = ContextReferenceExtractor.from(inputType);
 194             this.contextName = new NodeIdentifier(leafName);
 195         }
 196
 197         @Override
 198         NormalizedNode<?, ?> serialize(final DataObject input) {
 199             final InstanceIdentifier<?> bindingII = refExtractor.extract(input);
 200             if (bindingII != null) {
 201                 final YangInstanceIdentifier yangII = codec.toYangInstanceIdentifierCached(bindingII);
 202                 final LeafNode<?> contextRef = ImmutableNodes.leafNode(contextName, yangII);
 203                 return LazySerializedContainerNode.withContextRef(getRpcName(), input, contextRef,
 204                         codec.getCodecRegistry());
 205             }
 206             return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());
 207         }
 208
 209     }
 210 }