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

Method Detail

getBrokerName

String getBrokerName()
                     throws Exception
The name of the active broker (f.e. 'localhost' or 'my broker').

Returns:
not null
Throws:
Exception

getBrokerAdmin

BrokerViewMBean getBrokerAdmin()
                               throws Exception
Admin view of the broker.

Returns:
not null
Throws:
Exception

getQueues

Collection<QueueViewMBean> getQueues()
                                     throws Exception
All queues known to the broker.

Returns:
not null
Throws:
Exception

getTopics

Collection<TopicViewMBean> getTopics()
                                     throws Exception
All topics known to the broker.

Returns:
not null
Throws:
Exception

getQueueConsumers

Collection<SubscriptionViewMBean> getQueueConsumers(String queueName)
                                                    throws Exception
All active consumers of a queue.

Parameters:
queueName - the name of the queue, not null
Returns:
not null
Throws:
Exception

getDurableTopicSubscribers

Collection<DurableSubscriptionViewMBean> getDurableTopicSubscribers()
                                                                    throws Exception
Active durable subscribers to topics of the broker.

Returns:
not null
Throws:
Exception

getInactiveDurableTopicSubscribers

Collection<DurableSubscriptionViewMBean> getInactiveDurableTopicSubscribers()
                                                                            throws Exception
Inactive durable subscribers to topics of the broker.

Returns:
not null
Throws:
Exception

getConnectors

Collection<String> getConnectors()
                                 throws Exception
The names of all transport connectors of the broker (f.e. openwire, ssl)

Returns:
not null
Throws:
Exception

getConnector

ConnectorViewMBean getConnector(String name)
                                throws Exception
A transport connectors.

Parameters:
name - name of the connector (f.e. openwire)
Returns:
null if not found
Throws:
Exception

getConnections

Collection<ConnectionViewMBean> getConnections()
                                               throws Exception
All connections to all transport connectors of the broker.

Returns:
not null
Throws:
Exception

getConnections

Collection<String> getConnections(String connectorName)
                                  throws Exception
The names of all connections to a specific transport connectors of the broker.

Parameters:
connectorName - not null
Returns:
not null
Throws:
Exception
See Also:
getConnection(String)

getConnection

ConnectionViewMBean getConnection(String connectionName)
                                  throws Exception
A specific connection to the broker.

Parameters:
connectionName - the name of the connection, not null
Returns:
not null
Throws:
Exception

getConsumersOnConnection

Collection<SubscriptionViewMBean> getConsumersOnConnection(String connectionName)
                                                           throws Exception
Returns all consumers of a connection.

Parameters:
connectionName - the name of the connection, not null
Returns:
not null
Throws:
Exception

getNetworkConnectors

Collection<NetworkConnectorViewMBean> getNetworkConnectors()
                                                           throws Exception
The brokers network connectors.

Returns:
not null
Throws:
Exception

getNetworkBridges

Collection<NetworkBridgeViewMBean> getNetworkBridges()
                                                     throws Exception
The brokers network bridges.

Returns:
not null
Throws:
Exception

purgeQueue

void purgeQueue(ActiveMQDestination destination)
                throws Exception
Purges the given destination

Parameters:
destination -
Throws:
Exception

getQueue

QueueViewMBean getQueue(String name)
                        throws 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:
Exception

getTopic

TopicViewMBean getTopic(String name)
                        throws 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:
Exception

getJobScheduler

JobSchedulerViewMBean getJobScheduler()
                                      throws Exception
Get the JobScheduler MBean

Returns:
the jobScheduler or null if not configured
Throws:
Exception

getScheduledJobs

Collection<JobFacade> getScheduledJobs()
                                       throws Exception
Get the JobScheduler MBean

Returns:
the jobScheduler or null if not configured
Throws:
Exception

isJobSchedulerStarted

boolean isJobSchedulerStarted()


Copyright © 2005–2013 The Apache Software Foundation. All rights reserved.