checkStyleViolationSeverity=error implemented for mdsal-singleton-common-api and...
[mdsal.git] / binding / mdsal-binding-api / src / main / java / org / opendaylight / mdsal / binding / api / RpcConsumerRegistry.java
1 /*
2  * Copyright (c) 2014 Cisco 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 package org.opendaylight.mdsal.binding.api;
9
10
11
12 import org.opendaylight.yangtools.yang.binding.RpcService;
13
14 /**
15  * Provides access to registered Remote Procedure Call (RPC) service implementations. The RPCs are
16  * defined in YANG models.
17  * <p>
18  * RPC implementations are registered using the {@link RpcProviderService}.
19  *
20  */
21 public interface RpcConsumerRegistry extends BindingService {
22     /**
23      * Returns an implementation of a requested RPC service.
24      *
25      * <p>
26      * The returned instance is not an actual implementation of the RPC service interface, but a
27      * proxy implementation of the interface that forwards to an actual implementation, if any.
28      * <p>
29      *
30      * The following describes the behavior of the proxy when invoking RPC methods:
31      * <ul>
32      * <li>If an actual implementation is registered with the MD-SAL, all invocations are forwarded
33      * to the registered implementation.</li>
34      * <li>If no actual implementation is registered, all invocations will fail by throwing
35      * {@link IllegalStateException}.</li>
36      * <li>Prior to invoking the actual implementation, the method arguments are are validated. If
37      * any are invalid, an {@link IllegalArgumentException} is thrown.
38      * </ul>
39      *
40      * The returned proxy is automatically updated with the most recent registered implementation.
41      * <p>
42      * The generated RPC method APIs require implementors to return a
43      * {@link java.util.concurrent.Future Future} instance that wraps the
44      * {@link org.opendaylight.yangtools.yang.common.RpcResult RpcResult}. Since RPC methods may be
45      * implemented asynchronously, callers should avoid blocking on the
46      * {@link java.util.concurrent.Future Future} result. Instead, it is recommended to use
47      * {@link com.google.common.util.concurrent.JdkFutureAdapters#listenInPoolThread(java.util.concurrent.Future)}
48      * or
49      * {@link com.google.common.util.concurrent.JdkFutureAdapters#listenInPoolThread(java.util.concurrent.Future, java.util.concurrent.Executor)}
50      * to listen for Rpc Result. This will asynchronously listen for future result in executor and
51      * will not block current thread.
52      *
53      * <pre>
54      *   final Future&lt;RpcResult&lt;SomeRpcOutput&gt;&gt; future = someRpcService.someRpc( ... );
55      *   Futures.addCallback(JdkFutureAdapters.listenInThreadPool(future), new FutureCallback&lt;RpcResult&lt;SomeRpcOutput&gt;&gt;() {
56      *
57      *       public void onSuccess(RpcResult&lt;SomeRpcOutput&gt; result) {
58      *          // process result ...
59      *       }
60      *
61      *       public void onFailure(Throwable t) {
62      *          // RPC failed
63      *       }
64      *   );
65      * </pre>
66      *
67      * @param serviceInterface the interface of the RPC Service. Typically this is an interface
68      *        generated from a YANG model.
69      * @return the proxy for the requested RPC service. This method never returns null.
70      */
71     <T extends RpcService> T getRpcService(Class<T> serviceInterface);
72 }