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
9 package org.opendaylight.mdsal.binding.dom.adapter;
11 import org.opendaylight.mdsal.dom.api.DOMRpcException;
12 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
13 import org.opendaylight.mdsal.dom.api.DOMRpcService;
15 import com.google.common.base.Function;
16 import com.google.common.base.Preconditions;
17 import com.google.common.collect.ImmutableMap;
18 import com.google.common.util.concurrent.CheckedFuture;
19 import com.google.common.util.concurrent.Futures;
20 import com.google.common.util.concurrent.ListenableFuture;
21 import java.lang.reflect.InvocationHandler;
22 import java.lang.reflect.Method;
23 import java.lang.reflect.Proxy;
24 import java.util.Map.Entry;
25 import org.opendaylight.controller.md.sal.dom.broker.spi.rpc.RpcRoutingStrategy;
26 import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
27 import org.opendaylight.yangtools.yang.binding.DataContainer;
28 import org.opendaylight.yangtools.yang.binding.DataObject;
29 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
30 import org.opendaylight.yangtools.yang.binding.RpcService;
31 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
32 import org.opendaylight.yangtools.yang.common.QName;
33 import org.opendaylight.yangtools.yang.common.RpcResult;
34 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
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;
44 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;
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()));
61 rpcNames = rpcBuilder.build();
62 proxy = (RpcService) Proxy.newProxyInstance(type.getClassLoader(), new Class[] {type}, this);
65 private ListenableFuture<RpcResult<?>> invoke0(final SchemaPath schemaPath, final NormalizedNode<?, ?> input) {
66 final CheckedFuture<DOMRpcResult, DOMRpcException> result = delegate.invokeRpc(schemaPath, input);
67 if(result instanceof LazyDOMRpcResultFuture) {
68 return ((LazyDOMRpcResultFuture) result).getBindingFuture();
71 return transformFuture(schemaPath, result, codec.getCodecFactory());
74 private RpcInvocationStrategy createStrategy(final Method method, final RpcDefinition schema) {
75 final RpcRoutingStrategy strategy = RpcRoutingStrategy.from(schema);
76 if (strategy.isContextBasedRouted()) {
77 return new RoutedStrategy(schema.getPath(), method, strategy.getLeaf());
79 return new NonRoutedStrategy(schema.getPath());
82 RpcService getProxy() {
87 public Object invoke(final Object proxy, final Method method, final Object[] args) throws Throwable {
89 final RpcInvocationStrategy rpc = rpcNames.get(method);
91 if (method.getParameterTypes().length == 0) {
92 return rpc.invokeEmpty();
94 if (args.length != 1) {
95 throw new IllegalArgumentException("Input must be provided.");
97 return rpc.invoke((DataObject) args[0]);
100 if (isObjectMethod(method)) {
101 return callObjectMethod(proxy, method, args);
103 throw new UnsupportedOperationException("Method " + method.toString() + "is unsupported.");
106 private static boolean isObjectMethod(final Method m) {
107 switch (m.getName()) {
109 return (m.getReturnType().equals(String.class) && m.getParameterTypes().length == 0);
111 return (m.getReturnType().equals(int.class) && m.getParameterTypes().length == 0);
113 return (m.getReturnType().equals(boolean.class) && m.getParameterTypes().length == 1 && m
114 .getParameterTypes()[0] == Object.class);
120 private Object callObjectMethod(final Object self, final Method m, final Object[] args) {
121 switch (m.getName()) {
123 return type.getName() + "$Adapter{delegate=" + delegate.toString() + "}";
125 return System.identityHashCode(self);
127 return (self == args[0]);
133 private static ListenableFuture<RpcResult<?>> transformFuture(final SchemaPath rpc,
134 final ListenableFuture<DOMRpcResult> domFuture, final BindingNormalizedNodeCodecRegistry codec) {
135 return Futures.transform(domFuture, new Function<DOMRpcResult, RpcResult<?>>() {
137 public RpcResult<?> apply(final DOMRpcResult input) {
138 final NormalizedNode<?, ?> domData = input.getResult();
139 final DataObject bindingResult;
140 if (domData != null) {
141 final SchemaPath rpcOutput = rpc.createChild(QName.create(rpc.getLastComponent(), "output"));
142 bindingResult = codec.fromNormalizedNodeRpcData(rpcOutput, (ContainerNode) domData);
144 bindingResult = null;
146 return RpcResult.class.cast(RpcResultBuilder.success(bindingResult).build());
151 private abstract class RpcInvocationStrategy {
153 private final SchemaPath rpcName;
155 protected RpcInvocationStrategy(final SchemaPath path) {
159 final ListenableFuture<RpcResult<?>> invoke(final DataObject input) {
160 return invoke0(rpcName, serialize(input));
163 abstract NormalizedNode<?, ?> serialize(DataObject input);
165 final ListenableFuture<RpcResult<?>> invokeEmpty() {
166 return invoke0(rpcName, null);
169 final SchemaPath getRpcName() {
175 private final class NonRoutedStrategy extends RpcInvocationStrategy {
177 protected NonRoutedStrategy(final SchemaPath path) {
182 NormalizedNode<?, ?> serialize(final DataObject input) {
183 return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());
188 private final class RoutedStrategy extends RpcInvocationStrategy {
190 private final ContextReferenceExtractor refExtractor;
191 private final NodeIdentifier contextName;
193 protected RoutedStrategy(final SchemaPath path, final Method rpcMethod, final QName leafName) {
195 final Class<? extends DataContainer> inputType = BindingReflections.resolveRpcInputClass(rpcMethod).get();
196 refExtractor = ContextReferenceExtractor.from(inputType);
197 this.contextName = new NodeIdentifier(leafName);
201 NormalizedNode<?, ?> serialize(final DataObject input) {
202 final InstanceIdentifier<?> bindingII = refExtractor.extract(input);
203 if (bindingII != null) {
204 final YangInstanceIdentifier yangII = codec.toYangInstanceIdentifierCached(bindingII);
205 final LeafNode<?> contextRef = ImmutableNodes.leafNode(contextName, yangII);
206 return LazySerializedContainerNode.withContextRef(getRpcName(), input, contextRef,
207 codec.getCodecRegistry());
209 return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());