co.cask.cdap.notifications.feeds

Interface NotificationFeedManager

All Known Implementing Classes:

NoOpNotificationFeedManager, RemoteNotificationFeedManager

public interface NotificationFeedManager

Manager for NotificationFeedId objects.

Method Summary

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

Method Detail

createFeed

boolean createFeed(co.cask.cdap.proto.notification.NotificationFeedInfo 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.NotificationFeedId feed)
         throws NotificationFeedNotFoundException,
                NotificationFeedException

Deletes the feed from the manager store.

Parameters:

feed - the NotificationFeedId to delete

Throws:

NotificationFeedNotFoundException - if the feed does not exist

NotificationFeedException - in case of unforeseen error

getFeed

co.cask.cdap.proto.notification.NotificationFeedInfo getFeed(co.cask.cdap.proto.id.NotificationFeedId feed)
                                                      throws NotificationFeedNotFoundException,
                                                             NotificationFeedException

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

Parameters:

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

Returns:

NotificationFeedId 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.notification.NotificationFeedInfo> listFeeds(co.cask.cdap.proto.id.NamespaceId namespace)
                                                              throws NotificationFeedException

List all the NotificationFeedInfos present in the manager store for a namespace.

Parameters:

namespace - Id of the namespace to list feeds for

Returns:

all the NotificationFeedInfos present in the manager store

Throws:

NotificationFeedException - in case of unforeseen error