opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/RpcImplementation.java

   1 /*
   2  * Copyright (c) 2013 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.controller.sal.core.api;
   9
  10 import java.util.Set;
  11
  12 import org.opendaylight.yangtools.yang.common.QName;
  13 import org.opendaylight.yangtools.yang.common.RpcResult;
  14 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
  15
  16 import com.google.common.util.concurrent.ListenableFuture;
  17
  18 /**
  19  * {@link Provider}'s implementation of an RPC.
  20  *
  21  * In order to expose an RPC to other components, the provider MUST register
  22  * a concrete implementation of this interface.
  23  *
  24  * The registration could be done by :
  25  * <ul>
  26  * <li>returning an instance of implementation in the return value of
  27  * {@link Provider#getProviderFunctionality()}
  28  * <li>passing an instance of implementation and {@link QName} of rpc as
  29  * arguments to the
  30  * {@link org.opendaylight.controller.sal.core.api.Broker.ProviderSession#addRpcImplementation(QName, RpcImplementation)}
  31  * </ul>
  32  *
  33  * The simplified process of the invocation of rpc is following:
  34  *
  35  * <ol>
  36  * <li> {@link Consumer} invokes
  37  * {@link org.opendaylight.controller.sal.core.api.Broker.ConsumerSession#rpc(QName, CompositeNode)}
  38  * <li> {@link Broker} finds registered {@link RpcImplementation}s
  39  * <li> {@link Broker} invokes
  40  * {@link RpcImplementation#invokeRpc(QName, CompositeNode)}
  41  * <li> {@link RpcImplementation} processes the data and returns a
  42  * {@link RpcResult}
  43  * <li> {@link Broker} returns the {@link RpcResult} to {@link Consumer}
  44  * </ol>
  45  */
  46 public interface RpcImplementation extends Provider.ProviderFunctionality {
  47
  48     /**
  49      * A set of rpc types supported by implementation.
  50      *
  51      * The set of rpc {@link QName}s which are supported by this implementation.
  52      * This set is used, when {@link Provider} is registered to the SAL, to
  53      * register and expose the implementation of the returned rpcs.
  54      *
  55      * @return Set of QNames identifying supported RPCs
  56      */
  57     Set<QName> getSupportedRpcs();
  58
  59     /**
  60      * Invokes a implementation of specified RPC asynchronously.
  61      *
  62      * @param rpc
  63      *            RPC to be invoked
  64      * @param input
  65      *            Input data for the RPC.
  66      *
  67      * @throws IllegalArgumentException
  68      *             <ul>
  69      *             <li>If rpc is null.
  70      *             <li>If input is not <code>null</code> and
  71      *             <code>false == rpc.equals(input.getNodeType)</code>
  72      *             </ul>
  73      * @return Future promising an RpcResult containing the output of
  74      *         the RPC if was executed successfully, the list of errors
  75      *         otherwise.
  76      */
  77     ListenableFuture<RpcResult<CompositeNode>> invokeRpc(QName rpc, CompositeNode input);
  78 }