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 package org.opendaylight.mdsal.binding.dom.adapter;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.ImmutableMap;
  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.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
  22 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  23 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  24 import org.opendaylight.mdsal.dom.spi.RpcRoutingStrategy;
  25 import org.opendaylight.yangtools.yang.binding.DataContainer;
  26 import org.opendaylight.yangtools.yang.binding.DataObject;
  27 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  28 import org.opendaylight.yangtools.yang.binding.RpcService;
  29 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
  30 import org.opendaylight.yangtools.yang.common.QName;
  31 import org.opendaylight.yangtools.yang.common.RpcError;
  32 import org.opendaylight.yangtools.yang.common.RpcError.ErrorSeverity;
  33 import org.opendaylight.yangtools.yang.common.RpcResult;
  34 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  35 import org.opendaylight.yangtools.yang.common.YangConstants;
  36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  38 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  39 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  41 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  42 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  43 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  44
  45 class RpcServiceAdapter implements InvocationHandler {
  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     @SuppressWarnings("checkstyle:hiddenField")
  79     public Object invoke(final Object proxy, final Method method, final Object[] args) throws Throwable {
  80
  81         final RpcInvocationStrategy rpc = rpcNames.get(method);
  82         if (rpc != null) {
  83             if (method.getParameterTypes().length == 0) {
  84                 return rpc.invokeEmpty();
  85             }
  86             if (args.length != 1) {
  87                 throw new IllegalArgumentException("Input must be provided.");
  88             }
  89             return rpc.invoke((DataObject) args[0]);
  90         }
  91
  92         if (isObjectMethod(method)) {
  93             return callObjectMethod(proxy, method, args);
  94         }
  95         throw new UnsupportedOperationException("Method " + method.toString() + "is unsupported.");
  96     }
  97
  98     private static boolean isObjectMethod(final Method method) {
  99         switch (method.getName()) {
 100             case "toString":
 101                 return method.getReturnType().equals(String.class) && method.getParameterTypes().length == 0;
 102             case "hashCode":
 103                 return method.getReturnType().equals(int.class) && method.getParameterTypes().length == 0;
 104             case "equals":
 105                 return method.getReturnType().equals(boolean.class) && method.getParameterTypes().length == 1
 106                         && method.getParameterTypes()[0] == Object.class;
 107             default:
 108                 return false;
 109         }
 110     }
 111
 112     private Object callObjectMethod(final Object self, final Method method, final Object[] args) {
 113         switch (method.getName()) {
 114             case "toString":
 115                 return type.getName() + "$Adapter{delegate=" + delegate.toString() + "}";
 116             case "hashCode":
 117                 return System.identityHashCode(self);
 118             case "equals":
 119                 return self == args[0];
 120             default:
 121                 return null;
 122         }
 123     }
 124
 125     private abstract class RpcInvocationStrategy {
 126
 127         private final SchemaPath rpcName;
 128
 129         protected RpcInvocationStrategy(final SchemaPath path) {
 130             rpcName = path;
 131         }
 132
 133         final ListenableFuture<RpcResult<?>> invoke(final DataObject input) {
 134             return invoke0(rpcName, serialize(input));
 135         }
 136
 137         abstract ContainerNode serialize(DataObject input);
 138
 139         final ListenableFuture<RpcResult<?>> invokeEmpty() {
 140             return invoke0(rpcName, null);
 141         }
 142
 143         final SchemaPath getRpcName() {
 144             return rpcName;
 145         }
 146
 147         ListenableFuture<RpcResult<?>> invoke0(final SchemaPath schemaPath, final ContainerNode input) {
 148             final ListenableFuture<DOMRpcResult> result = delegate.invokeRpc(schemaPath, input);
 149             if (result instanceof BindingRpcFutureAware) {
 150                 return ((BindingRpcFutureAware) result).getBindingFuture();
 151             }
 152
 153             return transformFuture(schemaPath, result, codec.getCodecFactory());
 154         }
 155
 156         private ListenableFuture<RpcResult<?>> transformFuture(final SchemaPath rpc,
 157                 final ListenableFuture<DOMRpcResult> domFuture, final BindingNormalizedNodeCodecRegistry resultCodec) {
 158             return Futures.transform(domFuture, input -> {
 159                 final NormalizedNode<?, ?> domData = input.getResult();
 160                 final DataObject bindingResult;
 161                 if (domData != null) {
 162                     final SchemaPath rpcOutput = rpc.createChild(YangConstants.operationOutputQName(
 163                         rpc.getLastComponent().getModule()));
 164                     bindingResult = resultCodec.fromNormalizedNodeRpcData(rpcOutput, (ContainerNode) domData);
 165                 } else {
 166                     bindingResult = null;
 167                 }
 168
 169                 // DOMRpcResult does not have a notion of success, hence we have to reverse-engineer it by looking
 170                 // at reported errors and checking whether they are just warnings.
 171                 final Collection<RpcError> errors = input.getErrors();
 172                 return RpcResult.class.cast(RpcResultBuilder.status(errors.stream()
 173                     .noneMatch(error -> error.getSeverity() == ErrorSeverity.ERROR))
 174                     .withResult(bindingResult).withRpcErrors(errors).build());
 175             }, MoreExecutors.directExecutor());
 176         }
 177     }
 178
 179     private final class NonRoutedStrategy extends RpcInvocationStrategy {
 180
 181         protected NonRoutedStrategy(final SchemaPath path) {
 182             super(path);
 183         }
 184
 185         @Override
 186         ContainerNode serialize(final DataObject input) {
 187             return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());
 188         }
 189
 190     }
 191
 192     private final class RoutedStrategy extends RpcInvocationStrategy {
 193
 194         private final ContextReferenceExtractor refExtractor;
 195         private final NodeIdentifier contextName;
 196
 197         protected RoutedStrategy(final SchemaPath path, final Method rpcMethod, final QName leafName) {
 198             super(path);
 199             final Optional<Class<? extends DataContainer>> maybeInputType =
 200                     BindingReflections.resolveRpcInputClass(rpcMethod);
 201             Preconditions.checkState(maybeInputType.isPresent(), "RPC method %s has no input", rpcMethod.getName());
 202             final Class<? extends DataContainer> inputType = maybeInputType.get();
 203             refExtractor = ContextReferenceExtractor.from(inputType);
 204             this.contextName = new NodeIdentifier(leafName);
 205         }
 206
 207         @Override
 208         ContainerNode serialize(final DataObject input) {
 209             final InstanceIdentifier<?> bindingII = refExtractor.extract(input);
 210             if (bindingII != null) {
 211                 final YangInstanceIdentifier yangII = codec.toYangInstanceIdentifierCached(bindingII);
 212                 final LeafNode<?> contextRef = ImmutableNodes.leafNode(contextName, yangII);
 213                 return LazySerializedContainerNode.withContextRef(getRpcName(), input, contextRef,
 214                         codec.getCodecRegistry());
 215             }
 216             return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());
 217         }
 218
 219     }
 220 }