org.apache.activemq.broker.region
Class AbstractRegion

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

All Implemented Interfaces:

Region, Service

Direct Known Subclasses:

QueueRegion, TempQueueRegion, TempTopicRegion, TopicRegion

public abstract class AbstractRegion
extends java.lang.Object
implements Region

Version:

$Revision: 1.14 $

Field Summary

protected boolean	autoCreateDestinations
protected RegionBroker	broker
protected java.util.Map	consumerChangeMutexMap
protected DestinationFactory	destinationFactory
protected DestinationMap	destinationMap
protected edu.emory.mathcs.backport.java.util.concurrent.ConcurrentHashMap	destinations
protected java.lang.Object	destinationsMutex
protected DestinationStatistics	destinationStatistics
protected UsageManager	memoryManager
protected edu.emory.mathcs.backport.java.util.concurrent.ConcurrentHashMap	subscriptions
protected TaskRunnerFactory	taskRunnerFactory

Constructor Summary

AbstractRegion(RegionBroker broker, DestinationStatistics destinationStatistics, UsageManager memoryManager, TaskRunnerFactory taskRunnerFactory, DestinationFactory destinationFactory)

Method Summary

void	acknowledge(ConnectionContext context, MessageAck ack) Used to acknowledge the receipt of a message by a client.
Subscription	addConsumer(ConnectionContext context, ConsumerInfo info) Adds a consumer.
Destination	addDestination(ConnectionContext context, ActiveMQDestination destination) Used to create a destination.
protected Destination	createDestination(ConnectionContext context, ActiveMQDestination destination)
protected abstract Subscription	createSubscription(ConnectionContext context, ConsumerInfo info)
protected void	destroySubscription(Subscription sub)
void	gc()
java.util.Map	getDestinationMap() Returns a copy of the current destinations available in the region
java.util.Set	getDestinations(ActiveMQDestination destination) Provide an exact or wildcard lookup of destinations in the region
java.util.Set	getDurableDestinations() Get all the Destinations that are in storage
protected java.util.Set	getInactiveDestinations()
boolean	isAutoCreateDestinations()
protected Destination	lookup(ConnectionContext context, ActiveMQDestination destination)
Response	messagePull(ConnectionContext context, MessagePull pull) Allows a consumer to pull a message from a queue
void	processDispatchNotification(MessageDispatchNotification messageDispatchNotification) Process a notification of a dispatch - used by a Slave Broker
void	removeConsumer(ConnectionContext context, ConsumerInfo info) Removes a consumer.
void	removeDestination(ConnectionContext context, ActiveMQDestination destination, long timeout) Used to destroy a destination.
void	removeSubscription(ConnectionContext context, RemoveSubscriptionInfo info) Deletes a durable subscription.
void	send(ConnectionContext context, Message messageSend) Send a message to the broker to using the specified destination.
void	setAutoCreateDestinations(boolean autoCreateDestinations)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

destinations

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

destinationMap

protected final DestinationMap destinationMap

subscriptions

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

memoryManager

protected final UsageManager memoryManager

destinationFactory

protected final DestinationFactory destinationFactory

destinationStatistics

protected final DestinationStatistics destinationStatistics

broker

protected final RegionBroker broker

autoCreateDestinations

protected boolean autoCreateDestinations

taskRunnerFactory

protected final TaskRunnerFactory taskRunnerFactory

destinationsMutex

protected final java.lang.Object destinationsMutex

consumerChangeMutexMap

protected final java.util.Map consumerChangeMutexMap

Constructor Detail

AbstractRegion

public AbstractRegion(RegionBroker broker,
                      DestinationStatistics destinationStatistics,
                      UsageManager memoryManager,
                      TaskRunnerFactory taskRunnerFactory,
                      DestinationFactory destinationFactory)

Method Detail

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

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

getDestinations

public java.util.Set getDestinations(ActiveMQDestination destination)

Provide an exact or wildcard lookup of destinations in the region

Specified by:

getDestinations in interface Region

Returns:

a set of matching destination objects.

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.

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

getDurableDestinations

public java.util.Set getDurableDestinations()

Get all the Destinations that are in storage

Returns:

Set of all stored destinations

getInactiveDestinations

protected java.util.Set getInactiveDestinations()

Returns:

all Destinations that don't have active consumers

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

destroySubscription

protected void destroySubscription(Subscription sub)

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 messageSend)
          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

lookup

protected Destination lookup(ConnectionContext context,
                             ActiveMQDestination destination)
                      throws java.lang.Exception

Throws:

java.lang.Exception

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

gc

public void gc()

Specified by:

gc in interface Region

createSubscription

protected abstract Subscription createSubscription(ConnectionContext context,
                                                   ConsumerInfo info)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

createDestination

protected Destination createDestination(ConnectionContext context,
                                        ActiveMQDestination destination)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

isAutoCreateDestinations

public boolean isAutoCreateDestinations()

setAutoCreateDestinations

public void setAutoCreateDestinations(boolean autoCreateDestinations)