co.cask.cdap.notifications.feeds.service

Interface NotificationFeedStore

public interface NotificationFeedStore

Store for Id.NotificationFeed objects.

Method Summary

Methods

Modifier and Type	Method and Description
co.cask.cdap.proto.Id.NotificationFeed	createNotificationFeed(co.cask.cdap.proto.Id.NotificationFeed feed) Creates a new Notification feed.
co.cask.cdap.proto.Id.NotificationFeed	deleteNotificationFeed(String feedId) Deletes a Notification feed from the metadata store.
co.cask.cdap.proto.Id.NotificationFeed	getNotificationFeed(String feedId) Retrieves a Notification feed from the metadata store.
List<co.cask.cdap.proto.Id.NotificationFeed>	listNotificationFeeds(co.cask.cdap.proto.Id.Namespace namespace) Lists all registered Notification feeds for the namespace.

Method Detail

createNotificationFeed

@Nullable
co.cask.cdap.proto.Id.NotificationFeed createNotificationFeed(co.cask.cdap.proto.Id.NotificationFeed feed)

Creates a new Notification feed.

Parameters:

feed - Id.NotificationFeed representing the feed

Returns:

existing Id.NotificationFeed if a feed with the same id already exists, or null if no feed with the same id exists and the feed was created successfully

getNotificationFeed

@Nullable
co.cask.cdap.proto.Id.NotificationFeed getNotificationFeed(String feedId)

Retrieves a Notification feed from the metadata store.

Parameters:

feedId - id of the requested notification feed

Returns:

Id.NotificationFeed of the requested feed, or null if it was not found in the store

deleteNotificationFeed

@Nullable
co.cask.cdap.proto.Id.NotificationFeed deleteNotificationFeed(String feedId)

Deletes a Notification feed from the metadata store.

Parameters:

feedId - id of the notification feed to delete

Returns:

Id.NotificationFeed of the feed if it was found and deleted, null if the specified feed did not exist

listNotificationFeeds

List<co.cask.cdap.proto.Id.NotificationFeed> listNotificationFeeds(co.cask.cdap.proto.Id.Namespace namespace)

Lists all registered Notification feeds for the namespace.

Parameters:

namespace - Id of the namespace to list the feeds for

Returns:

a list of all registered feeds