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