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 com.google.common.base.Optional;
11 import com.google.common.base.Preconditions;
12 import com.google.common.collect.ImmutableMap;
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.Map.Entry;
20 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
21 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
22 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
23 import org.opendaylight.mdsal.dom.api.DOMRpcService;
24 import org.opendaylight.mdsal.dom.spi.RpcRoutingStrategy;
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.common.QName;
30 import org.opendaylight.yangtools.yang.common.RpcResult;
31 import org.opendaylight.yangtools.yang.common.YangConstants;
32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
34 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
37 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
38 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
39 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
41 class RpcServiceAdapter implements InvocationHandler {
42 private final ImmutableMap<Method, RpcInvocationStrategy> rpcNames;
43 private final Class<? extends RpcService> type;
44 private final BindingToNormalizedNodeCodec codec;
45 private final DOMRpcService delegate;
46 private final RpcService proxy;
48 RpcServiceAdapter(final Class<? extends RpcService> type, final BindingToNormalizedNodeCodec codec,
49 final DOMRpcService domService) {
50 this.type = Preconditions.checkNotNull(type);
51 this.codec = Preconditions.checkNotNull(codec);
52 this.delegate = Preconditions.checkNotNull(domService);
53 final ImmutableMap.Builder<Method, RpcInvocationStrategy> rpcBuilder = ImmutableMap.builder();
54 for (final Entry<Method, RpcDefinition> rpc : codec.getRpcMethodToSchema(type).entrySet()) {
55 rpcBuilder.put(rpc.getKey(), createStrategy(rpc.getKey(), rpc.getValue()));
57 rpcNames = rpcBuilder.build();
58 proxy = (RpcService) Proxy.newProxyInstance(type.getClassLoader(), new Class[] {type}, this);
61 private RpcInvocationStrategy createStrategy(final Method method, final RpcDefinition schema) {
62 final RpcRoutingStrategy strategy = RpcRoutingStrategy.from(schema);
63 if (strategy.isContextBasedRouted()) {
64 return new RoutedStrategy(schema.getPath(), method, strategy.getLeaf());
66 return new NonRoutedStrategy(schema.getPath());
69 RpcService getProxy() {
74 @SuppressWarnings("checkstyle:hiddenField")
75 public Object invoke(final Object proxy, final Method method, final Object[] args) throws Throwable {
77 final RpcInvocationStrategy rpc = rpcNames.get(method);
79 if (method.getParameterTypes().length == 0) {
80 return rpc.invokeEmpty();
82 if (args.length != 1) {
83 throw new IllegalArgumentException("Input must be provided.");
85 return rpc.invoke((DataObject) args[0]);
88 switch (method.getName()) {
90 if (method.getReturnType().equals(String.class) && method.getParameterTypes().length == 0) {
91 return type.getName() + "$Adapter{delegate=" + delegate.toString() + "}";
95 if (method.getReturnType().equals(int.class) && method.getParameterTypes().length == 0) {
96 return System.identityHashCode(proxy);
100 if (method.getReturnType().equals(boolean.class) && method.getParameterTypes().length == 1
101 && method.getParameterTypes()[0] == Object.class) {
102 return proxy == args[0];
109 throw new UnsupportedOperationException("Method " + method.toString() + "is unsupported.");
112 private abstract class RpcInvocationStrategy {
114 private final SchemaPath rpcName;
116 protected RpcInvocationStrategy(final SchemaPath path) {
120 final ListenableFuture<RpcResult<?>> invoke(final DataObject input) {
121 return invoke0(rpcName, serialize(input));
124 abstract ContainerNode serialize(DataObject input);
126 final ListenableFuture<RpcResult<?>> invokeEmpty() {
127 return invoke0(rpcName, null);
130 final SchemaPath getRpcName() {
134 ListenableFuture<RpcResult<?>> invoke0(final SchemaPath schemaPath, final ContainerNode input) {
135 final ListenableFuture<DOMRpcResult> result = delegate.invokeRpc(schemaPath, input);
136 if (result instanceof BindingRpcFutureAware) {
137 return ((BindingRpcFutureAware) result).getBindingFuture();
140 return transformFuture(schemaPath, result, codec.getCodecFactory());
143 private ListenableFuture<RpcResult<?>> transformFuture(final SchemaPath rpc,
144 final ListenableFuture<DOMRpcResult> domFuture, final BindingNormalizedNodeCodecRegistry resultCodec) {
145 return Futures.transform(domFuture, input -> {
146 final NormalizedNode<?, ?> domData = input.getResult();
147 final DataObject bindingResult;
148 if (domData != null) {
149 final SchemaPath rpcOutput = rpc.createChild(YangConstants.operationOutputQName(
150 rpc.getLastComponent().getModule()));
151 bindingResult = resultCodec.fromNormalizedNodeRpcData(rpcOutput, (ContainerNode) domData);
153 bindingResult = null;
156 return RpcResultUtil.rpcResultFromDOM(input.getErrors(), bindingResult);
157 }, MoreExecutors.directExecutor());
161 private final class NonRoutedStrategy extends RpcInvocationStrategy {
163 protected NonRoutedStrategy(final SchemaPath path) {
168 ContainerNode serialize(final DataObject input) {
169 return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());
174 private final class RoutedStrategy extends RpcInvocationStrategy {
176 private final ContextReferenceExtractor refExtractor;
177 private final NodeIdentifier contextName;
179 protected RoutedStrategy(final SchemaPath path, final Method rpcMethod, final QName leafName) {
181 final Optional<Class<? extends DataContainer>> maybeInputType =
182 BindingReflections.resolveRpcInputClass(rpcMethod);
183 Preconditions.checkState(maybeInputType.isPresent(), "RPC method %s has no input", rpcMethod.getName());
184 final Class<? extends DataContainer> inputType = maybeInputType.get();
185 refExtractor = ContextReferenceExtractor.from(inputType);
186 this.contextName = new NodeIdentifier(leafName);
190 ContainerNode serialize(final DataObject input) {
191 final InstanceIdentifier<?> bindingII = refExtractor.extract(input);
192 if (bindingII != null) {
193 final YangInstanceIdentifier yangII = codec.toYangInstanceIdentifierCached(bindingII);
194 final LeafNode<?> contextRef = ImmutableNodes.leafNode(contextName, yangII);
195 return LazySerializedContainerNode.withContextRef(getRpcName(), input, contextRef,
196 codec.getCodecRegistry());
198 return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());