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

Methods

Modifier and Type	Method and Description
java.lang.String	addConnector(java.lang.String discoveryAddress)
java.lang.String	addNetworkConnector(java.lang.String discoveryAddress)
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	disableStatistics()
void	enableStatistics()
void	gc() The Broker will flush it's caches so that the garbage collector can reclaim more memory.
long	getAverageMessageSize()
java.lang.String	getBrokerId()
java.lang.String	getBrokerName()
java.lang.String	getBrokerVersion()
int	getCurrentConnectionsCount()
java.lang.String	getDataDirectory()
javax.management.ObjectName[]	getDurableTopicSubscribers()
javax.management.ObjectName[]	getDynamicDestinationProducers()
javax.management.ObjectName[]	getInactiveDurableTopicSubscribers()
javax.management.ObjectName	getJMSJobScheduler()
long	getJobSchedulerStoreLimit()
int	getJobSchedulerStorePercentUsage()
long	getMaxMessageSize()
long	getMemoryLimit()
int	getMemoryPercentUsage()
long	getMinMessageSize()
java.lang.String	getOpenWireURL() Deprecated. use getTransportConnectors() or getTransportConnectorByType(String)
javax.management.ObjectName[]	getQueueProducers()
javax.management.ObjectName[]	getQueues()
javax.management.ObjectName[]	getQueueSubscribers()
java.lang.String	getSslURL() Deprecated. use getTransportConnectors() or getTransportConnectorByType(String)
java.lang.String	getStompSslURL() Deprecated. use getTransportConnectors() or getTransportConnectorByType(String)
java.lang.String	getStompURL() Deprecated. use getTransportConnectors() or getTransportConnectorByType(String)
long	getStoreLimit()
int	getStorePercentUsage()
long	getTempLimit()
javax.management.ObjectName[]	getTemporaryQueueProducers()
javax.management.ObjectName[]	getTemporaryQueues()
javax.management.ObjectName[]	getTemporaryQueueSubscribers()
javax.management.ObjectName[]	getTemporaryTopicProducers()
javax.management.ObjectName[]	getTemporaryTopics()
javax.management.ObjectName[]	getTemporaryTopicSubscribers()
int	getTempPercentUsage()
javax.management.ObjectName[]	getTopicProducers()
javax.management.ObjectName[]	getTopics()
javax.management.ObjectName[]	getTopicSubscribers()
long	getTotalConnectionsCount()
long	getTotalConsumerCount()
long	getTotalDequeueCount()
long	getTotalEnqueueCount()
long	getTotalMessageCount()
long	getTotalProducerCount()
java.lang.String	getTransportConnectorByType(java.lang.String type)
java.util.Map<java.lang.String,java.lang.String>	getTransportConnectors()
java.lang.String	getUptime()
java.lang.String	getVMURL()
boolean	isPersistent()
boolean	isSlave()
boolean	isStatisticsEnabled()
void	reloadLog4jProperties() Reloads log4j.properties from the classpath.
boolean	removeConnector(java.lang.String connectorName)
boolean	removeNetworkConnector(java.lang.String connectorName)
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	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(java.lang.String connectorName, java.lang.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

java.lang.String getBrokerId()

Returns:

The unique id of the broker.

getBrokerName

java.lang.String getBrokerName()

Returns:

The name of the broker.

getBrokerVersion

java.lang.String getBrokerVersion()

Returns:

The name of the broker.

getUptime

java.lang.String getUptime()

Returns:

Uptime of the broker.

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 java.lang.Exception

The Broker will flush it's caches so that the garbage collector can reclaim more memory.

Throws:

java.lang.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 java.lang.Exception

Stop the broker and all it's components.

Specified by:

stop in interface Service

Throws:

java.lang.Exception

restart

void restart()
             throws java.lang.Exception

Restart the broker and all it's components.

Throws:

java.lang.Exception

stopGracefully

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

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

getTopicProducers

javax.management.ObjectName[] getTopicProducers()

getQueueProducers

javax.management.ObjectName[] getQueueProducers()

getTemporaryTopicProducers

javax.management.ObjectName[] getTemporaryTopicProducers()

getTemporaryQueueProducers

javax.management.ObjectName[] getTemporaryQueueProducers()

getDynamicDestinationProducers

javax.management.ObjectName[] getDynamicDestinationProducers()

addConnector

java.lang.String addConnector(java.lang.String discoveryAddress)
                              throws java.lang.Exception

Throws:

java.lang.Exception

addNetworkConnector

java.lang.String addNetworkConnector(java.lang.String discoveryAddress)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

removeConnector

boolean removeConnector(java.lang.String connectorName)
                        throws java.lang.Exception

Throws:

java.lang.Exception

removeNetworkConnector

boolean removeNetworkConnector(java.lang.String connectorName)
                               throws java.lang.Exception

Throws:

java.lang.Exception

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

reloadLog4jProperties

void reloadLog4jProperties()
                           throws java.lang.Throwable

Reloads log4j.properties from the classpath. This methods calls org.apache.activemq.transport.TransportLoggerControl.reloadLog4jProperties

Throws:

java.lang.Throwable

getOpenWireURL

@Deprecated
java.lang.String getOpenWireURL()

Deprecated. use getTransportConnectors() or getTransportConnectorByType(String)

getStompURL

@Deprecated
java.lang.String getStompURL()

Deprecated. use getTransportConnectors() or getTransportConnectorByType(String)

getSslURL

@Deprecated
java.lang.String getSslURL()

Deprecated. use getTransportConnectors() or getTransportConnectorByType(String)

getStompSslURL

@Deprecated
java.lang.String getStompSslURL()

Deprecated. use getTransportConnectors() or getTransportConnectorByType(String)

getVMURL

java.lang.String getVMURL()

getTransportConnectors

java.util.Map<java.lang.String,java.lang.String> getTransportConnectors()

getTransportConnectorByType

java.lang.String getTransportConnectorByType(java.lang.String type)

getDataDirectory

java.lang.String getDataDirectory()

getJMSJobScheduler

javax.management.ObjectName getJMSJobScheduler()