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 Details

    • getBrokerName

      String getBrokerName() throws Exception
      The name of the active broker (f.e. 'localhost' or 'my broker').
      Returns:
      not null
      Throws:
      Exception
    • getBrokerAdmin

      org.apache.activemq.broker.jmx.BrokerViewMBean getBrokerAdmin() throws Exception
      Admin view of the broker.
      Returns:
      not null
      Throws:
      Exception
    • getQueues

      Collection<org.apache.activemq.broker.jmx.QueueViewMBean> getQueues() throws Exception
      All queues known to the broker.
      Returns:
      not null
      Throws:
      Exception
    • getTopics

      Collection<org.apache.activemq.broker.jmx.TopicViewMBean> getTopics() throws Exception
      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, not null
      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, not null
      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, not null
      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, not null
      Returns:
      not null
      Throws:
      Exception
    • getNonDurableTopicSubscribers

      Collection<org.apache.activemq.broker.jmx.SubscriptionViewMBean> getNonDurableTopicSubscribers() throws Exception
      All active non-durable subscribers to a topic.
      Returns:
      not null
      Throws:
      Exception
    • getDurableTopicSubscribers

      Collection<org.apache.activemq.broker.jmx.DurableSubscriptionViewMBean> getDurableTopicSubscribers() throws Exception
      Active durable subscribers to topics of the broker.
      Returns:
      not null
      Throws:
      Exception
    • getInactiveDurableTopicSubscribers

      Collection<org.apache.activemq.broker.jmx.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

      org.apache.activemq.broker.jmx.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<org.apache.activemq.broker.jmx.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

      org.apache.activemq.broker.jmx.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<org.apache.activemq.broker.jmx.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<org.apache.activemq.broker.jmx.NetworkConnectorViewMBean> getNetworkConnectors() throws Exception
      The brokers network connectors.
      Returns:
      not null
      Throws:
      Exception
    • getNetworkBridges

      Collection<org.apache.activemq.broker.jmx.NetworkBridgeViewMBean> getNetworkBridges() throws Exception
      The brokers network bridges.
      Returns:
      not null
      Throws:
      Exception
    • purgeQueue

      void purgeQueue(org.apache.activemq.command.ActiveMQDestination destination) throws Exception
      Purges the given destination
      Parameters:
      destination -
      Throws:
      Exception
    • getQueue

      org.apache.activemq.broker.jmx.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

      org.apache.activemq.broker.jmx.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

      org.apache.activemq.broker.jmx.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()