org.opendaylight.controller.md.sal.binding.compat

Class HeliumRpcProviderRegistry

java.lang.Object

org.opendaylight.controller.md.sal.binding.compat.HeliumRpcProviderRegistry

All Implemented Interfaces:

BindingService, RouteChangePublisher<RpcContextIdentifier,org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?>>, BindingAwareService, RpcConsumerRegistry, RpcProviderRegistry

public class HeliumRpcProviderRegistry
extends Object
implements RpcProviderRegistry

Constructor Summary

Constructors

Constructor and Description
HeliumRpcProviderRegistry(RpcConsumerRegistry consumerRegistry, BindingDOMRpcProviderServiceAdapter providerAdapter)

Method Summary

Modifier and Type	Method and Description
<T extends org.opendaylight.yangtools.yang.binding.RpcService> BindingAwareBroker.RoutedRpcRegistration<T>	addRoutedRpcImplementation(Class<T> type, T impl) Registers an implementation of the given routed RPC service interface.
<T extends org.opendaylight.yangtools.yang.binding.RpcService> BindingAwareBroker.RpcRegistration<T>	addRpcImplementation(Class<T> type, T impl) Registers a global implementation of the provided RPC service interface.
<T extends org.opendaylight.yangtools.yang.binding.RpcService> T	getRpcService(Class<T> type) Returns an implementation of a requested RPC service.
<L extends RouteChangeListener<RpcContextIdentifier,org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?>>> org.opendaylight.yangtools.concepts.ListenerRegistration<L>	registerRouteChangeListener(L listener)

Methods inherited from class java.lang.Object

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

Constructor Detail

HeliumRpcProviderRegistry

public HeliumRpcProviderRegistry(RpcConsumerRegistry consumerRegistry,
                                 BindingDOMRpcProviderServiceAdapter providerAdapter)

Method Detail

addRoutedRpcImplementation

public <T extends org.opendaylight.yangtools.yang.binding.RpcService> BindingAwareBroker.RoutedRpcRegistration<T> addRoutedRpcImplementation(Class<T> type,
                                                                                                                                             T impl)
                                                                                                                                      throws IllegalStateException

Description copied from interface: RpcProviderRegistry

Registers an implementation of the given routed RPC service interface.

See the class documentation for information and example on how to use routed RPCs.

Specified by:

addRoutedRpcImplementation in interface RpcProviderRegistry

Parameters:

type - the YANG-generated interface of the RPC Service for which to register.

impl - the implementation instance to register.

Returns:

a RoutedRpcRegistration instance which can be used to register paths for the RPC implementation via invoking RoutedRpcRegistration#registerPath(Class, InstanceIdentifer). BindingAwareBroker.RpcRegistration.close() should be called to unregister the implementation and all previously registered paths when no longer needed.

Throws:

IllegalStateException - if the supplied RPC interface is not a routed RPC type.

addRpcImplementation

public <T extends org.opendaylight.yangtools.yang.binding.RpcService> BindingAwareBroker.RpcRegistration<T> addRpcImplementation(Class<T> type,
                                                                                                                                 T impl)
                                                                                                                          throws IllegalStateException

Description copied from interface: RpcProviderRegistry

Registers a global implementation of the provided RPC service interface. All methods of the interface are required to be implemented.

Specified by:

addRpcImplementation in interface RpcProviderRegistry

Parameters:

type - the YANG-generated interface of the RPC Service for which to register.

impl - "the implementation of the RPC service interface.

Returns:

an RpcRegistration instance that should be used to unregister the RPC implementation when no longer needed by calling BindingAwareBroker.RpcRegistration.close().

Throws:

IllegalStateException - if the supplied RPC interface is a routed RPC type.

getRpcService

public <T extends org.opendaylight.yangtools.yang.binding.RpcService> T getRpcService(Class<T> type)

Description copied from interface: RpcConsumerRegistry

Returns an implementation of a requested RPC service.

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.

The following describes the behavior of the proxy when invoking RPC methods:

• If an actual implementation is registered with the MD-SAL, all invocations are forwarded to the registered implementation.
• If no actual implementation is registered, all invocations will fail by throwing IllegalStateException.
• Prior to invoking the actual implementation, the method arguments are are validated. If any are invalid, an IllegalArgumentException is thrown.

The returned proxy is automatically updated with the most recent registered implementation. 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 } });

Specified by:

getRpcService in interface RpcConsumerRegistry

Parameters:

type - the interface of the RPC Service. Typically this is an interface generated from a YANG model.

Returns:

the proxy for the requested RPC service. This method never returns null.

registerRouteChangeListener

public <L extends RouteChangeListener<RpcContextIdentifier,org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?>>> org.opendaylight.yangtools.concepts.ListenerRegistration<L> registerRouteChangeListener(L listener)

Specified by:

registerRouteChangeListener in interface RouteChangePublisher<RpcContextIdentifier,org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?>>