org.apache.activemq.broker.region
Class RegionBroker

java.lang.Object
  org.apache.activemq.broker.region.RegionBroker

All Implemented Interfaces:

Broker, Region, Service

Direct Known Subclasses:

ManagedRegionBroker

public class RegionBroker
extends java.lang.Object
implements Broker

Routes Broker operations to the correct messaging regions for processing.

Version:

$Revision$

Field Summary

protected edu.emory.mathcs.backport.java.util.concurrent.ConcurrentHashMap	connectionStates
protected DestinationFactory	destinationFactory
protected DestinationStatistics	destinationStatistics

Constructor Summary

RegionBroker(BrokerService brokerService, TaskRunnerFactory taskRunnerFactory, UsageManager memoryManager, DestinationFactory destinationFactory, DestinationInterceptor destinationInterceptor)

Method Summary

void	acknowledge(ConnectionContext context, MessageAck ack) Used to acknowledge the receipt of a message by a client.
void	addBroker(Connection connection, BrokerInfo info) A remote Broker connects
void	addConnection(ConnectionContext context, ConnectionInfo info) A client is establishing a connection with the broker.
Subscription	addConsumer(ConnectionContext context, ConsumerInfo info) Adds a consumer.
Destination	addDestination(ConnectionContext context, ActiveMQDestination destination) Used to create a destination.
void	addDestinationInfo(ConnectionContext context, DestinationInfo info) Add and process a DestinationInfo object
void	addProducer(ConnectionContext context, ProducerInfo info) Adds a producer.
void	addSession(ConnectionContext context, SessionInfo info) Adds a session.
void	beginTransaction(ConnectionContext context, TransactionId xid) Starts a transaction.
void	commitTransaction(ConnectionContext context, TransactionId xid, boolean onePhase) Commits a transaction.
protected Region	createQueueRegion(UsageManager memoryManager, TaskRunnerFactory taskRunnerFactory, DestinationFactory destinationFactory)
protected Region	createTempQueueRegion(UsageManager memoryManager, TaskRunnerFactory taskRunnerFactory, DestinationFactory destinationFactory)
protected Region	createTempTopicRegion(UsageManager memoryManager, TaskRunnerFactory taskRunnerFactory, DestinationFactory destinationFactory)
protected Region	createTopicRegion(UsageManager memoryManager, TaskRunnerFactory taskRunnerFactory, DestinationFactory destinationFactory)
protected javax.jms.JMSException	createUnknownDestinationTypeException(ActiveMQDestination destination)
protected void	doStop(ServiceStopper ss)
void	forgetTransaction(ConnectionContext context, TransactionId transactionId) Forgets a transaction.
void	gc()
Broker	getAdaptor(java.lang.Class type) Get a Broker from the Broker Stack that is a particular class
ConnectionContext	getAdminConnectionContext()
BrokerId	getBrokerId() Get the id of the broker
java.lang.String	getBrokerName() Get the name of the broker
Connection[]	getClients()
java.util.Map	getConnectionStates()
DestinationInterceptor	getDestinationInterceptor()
java.util.Map	getDestinationMap() Returns a copy of the current destinations available in the region
PolicyMap	getDestinationPolicy()
ActiveMQDestination[]	getDestinations()
java.util.Set	getDestinations(ActiveMQDestination destination) Provide an exact or wildcard lookup of destinations in the region
DestinationStatistics	getDestinationStatistics()
java.util.Set	getDurableDestinations()
BrokerInfo[]	getPeerBrokerInfos() Get the BrokerInfo's of any connected Brokers
PendingDurableSubscriberMessageStoragePolicy	getPendingDurableSubscriberPolicy()
TransactionId[]	getPreparedTransactions(ConnectionContext context) Gets a list of all the prepared xa transactions.
Region	getQueueRegion()
Store	getTempDataStore()
Region	getTempQueueRegion()
Region	getTempTopicRegion()
Region	getTopicRegion()
protected boolean	isEqual(ConnectionId connectionId, ConnectionId connectionId2)
boolean	isFaultTolerantConfiguration()
boolean	isKeepDurableSubsActive()
boolean	isSlaveBroker()
boolean	isStopped()
Response	messagePull(ConnectionContext context, MessagePull pull) Allows a consumer to pull a message from a queue
int	prepareTransaction(ConnectionContext context, TransactionId xid) Prepares a transaction.
void	processDispatch(MessageDispatch messageDispatch) Notify the Broker that a dispatch has happened
void	processDispatchNotification(MessageDispatchNotification messageDispatchNotification) Process a notification of a dispatch - used by a Slave Broker
void	removeBroker(Connection connection, BrokerInfo info) Remove a BrokerInfo
void	removeConnection(ConnectionContext context, ConnectionInfo info, java.lang.Throwable error) A client is disconnecting from the broker.
void	removeConsumer(ConnectionContext context, ConsumerInfo info) Removes a consumer.
void	removeDestination(ConnectionContext context, ActiveMQDestination destination, long timeout) Used to destroy a destination.
void	removeDestinationInfo(ConnectionContext context, DestinationInfo info) Remove and process a DestinationInfo object
void	removeProducer(ConnectionContext context, ProducerInfo info) Removes a producer.
void	removeSession(ConnectionContext context, SessionInfo info) Removes a session.
void	removeSubscription(ConnectionContext context, RemoveSubscriptionInfo info) Deletes a durable subscription.
void	rollbackTransaction(ConnectionContext context, TransactionId xid) Rollsback a transaction.
void	send(ConnectionContext context, Message message) Send a message to the broker to using the specified destination.
void	setAdminConnectionContext(ConnectionContext adminConnectionContext) Sets the default administration connection context used when configuring the broker on startup or via JMX
void	setBrokerId(BrokerId brokerId)
void	setBrokerName(java.lang.String brokerName)
void	setKeepDurableSubsActive(boolean keepDurableSubsActive)
void	setPendingDurableSubscriberPolicy(PendingDurableSubscriberMessageStoragePolicy durableSubscriberCursor)
void	start()
void	stop()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

