Fixup checkstyle

[controller.git] / opendaylight / md-sal / sal-binding-api / src / main / java / org / opendaylight / controller / sal / binding / api / RpcConsumerRegistry.java

diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java
index 615acd3195c8a99ed5b5f372f53dee46d5faac7b..cd70e4c8524ff59b590d9d3d3806b86bc198a2f8 100644 (file)
--- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java
+++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java
@@ -7,25 +7,28 @@
  */
 package org.opendaylight.controller.sal.binding.api;
 
+import org.opendaylight.controller.md.sal.binding.api.BindingService;
 import org.opendaylight.yangtools.yang.binding.RpcService;
 
 /**
  * Provides access to registered Remote Procedure Call (RPC) service implementations. The RPCs are
  * defined in YANG models.
+ *
  * <p>
  * RPC implementations are registered using the {@link RpcProviderRegistry}.
  *
+ * @deprecated Use {@link org.opendaylight.mdsal.binding.api.RpcConsumerRegistry} instead
  */
-public interface RpcConsumerRegistry extends BindingAwareService {
+@Deprecated
+public interface RpcConsumerRegistry extends BindingAwareService, BindingService {
     /**
      * Returns an implementation of a requested RPC service.
      *
      * <p>
-     * The returned instance is not an actual implementation of the RPC service
-     * interface, but a proxy implementation of the interface that forwards to
-     * an actual implementation, if any.
-     * <p>
+     * The returned instance is not an actual implementation of the RPC service interface, but a proxy implementation
+     * of the interface that forwards to an actual implementation, if any.
      *
+     * <p>
      * The following describes the behavior of the proxy when invoking RPC methods:
      * <ul>
      * <li>If an actual implementation is registered with the MD-SAL, all invocations are
@@ -36,31 +39,22 @@ public interface RpcConsumerRegistry extends BindingAwareService {
      * If any are invalid, an {@link IllegalArgumentException} is thrown.
      * </ul>
      *
-     * The returned proxy is automatically updated with the most recent
-     * registered implementation.
      * <p>
-     * The generated RPC method APIs require implementors to return a {@link java.util.concurrent.Future Future}
-     * instance that wraps the {@link org.opendaylight.yangtools.yang.common.RpcResult RpcResult}. Since
-     * RPC methods may be implemented asynchronously, callers should avoid blocking on the
-     * {@link java.util.concurrent.Future Future} result. Instead, it is recommended to use
-     * {@link com.google.common.util.concurrent.JdkFutureAdapters#listenInPoolThread(java.util.concurrent.Future)}
-     * or {@link com.google.common.util.concurrent.JdkFutureAdapters#listenInPoolThread(java.util.concurrent.Future, java.util.concurrent.Executor)}
-     * to listen for Rpc Result. This will asynchronously listen for future result in executor and
-     * will not block current thread.
-     *
-     * <pre>
+     * The returned proxy is automatically updated with the most recent registered implementation.
+     * {@code
      *   final Future<RpcResult<SomeRpcOutput>> future = someRpcService.someRpc( ... );
-     *   Futures.addCallback(JdkFutureAdapters.listenInThreadPool(future), new FutureCallback<RpcResult<SomeRpcOutput>>() {
+     *   Futures.addCallback(future,
+     *       new FutureCallback<RpcResult<SomeRpcOutput>>() {
+     *           public void onSuccess(RpcResult<SomeRpcOutput> result) {
+     *               // process result ...
+     *           }
      *
-     *       public void onSuccess(RpcResult<SomeRpcOutput> result) {
-     *          // process result ...
-     *       }
+     *           public void onFailure(Throwable t) {
+     *              // RPC failed
+     *           }
+     *       });
+     *  }
      *
-     *       public void onFailure(Throwable t) {
-     *          // RPC failed
-     *       }
-     *   );
-     * </pre>
      * @param serviceInterface the interface of the RPC Service. Typically this is an interface generated
      *                         from a YANG model.
      * @return the proxy for the requested RPC service. This method never returns null.