co.cask.cdap.notifications.service

Interface NotificationService

All Superinterfaces:

com.google.common.util.concurrent.Service

public interface NotificationService
extends com.google.common.util.concurrent.Service

A Notification service for publishing and subscribing to notifications.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Method Summary

Modifier and Type	Method and Description
<N> com.google.common.util.concurrent.ListenableFuture<N>	publish(co.cask.cdap.proto.id.NotificationFeedId feed, N notification) Send one Notification asynchronously.
<N> com.google.common.util.concurrent.ListenableFuture<N>	publish(co.cask.cdap.proto.id.NotificationFeedId feed, N notification, Type notificationType) Send one Notification asynchronously.
<N> org.apache.twill.common.Cancellable	subscribe(co.cask.cdap.proto.id.NotificationFeedId feed, NotificationHandler<N> handler) Subscribe to the notification received on the feed, and handle the notifications with the handler.
<N> org.apache.twill.common.Cancellable	subscribe(co.cask.cdap.proto.id.NotificationFeedId feed, NotificationHandler<N> handler, Executor executor) Subscribe to the notification received on the feed, and handle the notifications with the handler.

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, isRunning, start, startAndWait, state, stop, stopAndWait

Method Detail

publish

<N> com.google.common.util.concurrent.ListenableFuture<N> publish(co.cask.cdap.proto.id.NotificationFeedId feed,
                                                                  N notification)
                                                           throws NotificationException

Send one Notification asynchronously. The class of the notification is used to serialize the message passed to the Notification system.

Type Parameters:

N - Type of the notification to send

Parameters:

feed - NotificationFeedId where to publish the notification

notification - notification object to send

Returns:

a ListenableFuture describing the state of the async send operation

Throws:

NotificationFeedException - in case of any error regarding the feed

NotificationException - in case of any error when publishing the notification

publish

<N> com.google.common.util.concurrent.ListenableFuture<N> publish(co.cask.cdap.proto.id.NotificationFeedId feed,
                                                                  N notification,
                                                                  Type notificationType)
                                                           throws NotificationException

Send one Notification asynchronously. The notificationType is used to serialize the notification passed to the Notification system.

Type Parameters:

N - Type of the notification to send

Parameters:

feed - NotificationFeedId where to publish the notification

notification - notification object to send

notificationType - type to use to serialize the notification in the Notification system

Returns:

a ListenableFuture describing the state of the async send operation

Throws:

NotificationFeedException - in case of any error regarding the feed

NotificationException - in case of any error when publishing the notification

subscribe

<N> org.apache.twill.common.Cancellable subscribe(co.cask.cdap.proto.id.NotificationFeedId feed,
                                                  NotificationHandler<N> handler)
                                           throws NotificationFeedNotFoundException,
                                                  NotificationFeedException

Subscribe to the notification received on the feed, and handle the notifications with the handler. Before this call is made, the feed has to be created using the NotificationFeedManager. Multiple subscriptions to a same feed with different handlers are possible. This method is calling subscribe(NotificationFeedId, NotificationHandler, Executor) with a same thread executor. The invocation of the handler is done through one of the Notification service thread, hence the handler should not be doing long blocking task.

Type Parameters:

N - Type of the notifications

Parameters:

feed - NotificationFeedId to subscribe to

handler - NotificationHandler that will handle the notifications coming from the feed

Returns:

A Cancellable for cancelling Notification consumption

Throws:

NotificationFeedNotFoundException - if the feed does not exist, according to the NotificationFeedManager

NotificationFeedException - in case of any other error concerning the feed

subscribe

<N> org.apache.twill.common.Cancellable subscribe(co.cask.cdap.proto.id.NotificationFeedId feed,
                                                  NotificationHandler<N> handler,
                                                  Executor executor)
                                           throws NotificationFeedNotFoundException,
                                                  NotificationFeedException

Subscribe to the notification received on the feed, and handle the notifications with the handler. Before this call is made, the feed has to be created using the NotificationFeedManager. Multiple subscriptions to a same feed with different handlers are possible.

Type Parameters:

N - Type of the notifications

Parameters:

feed - NotificationFeedId to subscribe to

handler - NotificationHandler that will handle the notifications coming from the feed

executor - Executor to use to perform the polling/pushing of notifications from the Notification system, and to call the handler

Returns:

A Cancellable for cancelling Notification consumption

Throws:

NotificationFeedNotFoundException - if the feed does not exist, according to the NotificationFeedManager

NotificationFeedException - in case of any other error concerning the feed