dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMNotificationPublishService.java

   1 /*
   2  * Copyright (c) 2014 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.mdsal.dom.api;
   9
  10 import com.google.common.util.concurrent.ListenableFuture;
  11 import java.util.concurrent.TimeUnit;
  12 import org.checkerframework.checker.index.qual.NonNegative;
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
  15
  16 /**
  17  * A {@link DOMService} which allows its user to publish top-level (YANG 1.0) {@link DOMNotification}s. It provides two
  18  * styles of initiating the notification delivery, similar to {@link java.util.concurrent.BlockingQueue}:
  19  * <ul>
  20  *   <li>a put-style method which waits until the implementation can accept the notification for delivery, and</li>
  21  *   <li>an offer-style method, which attempts to enqueue the notification, but allows the caller to specify that it
  22  *       should never wait, or put an upper bound on how long it is going to wait</li>
  23  * </ul>
  24  */
  25 public interface DOMNotificationPublishService
  26         extends DOMService<DOMNotificationPublishService, DOMNotificationPublishService.Extension> {
  27     /**
  28      * Marker interface for an extension to {@link DOMNotificationPublishService}.
  29      */
  30     interface Extension extends DOMService.Extension<DOMNotificationPublishService, Extension> {
  31         // Marker interface
  32     }
  33
  34     /**
  35      * Well-known value indicating that the implementation is currently not able to accept a notification.
  36      */
  37     @NonNull ListenableFuture<?> REJECTED = FluentFutures.immediateFailedFluentFuture(
  38         new DOMNotificationRejectedException("Unacceptable blocking conditions encountered"));
  39
  40     /**
  41      * Publish a notification. The result of this method is a {@link ListenableFuture} which will
  42      * complete once the notification has been delivered to all immediate registrants. The type of
  43      * the object resulting from the future is not defined and implementations may use it to convey
  44      * additional information related to the publishing process.
  45      * Abstract subclasses can refine the return type as returning a promise of a more specific
  46      * type, e.g.:
  47      * public interface DeliveryStatus { int getListenerCount(); } ListenableFuture&lt;? extends
  48      * DeliveryStatus&gt;[ putNotification(DOMNotification notification);
  49      * Once the Future succeeds, the resulting object can be queried for traits using instanceof,
  50      * e.g:
  51      * // Can block when (for example) the implemention's ThreadPool queue is full Object o =
  52      * service.putNotification(notif).get(); if (o instanceof DeliveryStatus) { DeliveryStatus ds =
  53      * (DeliveryStatus)o; LOG.debug("Notification was received by {} listeners",
  54      * ds.getListenerCount();); } }
  55      * In case an implementation is running out of resources, it can block the calling thread until
  56      * enough resources become available to accept the notification for processing, or it is
  57      * interrupted.
  58      *
  59      * <p>
  60      * Caution: completion here means that the implementation has completed processing of the
  61      * notification. This does not mean that all existing registrants have seen the notification.
  62      * Most importantly, the delivery process at other cluster nodes may have not begun yet.
  63      *
  64      * @param notification Notification to be published.
  65      * @return A listenable future which will report completion when the service has finished
  66      *         propagating the notification to its immediate registrants.
  67      * @throws InterruptedException if interrupted while waiting
  68      * @throws NullPointerException if notification is null.
  69      */
  70     @NonNull ListenableFuture<? extends Object> putNotification(@NonNull DOMNotification notification)
  71             throws InterruptedException;
  72
  73     /**
  74      * Attempt to publish a notification. The result of this method is a {@link ListenableFuture}
  75      * which will complete once the notification has been delivered to all immediate registrants.
  76      * The type of the object resulting from the future is not defined and implementations may use
  77      * it to convey additional information related to the publishing process. Unlike
  78      * {@link #putNotification(DOMNotification)}, this method is guaranteed not to block if the
  79      * underlying implementation encounters contention.
  80      *
  81      * @param notification Notification to be published.
  82      * @return A listenable future which will report completion when the service has finished
  83      *         propagating the notification to its immediate registrants, or {@link #REJECTED} if
  84      *         resource constraints prevent the implementation from accepting the notification for
  85      *         delivery.
  86      * @throws NullPointerException if notification is null.
  87      */
  88     @NonNull ListenableFuture<? extends Object> offerNotification(@NonNull DOMNotification notification);
  89
  90     /**
  91      * Attempt to publish a notification. The result of this method is a {@link ListenableFuture}
  92      * which will complete once the notification has been delivered to all immediate registrants.
  93      * The type of the object resulting from the future is not defined and implementations may use
  94      * it to convey additional information related to the publishing process. Unlike
  95      * {@link #putNotification(DOMNotification)}, this method is guaranteed to block more than the
  96      * specified timeout.
  97      *
  98      * @param notification Notification to be published.
  99      * @param timeout how long to wait before giving up, in units of unit
 100      * @param unit a TimeUnit determining how to interpret the timeout parameter
 101      * @return A listenable future which will report completion when the service has finished
 102      *         propagating the notification to its immediate registrants, or {@link #REJECTED} if
 103      *         resource constraints prevent the implementation from accepting the notification for
 104      *         delivery.
 105      * @throws InterruptedException if interrupted while waiting
 106      * @throws NullPointerException if notification or unit is null.
 107      * @throws IllegalArgumentException if timeout is negative.
 108      */
 109     @NonNull ListenableFuture<? extends Object> offerNotification(@NonNull DOMNotification notification,
 110             @NonNegative long timeout, @NonNull TimeUnit unit) throws InterruptedException;
 111 }