Package 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
Modifier and TypeMethodDescriptionorg.apache.activemq.broker.jmx.BrokerViewMBeanAdmin view of the broker.The name of the active broker (f.e.org.apache.activemq.broker.jmx.ConnectionViewMBeangetConnection(String connectionName) A specific connection to the broker.Collection<org.apache.activemq.broker.jmx.ConnectionViewMBean>All connections to all transport connectors of the broker.getConnections(String connectorName) The names of all connections to a specific transport connectors of the broker.org.apache.activemq.broker.jmx.ConnectorViewMBeangetConnector(String name) A transport connectors.The names of all transport connectors of the broker (f.e. openwire, ssl)Collection<org.apache.activemq.broker.jmx.SubscriptionViewMBean>getConsumersOnConnection(String connectionName) Returns all consumers of a connection.Collection<org.apache.activemq.broker.jmx.DurableSubscriptionViewMBean>Active durable subscribers to topics of the broker.Collection<org.apache.activemq.broker.jmx.DurableSubscriptionViewMBean>Inactive durable subscribers to topics of the broker.org.apache.activemq.broker.jmx.JobSchedulerViewMBeanGet the JobScheduler MBeanCollection<org.apache.activemq.broker.jmx.NetworkBridgeViewMBean>The brokers network bridges.Collection<org.apache.activemq.broker.jmx.NetworkConnectorViewMBean>The brokers network connectors.Collection<org.apache.activemq.broker.jmx.SubscriptionViewMBean>All active non-durable subscribers to a topic.org.apache.activemq.broker.jmx.QueueViewMBeanGet the view of the queue with the specified name.Collection<org.apache.activemq.broker.jmx.SubscriptionViewMBean>getQueueConsumers(String queueName) All active consumers of a queue.Collection<org.apache.activemq.broker.jmx.ProducerViewMBean>getQueueProducers(String queueName) All active producers to a queue.Collection<org.apache.activemq.broker.jmx.QueueViewMBean>All queues known to the broker.Get the JobScheduler MBeanorg.apache.activemq.broker.jmx.TopicViewMBeanGet the view of the topic with the specified name.Collection<org.apache.activemq.broker.jmx.ProducerViewMBean>getTopicProducers(String queueName) All active producers to a topic.Collection<org.apache.activemq.broker.jmx.TopicViewMBean>All topics known to the broker.Collection<org.apache.activemq.broker.jmx.SubscriptionViewMBean>getTopicSubscribers(String topicName) All active non-durable subscribers to a topic.booleanvoidpurgeQueue(org.apache.activemq.command.ActiveMQDestination destination) Purges the given destination
-
Method Details
-
getBrokerName
The name of the active broker (f.e. 'localhost' or 'my broker').- Returns:
- not
null - Throws:
Exception
-
getBrokerAdmin
Admin view of the broker.- Returns:
- not
null - Throws:
Exception
-
getQueues
All queues known to the broker.- Returns:
- not
null - Throws:
Exception
-
getTopics
All topics known to the broker.- Returns:
- not
null - Throws:
Exception
-
getQueueConsumers
Collection<org.apache.activemq.broker.jmx.SubscriptionViewMBean> getQueueConsumers(String queueName) throws Exception All active consumers of a queue.- Parameters:
queueName- the name of the queue, notnull- Returns:
- not
null - Throws:
Exception
-
getQueueProducers
Collection<org.apache.activemq.broker.jmx.ProducerViewMBean> getQueueProducers(String queueName) throws Exception All active producers to a queue.- Parameters:
queueName- the name of the queue, notnull- Returns:
- not
null - Throws:
Exception
-
getTopicProducers
Collection<org.apache.activemq.broker.jmx.ProducerViewMBean> getTopicProducers(String queueName) throws Exception All active producers to a topic.- Parameters:
queueName- the name of the topic, notnull- Returns:
- not
null - Throws:
Exception
-
getTopicSubscribers
Collection<org.apache.activemq.broker.jmx.SubscriptionViewMBean> getTopicSubscribers(String topicName) throws Exception All active non-durable subscribers to a topic.- Parameters:
topicName- the name of the topic, notnull- Returns:
- not
null - Throws:
Exception
-
getNonDurableTopicSubscribers
Collection<org.apache.activemq.broker.jmx.SubscriptionViewMBean> getNonDurableTopicSubscribers() throws ExceptionAll active non-durable subscribers to a topic.- Returns:
- not
null - Throws:
Exception
-
getDurableTopicSubscribers
Collection<org.apache.activemq.broker.jmx.DurableSubscriptionViewMBean> getDurableTopicSubscribers() throws ExceptionActive durable subscribers to topics of the broker.- Returns:
- not
null - Throws:
Exception
-
getInactiveDurableTopicSubscribers
Collection<org.apache.activemq.broker.jmx.DurableSubscriptionViewMBean> getInactiveDurableTopicSubscribers() throws ExceptionInactive durable subscribers to topics of the broker.- Returns:
- not
null - Throws:
Exception
-
getConnectors
The names of all transport connectors of the broker (f.e. openwire, ssl)- Returns:
- not
null - Throws:
Exception
-
getConnector
A transport connectors.- Parameters:
name- name of the connector (f.e. openwire)- Returns:
nullif not found- Throws:
Exception
-
getConnections
All connections to all transport connectors of the broker.- Returns:
- not
null - Throws:
Exception
-
getConnections
The names of all connections to a specific transport connectors of the broker.- Parameters:
connectorName- notnull- Returns:
- not
null - Throws:
Exception- See Also:
-
getConnection
org.apache.activemq.broker.jmx.ConnectionViewMBean getConnection(String connectionName) throws Exception A specific connection to the broker.- Parameters:
connectionName- the name of the connection, notnull- Returns:
- not
null - Throws:
Exception
-
getConsumersOnConnection
Collection<org.apache.activemq.broker.jmx.SubscriptionViewMBean> getConsumersOnConnection(String connectionName) throws Exception Returns all consumers of a connection.- Parameters:
connectionName- the name of the connection, notnull- Returns:
- not
null - Throws:
Exception
-
getNetworkConnectors
Collection<org.apache.activemq.broker.jmx.NetworkConnectorViewMBean> getNetworkConnectors() throws ExceptionThe brokers network connectors.- Returns:
- not
null - Throws:
Exception
-
getNetworkBridges
Collection<org.apache.activemq.broker.jmx.NetworkBridgeViewMBean> getNetworkBridges() throws ExceptionThe brokers network bridges.- Returns:
- not
null - Throws:
Exception
-
purgeQueue
Purges the given destination- Parameters:
destination-- Throws:
Exception
-
getQueue
Get the view of the queue with the specified name.- Parameters:
name- notnull- Returns:
nullif no queue with this name exists- Throws:
Exception
-
getTopic
Get the view of the topic with the specified name.- Parameters:
name- notnull- Returns:
nullif no topic with this name exists- Throws:
Exception
-
getJobScheduler
Get the JobScheduler MBean- Returns:
- the jobScheduler or null if not configured
- Throws:
Exception
-
getScheduledJobs
Get the JobScheduler MBean- Returns:
- the jobScheduler or null if not configured
- Throws:
Exception
-
isJobSchedulerStarted
boolean isJobSchedulerStarted()
-