org.wso2.carbon.andes.event.core.internal.subscription.registry

Class TopicManagerServiceImpl

java.lang.Object

org.wso2.carbon.andes.event.core.internal.subscription.registry.TopicManagerServiceImpl

All Implemented Interfaces:

TopicManagerService

public class TopicManagerServiceImpl
extends Object
implements TopicManagerService

This class is utilized to perform actions related to topics.

Constructor Summary

Constructors

Constructor and Description
TopicManagerServiceImpl(String topicStoragePath) Initializes Registry Topic Manager

Method Summary

Methods

Modifier and Type	Method and Description
void	addTopic(String topicName) Adding topic, when creating topics from the user interface 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
String	getTopicStoragePath() Gets the topic storage path
TopicNode	getTopicTree() Gets the topic tree.
boolean	isTopicExists(String topicName) Checks whether topic exists
boolean	removeTopic(String topicName) Removes a topic
void	setTopicStoragePath(String topicStoragePath) The topic storage path
void	updatePermissions(String topicName, TopicRolePermission[] topicRolePermissions) Update permissions for a topic

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TopicManagerServiceImpl

public TopicManagerServiceImpl(String topicStoragePath)

Initializes Registry Topic Manager

Parameters:

topicStoragePath - the topic registry path

Method Detail

getTopicTree

public TopicNode getTopicTree()
                       throws EventBrokerException

Gets the topic tree.

Specified by:

getTopicTree in interface TopicManagerService

Returns:

a topic node which includes the name and its sub topics

Throws:

EventBrokerException

getPaginatedTopicTree

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

Get the paginated topic tree.

Specified by:

getPaginatedTopicTree in interface TopicManagerService

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

public void addTopic(String topicName)
              throws EventBrokerException

Adding topic, when creating topics from the user interface Adds a new topic

Specified by:

addTopic in interface TopicManagerService

Parameters:

topicName - topic name

Throws:

EventBrokerException

getTopicRolePermission

public TopicRolePermission[] getTopicRolePermission(String topicName)
                                             throws EventBrokerException

Gets the permissions for topic

Specified by:

getTopicRolePermission in interface TopicManagerService

Parameters:

topicName - topic name

Returns:

an array of permissions for topics

Throws:

EventBrokerException

updatePermissions

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

Update permissions for a topic

Specified by:

updatePermissions in interface TopicManagerService

Parameters:

topicName - topic name

topicRolePermissions - array of permissions for topics

Throws:

EventBrokerException

getTopicStoragePath

public String getTopicStoragePath()

Gets the topic storage path

Returns:

the topic storage path

setTopicStoragePath

public void setTopicStoragePath(String topicStoragePath)

The topic storage path

Parameters:

topicStoragePath - path for topic storage

getSubscriptions

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

Gets subscriptions for a topic

Specified by:

getSubscriptions in interface TopicManagerService

Parameters:

topicName - topic name

withChildren - include topics with children. i.e subtopics

Returns:

an array of subscriptions

Throws:

EventBrokerException

getJMSSubscriptions

public Subscription[] getJMSSubscriptions(String topicName)
                                   throws EventBrokerException

Gets the JMS subscriptions for a given topic

Specified by:

getJMSSubscriptions in interface TopicManagerService

Parameters:

topicName - topic name

Returns:

an array of subscriptions

Throws:

EventBrokerException

getBackendRoles

public String[] getBackendRoles()
                         throws EventBrokerException

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

Specified by:

getBackendRoles in interface TopicManagerService

Returns:

an array of roles

Throws:

EventBrokerException

removeTopic

public boolean removeTopic(String topicName)
                    throws EventBrokerException

Removes a topic

Specified by:

removeTopic in interface TopicManagerService

Parameters:

topicName - topic name

Returns:

true if topic removal succeeded, false otherwise.

Throws:

EventBrokerException

isTopicExists

public boolean isTopicExists(String topicName)
                      throws EventBrokerException

Checks whether topic exists

Specified by:

isTopicExists in interface TopicManagerService

Parameters:

topicName - topic name

Returns:

true if topic exists, false otherwise.

Throws:

EventBrokerException

checkUserHasAddTopicPermission

public boolean checkUserHasAddTopicPermission(String username)
                                       throws EventBrokerException

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

Specified by:

checkUserHasAddTopicPermission in interface TopicManagerService

Parameters:

username - username

Returns:

true/false based on permission

Throws:

EventBrokerException

checkUserHasDeleteTopicPermission

public boolean checkUserHasDeleteTopicPermission(String username)
                                          throws EventBrokerException

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

Specified by:

checkUserHasDeleteTopicPermission in interface TopicManagerService

Parameters:

username - username

Returns:

true/false based on permission

Throws:

EventBrokerException

checkUserHasDetailsTopicPermission

public boolean checkUserHasDetailsTopicPermission(String username)
                                           throws EventBrokerException

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

Specified by:

checkUserHasDetailsTopicPermission in interface TopicManagerService

Parameters:

username - username

Returns:

true/false based on permission

Throws:

EventBrokerException

checkUserHasPublishTopicPermission

public 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.

Specified by:

checkUserHasPublishTopicPermission in interface TopicManagerService

Parameters:

topicName - topic name to check against

username - username

Returns:

true/false based on permission

Throws:

EventBrokerException