opendaylight/sal/yang-prototype/sal/sal-core-api/src/main/java/org/opendaylight/controller/sal/core/api/notify/NotificationProviderService.java

   1 /*\r
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
   3  *\r
   4  * This program and the accompanying materials are made available under the\r
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
   7  */\r
   8 package org.opendaylight.controller.sal.core.api.notify;\r
   9 \r
  10 import org.opendaylight.controller.sal.core.api.Broker;\r
  11 import org.opendaylight.controller.sal.core.api.Provider;\r
  12 import org.opendaylight.controller.yang.data.api.CompositeNode;\r
  13 \r
  14 \r
  15 /**\r
  16  * Notification Publishing Service\r
  17  * \r
  18  * The simplified process of the notification publishing is following:\r
  19  * \r
  20  * <ol>\r
  21  * <li> {@link Provider} invokes {@link #sendNotification(CompositeNode)}\r
  22  * <li> {@link Broker} finds {@link NotificationListener}s which subscribed for\r
  23  * the notification type.\r
  24  * \r
  25  * <li>For each subscriber {@link Broker} invokes\r
  26  * {@link NotificationListener#onNotification(CompositeNode)}\r
  27  * </ol>\r
  28  * \r
  29  * \r
  30  * \r
  31  */\r
  32 public interface NotificationProviderService extends NotificationService {\r
  33 \r
  34     /**\r
  35      * Publishes a notification.\r
  36      * \r
  37      * Notification type is determined by the\r
  38      * {@link CompositeNode#getNodeType()} of the\r
  39      * <code>notification<code> parameter.\r
  40      * \r
  41      * @param notification\r
  42      *            Notification to publish\r
  43      */\r
  44     void sendNotification(CompositeNode notification);\r
  45 \r
  46 }\r