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.Collection;
20 import java.util.Map.Entry;
21 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
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.binding.util.BindingReflections;
30 import org.opendaylight.yangtools.yang.common.QName;
31 import org.opendaylight.yangtools.yang.common.RpcError;
32 import org.opendaylight.yangtools.yang.common.RpcError.ErrorSeverity;
33 import org.opendaylight.yangtools.yang.common.RpcResult;
34 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
35 import org.opendaylight.yangtools.yang.common.YangConstants;
36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
38 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
40 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
41 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
42 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
43 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
45 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 RpcInvocationStrategy createStrategy(final Method method, final RpcDefinition schema) {
66 final RpcRoutingStrategy strategy = RpcRoutingStrategy.from(schema);
67 if (strategy.isContextBasedRouted()) {
68 return new RoutedStrategy(schema.getPath(), method, strategy.getLeaf());
70 return new NonRoutedStrategy(schema.getPath());
73 RpcService getProxy() {
78 @SuppressWarnings("checkstyle:hiddenField")
79 public Object invoke(final Object proxy, final Method method, final Object[] args) throws Throwable {
81 final RpcInvocationStrategy rpc = rpcNames.get(method);
83 if (method.getParameterTypes().length == 0) {
84 return rpc.invokeEmpty();
86 if (args.length != 1) {
87 throw new IllegalArgumentException("Input must be provided.");
89 return rpc.invoke((DataObject) args[0]);
92 switch (method.getName()) {
94 if (method.getReturnType().equals(String.class) && method.getParameterTypes().length == 0) {
95 return type.getName() + "$Adapter{delegate=" + delegate.toString() + "}";
99 if (method.getReturnType().equals(int.class) && method.getParameterTypes().length == 0) {
100 return System.identityHashCode(proxy);
104 if (method.getReturnType().equals(boolean.class) && method.getParameterTypes().length == 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 {
118 private final SchemaPath rpcName;
120 protected RpcInvocationStrategy(final SchemaPath path) {
124 final ListenableFuture<RpcResult<?>> invoke(final DataObject input) {
125 return invoke0(rpcName, serialize(input));
128 abstract ContainerNode serialize(DataObject input);
130 final ListenableFuture<RpcResult<?>> invokeEmpty() {
131 return invoke0(rpcName, null);
134 final SchemaPath getRpcName() {
138 ListenableFuture<RpcResult<?>> invoke0(final SchemaPath schemaPath, final ContainerNode input) {
139 final ListenableFuture<DOMRpcResult> result = delegate.invokeRpc(schemaPath, input);
140 if (result instanceof BindingRpcFutureAware) {
141 return ((BindingRpcFutureAware) result).getBindingFuture();
144 return transformFuture(schemaPath, result, codec.getCodecFactory());
147 private ListenableFuture<RpcResult<?>> transformFuture(final SchemaPath rpc,
148 final ListenableFuture<DOMRpcResult> domFuture, final BindingNormalizedNodeCodecRegistry resultCodec) {
149 return Futures.transform(domFuture, input -> {
150 final NormalizedNode<?, ?> domData = input.getResult();
151 final DataObject bindingResult;
152 if (domData != null) {
153 final SchemaPath rpcOutput = rpc.createChild(YangConstants.operationOutputQName(
154 rpc.getLastComponent().getModule()));
155 bindingResult = resultCodec.fromNormalizedNodeRpcData(rpcOutput, (ContainerNode) domData);
157 bindingResult = null;
160 // DOMRpcResult does not have a notion of success, hence we have to reverse-engineer it by looking
161 // at reported errors and checking whether they are just warnings.
162 final Collection<RpcError> errors = input.getErrors();
163 return RpcResult.class.cast(RpcResultBuilder.status(errors.stream()
164 .noneMatch(error -> error.getSeverity() == ErrorSeverity.ERROR))
165 .withResult(bindingResult).withRpcErrors(errors).build());
166 }, MoreExecutors.directExecutor());
170 private final class NonRoutedStrategy extends RpcInvocationStrategy {
172 protected NonRoutedStrategy(final SchemaPath path) {
177 ContainerNode 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 Optional<Class<? extends DataContainer>> maybeInputType =
191 BindingReflections.resolveRpcInputClass(rpcMethod);
192 Preconditions.checkState(maybeInputType.isPresent(), "RPC method %s has no input", rpcMethod.getName());
193 final Class<? extends DataContainer> inputType = maybeInputType.get();
194 refExtractor = ContextReferenceExtractor.from(inputType);
195 this.contextName = new NodeIdentifier(leafName);
199 ContainerNode serialize(final DataObject input) {
200 final InstanceIdentifier<?> bindingII = refExtractor.extract(input);
201 if (bindingII != null) {
202 final YangInstanceIdentifier yangII = codec.toYangInstanceIdentifierCached(bindingII);
203 final LeafNode<?> contextRef = ImmutableNodes.leafNode(contextName, yangII);
204 return LazySerializedContainerNode.withContextRef(getRpcName(), input, contextRef,
205 codec.getCodecRegistry());
207 return LazySerializedContainerNode.create(getRpcName(), input, codec.getCodecRegistry());