org.opendaylight.yangtools.yang.binding.util

Class RpcServiceInvoker

java.lang.Object

org.opendaylight.yangtools.yang.binding.util.RpcServiceInvoker

public abstract class RpcServiceInvoker
extends Object

Provides single method invocation of RPCs on supplied instance. Rpc Service invoker provides common invocation interface for any subtype of RpcService. via invokeRpc(RpcService, QName, DataObject) method.

Constructor Summary

Constructors

Constructor and Description
RpcServiceInvoker()

Method Summary

Modifier and Type	Method and Description
static RpcServiceInvoker	from(Class<? extends RpcService> type) Creates RPCServiceInvoker for specified RpcService type
static RpcServiceInvoker	from(Map<org.opendaylight.yangtools.yang.common.QName,Method> qnameToMethod) Creates an RPCServiceInvoker for specified QName-<Method mapping.
abstract Future<org.opendaylight.yangtools.yang.common.RpcResult<?>>	invokeRpc(RpcService impl, org.opendaylight.yangtools.yang.common.QName rpcName, DataObject input) Invokes supplied RPC on provided implementation of RPC Service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RpcServiceInvoker

public RpcServiceInvoker()

Method Detail

from

public static RpcServiceInvoker from(Class<? extends RpcService> type)

Creates RPCServiceInvoker for specified RpcService type

Parameters:

type - RpcService interface, which was generated from model.

Returns:

Cached instance of RpcServiceInvoker for supplied RPC type.

from

public static RpcServiceInvoker from(Map<org.opendaylight.yangtools.yang.common.QName,Method> qnameToMethod)

Creates an RPCServiceInvoker for specified QName-<Method mapping.

Parameters:

qnameToMethod - translation mapping, must not be null nor empty.

Returns:

An RpcMethodInvoker instance.

invokeRpc

public abstract Future<org.opendaylight.yangtools.yang.common.RpcResult<?>> invokeRpc(@Nonnull
                                                                                      RpcService impl,
                                                                                      @Nonnull
                                                                                      org.opendaylight.yangtools.yang.common.QName rpcName,
                                                                                      @Nullable
                                                                                      DataObject input)

Invokes supplied RPC on provided implementation of RPC Service.

Parameters:

impl - Imlementation on which RPC should be invoked.

rpcName - Name of RPC to be invoked.

input - Input data for RPC.

Returns:

Future which will complete once rpc procesing is finished.