org.onosproject.yms.app.ynh

Class YangNotificationManager

java.lang.Object

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

org.onosproject.yms.app.ynh.YangNotificationManager

All Implemented Interfaces:

org.onosproject.event.EventSink<YangNotificationEvent>, org.onosproject.event.ListenerService<YangNotificationEvent,YangNotificationListener>, YangNotificationExtendedService, YangNotificationService

public class YangNotificationManager
extends org.onosproject.event.ListenerRegistry<YangNotificationEvent,YangNotificationListener>
implements YangNotificationExtendedService

Representation of YANG notification manager.

Field Summary

Fields inherited from class org.onosproject.event.ListenerRegistry

listeners

Constructor Summary

Constructors

Constructor and Description
YangNotificationManager(YangSchemaRegistry registry) Creates an instance of YANG notification manager.

Method Summary

Modifier and Type	Method and Description
YangNotification	getFilteredSubject(YangNotification subject, YangNotification filter) Protocols have their own mechanism to support notification filtering or notification subscription.
void	registerAsListener(org.onosproject.event.ListenerService manager) Registers as listener with application.

Methods inherited from class org.onosproject.event.ListenerRegistry

addListener, onProcessLimit, process, removeListener, reportProblem

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Constructor Detail

YangNotificationManager

public YangNotificationManager(YangSchemaRegistry registry)

Creates an instance of YANG notification manager.

Parameters:

registry - YANG schema registry

Method Detail

registerAsListener

public void registerAsListener(org.onosproject.event.ListenerService manager)

Description copied from interface: YangNotificationExtendedService

Registers as listener with application. This is called by YSR when it detects notification presence in application YANG file at the time when application registers it's schema with YMS.

Specified by:

registerAsListener in interface YangNotificationExtendedService

Parameters:

manager - application object

getFilteredSubject

public YangNotification getFilteredSubject(YangNotification subject,
                                           YangNotification filter)

Description copied from interface: YangNotificationService

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.

Specified by:

getFilteredSubject in interface YangNotificationService

Parameters:

subject - YANG notification subject reported by YANG notification service.

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

Returns:

filtered notification which passes the data model specific notification filter.