This documentation is for WSO2 Message Broker 3.0.0. View documentation for the latest release.
Due to a known issue do not use JDK1.8.0_151 with WSO2 products. Use JDK 1.8.0_144 until JDK 1.8.0_162-ea is released.
Skip to end of metadata
Go to start of metadata

Topics and sub topics can be easily added to WSO2 MB using the management console. The topics and sub topics you create will be arranged into a tree navigator, which you can expand and collapse to get an overview of the parent-child topic structure. You can also view details of a particular topic or sub topic by simply clicking on the topic in the tree navigator. Once a topic is addd to MB, users will be able to publish information to the topic and subscribe to the information published.

Following the instructions given below.


The possibility to work with Topics in WSO2 MB are strictly secured by role-based permissions. Therefore, a user needs to be linked to a role with the relevant permissions in order to start managing Topics in WSO2 MB. See the following links for details on how roles and permissions are set up for a user.

Adding topics from the management console

To create a new topic using the management console:

  1. Log in to the management console.
  2. In the Main tab, click Topics -> Add. The Add Topic screen will open.
  3. Enter a name for the topic in the Topic field. 

    Note the following for the Topic name:

    • Topic name can starts with any of the following: * , alphanumeric characters (a-z, A-Z or 0-9). These can be used any number of times delimited by dots. 
    • Topic name can end with the following: * , alphanumeric characters, hash (#).  
    • The “/” symbol (TENANT_SEPARATOR) can only be used to separate the tenant domain from the topic name when creating topics/subscribing to topics from external clients.
    • The colon (":") can be used in Topic names if the <allowStrictNameValidation> property is set to false in the broker.xml file (stored in the <MB_HOME>/repository/conf folder). This is only applicable for AMQP.
  4. Now you need to grant permissions for users in your system to publish and subscribe to the topic you are creating. You will be granting these permissions to users based on the user's role. As shown below, all the user roles in your tenant domain will be listed. You can select the relevant check box against each role:
    • If the Subscribe check box is selected, the users linked to the role has permission to subscribe to the topic.
    • If the Publish check box is selected, the users linked to the role has permission to publish information to the topic.
    If you want to create new user roles for topic subscription and publishing see the documentation on creating users and roles.

    The user that creates a topic in the system is by default granted permission to Subscribe and Publish to that particular topic. This is handled in the system by automatically creating an internal role and assigning it to the user creating the topic.

  5. Click Add Topic to create the topic.
  6. If the topic is added successfully, a message appears. Click OK to view the topic browser where the newly added topic is listed in a tree view:
  7. Click on the topic to view all the operations available. See the section on viewing topic details for more information.

Adding sub topics from the management console

You can add a sub topic under an existing topic as shown below.

  1. Go to the Topic Browser to select the parent topic.
  2. Click the topic to see the details.
  3. Click Add Subtopic to create the sub topic. The information that should be provided when adding a subtopic is the same as when adding a main topic.
  4. Once a sub topic is added, it will be displayed in the Topic Browser window under the main topic.

Viewing topic details

Once you have added your topics to the Topics Browser, you can view detailed information about the topic as shown below.

  1. Click on the topic in the Topic Browser. The Details option will be listed.
  2. Click Details to open the Topic Details screen:
    The following table shows descriptions of the parameters on this page:

    Permission DetailsPermissions related to the topic can be viewed here. Permissions can be changed by clearing or selecting the provided check boxes and clicking Update Permissions once done.
    JMS Subscription DetailsAll the durable and non durable JMS subscriptions are listed here.
    PublishPublish a sample XML message to a topic. When there is a subscription for the topic, the event sink URL receives the XML message specified here. Click the Publish button after placing the XML message in the provided space.

Deleting a topic

To delete a topic, the subscription count for that topic and its children should be zero. If not, an error message appears specifying that there are subscriptions for the topic or its children.

  • No labels