org.opendaylight.mdsal.dom.api

Interface DOMNotificationService

All Superinterfaces:

DOMService

All Known Implementing Classes:

DOMNotificationRouter, ForwardingDOMNotificationService

public interface DOMNotificationService
extends DOMService

A DOMService which allows its users to subscribe to receive DOMNotifications.

Method Summary

Modifier and Type	Method and Description
<T extends DOMNotificationListener> org.opendaylight.yangtools.concepts.ListenerRegistration<T>	registerNotificationListener(T listener, @NonNull Collection<org.opendaylight.yangtools.yang.model.api.SchemaPath> types) Register a DOMNotificationListener to receive a set of notifications.
<T extends DOMNotificationListener> org.opendaylight.yangtools.concepts.ListenerRegistration<T>	registerNotificationListener(T listener, org.opendaylight.yangtools.yang.model.api.SchemaPath... types) Register a DOMNotificationListener to receive a set of notifications.

Method Detail

registerNotificationListener

<T extends DOMNotificationListener> org.opendaylight.yangtools.concepts.ListenerRegistration<T> registerNotificationListener(T listener,
                                                                                                                             @NonNull Collection<org.opendaylight.yangtools.yang.model.api.SchemaPath> types)

Register a DOMNotificationListener to receive a set of notifications. As with other ListenerRegistration-based interfaces, registering an instance multiple times results in notifications being delivered for each registration.

Parameters:

listener - Notification instance to register

types - Notification types which should be delivered to the listener. Duplicate entries are processed only once, null entries are ignored.

Returns:

Registration handle. Invoking ListenerRegistration.close() will stop the delivery of notifications to the listener

Throws:

IllegalArgumentException - if types is empty or contains an invalid element, such as null or a SchemaPath which does not represent a valid DOMNotification type.

NullPointerException - if either of the arguments is null

registerNotificationListener

<T extends DOMNotificationListener> org.opendaylight.yangtools.concepts.ListenerRegistration<T> registerNotificationListener(T listener,
                                                                                                                             org.opendaylight.yangtools.yang.model.api.SchemaPath... types)

Register a DOMNotificationListener to receive a set of notifications. As with other ListenerRegistration-based interfaces, registering an instance multiple times results in notifications being delivered for each registration.

Parameters:

listener - Notification instance to register

types - Notification types which should be delivered to the listener. Duplicate entries are processed only once, null entries are ignored.

Returns:

Registration handle. Invoking ListenerRegistration.close() will stop the delivery of notifications to the listener

Throws:

IllegalArgumentException - if types is empty or contains an invalid element, such as null or a SchemaPath which does not represent a valid DOMNotification type.

NullPointerException - if listener is null