org.apache.activemq.broker.jmx
Interface BrokerViewMBean

All Superinterfaces:
Service
All Known Implementing Classes:
BrokerView

public interface BrokerViewMBean
extends Service

Author:
David Martin Clavo david(dot)martin(dot)clavo(at)gmail.com (for the reloadLog4jProperties method)

Method Summary
 String addConnector(String discoveryAddress)
           
 String addNetworkConnector(String discoveryAddress)
           
 void addQueue(String name)
          Adds a Queue destination to the broker.
 void addTopic(String name)
          Adds a Topic destination to the broker.
 ObjectName createDurableSubscriber(String clientId, String subscriberName, String topicName, String selector)
          Creates a new durable topic subscriber
 void destroyDurableSubscriber(String clientId, String subscriberName)
          Destroys a durable subscriber
 void disableStatistics()
           
 void enableStatistics()
           
 void gc()
          The Broker will flush it's caches so that the garbage collector can reclaim more memory.
 String getBrokerId()
           
 String getBrokerName()
           
 String getBrokerVersion()
           
 String getDataDirectory()
           
 ObjectName[] getDurableTopicSubscribers()
           
 ObjectName[] getDynamicDestinationProducers()
           
 ObjectName[] getInactiveDurableTopicSubscribers()
           
 ObjectName getJMSJobScheduler()
           
 long getJobSchedulerStoreLimit()
           
 int getJobSchedulerStorePercentUsage()
           
 long getMemoryLimit()
           
 int getMemoryPercentUsage()
           
 String getOpenWireURL()
          Deprecated. use getTransportConnectors() or getTransportConnectorByType(String)
 ObjectName[] getQueueProducers()
           
 ObjectName[] getQueues()
           
 ObjectName[] getQueueSubscribers()
           
 String getSslURL()
          Deprecated. use getTransportConnectors() or getTransportConnectorByType(String)
 String getStompSslURL()
          Deprecated. use getTransportConnectors() or getTransportConnectorByType(String)
 String getStompURL()
          Deprecated. use getTransportConnectors() or getTransportConnectorByType(String)
 long getStoreLimit()
           
 int getStorePercentUsage()
           
 long getTempLimit()
           
 ObjectName[] getTemporaryQueueProducers()
           
 ObjectName[] getTemporaryQueues()
           
 ObjectName[] getTemporaryQueueSubscribers()
           
 ObjectName[] getTemporaryTopicProducers()
           
 ObjectName[] getTemporaryTopics()
           
 ObjectName[] getTemporaryTopicSubscribers()
           
 int getTempPercentUsage()
           
 ObjectName[] getTopicProducers()
           
 ObjectName[] getTopics()
           
 ObjectName[] getTopicSubscribers()
           
 long getTotalConsumerCount()
           
 long getTotalDequeueCount()
           
 long getTotalEnqueueCount()
           
 long getTotalMessageCount()
           
 long getTotalProducerCount()
           
 String getTransportConnectorByType(String type)
           
 Map<String,String> getTransportConnectors()
           
 String getUptime()
           
 String getVMURL()
           
 boolean isPersistent()
           
 boolean isStatisticsEnabled()
           
 void reloadLog4jProperties()
          Reloads log4j.properties from the classpath.
 boolean removeConnector(String connectorName)
           
 boolean removeNetworkConnector(String connectorName)
           
 void removeQueue(String name)
          Removes a Queue destination from the broker.
 void removeTopic(String name)
          Removes a Topic destination from the broker.
 void resetStatistics()
           
 void setJobSchedulerStoreLimit(long limit)
           
 void setMemoryLimit(long limit)
           
 void setStoreLimit(long limit)
           
 void setTempLimit(long limit)
           
 void stop()
          Stop the broker and all it's components.
 void stopGracefully(String connectorName, String queueName, long timeout, long pollInterval)
           
 void terminateJVM(int exitCode)
          Shuts down the JVM.
 
Methods inherited from interface org.apache.activemq.Service
start
 

Method Detail

getBrokerId

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

getBrokerName

String getBrokerName()
Returns:
The name of the broker.

getBrokerVersion

String getBrokerVersion()
Returns:
The name of the broker.

getUptime

String getUptime()
Returns:
Uptime of the broker.

gc

void gc()
        throws Exception
The Broker will flush it's caches so that the garbage collector can reclaim more memory.

Throws:
Exception

resetStatistics

void resetStatistics()

enableStatistics

void enableStatistics()

disableStatistics

void disableStatistics()

isStatisticsEnabled

boolean isStatisticsEnabled()

getTotalEnqueueCount

