2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the terms of the Eclipse
5 * Public License v1.0 which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.md.sal.binding.impl;
10 import com.google.common.base.Function;
11 import com.google.common.base.Preconditions;
12 import com.google.common.collect.ImmutableMap;
13 import com.google.common.util.concurrent.CheckedFuture;
14 import com.google.common.util.concurrent.Futures;
15 import com.google.common.util.concurrent.ListenableFuture;
16 import java.lang.reflect.InvocationHandler;
17 import java.lang.reflect.Method;
18 import java.lang.reflect.Proxy;
19 import java.util.Map.Entry;
20 import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
21 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
22 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
23 import org.opendaylight.controller.md.sal.dom.broker.spi.rpc.RpcRoutingStrategy;
24 import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
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.RpcResult;
32 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
35 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
37 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
38 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
39 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
40 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
42 class RpcServiceAdapter implements InvocationHandler {
44 private final ImmutableMap<Method, RpcInvocationStrategy> rpcNames;
45 private final Class<? extends RpcService> type;
46 private final BindingToNormalizedNodeCodec codec;
47 private final DOMRpcService delegate;
48 private final RpcService proxy;
50 RpcServiceAdapter(final Class<? extends RpcService> type, final BindingToNormalizedNodeCodec codec,
51 final DOMRpcService domService) {
52 this.type = Preconditions.checkNotNull(type);
53 this.codec = Preconditions.checkNotNull(codec);
54 this.delegate = Preconditions.checkNotNull(domService);
55 final ImmutableMap.Builder<Method, RpcInvocationStrategy> rpcBuilder = ImmutableMap.builder();
56 for (final Entry<Method, RpcDefinition> rpc : codec.getRpcMethodToSchema(type).entrySet()) {
57 rpcBuilder.put(rpc.getKey(), createStrategy(rpc.getKey(), rpc.getValue()));
59 rpcNames = rpcBuilder.build();
60 proxy = (RpcService) Proxy.newProxyInstance(type.getClassLoader(), new Class[] {type}, this);
63 private final ListenableFuture<RpcResult<?>> invoke0(final SchemaPath schemaPath, final NormalizedNode<?, ?> input) {
64 final CheckedFuture<DOMRpcResult, DOMRpcException> result = delegate.invokeRpc(schemaPath, input);
65 return transformFuture(schemaPath, result, codec.getCodecFactory());
68 private RpcInvocationStrategy createStrategy(final Method method, final RpcDefinition schema) {
69 final RpcRoutingStrategy strategy = RpcRoutingStrategy.from(schema);
70 if (strategy.isContextBasedRouted()) {
71 return new RoutedStrategy(schema.getPath(), method, strategy.getLeaf());
73 return new NonRoutedStrategy(schema.getPath());
76 RpcService getProxy() {
81 public Object invoke(final Object proxy, final Method method, final Object[] args) throws Throwable {
83 final RpcInvocationStrategy rpc = rpcNames.get(method);
85 if (method.getParameterTypes().length == 0) {
86 return rpc.invokeEmpty();
88 if (args.length != 1) {
89 throw new IllegalArgumentException("Input must be provided.");
91 return rpc.invoke((DataObject) args[0]);
94 if (isObjectMethod(method)) {
95 return callObjectMethod(proxy, method, args);
97 throw new UnsupportedOperationException("Method " + method.toString() + "is unsupported.");
100 private static boolean isObjectMethod(final Method m) {
101 switch (m.getName()) {
103 return (m.getReturnType() == String.class && m.getParameterTypes().length == 0);
105 return (m.getReturnType() == int.class && m.getParameterTypes().length == 0);
107 return (m.getReturnType() == boolean.class && m.getParameterTypes().length == 1 && m
108 .getParameterTypes()[0] == Object.class);
113 private Object callObjectMethod(final Object self, final Method m, final Object[] args) {
114 switch (m.getName()) {
116 return type.getName() + "$Adapter{delegate=" + delegate.toString() + "}";
118 return System.identityHashCode(self);
120 return (self == args[0]);
125 private static ListenableFuture<RpcResult<?>> transformFuture(final SchemaPath rpc,
126 final ListenableFuture<DOMRpcResult> domFuture, final BindingNormalizedNodeCodecRegistry codec) {
127 return Futures.transform(domFuture, new Function<DOMRpcResult, RpcResult<?>>() {
129 public RpcResult<?> apply(final DOMRpcResult input) {
130 if (input instanceof LazySerializedDOMRpcResult) {
131 return ((LazySerializedDOMRpcResult) input).bidningRpcResult();
133 final NormalizedNode<?, ?> domData = input.getResult();
134 final DataObject bindingResult;
135 if (domData != null) {
136 final SchemaPath rpcOutput = rpc.createChild(QName.create(rpc.getLastComponent(), "output"));
137 bindingResult = codec.fromNormalizedNodeRpcData(rpcOutput, (ContainerNode) domData);
139 bindingResult = null;
141 return RpcResult.class.cast(RpcResultBuilder.success(bindingResult).build());
146 private abstract class RpcInvocationStrategy {
148 private final SchemaPath rpcName;
150 protected RpcInvocationStrategy(final SchemaPath path) {
154 final ListenableFuture<RpcResult<?>> invoke(final DataObject input) {
155 return invoke0(rpcName, serialize(input));
158 abstract NormalizedNode<?, ?> serialize(DataObject input);
160 final ListenableFuture<RpcResult<?>> invokeEmpty() {
161 return invoke0(rpcName, null);
164 final SchemaPath getRpcName() {
170 private final class NonRoutedStrategy extends RpcInvocationStrategy {
172 protected NonRoutedStrategy(final SchemaPath path) {
177 NormalizedNode<?, ?> serialize(final DataObject input) {
178 return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());
183 private final class RoutedStrategy extends RpcInvocationStrategy {
185 private final ContextReferenceExtractor refExtractor;
186 private final NodeIdentifier contextName;
188 protected RoutedStrategy(final SchemaPath path, final Method rpcMethod, final QName leafName) {
190 final Class<? extends DataContainer> inputType = BindingReflections.resolveRpcInputClass(rpcMethod).get();
191 refExtractor = ContextReferenceExtractor.from(inputType);
192 this.contextName = new NodeIdentifier(leafName);
196 NormalizedNode<?, ?> serialize(final DataObject input) {
197 final InstanceIdentifier<?> bindingII = refExtractor.extract(input);
198 if (bindingII != null) {
199 final YangInstanceIdentifier yangII = codec.toYangInstanceIdentifierCached(bindingII);
200 final LeafNode<?> contextRef = ImmutableNodes.leafNode(contextName, yangII);
201 return LazySerializedContainerNode.withContextRef(getRpcName(), input, contextRef,
202 codec.getCodecRegistry());
204 return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());