X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-dom-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Fcore%2Fapi%2FRpcImplementation.java;h=5055ad1430b1d584f9918e8b76101d766105a543;hb=3997099eb61b0f2adc47f7a85952c324e9de223f;hp=0299505cdeee6bcef00315507012cbd030f384c1;hpb=6b64494fd8e4654a298312afb4b8e6e827b75d5d;p=controller.git
diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/RpcImplementation.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/RpcImplementation.java
index 0299505cde..5055ad1430 100644
--- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/RpcImplementation.java
+++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/RpcImplementation.java
@@ -7,34 +7,32 @@
*/
package org.opendaylight.controller.sal.core.api;
+import com.google.common.util.concurrent.ListenableFuture;
import java.util.Set;
-
-import org.opendaylight.controller.sal.core.api.Broker.ConsumerSession;
-import org.opendaylight.controller.sal.core.api.Broker.ProviderSession;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.RpcResult;
import org.opendaylight.yangtools.yang.data.api.CompositeNode;
/**
- * {@link Provider}'s implementation of rpc.
- *
- * In order to expose the rpc to other components, the provider MUST register
- * concrete implementation of this interface
- *
+ * {@link Provider}'s implementation of an RPC.
+ *
+ * In order to expose an RPC to other components, the provider MUST register
+ * a concrete implementation of this interface.
+ *
* The registration could be done by :
*
* - returning an instance of implementation in the return value of
* {@link Provider#getProviderFunctionality()}
*
- passing an instance of implementation and {@link QName} of rpc as
* arguments to the
- * {@link ProviderSession#addRpcImplementation(QName, RpcImplementation)}
+ * {@link org.opendaylight.controller.sal.core.api.Broker.ProviderSession#addRpcImplementation(QName, RpcImplementation)}
*
- *
+ *
* The simplified process of the invocation of rpc is following:
- *
+ *
*
* - {@link Consumer} invokes
- * {@link ConsumerSession#rpc(QName, CompositeNode)}
+ * {@link org.opendaylight.controller.sal.core.api.Broker.ConsumerSession#rpc(QName, CompositeNode)}
*
- {@link Broker} finds registered {@link RpcImplementation}s
*
- {@link Broker} invokes
* {@link RpcImplementation#invokeRpc(QName, CompositeNode)}
@@ -42,40 +40,40 @@ import org.opendaylight.yangtools.yang.data.api.CompositeNode;
* {@link RpcResult}
*
- {@link Broker} returns the {@link RpcResult} to {@link Consumer}
*
- *
- *
+ *
+ * @deprecated Use {@link org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementation} instead.
*/
+@Deprecated
public interface RpcImplementation extends Provider.ProviderFunctionality {
/**
* A set of rpc types supported by implementation.
- *
+ *
* The set of rpc {@link QName}s which are supported by this implementation.
* This set is used, when {@link Provider} is registered to the SAL, to
* register and expose the implementation of the returned rpcs.
- *
+ *
* @return Set of QNames identifying supported RPCs
*/
Set getSupportedRpcs();
/**
- * Invokes a implementation of specified rpc.
- *
- *
+ * Invokes a implementation of specified RPC asynchronously.
+ *
* @param rpc
- * Rpc to be invoked
+ * RPC to be invoked
* @param input
- * Input data for rpc.
- *
+ * Input data for the RPC.
+ *
* @throws IllegalArgumentException
*
* - If rpc is null.
*
- If input is not
null
and
* false == rpc.equals(input.getNodeType)
*
- * @return RpcResult containing the output of rpc if was executed
- * successfully, the list of errors otherwise.
+ * @return Future promising an RpcResult containing the output of
+ * the RPC if was executed successfully, the list of errors
+ * otherwise.
*/
- RpcResult invokeRpc(QName rpc, CompositeNode input);
-
+ ListenableFuture> invokeRpc(QName rpc, CompositeNode input);
}