org.onosproject.yms.ynh

Interface YangNotificationService

All Superinterfaces:

org.onosproject.event.ListenerService<YangNotificationEvent,YangNotificationListener>

All Known Subinterfaces:

YangNotificationExtendedService

All Known Implementing Classes:

YangNotificationManager

public interface YangNotificationService
extends org.onosproject.event.ListenerService<YangNotificationEvent,YangNotificationListener>

Abstraction of an entity which provides interfaces to YANG notification service. YANG notification handler receives the event notifications from application/core and provide it to the protocols. NBI Protocols which can support notification delivery for application(s) needs to add themselves as a listeners with YANG notification service. Also based on registered schema YMS add themselves as a listener to applications. Application sends their notification in YANG utils generated notification. YMS obtains the module/sub-module schema tree in which this notification is contained and then convert this data to an abstract tree notation (YDT) with root node as the module/sub-module node in which notification is contained. It sends the same to all the protocol who has added them as a listener as a YANG notification. Also Protocols can use YANG notification service to check if a received notification should be filtered against any of their protocol specific filtering mechanism.

Method Summary

Modifier and Type	Method and Description
YangNotification	getFilteredSubject(YangNotification notificationSubject, YangNotification notificationFilter) Protocols have their own mechanism to support notification filtering or notification subscription.

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Method Detail

getFilteredSubject

YangNotification getFilteredSubject(YangNotification notificationSubject,
                                    YangNotification notificationFilter)

Protocols have their own mechanism to support notification filtering or notification subscription. Depending on the protocol specification, the filtering is implemented in the protocol. The Protocol implementations are abstracted of the Schema, there are scenarios in which they need to check if the received notification is of interest as per the schema filtering / subscription. In such scenario, protocols can create a filtering / subscription YANG data tree and use the notification service to filter the notification subject against their filter. Filters the notification subject YANG data tree, with the specified filter of the NBI protocol. If the filter does not match for the passed notification subject, null will be returned. Otherwise, the part of the subject matching the filter will be returned.

Parameters:

notificationSubject - YANG notification subject reported by YANG notification service.

notificationFilter - Protocols data model specific notification filter represented in YANG data tree.

Returns:

filtered notification which passes the data model specific notification filter.