destinationStatistics

protected final DestinationStatistics destinationStatistics

destinationFactory

protected DestinationFactory destinationFactory

connectionStates

protected final edu.emory.mathcs.backport.java.util.concurrent.ConcurrentHashMap connectionStates

Constructor Detail

RegionBroker

public RegionBroker(BrokerService brokerService,
                    TaskRunnerFactory taskRunnerFactory,
                    UsageManager memoryManager,
                    DestinationFactory destinationFactory,
                    DestinationInterceptor destinationInterceptor)
             throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getDestinationMap

public java.util.Map getDestinationMap()

Description copied from interface: Region

Returns a copy of the current destinations available in the region

Specified by:

getDestinationMap in interface Region

Returns:

a copy of the regions currently active at the time of the call with the key the destination and the value the Destination.

getDestinations

public java.util.Set getDestinations(ActiveMQDestination destination)

Description copied from interface: Region

Provide an exact or wildcard lookup of destinations in the region

Specified by:

getDestinations in interface Region

Returns:

a set of matching destination objects.

getAdaptor

public Broker getAdaptor(java.lang.Class type)

Description copied from interface: Broker

Get a Broker from the Broker Stack that is a particular class

Specified by:

getAdaptor in interface Broker

Returns:

getQueueRegion

public Region getQueueRegion()

getTempQueueRegion

public Region getTempQueueRegion()

getTempTopicRegion

public Region getTempTopicRegion()

getTopicRegion

public Region getTopicRegion()

createTempTopicRegion

protected Region createTempTopicRegion(UsageManager memoryManager,
                                       TaskRunnerFactory taskRunnerFactory,
                                       DestinationFactory destinationFactory)

createTempQueueRegion

protected Region createTempQueueRegion(UsageManager memoryManager,
                                       TaskRunnerFactory taskRunnerFactory,
                                       DestinationFactory destinationFactory)

createTopicRegion

protected Region createTopicRegion(UsageManager memoryManager,
                                   TaskRunnerFactory taskRunnerFactory,
                                   DestinationFactory destinationFactory)

createQueueRegion

