co.cask.cdap.notifications.feeds

Interface NotificationFeedManager

All Known Implementing Classes:

NoOpNotificationFeedManager, RemoteNotificationFeedManager

public interface NotificationFeedManager

Manager for Id.NotificationFeed objects.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	createFeed(co.cask.cdap.proto.Id.NotificationFeed feed) Create a notification feed.
void	deleteFeed(co.cask.cdap.proto.Id.NotificationFeed feed) Deletes the feed from the manager store.
co.cask.cdap.proto.Id.NotificationFeed	getFeed(co.cask.cdap.proto.Id.NotificationFeed feed) Get a Id.NotificationFeed based on the feed.getId() method of the feed argument.
List<co.cask.cdap.proto.Id.NotificationFeed>	listFeeds(co.cask.cdap.proto.Id.Namespace namespace) List all the Id.NotificationFeeds present in the manager store for a namespace.

Method Detail

createFeed

boolean createFeed(co.cask.cdap.proto.Id.NotificationFeed feed)
                   throws NotificationFeedException

Create a notification feed.

Parameters:

feed - the feed to create

Returns:

true if the feed was created successfully; false if the feed already exists

Throws:

NotificationFeedException - if the feed has an incorrect structure; for example, if it is missing a name, a namespace or a category

deleteFeed

void deleteFeed(co.cask.cdap.proto.Id.NotificationFeed feed)
                throws NotificationFeedNotFoundException,
                       NotificationFeedException

Deletes the feed from the manager store. To determine if the feed exists, the Id.NotificationFeed#getFeedId method is used.

Parameters:

feed - the Id.NotificationFeed to delete

Throws:

NotificationFeedNotFoundException - if the feed does not exist

NotificationFeedException - in case of unforeseen error

getFeed

co.cask.cdap.proto.Id.NotificationFeed getFeed(co.cask.cdap.proto.Id.NotificationFeed feed)
                                               throws NotificationFeedNotFoundException,
                                                      NotificationFeedException

Get a Id.NotificationFeed based on the feed.getId() method of the feed argument.

Parameters:

feed - feed containing the feed Id of the feed to retrieve

Returns:

Id.NotificationFeed of the feed which ID is the same as feed

Throws:

NotificationFeedNotFoundException - if the feed does not exist

NotificationFeedException - in case of unforeseen error

listFeeds

List<co.cask.cdap.proto.Id.NotificationFeed> listFeeds(co.cask.cdap.proto.Id.Namespace namespace)
                                                       throws NotificationFeedException

List all the Id.NotificationFeeds present in the manager store for a namespace.

Parameters:

namespace - Id of the namespace to list feeds for

Returns:

all the Id.NotificationFeeds present in the manager store

Throws:

NotificationFeedException - in case of unforeseen error