2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.binding.dom.adapter;
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;
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.eclipse.jdt.annotation.NonNull;
26 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
27 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
28 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
29 import org.opendaylight.mdsal.dom.api.DOMRpcService;
30 import org.opendaylight.mdsal.dom.spi.RpcRoutingStrategy;
31 import org.opendaylight.yangtools.yang.binding.DataContainer;
32 import org.opendaylight.yangtools.yang.binding.DataObject;
33 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
34 import org.opendaylight.yangtools.yang.binding.RpcService;
35 import org.opendaylight.yangtools.yang.common.QName;
36 import org.opendaylight.yangtools.yang.common.RpcResult;
37 import org.opendaylight.yangtools.yang.common.YangConstants;
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.stmt.SchemaNodeIdentifier.Absolute;
47 class RpcServiceAdapter implements InvocationHandler {
48 private final ImmutableMap<Method, RpcInvocationStrategy> rpcNames;
49 private final Class<? extends RpcService> type;
50 private final AdapterContext adapterContext;
51 private final DOMRpcService delegate;
52 private final RpcService proxy;
54 RpcServiceAdapter(final Class<? extends RpcService> type, final AdapterContext adapterContext,
55 final DOMRpcService domService) {
56 this.type = requireNonNull(type);
57 this.adapterContext = requireNonNull(adapterContext);
58 this.delegate = requireNonNull(domService);
60 final ImmutableBiMap<Method, RpcDefinition> methods = adapterContext.currentSerializer()
61 .getRpcMethodToSchema(type);
62 final Builder<Method, RpcInvocationStrategy> rpcBuilder = ImmutableMap.builderWithExpectedSize(methods.size());
63 for (final Entry<Method, RpcDefinition> rpc : methods.entrySet()) {
64 rpcBuilder.put(rpc.getKey(), createStrategy(rpc.getKey(), rpc.getValue()));
66 rpcNames = rpcBuilder.build();
67 proxy = (RpcService) Proxy.newProxyInstance(type.getClassLoader(), new Class[] {type}, this);
70 private RpcInvocationStrategy createStrategy(final Method method, final RpcDefinition schema) {
71 final QName rpcType = schema.getQName();
72 final RpcRoutingStrategy strategy = RpcRoutingStrategy.from(schema);
73 return strategy.isContextBasedRouted() ? new RoutedStrategy(rpcType, method, strategy.getLeaf())
74 : new NonRoutedStrategy(rpcType);
77 RpcService getProxy() {
82 @SuppressWarnings("checkstyle:hiddenField")
83 public Object invoke(final Object proxy, final Method method, final Object[] args) {
84 final RpcInvocationStrategy rpc = rpcNames.get(method);
86 if (args.length != 1) {
87 throw new IllegalArgumentException("Input must be provided.");
89 return rpc.invoke((DataObject) requireNonNull(args[0]));
92 switch (method.getName()) {
94 if (method.getReturnType().equals(String.class) && method.getParameterCount() == 0) {
95 return type.getName() + "$Adapter{delegate=" + delegate.toString() + "}";
99 if (method.getReturnType().equals(int.class) && method.getParameterCount() == 0) {
100 return System.identityHashCode(proxy);
104 if (method.getReturnType().equals(boolean.class) && method.getParameterCount() == 1
105 && method.getParameterTypes()[0] == Object.class) {
106 return proxy == args[0];
113 throw new UnsupportedOperationException("Method " + method.toString() + "is unsupported.");
116 private abstract class RpcInvocationStrategy {
117 private final @NonNull Absolute outputPath;
119 RpcInvocationStrategy(final QName rpcName) {
120 this.outputPath = Absolute.of(rpcName, YangConstants.operationOutputQName(rpcName.getModule()).intern())
124 final ListenableFuture<RpcResult<?>> invoke(final DataObject input) {
125 return invoke0(serialize(input));
128 abstract ContainerNode serialize(DataObject input);
130 final QName getRpcName() {
131 return outputPath.firstNodeIdentifier();
134 ListenableFuture<RpcResult<?>> invoke0(final ContainerNode input) {
135 final ListenableFuture<? extends DOMRpcResult> result =
136 delegate.invokeRpc(outputPath.firstNodeIdentifier(), input);
137 if (ENABLE_CODEC_SHORTCUT && result instanceof BindingRpcFutureAware) {
138 return ((BindingRpcFutureAware) result).getBindingFuture();
141 return transformFuture(result, adapterContext.currentSerializer());
144 private ListenableFuture<RpcResult<?>> transformFuture(final ListenableFuture<? extends DOMRpcResult> domFuture,
145 final BindingNormalizedNodeSerializer resultCodec) {
146 return Futures.transform(domFuture, input -> {
147 final NormalizedNode domData = input.getResult();
148 final DataObject bindingResult;
149 if (domData != null) {
150 bindingResult = resultCodec.fromNormalizedNodeRpcData(outputPath, (ContainerNode) domData);
152 bindingResult = null;
155 return RpcResultUtil.rpcResultFromDOM(input.getErrors(), bindingResult);
156 }, MoreExecutors.directExecutor());
160 private final class NonRoutedStrategy extends RpcInvocationStrategy {
161 NonRoutedStrategy(final QName rpcName) {
166 ContainerNode serialize(final DataObject input) {
167 return LazySerializedContainerNode.create(getRpcName(), input, adapterContext.currentSerializer());
171 private final class RoutedStrategy extends RpcInvocationStrategy {
172 private final ContextReferenceExtractor refExtractor;
173 private final NodeIdentifier contextName;
175 RoutedStrategy(final QName rpcName, final Method rpcMethod, final QName leafName) {
177 final Optional<Class<? extends DataContainer>> maybeInputType =
178 BindingReflections.resolveRpcInputClass(rpcMethod);
179 checkState(maybeInputType.isPresent(), "RPC method %s has no input", rpcMethod.getName());
180 final Class<? extends DataContainer> inputType = maybeInputType.get();
181 refExtractor = ContextReferenceExtractor.from(inputType);
182 this.contextName = new NodeIdentifier(leafName);
186 ContainerNode serialize(final DataObject input) {
187 final InstanceIdentifier<?> bindingII = refExtractor.extract(input);
188 final CurrentAdapterSerializer serializer = adapterContext.currentSerializer();
190 if (bindingII != null) {
191 final YangInstanceIdentifier yangII = serializer.toCachedYangInstanceIdentifier(bindingII);
192 final LeafNode<?> contextRef = ImmutableNodes.leafNode(contextName, yangII);
193 return LazySerializedContainerNode.withContextRef(getRpcName(), input, contextRef, serializer);
195 return LazySerializedContainerNode.create(getRpcName(), input, serializer);