protected Region createQueueRegion(UsageManager memoryManager,
                                   TaskRunnerFactory taskRunnerFactory,
                                   DestinationFactory destinationFactory)

start

public void start()
           throws java.lang.Exception

Specified by:

start in interface Service

Throws:

java.lang.Exception

stop

public void stop()
          throws java.lang.Exception

Specified by:

stop in interface Service

Throws:

java.lang.Exception

getDestinationPolicy

public PolicyMap getDestinationPolicy()

addConnection

public void addConnection(ConnectionContext context,
                          ConnectionInfo info)
                   throws java.lang.Exception

Description copied from interface: Broker

A client is establishing a connection with the broker.

Specified by:

addConnection in interface Broker

Throws:

java.lang.Exception - TODO

removeConnection

public void removeConnection(ConnectionContext context,
                             ConnectionInfo info,
                             java.lang.Throwable error)
                      throws java.lang.Exception

Description copied from interface: Broker

A client is disconnecting from the broker.

Specified by:

removeConnection in interface Broker

Parameters:

context - the environment the operation is being executed under.

error - null if the client requested the disconnect or the error that caused the client to disconnect.

Throws:

java.lang.Exception - TODO

isEqual

protected boolean isEqual(ConnectionId connectionId,
                          ConnectionId connectionId2)

getClients

public Connection[] getClients()
                        throws java.lang.Exception

Specified by:

getClients in interface Broker

Returns:

all clients added to the Broker.

Throws:

java.lang.Exception - TODO

addDestination

public Destination addDestination(ConnectionContext context,
                                  ActiveMQDestination destination)
                           throws java.lang.Exception

Description copied from interface: Region

Used to create a destination. Usually, this method is invoked as a side-effect of sending a message to a destination that does not exist yet.

Specified by:

addDestination in interface Region

destination - the destination to create.

Returns:

TODO

Throws:

java.lang.Exception - TODO

removeDestination

public void removeDestination(ConnectionContext context,
                              ActiveMQDestination destination,
                              long timeout)
                       throws java.lang.Exception

Description copied from interface: Region

Used to destroy a destination. This should try to quiesce use of the destination up to the timeout allotted time before removing the destination. This will remove all persistent messages associated with the destination.

Specified by:

removeDestination in interface Region

Parameters:

context - the environment the operation is being executed under.

destination - what is being removed from the broker.

timeout - the max amount of time to wait for the destination to quiesce

Throws:

java.lang.Exception - TODO

addDestinationInfo

public void addDestinationInfo(ConnectionContext context,
                               DestinationInfo info)
                        throws java.lang.Exception

Description copied from interface: Broker

Add and process a DestinationInfo object

Specified by:

addDestinationInfo in interface Broker

Throws:

java.lang.Exception

removeDestinationInfo

public void removeDestinationInfo(ConnectionContext context,
                                  DestinationInfo info)
                           throws java.lang.Exception

Description copied from interface: Broker

Remove and process a DestinationInfo object

Specified by:

removeDestinationInfo in interface Broker

Throws:

java.lang.Exception

getDestinations

public ActiveMQDestination[] getDestinations()
                                      throws java.lang.Exception

Specified by:

getDestinations in interface Broker

Returns:

all destinations added to the Broker.

Throws:

java.lang.Exception - TODO

addSession

public void addSession(ConnectionContext context,
                       SessionInfo info)
                throws java.lang.Exception

Description copied from interface: Broker

Adds a session.

Specified by:

addSession in interface Broker

Throws:

java.lang.Exception - TODO

removeSession

public void removeSession(ConnectionContext context,
                          SessionInfo info)
                   throws java.lang.Exception

Description copied from interface: Broker

Removes a session.

Specified by:

removeSession in interface Broker

Throws:

java.lang.Exception - TODO

addProducer

public void addProducer(ConnectionContext context,
                        ProducerInfo info)
                 throws java.lang.Exception

Description copied from interface: Broker

Adds a producer.

Specified by:

addProducer in interface Broker

Parameters:

context - the enviorment the operation is being executed under.

Throws:

java.lang.Exception - TODO

removeProducer