long getTotalEnqueueCount()

getTotalDequeueCount

long getTotalDequeueCount()

getTotalConsumerCount

long getTotalConsumerCount()

getTotalProducerCount

long getTotalProducerCount()

getTotalMessageCount

long getTotalMessageCount()

getMemoryPercentUsage

int getMemoryPercentUsage()

getMemoryLimit

long getMemoryLimit()

setMemoryLimit

void setMemoryLimit(long limit)

getStorePercentUsage

int getStorePercentUsage()

getStoreLimit

long getStoreLimit()

setStoreLimit

void setStoreLimit(long limit)

getTempPercentUsage

int getTempPercentUsage()

getTempLimit

long getTempLimit()

setTempLimit

void setTempLimit(long limit)

getJobSchedulerStorePercentUsage

int getJobSchedulerStorePercentUsage()

getJobSchedulerStoreLimit

long getJobSchedulerStoreLimit()

setJobSchedulerStoreLimit

void setJobSchedulerStoreLimit(long limit)

isPersistent

boolean isPersistent()

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 Exception
Stop the broker and all it's components.

Specified by:
stop in interface Service
Throws:
Exception

stopGracefully

void stopGracefully(String connectorName,
                    String queueName,
                    long timeout,
                    long pollInterval)
                    throws Exception
Throws:
Exception

getTopics

ObjectName[] getTopics()

getQueues

ObjectName[] getQueues()

getTemporaryTopics

ObjectName[] getTemporaryTopics()

getTemporaryQueues

ObjectName[] getTemporaryQueues()

getTopicSubscribers

ObjectName[] getTopicSubscribers()

getDurableTopicSubscribers

ObjectName[] getDurableTopicSubscribers()

getInactiveDurableTopicSubscribers

ObjectName[] getInactiveDurableTopicSubscribers()

getQueueSubscribers

ObjectName[] getQueueSubscribers()

getTemporaryTopicSubscribers

ObjectName[] getTemporaryTopicSubscribers()

getTemporaryQueueSubscribers

ObjectName[] getTemporaryQueueSubscribers()

getTopicProducers

ObjectName[] getTopicProducers()

getQueueProducers

ObjectName[] getQueueProducers()

getTemporaryTopicProducers

ObjectName[] getTemporaryTopicProducers()

getTemporaryQueueProducers

ObjectName[] getTemporaryQueueProducers()

getDynamicDestinationProducers

ObjectName[] getDynamicDestinationProducers()

addConnector

String addConnector(String discoveryAddress)
                    throws Exception
Throws:
Exception

addNetworkConnector

String addNetworkConnector(String discoveryAddress)
                           throws Exception
Throws:
Exception

removeConnector

boolean removeConnector(String connectorName)
                        throws Exception
Throws:
Exception

removeNetworkConnector

boolean removeNetworkConnector(String connectorName)
                               throws Exception
Throws:
Exception

addTopic

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

Parameters:
name - The name of the Topic
Throws:
Exception

addQueue

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

Parameters:
name - The name of the Queue
Throws:
Exception

removeTopic

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

Parameters:
name - The name of the Topic
Throws:
Exception

removeQueue

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

Parameters:
name - The name of the Queue
Throws:
Exception

createDurableSubscriber

ObjectName createDurableSubscriber(String clientId,
                                   String subscriberName,
                                   String topicName,
                                   String selector)
                                   throws 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:
Exception

destroyDurableSubscriber

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

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

reloadLog4jProperties

void reloadLog4jProperties()
                           throws Throwable
Reloads log4j.properties from the classpath. This methods calls org.apache.activemq.transport.TransportLoggerControl.reloadLog4jProperties

Throws:
Throwable

getOpenWireURL

@Deprecated
String getOpenWireURL()
Deprecated. use getTransportConnectors() or getTransportConnectorByType(String)


getStompURL

@Deprecated
String getStompURL()
Deprecated. use getTransportConnectors() or getTransportConnectorByType(String)


getSslURL

@Deprecated
String getSslURL()
Deprecated. use getTransportConnectors() or getTransportConnectorByType(String)


getStompSslURL

@Deprecated
String getStompSslURL()
Deprecated. use getTransportConnectors() or getTransportConnectorByType(String)


getVMURL

String getVMURL()

getTransportConnectors

Map<String,String> getTransportConnectors()

getTransportConnectorByType

String getTransportConnectorByType(String type)

getDataDirectory

String getDataDirectory()

getJMSJobScheduler

ObjectName getJMSJobScheduler()


Copyright © 2005-2013 The Apache Software Foundation. All Rights Reserved.