org.hornetq.api.jms.management

Interface TopicControl

All Superinterfaces:

DestinationControl

public interface TopicControl
extends DestinationControl

A TopicControl is used to manage a JMS Topic.

Author:

Jeff Mesnil

Method Summary

Methods

Modifier and Type	Method and Description
void	addJNDI(java.lang.String jndi) Add the JNDI binding to this destination
int	countMessagesForSubscription(java.lang.String clientID, java.lang.String subscriptionName, java.lang.String filter) Counts the number of messages in the subscription specified by the specified client ID and subscription name.
void	dropAllSubscriptions() Drops all subscriptions.
void	dropDurableSubscription(java.lang.String clientID, java.lang.String subscriptionName) Drops the subscription specified by the specified client ID and subscription name.
int	getDurableMessageCount() Returns the number of messages for all durable subscribers for this topic.
int	getDurableSubscriptionCount() Returns the number of durable subscribers for this topic.
java.lang.String[]	getJNDIBindings() Returns the JNDI bindings associated to this connection factory.
int	getNonDurableMessageCount() Returns the number of messages for all non-durable subscribers for this topic.
int	getNonDurableSubscriptionCount() Returns the number of non-durable subscribers for this topic.
int	getSubscriptionCount() Returns the number of (durable and non-durable) subscribers for this topic.
java.lang.Object[]	listAllSubscriptions() Lists all the subscriptions for this topic (both durable and non-durable).
java.lang.String	listAllSubscriptionsAsJSON() Lists all the subscriptions for this topic (both durable and non-durable) using JSON serialization.
java.lang.Object[]	listDurableSubscriptions() Lists all the durable subscriptions for this topic.
java.lang.String	listDurableSubscriptionsAsJSON() Lists all the durable subscriptions using JSON serialization.
java.util.Map<java.lang.String,java.lang.Object>[]	listMessagesForSubscription(java.lang.String queueName) Lists all the messages in this queue matching the specified queue representing the subscription.
java.lang.String	listMessagesForSubscriptionAsJSON(java.lang.String queueName) Lists all the messages in this queue matching the specified queue representing the subscription using JSON serialization.
java.lang.Object[]	listNonDurableSubscriptions() Lists all the non-durable subscriptions for this topic.
java.lang.String	listNonDurableSubscriptionsAsJSON() Lists all the non-durable subscriptions using JSON serialization.
void	removeJNDI(java.lang.String jndi)

Methods inherited from interface org.hornetq.api.jms.management.DestinationControl

getAddress, getDeliveringCount, getMessageCount, getMessagesAdded, getName, isTemporary, removeMessages

Method Detail

getSubscriptionCount

int getSubscriptionCount()

Returns the number of (durable and non-durable) subscribers for this topic.

getDurableSubscriptionCount

int getDurableSubscriptionCount()

Returns the number of durable subscribers for this topic.

getNonDurableSubscriptionCount

int getNonDurableSubscriptionCount()

Returns the number of non-durable subscribers for this topic.

getDurableMessageCount

int getDurableMessageCount()

Returns the number of messages for all durable subscribers for this topic.

getNonDurableMessageCount

int getNonDurableMessageCount()

Returns the number of messages for all non-durable subscribers for this topic.

getJNDIBindings

java.lang.String[] getJNDIBindings()

Returns the JNDI bindings associated to this connection factory.

addJNDI

void addJNDI(java.lang.String jndi)
             throws java.lang.Exception

Add the JNDI binding to this destination

Throws:

java.lang.Exception

removeJNDI

void removeJNDI(java.lang.String jndi)
                throws java.lang.Exception

Throws:

java.lang.Exception

listAllSubscriptions

java.lang.Object[] listAllSubscriptions()
                                        throws java.lang.Exception

Lists all the subscriptions for this topic (both durable and non-durable).

Throws:

java.lang.Exception

listAllSubscriptionsAsJSON

java.lang.String listAllSubscriptionsAsJSON()
                                            throws java.lang.Exception

Lists all the subscriptions for this topic (both durable and non-durable) using JSON serialization.
Java objects can be recreated from JSON serialization using SubscriptionInfo.from(String).

Throws:

java.lang.Exception

listDurableSubscriptions

java.lang.Object[] listDurableSubscriptions()
                                            throws java.lang.Exception

Lists all the durable subscriptions for this topic.

Throws:

java.lang.Exception

listDurableSubscriptionsAsJSON

java.lang.String listDurableSubscriptionsAsJSON()
                                                throws java.lang.Exception

Lists all the durable subscriptions using JSON serialization.
Java objects can be recreated from JSON serialization using SubscriptionInfo.from(String).

Throws:

java.lang.Exception

listNonDurableSubscriptions

java.lang.Object[] listNonDurableSubscriptions()
                                               throws java.lang.Exception

Lists all the non-durable subscriptions for this topic.

Throws:

java.lang.Exception

listNonDurableSubscriptionsAsJSON

java.lang.String listNonDurableSubscriptionsAsJSON()
                                                   throws java.lang.Exception

Lists all the non-durable subscriptions using JSON serialization.
Java objects can be recreated from JSON serialization using SubscriptionInfo.from(String).

Throws:

java.lang.Exception

listMessagesForSubscription

java.util.Map<java.lang.String,java.lang.Object>[] listMessagesForSubscription(java.lang.String queueName)
                                                                               throws java.lang.Exception

Lists all the messages in this queue matching the specified queue representing the subscription.
1 Map represents 1 message, keys are the message's properties and headers, values are the corresponding values.

Throws:

java.lang.Exception

listMessagesForSubscriptionAsJSON

java.lang.String listMessagesForSubscriptionAsJSON(java.lang.String queueName)
                                                   throws java.lang.Exception

Lists all the messages in this queue matching the specified queue representing the subscription using JSON serialization.

Throws:

java.lang.Exception

countMessagesForSubscription

int countMessagesForSubscription(java.lang.String clientID,
                               java.lang.String subscriptionName,
                               java.lang.String filter)
                                 throws java.lang.Exception

Counts the number of messages in the subscription specified by the specified client ID and subscription name. Only messages matching the filter will be counted.
Using null or an empty filter will count all messages from this queue.

Throws:

java.lang.Exception

dropDurableSubscription

void dropDurableSubscription(java.lang.String clientID,
                           java.lang.String subscriptionName)
                             throws java.lang.Exception

Drops the subscription specified by the specified client ID and subscription name.

Throws:

java.lang.Exception

dropAllSubscriptions

void dropAllSubscriptions()
                          throws java.lang.Exception

Drops all subscriptions.

Throws:

java.lang.Exception