org.wso2.carbon.andes.event.core

Interface TopicManagerService

All Known Implementing Classes:

TopicManagerServiceImpl

public interface TopicManagerService

An interface for topic manager. Includes actions which are related to topics.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTopic(String topicName) Adds a new topic
boolean	checkUserHasAddTopicPermission(String username) Check if given user has add topic permission.
boolean	checkUserHasDeleteTopicPermission(String username) Check if given user has delete topic permission.
boolean	checkUserHasDetailsTopicPermission(String username) Check if given user has permission to view topic details.
boolean	checkUserHasPublishTopicPermission(String topicName, String username) Check if given user has permission to publish to topic.
String[]	getBackendRoles() Get array of backend roles excluding admin and wso2.anonymous.role roles
Subscription[]	getJMSSubscriptions(String topicName) Gets the JMS subscriptions for a given topic
TopicNode	getPaginatedTopicTree(String topicPath, int startIndex, int numberOfTopicsPerRound) Get the paginated topic tree.
Subscription[]	getSubscriptions(String topicName, boolean withChildren) Gets subscriptions for a topic
TopicRolePermission[]	getTopicRolePermission(String topicName) Gets the permissions for topic
TopicNode	getTopicTree() Gets the topic tree.
boolean	isTopicExists(String topicName) Checks whether topic exists
boolean	removeTopic(String topicName) Removes a topic
void	updatePermissions(String topicName, TopicRolePermission[] topicRolePermissions) Update permissions for a topic

Method Detail

getTopicTree

TopicNode getTopicTree()
                       throws EventBrokerException

Gets the topic tree.

Returns:

a topic node which includes the name and its sub topics

Throws:

EventBrokerException

getPaginatedTopicTree

TopicNode getPaginatedTopicTree(String topicPath,
                              int startIndex,
                              int numberOfTopicsPerRound)
                                throws EventBrokerException

Get the paginated topic tree.

Parameters:

topicPath - path of the node in the topic tree

startIndex - start index of the paginated tree

numberOfTopicsPerRound - number of topics should be shown per round

Returns:

a subset of topic tree

Throws:

EventBrokerException

addTopic

void addTopic(String topicName)
              throws EventBrokerException

Adds a new topic

Parameters:

topicName - topic name

Throws:

EventBrokerException

getTopicRolePermission

TopicRolePermission[] getTopicRolePermission(String topicName)
                                             throws EventBrokerException

Gets the permissions for topic

Parameters:

topicName - topic name

Returns:

an array of permissions for topics

Throws:

EventBrokerException

updatePermissions

void updatePermissions(String topicName,
                     TopicRolePermission[] topicRolePermissions)
                       throws EventBrokerException

Update permissions for a topic

Parameters:

topicName - topic name

topicRolePermissions - array of permissions for topics

Throws:

EventBrokerException

getSubscriptions

Subscription[] getSubscriptions(String topicName,
                              boolean withChildren)
                                throws EventBrokerException

Gets subscriptions for a topic

Parameters:

topicName - topic name

withChildren - include topics with children. i.e subtopics

Returns:

an array of subscriptions

Throws:

EventBrokerException

getJMSSubscriptions

Subscription[] getJMSSubscriptions(String topicName)
                                   throws EventBrokerException

Gets the JMS subscriptions for a given topic

Parameters:

topicName - topic name

Returns:

an array of subscriptions

Throws:

EventBrokerException

getBackendRoles

String[] getBackendRoles()
                         throws EventBrokerException

Get array of backend roles excluding admin and wso2.anonymous.role roles

Returns:

an array of roles

Throws:

EventBrokerException

removeTopic

boolean removeTopic(String topicName)
                    throws EventBrokerException

Removes a topic

Parameters:

topicName - topic name

Returns:

true if topic removal succeeded, false otherwise.

Throws:

EventBrokerException

isTopicExists

boolean isTopicExists(String topicName)
                      throws EventBrokerException

Checks whether topic exists

Parameters:

topicName - topic name

Returns:

true if topic exists, false otherwise.

Throws:

EventBrokerException

checkUserHasAddTopicPermission

boolean checkUserHasAddTopicPermission(String username)
                                       throws EventBrokerException

Check if given user has add topic permission. We bypass permission evaluating if user is admin.

Parameters:

username - username

Returns:

true/false based on permission

Throws:

EventBrokerException

checkUserHasDeleteTopicPermission

boolean checkUserHasDeleteTopicPermission(String username)
                                          throws EventBrokerException

Check if given user has delete topic permission. We bypass permission evaluating if user is admin.

Parameters:

username - username

Returns:

true/false based on permission

Throws:

EventBrokerException

checkUserHasDetailsTopicPermission

boolean checkUserHasDetailsTopicPermission(String username)
                                           throws EventBrokerException

Check if given user has permission to view topic details. We bypass permission evaluating if user is admin.

Parameters:

username - username

Returns:

true/false based on permission

Throws:

EventBrokerException

checkUserHasPublishTopicPermission

boolean checkUserHasPublishTopicPermission(String topicName,
                                         String username)
                                           throws EventBrokerException

Check if given user has permission to publish to topic. We bypass permission evaluating if user is admin.

Parameters:

topicName - topic name to check against

username - username

Returns:

true/false based on permission

Throws:

EventBrokerException