public void removeProducer(ConnectionContext context,
                           ProducerInfo info)
                    throws java.lang.Exception

Description copied from interface: Broker

Removes a producer.

Specified by:

removeProducer in interface Broker

Parameters:

context - the enviorment the operation is being executed under.

Throws:

java.lang.Exception - TODO

addConsumer

public Subscription addConsumer(ConnectionContext context,
                                ConsumerInfo info)
                         throws java.lang.Exception

Description copied from interface: Region

Adds a consumer.

Specified by:

addConsumer in interface Region

Parameters:

context - the environment the operation is being executed under.

Returns:

TODO

Throws:

java.lang.Exception - TODO

removeConsumer

public void removeConsumer(ConnectionContext context,
                           ConsumerInfo info)
                    throws java.lang.Exception

Description copied from interface: Region

Removes a consumer.

Specified by:

removeConsumer in interface Region

Parameters:

context - the environment the operation is being executed under.

Throws:

java.lang.Exception - TODO

removeSubscription

public void removeSubscription(ConnectionContext context,
                               RemoveSubscriptionInfo info)
                        throws java.lang.Exception

Description copied from interface: Region

Deletes a durable subscription.

Specified by:

removeSubscription in interface Region

Parameters:

context - the environment the operation is being executed under.

info - TODO

Throws:

java.lang.Exception - TODO

send

public void send(ConnectionContext context,
                 Message message)
          throws java.lang.Exception

Description copied from interface: Region

Send a message to the broker to using the specified destination. The destination specified in the message does not need to match the destination the message is sent to. This is handy in case the message is being sent to a dead letter destination.

Specified by:

send in interface Region

Parameters:

context - the environment the operation is being executed under.

Throws:

java.lang.Exception - TODO

acknowledge

public void acknowledge(ConnectionContext context,
                        MessageAck ack)
                 throws java.lang.Exception

Description copied from interface: Region

Used to acknowledge the receipt of a message by a client.

Specified by:

acknowledge in interface Region

Parameters:

context - the environment the operation is being executed under.

Throws:

java.lang.Exception - TODO

messagePull

public Response messagePull(ConnectionContext context,
                            MessagePull pull)
                     throws java.lang.Exception

Description copied from interface: Region

Allows a consumer to pull a message from a queue

Specified by:

messagePull in interface Region

Throws:

java.lang.Exception

getPreparedTransactions

public TransactionId[] getPreparedTransactions(ConnectionContext context)
                                        throws java.lang.Exception

Description copied from interface: Broker

Gets a list of all the prepared xa transactions.

Specified by:

getPreparedTransactions in interface Broker

Throws:

java.lang.Exception - TODO

beginTransaction

public void beginTransaction(ConnectionContext context,
                             TransactionId xid)
                      throws java.lang.Exception

Description copied from interface: Broker

Starts a transaction.

Specified by:

beginTransaction in interface Broker

Throws:

java.lang.Exception - TODO

prepareTransaction

public int prepareTransaction(ConnectionContext context,
                              TransactionId xid)
                       throws java.lang.Exception

Description copied from interface: Broker

Prepares a transaction. Only valid for xa transactions.

Specified by:

prepareTransaction in interface Broker

Returns:

Throws:

java.lang.Exception - TODO

rollbackTransaction

public void rollbackTransaction(ConnectionContext context,
                                TransactionId xid)
                         throws java.lang.Exception

Description copied from interface: Broker

Rollsback a transaction.

Specified by:

rollbackTransaction in interface Broker

Throws:

java.lang.Exception - TODO

commitTransaction

public void commitTransaction(ConnectionContext context,
                              TransactionId xid,
                              boolean onePhase)
                       throws java.lang.Exception

Description copied from interface: Broker

Commits a transaction.

Specified by:

commitTransaction in interface Broker

Throws:

java.lang.Exception - TODO

forgetTransaction

public void forgetTransaction(ConnectionContext context,
                              TransactionId transactionId)
                       throws java.lang.Exception

Description copied from interface: Broker

Forgets a transaction.

Specified by:

forgetTransaction in interface Broker

Throws:

