opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/notify/NotificationPublishService.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.core.api.notify;
   9
  10 import org.opendaylight.controller.sal.core.api.Broker;
  11 import org.opendaylight.controller.sal.core.api.Provider;
  12 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
  13
  14 /**
  15  * Notification Publishing Service
  16  *
  17  * The simplified process of the notification publishing is following:
  18  *
  19  * <ol>
  20  * <li> {@link Provider} invokes {@link #sendNotification(CompositeNode)}
  21  * <li> {@link Broker} finds {@link NotificationListener}s which subscribed for
  22  * the notification type.
  23  *
  24  * <li>For each subscriber {@link Broker} invokes
  25  * {@link NotificationListener#onNotification(CompositeNode)}
  26  * </ol>
  27  */
  28 public interface NotificationPublishService extends NotificationService {
  29     /**
  30      * Publishes a notification.
  31      *
  32      * Notification type is determined by the
  33      * {@link CompositeNode#getNodeType()} of the
  34      * <code>notification<code> parameter.
  35      *
  36      * @param notification
  37      *            Notification to publish
  38      */
  39     void publish(CompositeNode notification);
  40 }