org.opendaylight.controller.sal.binding.api

Interface NotificationProviderService

All Superinterfaces:

BindingAwareService, NotificationPublishService<org.opendaylight.yangtools.yang.binding.Notification>, NotificationService

All Known Implementing Classes:

AbstractBindingSalProviderInstance, HeliumNotificationProviderServiceAdapter, HeliumNotificationProviderServiceWithInterestListeners, RootBindingAwareBroker.RootSalInstance

Deprecated.

Please use NotificationPublishService.

@Deprecated
public interface NotificationProviderService
extends NotificationService, NotificationPublishService<org.opendaylight.yangtools.yang.binding.Notification>

Interface for a notification service that provides publish/subscribe capabilities for YANG modeled notifications. This interface is a combination of the NotificationService and NotificationPublishService interfaces.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NotificationProviderService.NotificationInterestListener Deprecated. Interface for a listener interested in being notified about notification subscriptions.

Method Summary

Modifier and Type	Method and Description
void	publish(org.opendaylight.yangtools.yang.binding.Notification notification) Deprecated. Publishes a notification and notifies subscribed listeners.
void	publish(org.opendaylight.yangtools.yang.binding.Notification notification, ExecutorService executor) Deprecated. Publishes a notification and notifies subscribed listeners.
org.opendaylight.yangtools.concepts.ListenerRegistration<NotificationProviderService.NotificationInterestListener>	registerInterestListener(NotificationProviderService.NotificationInterestListener interestListener) Deprecated. Registers a listener to be notified about notification subscriptions.

Methods inherited from interface org.opendaylight.controller.sal.binding.api.NotificationService

registerNotificationListener, registerNotificationListener

Method Detail

publish

void publish(org.opendaylight.yangtools.yang.binding.Notification notification)

Deprecated.

Description copied from interface: NotificationPublishService

Publishes a notification and notifies subscribed listeners. All listener notifications are done via a default executor.

Note: This call will block when the default executor is saturated and the notification queue for this executor is full.

Specified by:

publish in interface NotificationPublishService<org.opendaylight.yangtools.yang.binding.Notification>

Parameters:

notification - the notification to publish.

publish

void publish(org.opendaylight.yangtools.yang.binding.Notification notification,
             ExecutorService executor)

Deprecated.

Description copied from interface: NotificationPublishService

Publishes a notification and notifies subscribed listeners. All listener notifications are done via the provided executor.

Note: Use only if necessary. Consider using NotificationPublishService.publish(Object) for most use-cases.

By using this method you could customize execution policy of listeners present inside process (e.g. using single-threaded executor or even same-thread executor delivery.

This executor is used only for inside-process notification deliveries.

Specified by:

publish in interface NotificationPublishService<org.opendaylight.yangtools.yang.binding.Notification>

Parameters:

notification - the notification to publish.

executor - the executor that will be used to deliver notifications to subscribed listeners.

registerInterestListener

org.opendaylight.yangtools.concepts.ListenerRegistration<NotificationProviderService.NotificationInterestListener> registerInterestListener(NotificationProviderService.NotificationInterestListener interestListener)

Deprecated.

Registers a listener to be notified about notification subscriptions. This enables a component to know when there is a notification listener subscribed for a particular notification type.

On registration of this listener, the NotificationProviderService.NotificationInterestListener.onNotificationSubscribtion(Class) method will be invoked for every notification type that currently has a notification listener subscribed.

Parameters:

interestListener - the listener that will be notified when subscriptions for new notification types occur.

Returns:

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