d08b217e71c547ea3cd2aa3dcb24a0b3374e9744
[controller.git] / opendaylight / md-sal / sal-binding-broker / src / main / java / org / opendaylight / controller / sal / binding / impl / connect / dom / RpcInvocationStrategy.java
1 /*
2  ** Copyright (c) 2014 Brocade Communications Systems, Inc. and others.  All rights reserved.
3  **
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
7  **/
8
9 package org.opendaylight.controller.sal.binding.impl.connect.dom;
10
11 import java.lang.ref.WeakReference;
12 import java.lang.reflect.Method;
13 import java.util.Collection;
14 import java.util.Collections;
15 import java.util.concurrent.Future;
16
17 import org.opendaylight.controller.sal.common.util.Rpcs;
18 import org.opendaylight.controller.sal.core.api.RpcProvisionRegistry;
19 import org.opendaylight.yangtools.yang.binding.DataContainer;
20 import org.opendaylight.yangtools.yang.binding.DataObject;
21 import org.opendaylight.yangtools.yang.binding.RpcService;
22 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
23 import org.opendaylight.yangtools.yang.common.QName;
24 import org.opendaylight.yangtools.yang.common.RpcError;
25 import org.opendaylight.yangtools.yang.common.RpcResult;
26 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
27 import org.opendaylight.yangtools.yang.data.api.Node;
28 import org.opendaylight.yangtools.yang.data.impl.ImmutableCompositeNode;
29 import org.opendaylight.yangtools.yang.data.impl.codec.BindingIndependentMappingService;
30
31 import com.google.common.base.Function;
32 import com.google.common.base.Optional;
33 import com.google.common.collect.ImmutableList;
34 import com.google.common.util.concurrent.Futures;
35 import com.google.common.util.concurrent.ListenableFuture;
36
37 /*
38  * RPC's can have both input, output, one or the other, or neither.
39  *
40  * This class handles the permutations and provides two means of invocation:
41  * 1. forwardToDomBroker
42  * 2.
43  *
44  * Weak References to the input and output classes are used to allow these classes to
45  * be from another OSGi bundle/class loader which may come and go.
46  *
47  */
48 public class RpcInvocationStrategy {
49
50     private final BindingIndependentMappingService mappingService;
51     private final RpcProvisionRegistry biRpcRegistry;
52     protected final Method targetMethod;
53     protected final QName rpc;
54
55     @SuppressWarnings("rawtypes")
56     private final WeakReference<Class> inputClass;
57
58     @SuppressWarnings("rawtypes")
59     private final WeakReference<Class> outputClass;
60
61     @SuppressWarnings({ "rawtypes" })
62     public RpcInvocationStrategy(final QName rpc,
63                                  final Method targetMethod,
64                                  final BindingIndependentMappingService mappingService,
65                                  final RpcProvisionRegistry biRpcRegistry ) {
66
67         this.targetMethod = targetMethod;
68         this.rpc = rpc;
69
70         Optional<Class<?>> outputClassOption = BindingReflections.resolveRpcOutputClass(targetMethod);
71         Optional<Class<? extends DataContainer>> inputClassOption = BindingReflections.resolveRpcInputClass(targetMethod);
72
73         if ( outputClassOption != null && outputClassOption.isPresent() ) {
74             this.outputClass = new WeakReference(outputClassOption.get() ) ;
75         } else {
76             this.outputClass = null ;
77         }
78         if ( inputClassOption != null && inputClassOption.isPresent() ) {
79             this.inputClass = new WeakReference(inputClassOption.get() ) ;
80         } else {
81             this.inputClass = null ;
82         }
83
84         this.mappingService = mappingService;
85         this.biRpcRegistry = biRpcRegistry;
86     }
87
88     @SuppressWarnings({ "unchecked" })
89     public ListenableFuture<RpcResult<?>> forwardToDomBroker(final DataObject input) {
90
91         if(biRpcRegistry == null) {
92             return Futures.<RpcResult<?>> immediateFuture(Rpcs.getRpcResult(false));
93         }
94
95         CompositeNode inputXml = null;
96         if( input != null ) {
97             CompositeNode xml = mappingService.toDataDom(input);
98             inputXml = ImmutableCompositeNode.create(rpc, ImmutableList.<Node<?>> of(xml));
99         } else {
100             inputXml = ImmutableCompositeNode.create( rpc, Collections.<Node<?>>emptyList() );
101         }
102
103         Function<RpcResult<CompositeNode>, RpcResult<?>> transformationFunction =
104                                        new Function<RpcResult<CompositeNode>, RpcResult<?>>() {
105             @Override
106             public RpcResult<?> apply(RpcResult<CompositeNode> result) {
107
108                 Object output = null;
109
110                 if( getOutputClass() != null ) {
111                     if (result.getResult() != null) {
112                         output = mappingService.dataObjectFromDataDom(getOutputClass().get(),
113                                                                     result.getResult());
114                     }
115                 }
116
117                 return Rpcs.getRpcResult(result.isSuccessful(), output, result.getErrors());
118             }
119         };
120
121         return Futures.transform(biRpcRegistry.invokeRpc(rpc, inputXml), transformationFunction);
122     }
123
124     @SuppressWarnings("unchecked")
125     private RpcResult<CompositeNode> uncheckedInvoke(final RpcService rpcService, final CompositeNode domInput) throws Exception {
126
127         Future<RpcResult<?>> futureResult = null;
128
129         if( inputClass != null ){
130             DataContainer bindingInput = mappingService.dataObjectFromDataDom(inputClass.get(), domInput);
131             futureResult = (Future<RpcResult<?>>) targetMethod.invoke(rpcService, bindingInput);
132
133         } else {
134             futureResult = (Future<RpcResult<?>>) targetMethod.invoke(rpcService);
135         }
136
137         if (futureResult == null) {
138             return Rpcs.getRpcResult(false);
139         }
140
141         RpcResult<?> bindingResult = futureResult.get();
142
143         Collection<RpcError> errors = bindingResult.getErrors();
144         if( errors == null ) {
145             errors = Collections.<RpcError>emptySet();
146         }
147
148         final Object resultObj = bindingResult.getResult();
149         CompositeNode output = null;
150         if (resultObj instanceof DataObject) {
151             output = mappingService.toDataDom((DataObject)resultObj);
152         }
153         return Rpcs.getRpcResult( bindingResult.isSuccessful(), output, errors);
154     }
155
156     public RpcResult<CompositeNode> invokeOn(final RpcService rpcService, final CompositeNode domInput) throws Exception {
157         return uncheckedInvoke(rpcService, domInput);
158     }
159
160     @SuppressWarnings("rawtypes")
161     public WeakReference<Class> getOutputClass() {
162         return outputClass;
163     }
164 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.