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