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