io.cdap.cdap.api.messaging

Interface MessagingAdmin

All Known Subinterfaces:

Admin

@Beta
public interface MessagingAdmin

Provides topic administration functions of the Transactional Messaging System.

Method Summary

Modifier and Type	Method and Description
void	createTopic(String topic) Creates a new topic with the default topic properties.
void	createTopic(String topic, Map<String,String> properties) Creates a new topic.
void	deleteTopic(String topic) Deletes a topic.
Map<String,String>	getTopicProperties(String topic) Returns the properties of a topic.
void	updateTopic(String topic, Map<String,String> properties) Updates the properties of a topic.

Method Detail

createTopic

void createTopic(String topic)
          throws TopicAlreadyExistsException,
                 IOException,
                 AccessException

Creates a new topic with the default topic properties.

Parameters:

topic - name of the topic

Throws:

IOException - if there was a failure to communicate with the messaging system. Caller may retry this call or use the getTopicProperties(String) method to verify that the topic has been created.

IllegalArgumentException - if the topic name is invalid. A valid id should only contain alphanumeric characters, _, or -.

TopicAlreadyExistsException - if the topic already exists

AccessException - if caller do not have proper access to the topic

createTopic

void createTopic(String topic,
                 Map<String,String> properties)
          throws TopicAlreadyExistsException,
                 IOException,
                 AccessException

Creates a new topic.

Parameters:

topic - name of the topic

properties - properties for the topic

Throws:

IOException - if there was a failure to communicate with the messaging system. Caller may retry this call or use the getTopicProperties(String) method to verify that the topic has been created.

IllegalArgumentException - if the topic name is invalid. A valid id should only contain alphanumeric characters, _, or -.

TopicAlreadyExistsException - if the topic already exists

AccessException - if caller do not have proper access to the topic

getTopicProperties

Map<String,String> getTopicProperties(String topic)
                               throws TopicNotFoundException,
                                      IOException,
                                      AccessException

Returns the properties of a topic.

Parameters:

topic - name of the topic

Returns:

the topic properties

Throws:

IOException - if failed to communicate with the messaging system.

IllegalArgumentException - if the topic name is invalid. A valid id should only contain alphanumeric characters, _, or -.

TopicNotFoundException - if the topic does not exist

AccessException - if caller do not have proper access to the topic

updateTopic

void updateTopic(String topic,
                 Map<String,String> properties)
          throws TopicNotFoundException,
                 IOException,
                 AccessException

Updates the properties of a topic.

Parameters:

topic - name of the topic

properties - the topic properties. This will overwrite the existing properties.

Throws:

IOException - if there was a failure to communicate with the messaging system. Caller may use the getTopicProperties(String) method to verify that the properties have been updated.

IllegalArgumentException - if the topic name is invalid. A valid id should only contain alphanumeric characters, _, or -.

TopicNotFoundException - if the topic does not exist

AccessException - if caller do not have proper access to the topic

deleteTopic

void deleteTopic(String topic)
          throws TopicNotFoundException,
                 IOException,
                 AccessException

Deletes a topic.

Parameters:

topic - name of the topic

Throws:

IOException - if there was a failure to communicate with the messaging system. Caller may retry this call or use the getTopicProperties(String) method to verify that the topic has been deleted.

IllegalArgumentException - if the topic name is invalid. A valid id should only contain alphanumeric characters, _, or -.

TopicNotFoundException - if the topic does not exist

AccessException - if caller do not have proper access to the topic