java.lang.Exception - TODO

gc

public void gc()

Specified by:

gc in interface Region

getBrokerId

public BrokerId getBrokerId()

Description copied from interface: Broker

Get the id of the broker

Specified by:

getBrokerId in interface Broker

setBrokerId

public void setBrokerId(BrokerId brokerId)

getBrokerName

public java.lang.String getBrokerName()

Description copied from interface: Broker

Get the name of the broker

Specified by:

getBrokerName in interface Broker

setBrokerName

public void setBrokerName(java.lang.String brokerName)

getDestinationStatistics

public DestinationStatistics getDestinationStatistics()

createUnknownDestinationTypeException

protected javax.jms.JMSException createUnknownDestinationTypeException(ActiveMQDestination destination)

addBroker

public void addBroker(Connection connection,
                      BrokerInfo info)

Description copied from interface: Broker

A remote Broker connects

Specified by:

addBroker in interface Broker

removeBroker

public void removeBroker(Connection connection,
                         BrokerInfo info)

Description copied from interface: Broker

Remove a BrokerInfo

Specified by:

removeBroker in interface Broker

getPeerBrokerInfos

public BrokerInfo[] getPeerBrokerInfos()

Description copied from interface: Broker

Get the BrokerInfo's of any connected Brokers

Specified by:

getPeerBrokerInfos in interface Broker

Returns:

array of peer BrokerInfos

processDispatch

public void processDispatch(MessageDispatch messageDispatch)

Description copied from interface: Broker

Notify the Broker that a dispatch has happened

Specified by:

processDispatch in interface Broker

processDispatchNotification

public void processDispatchNotification(MessageDispatchNotification messageDispatchNotification)
                                 throws java.lang.Exception

Description copied from interface: Region

Process a notification of a dispatch - used by a Slave Broker

Specified by:

processDispatchNotification in interface Region

Throws:

java.lang.Exception - TODO

isSlaveBroker

public boolean isSlaveBroker()

Specified by:

isSlaveBroker in interface Broker

Returns:

true if the broker is running as a slave

isStopped

public boolean isStopped()

Specified by:

isStopped in interface Broker

Returns:

true if the broker has stopped

getDurableDestinations

public java.util.Set getDurableDestinations()

Specified by:

getDurableDestinations in interface Broker

Returns:

a Set of all durable destinations

isFaultTolerantConfiguration

public boolean isFaultTolerantConfiguration()

Specified by:

isFaultTolerantConfiguration in interface Broker

Returns:

true if fault tolerant

doStop

protected void doStop(ServiceStopper ss)

isKeepDurableSubsActive

public boolean isKeepDurableSubsActive()

setKeepDurableSubsActive

public void setKeepDurableSubsActive(boolean keepDurableSubsActive)

getDestinationInterceptor

public DestinationInterceptor getDestinationInterceptor()

getAdminConnectionContext

public ConnectionContext getAdminConnectionContext()

Specified by:

getAdminConnectionContext in interface Broker

Returns:

the connection context used to make administration operations on startup or via JMX MBeans

setAdminConnectionContext

public void setAdminConnectionContext(ConnectionContext adminConnectionContext)

Description copied from interface: Broker

Sets the default administration connection context used when configuring the broker on startup or via JMX

Specified by:

setAdminConnectionContext in interface Broker

getConnectionStates

public java.util.Map getConnectionStates()

getTempDataStore

public Store getTempDataStore()

Specified by:

getTempDataStore in interface Broker

Returns:

the broker's temp data store

getPendingDurableSubscriberPolicy

public PendingDurableSubscriberMessageStoragePolicy getPendingDurableSubscriberPolicy()

Specified by:

getPendingDurableSubscriberPolicy in interface Broker

Returns:

the pendingDurableSubscriberPolicy

setPendingDurableSubscriberPolicy

public void setPendingDurableSubscriberPolicy(PendingDurableSubscriberMessageStoragePolicy durableSubscriberCursor)

Specified by:

setPendingDurableSubscriberPolicy in interface Broker

Parameters:

durableSubscriberCursor - the pendingDurableSubscriberPolicy to set