co.cask.cdap.messaging.store

Interface MetadataTable

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

HBaseMetadataTable

public interface MetadataTable
extends Closeable

Table to store information about the topics and their properties.

Method Summary

Modifier and Type	Method and Description
void	createTopic(TopicMetadata topicMetadata) Create a topic with properties.
void	deleteTopic(co.cask.cdap.proto.id.TopicId topicId) Delete a topic.
TopicMetadata	getMetadata(co.cask.cdap.proto.id.TopicId topicId) Fetch the metadata of the TopicId.
List<co.cask.cdap.proto.id.TopicId>	listTopics() List all topics in the messaging system.
List<co.cask.cdap.proto.id.TopicId>	listTopics(co.cask.cdap.proto.id.NamespaceId namespaceId) List all the topics in a namespace.
void	updateTopic(TopicMetadata topicMetadata) Updates the topic properties.

Methods inherited from interface java.io.Closeable

close

Method Detail

getMetadata

TopicMetadata getMetadata(co.cask.cdap.proto.id.TopicId topicId)
                   throws co.cask.cdap.api.messaging.TopicNotFoundException,
                          IOException

Fetch the metadata of the TopicId.

Parameters:

topicId - message topic

Returns:

metadata of the TopicId

Throws:

co.cask.cdap.api.messaging.TopicNotFoundException - if the topic doesn't exist

IOException - if failed to retrieve metadata

createTopic

void createTopic(TopicMetadata topicMetadata)
          throws co.cask.cdap.api.messaging.TopicAlreadyExistsException,
                 IOException

Create a topic with properties.

Parameters:

topicMetadata - metadata of the topic

Throws:

co.cask.cdap.api.messaging.TopicAlreadyExistsException - if the topic already exist

IOException - if failed to create topic

updateTopic

void updateTopic(TopicMetadata topicMetadata)
          throws co.cask.cdap.api.messaging.TopicNotFoundException,
                 IOException

Updates the topic properties.

Parameters:

topicMetadata - metadata of the topic.

Throws:

co.cask.cdap.api.messaging.TopicNotFoundException - if the topic doesn't exist

IOException - if failed to update metadata

deleteTopic

void deleteTopic(co.cask.cdap.proto.id.TopicId topicId)
          throws co.cask.cdap.api.messaging.TopicNotFoundException,
                 IOException

Delete a topic.

Parameters:

topicId - message topic

Throws:

co.cask.cdap.api.messaging.TopicNotFoundException - if the topic doesn't exist

IOException - if failed to delete the topic

listTopics

List<co.cask.cdap.proto.id.TopicId> listTopics(co.cask.cdap.proto.id.NamespaceId namespaceId)
                                        throws IOException

List all the topics in a namespace.

Parameters:

namespaceId - namespace

Returns:

List of topics in that namespace

Throws:

IOException - if failed to retrieve topics

listTopics

List<co.cask.cdap.proto.id.TopicId> listTopics()
                                        throws IOException

List all topics in the messaging system.

Returns:

List of all topics.

Throws:

IOException - if failed to retrieve topics