2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.sal.binding.api;
10 import java.util.EventListener;
11 import java.util.concurrent.ExecutorService;
12 import org.opendaylight.controller.md.sal.common.api.notify.NotificationPublishService;
13 import org.opendaylight.yangtools.concepts.ListenerRegistration;
14 import org.opendaylight.yangtools.yang.binding.Notification;
17 * Interface for a notification service that provides publish/subscribe capabilities for YANG
18 * modeled notifications. This interface is a combination of the {@link NotificationService} and
19 * {@link NotificationPublishService} interfaces.
21 * @deprecated Please use {@link org.opendaylight.mdsal.binding.api.NotificationPublishService}.
23 @Deprecated(forRemoval = true)
24 public interface NotificationProviderService extends NotificationService, NotificationPublishService<Notification> {
27 void publish(Notification notification);
30 void publish(Notification notification, ExecutorService executor);
33 * Registers a listener to be notified about notification subscriptions. This
34 * enables a component to know when there is a notification listener subscribed
35 * for a particular notification type.
38 * On registration of this listener, the
39 * {@link NotificationInterestListener#onNotificationSubscribtion(Class)} method
40 * will be invoked for every notification type that currently has a notification listener
43 * @param interestListener the listener that will be notified when subscriptions
44 * for new notification types occur.
45 * @return a {@link ListenerRegistration} instance that should be used to unregister the listener
46 * by invoking the {@link ListenerRegistration#close()} method when no longer needed.
48 ListenerRegistration<NotificationInterestListener> registerInterestListener(
49 NotificationInterestListener interestListener);
52 * Interface for a listener interested in being notified about notification subscriptions.
54 interface NotificationInterestListener extends EventListener {
57 * Callback that is invoked when a notification listener subscribes for a particular notification type.
60 * This method is only called for the first subscription that occurs for a
61 * particular notification type. Subsequent subscriptions for the same
62 * notification type do not trigger invocation of this method.
65 * <b>Note:</b>This callback is delivered from thread not owned by this listener,
66 * all processing should be as fast as possible and implementations should
67 * not do any blocking calls or block this thread.
69 * @param notificationType the notification type for the subscription that occurred.
71 void onNotificationSubscribtion(Class<? extends Notification> notificationType);