org.opendaylight.controller.md.sal.binding.util

Class AbstractBindingSalConsumerInstance<N extends NotificationService,R extends RpcConsumerRegistry>

java.lang.Object

org.opendaylight.controller.md.sal.binding.util.AbstractBindingSalConsumerInstance<N,R>

All Implemented Interfaces:

BindingService, BindingAwareService, NotificationService, RpcConsumerRegistry

Direct Known Subclasses:

AbstractBindingSalProviderInstance

public abstract class AbstractBindingSalConsumerInstance<N extends NotificationService,R extends RpcConsumerRegistry>
extends Object
implements RpcConsumerRegistry, NotificationService

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBindingSalConsumerInstance(R rpcRegistry, N notificationBroker)

Method Summary

Modifier and Type	Method and Description
protected N	getNotificationBroker()
protected N	getNotificationBrokerChecked()
protected R	getRpcRegistry()
protected R	getRpcRegistryChecked()
<T extends org.opendaylight.yangtools.yang.binding.RpcService> T	getRpcService(Class<T> module) Returns an implementation of a requested RPC service.
<T extends org.opendaylight.yangtools.yang.binding.Notification> org.opendaylight.yangtools.concepts.ListenerRegistration<NotificationListener<T>>	registerNotificationListener(Class<T> notificationType, NotificationListener<T> listener) Registers a generic listener implementation for a specified notification type.
org.opendaylight.yangtools.concepts.ListenerRegistration<org.opendaylight.yangtools.yang.binding.NotificationListener>	registerNotificationListener(org.opendaylight.yangtools.yang.binding.NotificationListener listener) Registers a listener which implements a YANG-generated notification interface derived from NotificationListener.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBindingSalConsumerInstance

protected AbstractBindingSalConsumerInstance(R rpcRegistry,
                                             N notificationBroker)

Method Detail

getRpcRegistry

protected final R getRpcRegistry()

getNotificationBroker

protected final N getNotificationBroker()

getRpcRegistryChecked

protected final R getRpcRegistryChecked()

getNotificationBrokerChecked

protected final N getNotificationBrokerChecked()

getRpcService

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

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:

module - 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.

registerNotificationListener

public <T extends org.opendaylight.yangtools.yang.binding.Notification> org.opendaylight.yangtools.concepts.ListenerRegistration<NotificationListener<T>> registerNotificationListener(Class<T> notificationType,
                                                                                                                                                                                       NotificationListener<T> listener)

Description copied from interface: NotificationService

Registers a generic listener implementation for a specified notification type.

Specified by:

registerNotificationListener in interface NotificationService

Parameters:

notificationType - the YANG-generated interface of the notification type.

listener - the listener implementation that will receive notifications.

Returns:

a ListenerRegistration instance that should be used to unregister the listener by invoking the ListenerRegistration.close() method when no longer needed.

registerNotificationListener

public org.opendaylight.yangtools.concepts.ListenerRegistration<org.opendaylight.yangtools.yang.binding.NotificationListener> registerNotificationListener(org.opendaylight.yangtools.yang.binding.NotificationListener listener)

Description copied from interface: NotificationService

Registers a listener which implements a YANG-generated notification interface derived from NotificationListener. The listener is registered for all notifications present in the implemented interface.

Specified by:

registerNotificationListener in interface NotificationService

Parameters:

listener - the listener implementation that will receive notifications.

Returns:

a ListenerRegistration instance that should be used to unregister the listener by invoking the ListenerRegistration.close() method when no longer needed.