import java.util.concurrent.TimeUnit;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
+import org.opendaylight.controller.sal.core.api.BrokerService;
/**
* A {@link DOMService} which allows its user to send {@link DOMNotification}s. It
* the caller to specify that it should never wait, or put an upper bound on how
* long it is going to wait.
*/
-public interface DOMNotificationPublishService extends DOMService {
+public interface DOMNotificationPublishService extends DOMService, BrokerService {
/**
* Well-known value indicating that the implementation is currently not
* able to accept a notification.
*/
- ListenableFuture<Object> REJECTED = Futures.immediateFailedFuture(new Throwable("Unacceptable blocking conditions encountered"));
+ ListenableFuture<Object> REJECTED = Futures.immediateFailedFuture(new DOMNotificationRejectedException("Unacceptable blocking conditions encountered"));
/**
* Publish a notification. The result of this method is a {@link ListenableFuture}
* Abstract subclasses can refine the return type as returning a promise of a
* more specific type, e.g.:
*
+ * {@code
* public interface DeliveryStatus { int getListenerCount(); }
* ListenableFuture<? extends DeliveryStatus> putNotification(DOMNotification notification);
+ * }
*
* Once the Future succeeds, the resulting object can be queried for traits using
* instanceof, e.g:
*
+ * {@code
* // Can block when (for example) the implemention's ThreadPool queue is full
* Object o = service.putNotification(notif).get();
* if (o instanceof DeliveryStatus) {
* @throws InterruptedException if interrupted while waiting
* @throws NullPointerException if notification is null.
*/
- @Nonnull ListenableFuture<? extends Object> putNotification(@Nonnull DOMNotification notification) throws InterruptedException;
+ @Nonnull ListenableFuture<?> putNotification(@Nonnull DOMNotification notification) throws InterruptedException;
/**
* Attempt to publish a notification. The result of this method is a {@link ListenableFuture}
* @param notification Notification to be published.
* @return A listenable future which will report completion when the service
* has finished propagating the notification to its immediate registrants,
- * or {@value #REJECTED} if resource constraints prevent
+ * or {@link #REJECTED} if resource constraints prevent
* the implementation from accepting the notification for delivery.
* @throws NullPointerException if notification is null.
*/
- @Nonnull ListenableFuture<? extends Object> offerNotification(@Nonnull DOMNotification notification);
+ @Nonnull ListenableFuture<?> offerNotification(@Nonnull DOMNotification notification);
/**
* Attempt to publish a notification. The result of this method is a {@link ListenableFuture}
* @param unit a TimeUnit determining how to interpret the timeout parameter
* @return A listenable future which will report completion when the service
* has finished propagating the notification to its immediate registrants,
- * or {@value #REJECTED} if resource constraints prevent
+ * or {@link #REJECTED} if resource constraints prevent
* the implementation from accepting the notification for delivery.
* @throws InterruptedException if interrupted while waiting
* @throws NullPointerException if notification or unit is null.
* @throws IllegalArgumentException if timeout is negative.
*/
- @Nonnull ListenableFuture<? extends Object> offerNotification(@Nonnull DOMNotification notification,
+ @Nonnull ListenableFuture<?> offerNotification(@Nonnull DOMNotification notification,
@Nonnegative long timeout, @Nonnull TimeUnit unit) throws InterruptedException;
}