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 static com.google.common.base.Preconditions.checkState;
  11 import static java.util.Objects.requireNonNull;
  12 import static org.opendaylight.mdsal.binding.dom.adapter.StaticConfiguration.ENABLE_CODEC_SHORTCUT;
  13
  14 import com.google.common.collect.ImmutableMap;
  15 import com.google.common.util.concurrent.Futures;
  16 import com.google.common.util.concurrent.ListenableFuture;
  17 import com.google.common.util.concurrent.MoreExecutors;
  18 import java.lang.reflect.InvocationHandler;
  19 import java.lang.reflect.Method;
  20 import java.lang.reflect.Proxy;
  21 import java.util.Map.Entry;
  22 import java.util.Optional;
  23 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  24 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  25 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  26 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  27 import org.opendaylight.mdsal.dom.spi.RpcRoutingStrategy;
  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.common.QName;
  33 import org.opendaylight.yangtools.yang.common.RpcResult;
  34 import org.opendaylight.yangtools.yang.common.YangConstants;
  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     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 = requireNonNull(type);
  54         this.codec = requireNonNull(codec);
  55         this.delegate = requireNonNull(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 RpcInvocationStrategy createStrategy(final Method method, final RpcDefinition schema) {
  65         final RpcRoutingStrategy strategy = RpcRoutingStrategy.from(schema);
  66         if (strategy.isContextBasedRouted()) {
  67             return new RoutedStrategy(schema.getPath(), method, strategy.getLeaf());
  68         }
  69         return new NonRoutedStrategy(schema.getPath());
  70     }
  71
  72     RpcService getProxy() {
  73         return proxy;
  74     }
  75
  76     @Override
  77     @SuppressWarnings("checkstyle:hiddenField")
  78     public Object invoke(final Object proxy, final Method method, final Object[] args) throws Throwable {
  79
  80         final RpcInvocationStrategy rpc = rpcNames.get(method);
  81         if (rpc != null) {
  82             if (method.getParameterCount() == 0) {
  83                 return rpc.invokeEmpty();
  84             }
  85             if (args.length != 1) {
  86                 throw new IllegalArgumentException("Input must be provided.");
  87             }
  88             return rpc.invoke((DataObject) args[0]);
  89         }
  90
  91         switch (method.getName()) {
  92             case "toString":
  93                 if (method.getReturnType().equals(String.class) && method.getParameterCount() == 0) {
  94                     return type.getName() + "$Adapter{delegate=" + delegate.toString() + "}";
  95                 }
  96                 break;
  97             case "hashCode":
  98                 if (method.getReturnType().equals(int.class) && method.getParameterCount() == 0) {
  99                     return System.identityHashCode(proxy);
 100                 }
 101                 break;
 102             case "equals":
 103                 if (method.getReturnType().equals(boolean.class) && method.getParameterCount() == 1
 104                         && method.getParameterTypes()[0] == Object.class) {
 105                     return proxy == args[0];
 106                 }
 107                 break;
 108             default:
 109                 break;
 110         }
 111
 112         throw new UnsupportedOperationException("Method " + method.toString() + "is unsupported.");
 113     }
 114
 115     private abstract class RpcInvocationStrategy {
 116
 117         private final SchemaPath rpcName;
 118
 119         protected RpcInvocationStrategy(final SchemaPath path) {
 120             rpcName = path;
 121         }
 122
 123         final ListenableFuture<RpcResult<?>> invoke(final DataObject input) {
 124             return invoke0(rpcName, serialize(input));
 125         }
 126
 127         abstract ContainerNode serialize(DataObject input);
 128
 129         final ListenableFuture<RpcResult<?>> invokeEmpty() {
 130             return invoke0(rpcName, null);
 131         }
 132
 133         final SchemaPath getRpcName() {
 134             return rpcName;
 135         }
 136
 137         ListenableFuture<RpcResult<?>> invoke0(final SchemaPath schemaPath, final ContainerNode input) {
 138             final ListenableFuture<DOMRpcResult> result = delegate.invokeRpc(schemaPath, input);
 139             if (ENABLE_CODEC_SHORTCUT && result instanceof BindingRpcFutureAware) {
 140                 return ((BindingRpcFutureAware) result).getBindingFuture();
 141             }
 142
 143             return transformFuture(schemaPath, result, codec.getCodecRegistry());
 144         }
 145
 146         private ListenableFuture<RpcResult<?>> transformFuture(final SchemaPath rpc,
 147                 final ListenableFuture<DOMRpcResult> domFuture, final BindingNormalizedNodeSerializer resultCodec) {
 148             return Futures.transform(domFuture, input -> {
 149                 final NormalizedNode<?, ?> domData = input.getResult();
 150                 final DataObject bindingResult;
 151                 if (domData != null) {
 152                     final SchemaPath rpcOutput = rpc.createChild(YangConstants.operationOutputQName(
 153                         rpc.getLastComponent().getModule()));
 154                     bindingResult = resultCodec.fromNormalizedNodeRpcData(rpcOutput, (ContainerNode) domData);
 155                 } else {
 156                     bindingResult = null;
 157                 }
 158
 159                 return RpcResultUtil.rpcResultFromDOM(input.getErrors(), bindingResult);
 160             }, MoreExecutors.directExecutor());
 161         }
 162     }
 163
 164     private final class NonRoutedStrategy extends RpcInvocationStrategy {
 165
 166         protected NonRoutedStrategy(final SchemaPath path) {
 167             super(path);
 168         }
 169
 170         @Override
 171         ContainerNode serialize(final DataObject input) {
 172             return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());
 173         }
 174
 175     }
 176
 177     private final class RoutedStrategy extends RpcInvocationStrategy {
 178
 179         private final ContextReferenceExtractor refExtractor;
 180         private final NodeIdentifier contextName;
 181
 182         protected RoutedStrategy(final SchemaPath path, final Method rpcMethod, final QName leafName) {
 183             super(path);
 184             final Optional<Class<? extends DataContainer>> maybeInputType =
 185                     BindingReflections.resolveRpcInputClass(rpcMethod);
 186             checkState(maybeInputType.isPresent(), "RPC method %s has no input", rpcMethod.getName());
 187             final Class<? extends DataContainer> inputType = maybeInputType.get();
 188             refExtractor = ContextReferenceExtractor.from(inputType);
 189             this.contextName = new NodeIdentifier(leafName);
 190         }
 191
 192         @Override
 193         ContainerNode serialize(final DataObject input) {
 194             final InstanceIdentifier<?> bindingII = refExtractor.extract(input);
 195             if (bindingII != null) {
 196                 final YangInstanceIdentifier yangII = codec.toYangInstanceIdentifierCached(bindingII);
 197                 final LeafNode<?> contextRef = ImmutableNodes.leafNode(contextName, yangII);
 198                 return LazySerializedContainerNode.withContextRef(getRpcName(), input, contextRef,
 199                         codec.getCodecRegistry());
 200             }
 201             return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());
 202         }
 203
 204     }
 205 }