Package org.apache.activemq.broker.jmx

Interface BrokerViewMBean

All Superinterfaces:

Service

All Known Implementing Classes:

BrokerView

public interface BrokerViewMBean
extends Service

Method Summary

Modifier and Type	Method	Description
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.
CompositeData[]	browseQueue(String queueName)
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.
long	getAverageMessageSize()
String	getBrokerId()
String	getBrokerName()
String	getBrokerVersion()
int	getCurrentConnectionsCount()
String	getDataDirectory()
ObjectName[]	getDurableTopicSubscribers()
ObjectName[]	getDynamicDestinationProducers()
ObjectName[]	getInactiveDurableTopicSubscribers()
ObjectName	getJMSJobScheduler()
long	getJobSchedulerStoreLimit()
int	getJobSchedulerStorePercentUsage()
long	getMaxMessageSize()
long	getMemoryLimit()
int	getMemoryPercentUsage()
long	getMinMessageSize()
ObjectName[]	getQueueProducers()
ObjectName[]	getQueues()
ObjectName[]	getQueueSubscribers()
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	getTotalConnectionsCount()
long	getTotalConsumerCount()
long	getTotalDequeueCount()
long	getTotalEnqueueCount()
long	getTotalMessageCount()
long	getTotalProducerCount()
String	getTransportConnectorByType(String type)
Map<String,String>	getTransportConnectors()
String	getUptime()
long	getUptimeMillis()
String	getVMURL()
boolean	isPersistent()
boolean	isSlave()
boolean	isStatisticsEnabled()
String	queryQueues(String filter, int page, int pageSize)	Queue Query API, take a look at DestinationsViewFilter for more information
String	queryTopics(String filter, int page, int pageSize)	Topic Query API, take a look at DestinationsViewFilter for more information
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	restart()	Restart the broker and all it's components.
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.

getUptimeMillis

long getUptimeMillis()

Returns:

Uptime of the broker in milliseconds.

getCurrentConnectionsCount

int getCurrentConnectionsCount()

Returns:

The current number of active connections on this Broker.

getTotalConnectionsCount

long getTotalConnectionsCount()

Returns:

The total number of connections serviced since this Broker was started.

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()

getAverageMessageSize

long getAverageMessageSize()

getMaxMessageSize

long getMaxMessageSize()

getMinMessageSize

long getMinMessageSize()

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()

isSlave

boolean isSlave()

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

restart

void restart()
      throws Exception

Restart the broker and all it's components.

Throws:

Exception

stopGracefully

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

Throws:

Exception

getTopics

ObjectName[] getTopics()

getQueues

ObjectName[] getQueues()

queryQueues

String queryQueues(String filter,
                   int page,
                   int pageSize)
            throws IOException

Queue Query API, take a look at DestinationsViewFilter for more information

Throws:

IOException

queryTopics

String queryTopics(String filter,
                   int page,
                   int pageSize)
            throws IOException

Topic Query API, take a look at DestinationsViewFilter for more information

Throws:

IOException

browseQueue

CompositeData[] browseQueue(String queueName)
                     throws OpenDataException,
                            MalformedObjectNameException

Throws:

OpenDataException

MalformedObjectNameException

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

getVMURL

String getVMURL()

getTransportConnectors

Map<String,String> getTransportConnectors()

getTransportConnectorByType

String getTransportConnectorByType(String type)

getDataDirectory

String getDataDirectory()

getJMSJobScheduler

ObjectName getJMSJobScheduler()