opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/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.controller.md.sal.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(
  32             new DOMNotificationRejectedException("Unacceptable blocking conditions encountered"));
  33
  34     /**
  35      * Publish a notification. The result of this method is a {@link ListenableFuture}
  36      * which will complete once the notification has been delivered to all immediate
  37      * registrants. The type of the object resulting from the future is not defined
  38      * and implementations may use it to convey additional information related to the
  39      * publishing process.
  40      *
  41      * <p>
  42      * Abstract subclasses can refine the return type as returning a promise of a
  43      * more specific type, e.g.:
  44      *
  45      * {@code
  46      *     public interface DeliveryStatus { int getListenerCount(); }
  47      *     ListenableFuture<? extends DeliveryStatus> putNotification(DOMNotification notification);
  48      * }
  49      *
  50      * <p>
  51      * Once the Future succeeds, the resulting object can be queried for traits using
  52      * instanceof, e.g:
  53      *
  54      * {@code
  55      *     // Can block when (for example) the implemention's ThreadPool queue is full
  56      *     Object o = service.putNotification(notif).get();
  57      *     if (o instanceof DeliveryStatus) {
  58      *         DeliveryStatus ds = (DeliveryStatus)o;
  59      *         LOG.debug("Notification was received by {} listeners", ds.getListenerCount(););
  60      *     }
  61      * }
  62      *
  63      * <p>
  64      * In case an implementation is running out of resources, it can block the calling
  65      * thread until enough resources become available to accept the notification for
  66      * processing, or it is interrupted.
  67      *
  68      * <p>
  69      * Caution: completion here means that the implementation has completed processing
  70      *          of the notification. This does not mean that all existing registrants
  71      *          have seen the notification. Most importantly, the delivery process at
  72      *          other cluster nodes may have not begun yet.
  73      *
  74      * @param notification Notification to be published.
  75      * @return A listenable future which will report completion when the service
  76      *         has finished propagating the notification to its immediate registrants.
  77      * @throws InterruptedException if interrupted while waiting
  78      * @throws NullPointerException if notification is null.
  79      */
  80     @Nonnull ListenableFuture<?> putNotification(@Nonnull DOMNotification notification) throws InterruptedException;
  81
  82     /**
  83      * Attempt to publish a notification. The result of this method is a {@link ListenableFuture}
  84      * which will complete once the notification has been delivered to all immediate
  85      * registrants. The type of the object resulting from the future is not defined
  86      * and implementations may use it to convey additional information related to the
  87      * publishing process. Unlike {@link #putNotification(DOMNotification)}, this method
  88      * is guaranteed not to block if the underlying implementation encounters contention.
  89      *
  90      * @param notification Notification to be published.
  91      * @return A listenable future which will report completion when the service
  92      *         has finished propagating the notification to its immediate registrants,
  93      *         or {@link #REJECTED} if resource constraints prevent
  94      *         the implementation from accepting the notification for delivery.
  95      * @throws NullPointerException if notification is null.
  96      */
  97     @Nonnull ListenableFuture<?> offerNotification(@Nonnull DOMNotification notification);
  98
  99     /**
 100      * Attempt to publish a notification. The result of this method is a {@link ListenableFuture}
 101      * which will complete once the notification has been delivered to all immediate
 102      * registrants. The type of the object resulting from the future is not defined
 103      * and implementations may use it to convey additional information related to the
 104      * publishing process. Unlike {@link #putNotification(DOMNotification)}, this method
 105      * is guaranteed to block more than the specified timeout.
 106      *
 107      * @param notification Notification to be published.
 108      * @param timeout how long to wait before giving up, in units of unit
 109      * @param unit a TimeUnit determining how to interpret the timeout parameter
 110      * @return A listenable future which will report completion when the service
 111      *         has finished propagating the notification to its immediate registrants,
 112      *         or {@link #REJECTED} if resource constraints prevent
 113      *         the implementation from accepting the notification for delivery.
 114      * @throws InterruptedException if interrupted while waiting
 115      * @throws NullPointerException if notification or unit is null.
 116      * @throws IllegalArgumentException if timeout is negative.
 117      */
 118     @Nonnull ListenableFuture<?> offerNotification(@Nonnull DOMNotification notification,
 119         @Nonnegative long timeout, @Nonnull TimeUnit unit) throws InterruptedException;
 120 }