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.controller.md.sal.binding.impl;
10 import com.google.common.base.Preconditions;
11 import com.google.common.collect.ImmutableMap;
12 import com.google.common.util.concurrent.CheckedFuture;
13 import com.google.common.util.concurrent.Futures;
14 import com.google.common.util.concurrent.ListenableFuture;
15 import com.google.common.util.concurrent.MoreExecutors;
16 import java.lang.reflect.InvocationHandler;
17 import java.lang.reflect.Method;
18 import java.lang.reflect.Proxy;
19 import java.util.Collection;
20 import java.util.Map.Entry;
21 import java.util.concurrent.Future;
22 import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
23 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
24 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
25 import org.opendaylight.controller.md.sal.dom.broker.spi.rpc.RpcRoutingStrategy;
26 import org.opendaylight.controller.sal.core.compat.LegacyDOMRpcResultFutureAdapter;
27 import org.opendaylight.mdsal.binding.dom.adapter.BindingRpcFutureAware;
28 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
29 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
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.RpcError;
36 import org.opendaylight.yangtools.yang.common.RpcError.ErrorSeverity;
37 import org.opendaylight.yangtools.yang.common.RpcResult;
38 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
41 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
42 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
43 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
44 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
45 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
46 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
49 class RpcServiceAdapter implements InvocationHandler {
51 private final ImmutableMap<Method, RpcInvocationStrategy> rpcNames;
52 private final Class<? extends RpcService> type;
53 private final BindingToNormalizedNodeCodec codec;
54 private final DOMRpcService delegate;
55 private final RpcService proxy;
57 RpcServiceAdapter(final Class<? extends RpcService> type, final BindingToNormalizedNodeCodec codec,
58 final DOMRpcService domService) {
59 this.type = Preconditions.checkNotNull(type);
60 this.codec = Preconditions.checkNotNull(codec);
61 this.delegate = Preconditions.checkNotNull(domService);
62 final ImmutableMap.Builder<Method, RpcInvocationStrategy> rpcBuilder = ImmutableMap.builder();
63 for (final Entry<Method, RpcDefinition> rpc : codec.getRpcMethodToSchema(type).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 ListenableFuture<RpcResult<?>> invoke0(final SchemaPath schemaPath, final NormalizedNode<?, ?> input) {
71 final CheckedFuture<DOMRpcResult, DOMRpcException> result = delegate.invokeRpc(schemaPath, input);
72 if (result instanceof BindingRpcFutureAware) {
73 return ((BindingRpcFutureAware) result).getBindingFuture();
74 } else if (result instanceof LegacyDOMRpcResultFutureAdapter) {
75 Future<org.opendaylight.mdsal.dom.api.DOMRpcResult> delegateFuture =
76 ((LegacyDOMRpcResultFutureAdapter)result).delegate();
77 if (delegateFuture instanceof BindingRpcFutureAware) {
78 return ((BindingRpcFutureAware) delegateFuture).getBindingFuture();
82 return transformFuture(schemaPath, result, codec.getCodecFactory());
85 private RpcInvocationStrategy createStrategy(final Method method, final RpcDefinition schema) {
86 final RpcRoutingStrategy strategy = RpcRoutingStrategy.from(schema);
87 if (strategy.isContextBasedRouted()) {
88 return new RoutedStrategy(schema.getPath(), method, strategy.getLeaf());
90 return new NonRoutedStrategy(schema.getPath());
93 RpcService getProxy() {
98 public Object invoke(final Object proxyObj, final Method method, final Object[] args) {
100 final RpcInvocationStrategy rpc = rpcNames.get(method);
102 if (method.getParameterCount() == 0) {
103 return rpc.invokeEmpty();
105 if (args.length != 1) {
106 throw new IllegalArgumentException("Input must be provided.");
108 return rpc.invoke((DataObject) args[0]);
111 if (isObjectMethod(method)) {
112 return callObjectMethod(proxyObj, method, args);
114 throw new UnsupportedOperationException("Method " + method.toString() + "is unsupported.");
117 private static boolean isObjectMethod(final Method method) {
118 switch (method.getName()) {
120 return method.getReturnType().equals(String.class) && method.getParameterCount() == 0;
122 return method.getReturnType().equals(int.class) && method.getParameterCount() == 0;
124 return method.getReturnType().equals(boolean.class) && method.getParameterCount() == 1 && method
125 .getParameterTypes()[0] == Object.class;
131 private Object callObjectMethod(final Object self, final Method method, final Object[] args) {
132 switch (method.getName()) {
134 return type.getName() + "$Adapter{delegate=" + delegate.toString() + "}";
136 return System.identityHashCode(self);
138 return self == args[0];
144 private static ListenableFuture<RpcResult<?>> transformFuture(final SchemaPath rpc,
145 final ListenableFuture<DOMRpcResult> domFuture, final BindingNormalizedNodeSerializer codec) {
146 return Futures.transform(domFuture, input -> {
147 final NormalizedNode<?, ?> domData = input.getResult();
148 final DataObject bindingResult;
149 if (domData != null) {
150 final SchemaPath rpcOutput = rpc.createChild(QName.create(rpc.getLastComponent(), "output"));
151 bindingResult = codec.fromNormalizedNodeRpcData(rpcOutput, (ContainerNode) domData);
153 bindingResult = null;
156 // DOMRpcResult does not have a notion of success, hence we have to reverse-engineer it by looking
157 // at reported errors and checking whether they are just warnings.
158 final Collection<? extends RpcError> errors = input.getErrors();
159 return RpcResult.class.cast(RpcResultBuilder.status(errors.stream()
160 .noneMatch(error -> error.getSeverity() == ErrorSeverity.ERROR))
161 .withResult(bindingResult).withRpcErrors(errors).build());
162 }, MoreExecutors.directExecutor());
165 private abstract class RpcInvocationStrategy {
167 private final SchemaPath rpcName;
169 protected RpcInvocationStrategy(final SchemaPath path) {
173 final ListenableFuture<RpcResult<?>> invoke(final DataObject input) {
174 return invoke0(rpcName, serialize(input));
177 abstract NormalizedNode<?, ?> serialize(DataObject input);
179 final ListenableFuture<RpcResult<?>> invokeEmpty() {
180 return invoke0(rpcName, null);
183 final SchemaPath getRpcName() {
188 private final class NonRoutedStrategy extends RpcInvocationStrategy {
190 protected NonRoutedStrategy(final SchemaPath path) {
195 NormalizedNode<?, ?> serialize(final DataObject input) {
196 return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());
200 private final class RoutedStrategy extends RpcInvocationStrategy {
202 private final ContextReferenceExtractor refExtractor;
203 private final NodeIdentifier contextName;
205 protected RoutedStrategy(final SchemaPath path, final Method rpcMethod, final QName leafName) {
207 final Class<? extends DataContainer> inputType = BindingReflections.resolveRpcInputClass(rpcMethod).get();
208 refExtractor = ContextReferenceExtractor.from(inputType);
209 this.contextName = new NodeIdentifier(leafName);
213 NormalizedNode<?, ?> serialize(final DataObject input) {
214 final InstanceIdentifier<?> bindingII = refExtractor.extract(input);
215 if (bindingII != null) {
216 final YangInstanceIdentifier yangII = codec.toYangInstanceIdentifierCached(bindingII);
217 final LeafNode<?> contextRef = ImmutableNodes.leafNode(contextName, yangII);
218 return LazySerializedContainerNode.withContextRef(getRpcName(), input, contextRef,
219 codec.getCodecRegistry());
221 return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());