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