org.fusesource.fabric.activemq.facade
Interface BrokerFacade

All Known Implementing Classes:

BrokerFacadeSupport, JMXConnectorBrokerFacade, JmxTemplateBrokerFacade, LocalBrokerFacade, RemoteBrokerFacade, RemoteBrokerFacadeSupport, SingletonBrokerFacade

public interface BrokerFacade

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

Method Summary

BrokerViewFacade	getBrokerAdmin() Admin view of the broker.
java.lang.String	getBrokerName() The name of the active broker (f.e.
BrokerFacade[]	getBrokers() Returns all the available brokers.
ConnectionViewFacade	getConnection(java.lang.String connectionName) A specific connection to the broker.
java.util.Collection<ConnectionViewFacade>	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.
ConnectorViewFacade	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<SubscriptionViewFacade>	getConsumersOnConnection(java.lang.String connectionName) Returns all consumers of a connection.
java.util.Collection<DurableSubscriptionViewFacade>	getDurableTopicSubscribers() Active durable subscribers to topics of the broker.
java.lang.String	getId()
java.util.Collection<DurableSubscriptionViewFacade>	getInactiveDurableTopicSubscribers() Inactive durable subscribers to topics of the broker.
JobSchedulerViewFacade	getJobScheduler() Get the JobScheduler MBean
java.util.Collection<NetworkBridgeViewFacade>	getNetworkBridges() The brokers network bridges.
java.util.Collection<NetworkConnectorViewFacade>	getNetworkConnectors() The brokers network connectors.
QueueViewFacade	getQueue(java.lang.String name) Get the view of the queue with the specified name.
java.util.Collection<SubscriptionViewFacade>	getQueueConsumers(java.lang.String queueName) All active consumers of a queue.
java.util.Collection<ProducerViewFacade>	getQueueProducers(java.lang.String queueName) Returns the producers available on the given queue
java.util.Collection<QueueViewFacade>	getQueues() All queues known to the broker.
java.util.Collection<JobFacade>	getScheduledJobs() Get the JobScheduler MBean
TopicViewFacade	getTopic(java.lang.String name) Get the view of the topic with the specified name.
java.util.Collection<SubscriptionViewFacade>	getTopicConsumers(java.lang.String topicName) Returns the consumers available on the given topic
java.util.Collection<DurableSubscriptionViewFacade>	getTopicDurableConsumers(java.lang.String topicName) Returns the durable consumers available on the given topic
java.util.Collection<ProducerViewFacade>	getTopicProducers(java.lang.String topicName) Returns the producers available on the given topic
java.util.Collection<TopicViewFacade>	getTopics() All topics known to the broker.
boolean	isJobSchedulerStarted()
void	purgeQueue(org.apache.activemq.command.ActiveMQDestination destination) Purges the given destination

Method Detail

getId

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

Returns:

a unique id for this resource, typically a JMX ObjectName

Throws:

java.lang.Exception

getBrokers

BrokerFacade[] getBrokers()
                          throws java.lang.Exception

Returns all the available brokers.

Returns:

not null

Throws:

java.lang.Exception

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

BrokerViewFacade getBrokerAdmin()
                                throws java.lang.Exception

Admin view of the broker.

Returns:

not null

Throws:

java.lang.Exception

getQueues

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

All queues known to the broker.

Returns:

not null

Throws:

java.lang.Exception

getTopics

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

All topics known to the broker.

Returns:

not null

Throws:

java.lang.Exception

getQueueConsumers

java.util.Collection<SubscriptionViewFacade> 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

getTopicConsumers

java.util.Collection<SubscriptionViewFacade> getTopicConsumers(java.lang.String topicName)
                                                               throws java.lang.Exception

Returns the consumers available on the given topic

Throws:

java.lang.Exception

getTopicDurableConsumers

java.util.Collection<DurableSubscriptionViewFacade> getTopicDurableConsumers(java.lang.String topicName)
                                                                             throws java.lang.Exception

Returns the durable consumers available on the given topic

Throws:

java.lang.Exception

getQueueProducers

java.util.Collection<ProducerViewFacade> getQueueProducers(java.lang.String queueName)
                                                           throws java.lang.Exception

Returns the producers available on the given queue

Throws:

java.lang.Exception

getTopicProducers

java.util.Collection<ProducerViewFacade> getTopicProducers(java.lang.String topicName)
                                                           throws java.lang.Exception

Returns the producers available on the given topic

Throws:

java.lang.Exception

getDurableTopicSubscribers

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

Active durable subscribers to topics of the broker.

Returns:

not null

Throws:

java.lang.Exception

getInactiveDurableTopicSubscribers

java.util.Collection<DurableSubscriptionViewFacade> 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

ConnectorViewFacade 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<ConnectionViewFacade> 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

ConnectionViewFacade 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<SubscriptionViewFacade> 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<NetworkConnectorViewFacade> getNetworkConnectors()
                                                                      throws java.lang.Exception

The brokers network connectors.

Returns:

not null

Throws:

java.lang.Exception

getNetworkBridges

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

The brokers network bridges.

Returns:

not null

Throws:

java.lang.Exception

purgeQueue

void purgeQueue(org.apache.activemq.command.ActiveMQDestination destination)
                throws java.lang.Exception

Purges the given destination

Parameters:

destination -

Throws:

java.lang.Exception

getQueue

QueueViewFacade 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

TopicViewFacade 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

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