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 72c6b1d75d99fec54f2914b2cc201e9a527910ed..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
@@ -1,20 +1,63 @@
+/*
+ * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
 package org.opendaylight.controller.sal.binding.api;
 
+import org.opendaylight.controller.md.sal.binding.api.BindingService;
 import org.opendaylight.yangtools.yang.binding.RpcService;
 
 /**
- * Base interface defining contract for retrieving MD-SAL
- * version of RpcServices
- * 
+ * 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 a session specific instance (implementation) of requested
-     * YANG module implentation / service provided by consumer.
-     * 
-     * @param service
-     *            Broker service
-     * @return Session specific implementation of service
+     * 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 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
+     * forwarded to the registered implementation.</li>
+     * <li>If no actual implementation is registered, all invocations will fail by
+     * throwing {@link IllegalStateException}.</li>
+     * <li>Prior to invoking the actual implementation, the method arguments are are validated.
+     * If any are invalid, an {@link IllegalArgumentException} is thrown.
+     * </ul>
+     *
+     * <p>
+     * The returned proxy is automatically updated with the most recent registered implementation.
+     * {@code
+     *   final Future<RpcResult<SomeRpcOutput>> future = someRpcService.someRpc( ... );
+     *   Futures.addCallback(future,
+     *       new FutureCallback<RpcResult<SomeRpcOutput>>() {
+     *           public void onSuccess(RpcResult<SomeRpcOutput> result) {
+     *               // process result ...
+     *           }
+     *
+     *           public void onFailure(Throwable t) {
+     *              // RPC failed
+     *           }
+     *       });
+     *  }
+     *
+     * @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.
      */
-    <T extends RpcService> T getRpcService(Class<T> module);
+    <T extends RpcService> T getRpcService(Class<T> serviceInterface);
 }