org.apache.activemq.broker.jmx
Interface BrokerViewMBean

All Superinterfaces:
Service
All Known Implementing Classes:
BrokerView

public interface BrokerViewMBean
extends Service


Method Summary
 void addQueue(java.lang.String name)
          Adds a Queue destination to the broker.
 void addTopic(java.lang.String name)
          Adds a Topic destination to the broker.
 javax.management.ObjectName createDurableSubscriber(java.lang.String clientId, java.lang.String subscriberName, java.lang.String topicName, java.lang.String selector)
          Creates a new durable topic subscriber
 void destroyDurableSubscriber(java.lang.String clientId, java.lang.String subscriberName)
          Destroys a durable subscriber
 void gc()
          The Broker will fush it's caches so that the garbage collector can recalaim more memory.
 java.lang.String getBrokerId()
           
 javax.management.ObjectName[] getDurableTopicSubscribers()
           
 javax.management.ObjectName[] getInactiveDurableTopicSubscribers()
           
 long getMemoryLimit()
           
 int getMemoryPercentageUsed()
           
 javax.management.ObjectName[] getQueues()
           
 javax.management.ObjectName[] getQueueSubscribers()
           
 javax.management.ObjectName[] getTemporaryQueues()
           
 javax.management.ObjectName[] getTemporaryQueueSubscribers()
           
 javax.management.ObjectName[] getTemporaryTopics()
           
 javax.management.ObjectName[] getTemporaryTopicSubscribers()
           
 javax.management.ObjectName[] getTopics()
           
 javax.management.ObjectName[] getTopicSubscribers()
           
 long getTotalConsumerCount()
           
 long getTotalDequeueCount()
           
 long getTotalEnqueueCount()
           
 long getTotalMessageCount()
           
 void removeQueue(java.lang.String name)
          Removes a Queue destination from the broker.
 void removeTopic(java.lang.String name)
          Removes a Topic destination from the broker.
 void resetStatistics()
           
 void setMemoryLimit(long limit)
           
 void stop()
          Stop the broker and all it's components.
 void terminateJVM(int exitCode)
          Shuts down the JVM.
 
Methods inherited from interface org.apache.activemq.Service
start
 

Method Detail

getBrokerId

java.lang.String getBrokerId()
Returns:
The unique id of the broker.

gc

void gc()
        throws java.lang.Exception
The Broker will fush it's caches so that the garbage collector can recalaim more memory.

Throws:
java.lang.Exception

resetStatistics

void resetStatistics()

getTotalEnqueueCount

long getTotalEnqueueCount()

getTotalDequeueCount

long getTotalDequeueCount()

getTotalConsumerCount

long getTotalConsumerCount()

getTotalMessageCount

long getTotalMessageCount()

getMemoryPercentageUsed

int getMemoryPercentageUsed()

getMemoryLimit

long getMemoryLimit()

setMemoryLimit

void setMemoryLimit(long limit)

terminateJVM

void terminateJVM(int exitCode)
Shuts down the JVM.

Parameters:
exitCode - the exit code that will be reported by the JVM process when it exits.

stop

void stop()
          throws java.lang.Exception
Stop the broker and all it's components.

Specified by:
stop in interface Service
Throws:
java.lang.Exception

getTopics

javax.management.ObjectName[] getTopics()

getQueues

javax.management.ObjectName[] getQueues()

getTemporaryTopics

javax.management.ObjectName[] getTemporaryTopics()

getTemporaryQueues

javax.management.ObjectName[] getTemporaryQueues()

getTopicSubscribers

javax.management.ObjectName[] getTopicSubscribers()

getDurableTopicSubscribers

javax.management.ObjectName[] getDurableTopicSubscribers()

getInactiveDurableTopicSubscribers

javax.management.ObjectName[] getInactiveDurableTopicSubscribers()

getQueueSubscribers

javax.management.ObjectName[] getQueueSubscribers()

getTemporaryTopicSubscribers

javax.management.ObjectName[] getTemporaryTopicSubscribers()

getTemporaryQueueSubscribers

javax.management.ObjectName[] getTemporaryQueueSubscribers()

addTopic

void addTopic(java.lang.String name)
              throws java.lang.Exception
Adds a Topic destination to the broker.

Parameters:
name - The name of the Topic
Throws:
java.lang.Exception

addQueue

void addQueue(java.lang.String name)
              throws java.lang.Exception
Adds a Queue destination to the broker.

Parameters:
name - The name of the Queue
Throws:
java.lang.Exception

removeTopic

void removeTopic(java.lang.String name)
                 throws java.lang.Exception
Removes a Topic destination from the broker.

Parameters:
name - The name of the Topic
Throws:
java.lang.Exception

removeQueue

void removeQueue(java.lang.String name)
                 throws java.lang.Exception
Removes a Queue destination from the broker.

Parameters:
name - The name of the Queue
Throws:
java.lang.Exception

createDurableSubscriber

javax.management.ObjectName createDurableSubscriber(java.lang.String clientId,
                                                    java.lang.String subscriberName,
                                                    java.lang.String topicName,
                                                    java.lang.String selector)
                                                    throws java.lang.Exception
Creates a new durable topic subscriber

Parameters:
clientId - the JMS client ID
subscriberName - the durable subscriber name
topicName - the name of the topic to subscribe to
selector - a selector or null
Returns:
the object name of the MBean registered in JMX
Throws:
java.lang.Exception

destroyDurableSubscriber

void destroyDurableSubscriber(java.lang.String clientId,
                              java.lang.String subscriberName)
                              throws java.lang.Exception
Destroys a durable subscriber

Parameters:
clientId - the JMS client ID
subscriberName - the durable subscriber name
Throws:
java.lang.Exception


Copyright © 2010 Apache Software Foundation. All Rights Reserved.