opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationProviderService.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.sal.binding.api;
   9
  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;
  15
  16 /**
  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.
  20  *
  21  * @deprecated Please use {@link org.opendaylight.controller.md.sal.binding.api.NotificationPublishService}.
  22  */
  23 @Deprecated
  24 public interface NotificationProviderService extends NotificationService, NotificationPublishService<Notification> {
  25
  26     /**
  27      * {@inheritDoc}
  28      */
  29     @Override
  30     public void publish(Notification notification);
  31
  32     /**
  33      * {@inheritDoc}
  34      */
  35     @Override
  36     void publish(Notification notification, ExecutorService executor);
  37
  38     /**
  39      * Registers a listener to be notified about notification subscriptions. This
  40      * enables a component to know when there is a notification listener subscribed
  41      * for a particular notification type.
  42      * <p>
  43      * On registration of this listener, the
  44      * {@link NotificationInterestListener#onNotificationSubscribtion(Class)} method
  45      * will be invoked for every notification type that currently has a notification listener
  46      * subscribed.
  47      *
  48      * @param interestListener the listener that will be notified when subscriptions
  49      *                         for new notification types occur.
  50      * @return a {@link ListenerRegistration} instance that should be used to unregister the listener
  51      *         by invoking the {@link ListenerRegistration#close()} method when no longer needed.
  52      */
  53     ListenerRegistration<NotificationInterestListener> registerInterestListener(
  54             NotificationInterestListener interestListener);
  55
  56     /**
  57      * Interface for a listener interested in being notified about notification subscriptions.
  58      */
  59     public interface NotificationInterestListener extends EventListener {
  60
  61         /**
  62          * Callback that is invoked when a notification listener subscribes for a
  63          * particular notification type.
  64          * <p>
  65          * This method is only called for the first subscription that occurs for a
  66          * particular notification type. Subsequent subscriptions for the same
  67          * notification type do not trigger invocation of this method.
  68          * <p>
  69          * <b>Note:</b>This callback is delivered from thread not owned by this listener,
  70          * all processing should be as fast as possible and implementations should
  71          * not do any blocking calls or block this thread.
  72          *
  73          * @param notificationType the notification type for the subscription that occurred.
  74          */
  75         void onNotificationSubscribtion(Class<? extends Notification> notificationType);
  76     }
  77 }