org.apache.activemq.web

Interface BrokerFacade

All Known Implementing Classes:

BrokerFacadeSupport, LocalBrokerFacade, RemoteJMXBrokerFacade, SingletonBrokerFacade

public interface BrokerFacade

A facade for either a local in JVM broker or a remote broker over JMX

Method Summary

Methods

Modifier and Type	Method and Description
BrokerViewMBean	getBrokerAdmin() Admin view of the broker.
java.lang.String	getBrokerName() The name of the active broker (f.e.
ConnectionViewMBean	getConnection(java.lang.String connectionName) A specific connection to the broker.
java.util.Collection<ConnectionViewMBean>	getConnections() All connections to all transport connectors of the broker.
java.util.Collection<java.lang.String>	getConnections(java.lang.String connectorName) The names of all connections to a specific transport connectors of the broker.
ConnectorViewMBean	getConnector(java.lang.String name) A transport connectors.
java.util.Collection<java.lang.String>	getConnectors() The names of all transport connectors of the broker (f.e.
java.util.Collection<SubscriptionViewMBean>	getConsumersOnConnection(java.lang.String connectionName) Returns all consumers of a connection.
java.util.Collection<DurableSubscriptionViewMBean>	getDurableTopicSubscribers() Active durable subscribers to topics of the broker.
java.util.Collection<DurableSubscriptionViewMBean>	getInactiveDurableTopicSubscribers() Inactive durable subscribers to topics of the broker.
JobSchedulerViewMBean	getJobScheduler() Get the JobScheduler MBean
java.util.Collection<NetworkBridgeViewMBean>	getNetworkBridges() The brokers network bridges.
java.util.Collection<NetworkConnectorViewMBean>	getNetworkConnectors() The brokers network connectors.
QueueViewMBean	getQueue(java.lang.String name) Get the view of the queue with the specified name.
java.util.Collection<SubscriptionViewMBean>	getQueueConsumers(java.lang.String queueName) All active consumers of a queue.
java.util.Collection<QueueViewMBean>	getQueues() All queues known to the broker.
java.util.Collection<JobFacade>	getScheduledJobs() Get the JobScheduler MBean
TopicViewMBean	getTopic(java.lang.String name) Get the view of the topic with the specified name.
java.util.Collection<TopicViewMBean>	getTopics() All topics known to the broker.
boolean	isJobSchedulerStarted()
void	purgeQueue(ActiveMQDestination destination) Purges the given destination

Method Detail

getBrokerName

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

The name of the active broker (f.e. 'localhost' or 'my broker').

Returns:

not null

Throws:

java.lang.Exception

getBrokerAdmin

BrokerViewMBean getBrokerAdmin()
                               throws java.lang.Exception

Admin view of the broker.

Returns:

not null

Throws:

java.lang.Exception

getQueues

java.util.Collection<QueueViewMBean> getQueues()
                                               throws java.lang.Exception

All queues known to the broker.

Returns:

not null

Throws:

java.lang.Exception

getTopics

java.util.Collection<TopicViewMBean> getTopics()
                                               throws java.lang.Exception

All topics known to the broker.

Returns:

not null

Throws:

java.lang.Exception

getQueueConsumers

java.util.Collection<SubscriptionViewMBean> getQueueConsumers(java.lang.String queueName)
                                                              throws java.lang.Exception

All active consumers of a queue.

Parameters:

queueName - the name of the queue, not null

Returns:

not null

Throws:

java.lang.Exception

getDurableTopicSubscribers

java.util.Collection<DurableSubscriptionViewMBean> getDurableTopicSubscribers()
                                                                              throws java.lang.Exception

Active durable subscribers to topics of the broker.

Returns:

not null

Throws:

java.lang.Exception

getInactiveDurableTopicSubscribers

java.util.Collection<DurableSubscriptionViewMBean> getInactiveDurableTopicSubscribers()
                                                                                      throws java.lang.Exception

Inactive durable subscribers to topics of the broker.

Returns:

not null

Throws:

java.lang.Exception

getConnectors

java.util.Collection<java.lang.String> getConnectors()
                                                     throws java.lang.Exception

The names of all transport connectors of the broker (f.e. openwire, ssl)

Returns:

not null

Throws:

java.lang.Exception

getConnector

ConnectorViewMBean getConnector(java.lang.String name)
                                throws java.lang.Exception

A transport connectors.

Parameters:

name - name of the connector (f.e. openwire)

Returns:

null if not found

Throws:

java.lang.Exception

getConnections

java.util.Collection<ConnectionViewMBean> getConnections()
                                                         throws java.lang.Exception

All connections to all transport connectors of the broker.

Returns:

not null

Throws:

java.lang.Exception

getConnections

java.util.Collection<java.lang.String> getConnections(java.lang.String connectorName)
                                                      throws java.lang.Exception

The names of all connections to a specific transport connectors of the broker.

Parameters:

connectorName - not null

Returns:

not null

Throws:

java.lang.Exception

See Also:

getConnection(String)

getConnection

ConnectionViewMBean getConnection(java.lang.String connectionName)
                                  throws java.lang.Exception

A specific connection to the broker.

Parameters:

connectionName - the name of the connection, not null

Returns:

not null

Throws:

java.lang.Exception

getConsumersOnConnection

java.util.Collection<SubscriptionViewMBean> getConsumersOnConnection(java.lang.String connectionName)
                                                                     throws java.lang.Exception

Returns all consumers of a connection.

Parameters:

connectionName - the name of the connection, not null

Returns:

not null

Throws:

java.lang.Exception

getNetworkConnectors

java.util.Collection<NetworkConnectorViewMBean> getNetworkConnectors()
                                                                     throws java.lang.Exception

The brokers network connectors.

Returns:

not null

Throws:

java.lang.Exception

getNetworkBridges

java.util.Collection<NetworkBridgeViewMBean> getNetworkBridges()
                                                               throws java.lang.Exception

The brokers network bridges.

Returns:

not null

Throws:

java.lang.Exception

purgeQueue

void purgeQueue(ActiveMQDestination destination)
                throws java.lang.Exception

Purges the given destination

Parameters:

destination -

Throws:

java.lang.Exception

getQueue

QueueViewMBean getQueue(java.lang.String name)
                        throws java.lang.Exception

Get the view of the queue with the specified name.

Parameters:

name - not null

Returns:

null if no queue with this name exists

Throws:

java.lang.Exception

getTopic

TopicViewMBean getTopic(java.lang.String name)
                        throws java.lang.Exception

Get the view of the topic with the specified name.

Parameters:

name - not null

Returns:

null if no topic with this name exists

Throws:

java.lang.Exception

getJobScheduler

JobSchedulerViewMBean getJobScheduler()
                                      throws java.lang.Exception

Get the JobScheduler MBean

Returns:

the jobScheduler or null if not configured

Throws:

java.lang.Exception

getScheduledJobs

java.util.Collection<JobFacade> getScheduledJobs()
                                                 throws java.lang.Exception

Get the JobScheduler MBean

Returns:

the jobScheduler or null if not configured

Throws:

java.lang.Exception

isJobSchedulerStarted

boolean isJobSchedulerStarted()