co.cask.cdap.notifications.service

Class AbstractNotificationService

java.lang.Object

com.google.common.util.concurrent.AbstractIdleService

co.cask.cdap.common.service.UncaughtExceptionIdleService

co.cask.cdap.notifications.service.AbstractNotificationService

All Implemented Interfaces:

NotificationService, com.google.common.util.concurrent.Service

Direct Known Subclasses:

InMemoryNotificationService, KafkaNotificationService

public abstract class AbstractNotificationService
extends UncaughtExceptionIdleService
implements NotificationService

Common implementation of the the NotificationService that handles the subscriptions to all the notification feeds for the current process and that has the ability to push notifications to subscribers.

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractNotificationService(DatasetFramework dsFramework, TransactionSystemClientService transactionSystemClient, NotificationFeedManager feedManager)

Method Summary

Methods

Modifier and Type	Method and Description
protected com.google.gson.Gson	createGson()
protected org.slf4j.Logger	getUncaughtExceptionLogger()
protected void	notificationReceived(Id.NotificationFeed feed, com.google.gson.JsonElement notificationJson) Called when a notification is received on a feed, to push it to all the handlers that subscribed to the feed.
<N> com.google.common.util.concurrent.ListenableFuture<N>	publish(Id.NotificationFeed feed, N notification)
protected void	shutDown()
protected void	startUp()
<N> Cancellable	subscribe(Id.NotificationFeed feed, NotificationHandler<N> handler)
<N> Cancellable	subscribe(Id.NotificationFeed feed, NotificationHandler<N> handler, Executor executor)

Methods inherited from class co.cask.cdap.common.service.UncaughtExceptionIdleService

executor, newHandler

Methods inherited from class com.google.common.util.concurrent.AbstractIdleService

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface co.cask.cdap.notifications.service.NotificationService

publish

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

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

Constructor Detail

AbstractNotificationService

protected AbstractNotificationService(DatasetFramework dsFramework,
                           TransactionSystemClientService transactionSystemClient,
                           NotificationFeedManager feedManager)

Method Detail

startUp

protected void startUp()
                throws Exception

Specified by:

startUp in class com.google.common.util.concurrent.AbstractIdleService

Throws:

Exception

shutDown

protected void shutDown()
                 throws Exception

Specified by:

shutDown in class com.google.common.util.concurrent.AbstractIdleService

Throws:

Exception

createGson

protected com.google.gson.Gson createGson()

notificationReceived

protected void notificationReceived(Id.NotificationFeed feed,
                        com.google.gson.JsonElement notificationJson)

Called when a notification is received on a feed, to push it to all the handlers that subscribed to the feed.

Parameters:

feed - Id.NotificationFeed of the notification

notificationJson - notification as a json object

publish

public <N> com.google.common.util.concurrent.ListenableFuture<N> publish(Id.NotificationFeed feed,
                                                                N notification)
                                                              throws NotificationException

Specified by:

publish in interface NotificationService

Throws:

NotificationException

subscribe

public <N> Cancellable subscribe(Id.NotificationFeed feed,
                        NotificationHandler<N> handler)
                      throws NotificationFeedNotFoundException,
                             NotificationFeedException

Specified by:

subscribe in interface NotificationService

Throws:

NotificationFeedNotFoundException

NotificationFeedException

subscribe

public <N> Cancellable subscribe(Id.NotificationFeed feed,
                        NotificationHandler<N> handler,
                        Executor executor)
                      throws NotificationFeedNotFoundException,
                             NotificationFeedException

Specified by:

subscribe in interface NotificationService

Throws:

NotificationFeedNotFoundException

NotificationFeedException

getUncaughtExceptionLogger

protected org.slf4j.Logger getUncaughtExceptionLogger()

Specified by:

getUncaughtExceptionLogger in class UncaughtExceptionIdleService