Package org.apache.activemq.artemis.core.postoffice.impl

Class PostOfficeImpl

java.lang.Object

org.apache.activemq.artemis.core.postoffice.impl.PostOfficeImpl

All Implemented Interfaces:

BindingsFactory, PostOffice, ActiveMQComponent, NotificationListener

public class PostOfficeImpl
extends Object
implements PostOffice, NotificationListener, BindingsFactory

This is the class that will make the routing to Queues and decide which consumer will get the messages It's the queue component on distributing the messages * *

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PostOfficeImpl.AddOperation

Field Summary

Fields

Modifier and Type	Field	Description
static SimpleString	BRIDGE_CACHE_STR
static SimpleString	HDR_RESET_QUEUE_DATA
static SimpleString	HDR_RESET_QUEUE_DATA_COMPLETE

Constructor Summary

Constructors

Constructor	Description
PostOfficeImpl(ActiveMQServer server, StorageManager storageManager, PagingManager pagingManager, QueueFactory bindableFactory, ManagementService managementService, long expiryReaperPeriod, long addressQueueReaperPeriod, WildcardConfiguration wildcardConfiguration, int idCacheSize, boolean persistIDCache, HierarchicalRepository<AddressSettings> addressSettingsRepository)

Method Summary

Modifier and Type	Method	Description
boolean	addAddressInfo(AddressInfo addressInfo)
void	addBinding(Binding binding)
Bindings	createBindings(SimpleString address)
Set<SimpleString>	getAddresses()
AddressInfo	getAddressInfo(SimpleString addressName)
AddressManager	getAddressManager()
Stream<Binding>	getAllBindings()
Binding	getBinding(SimpleString name)
Bindings	getBindingsForAddress(SimpleString address)	Differently to lookupBindings, this will always create a new element on the Queue if non-existent
Collection<Binding>	getDirectBindings(SimpleString address)
DuplicateIDCache	getDuplicateIDCache(SimpleString address)
DuplicateIDCache	getDuplicateIDCache(SimpleString address, int cacheSizeToUse)
ConcurrentMap<SimpleString,DuplicateIDCache>	getDuplicateIDCaches()
Collection<Binding>	getMatchingBindings(SimpleString address)
SimpleString	getMatchingQueue(SimpleString address, RoutingType routingType)
SimpleString	getMatchingQueue(SimpleString address, SimpleString queueName, RoutingType routingType)
MirrorController	getMirrorControlSource()
Object	getNotificationLock()
ActiveMQServer	getServer()
boolean	isAddressBound(SimpleString address)
boolean	isStarted()
List<Queue>	listQueuesForAddress(SimpleString address)
Bindings	lookupBindingsForAddress(SimpleString address)	It will lookup the Binding without creating an item on the Queue if non-existent
void	onNotification(Notification notification)
void	postAcknowledge(MessageReference ref, AckReason reason)
void	preAcknowledge(Transaction tx, MessageReference ref, AckReason reason)
static void	processReference(MessageReference ref, boolean direct)
static void	processReferences(List<MessageReference> refs, boolean direct)
void	processRoute(Message message, RoutingContext context, boolean direct)
Pair<RoutingContext,Message>	redistribute(Message message, Queue originatingQueue)	The redistribution can't process the route right away as we may be dealing with a large message which will need to be processed on a different thread
MessageReference	reload(Message message, Queue queue, Transaction tx)
void	reloadAddressInfo(AddressInfo addressInfo)
AddressInfo	removeAddressInfo(SimpleString address)
AddressInfo	removeAddressInfo(SimpleString address, boolean force)
Binding	removeBinding(SimpleString uniqueName, Transaction tx, boolean deleteData)
RoutingStatus	route(Message message, boolean direct)
RoutingStatus	route(Message message, RoutingContext context, boolean direct)
RoutingStatus	route(Message message, RoutingContext context, boolean direct, boolean rejectDuplicates, Binding bindingMove)
RoutingStatus	route(Message message, Transaction tx, boolean direct)
RoutingStatus	route(Message message, Transaction tx, boolean direct, boolean rejectDuplicates)
RoutingStatus	route(Message message, Transaction tx, boolean direct, boolean rejectDuplicates, Binding binding)
void	scanAddresses(MirrorController mirrorController)
void	sendQueueInfoToQueue(SimpleString queueName, SimpleString address)
PostOfficeImpl	setMirrorControlSource(MirrorController mirrorControllerSource)
void	start()
void	startAddressQueueScanner()
void	startExpiryScanner()	The expiry scanner can't be started until the whole server has been started other wise you may get races
void	stop()
static void	storeDurableReference(StorageManager storageManager, Message message, Transaction tx, Queue queue, boolean sync)
String	toString()
AddressInfo	updateAddressInfo(SimpleString addressName, EnumSet<RoutingType> routingTypes)
QueueBinding	updateQueue(QueueConfiguration queueConfiguration)
QueueBinding	updateQueue(QueueConfiguration queueConfiguration, boolean forceUpdate)
QueueBinding	updateQueue(SimpleString name, RoutingType routingType, Filter filter, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, Boolean groupRebalance, Integer groupBuckets, SimpleString groupFirstKey, Boolean nonDestructive, Integer consumersBeforeDispatch, Long delayBeforeDispatch, SimpleString user, Boolean configurationManaged)	Deprecated.
QueueBinding	updateQueue(SimpleString name, RoutingType routingType, Filter filter, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, Boolean groupRebalance, Integer groupBuckets, SimpleString groupFirstKey, Boolean nonDestructive, Integer consumersBeforeDispatch, Long delayBeforeDispatch, SimpleString user, Boolean configurationManaged, Long ringSize)	Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.activemq.artemis.core.server.ActiveMQComponent

asyncStop

Methods inherited from interface org.apache.activemq.artemis.core.postoffice.PostOffice

reroute

Field Detail

HDR_RESET_QUEUE_DATA

public static final SimpleString HDR_RESET_QUEUE_DATA

HDR_RESET_QUEUE_DATA_COMPLETE

public static final SimpleString HDR_RESET_QUEUE_DATA_COMPLETE

BRIDGE_CACHE_STR

public static final SimpleString BRIDGE_CACHE_STR

Constructor Detail

PostOfficeImpl

public PostOfficeImpl(ActiveMQServer server,
                      StorageManager storageManager,
                      PagingManager pagingManager,
                      QueueFactory bindableFactory,
                      ManagementService managementService,
                      long expiryReaperPeriod,
                      long addressQueueReaperPeriod,
                      WildcardConfiguration wildcardConfiguration,
                      int idCacheSize,
                      boolean persistIDCache,
                      HierarchicalRepository<AddressSettings> addressSettingsRepository)

Method Detail

start

public void start()
           throws Exception

Specified by:

start in interface ActiveMQComponent

Throws:

Exception

stop

public void stop()
          throws Exception

Specified by:

stop in interface ActiveMQComponent

Throws:

Exception

isStarted

public boolean isStarted()

Specified by:

isStarted in interface ActiveMQComponent

getMirrorControlSource

public MirrorController getMirrorControlSource()

Specified by:

getMirrorControlSource in interface PostOffice

setMirrorControlSource

public PostOfficeImpl setMirrorControlSource(MirrorController mirrorControllerSource)

Specified by:

setMirrorControlSource in interface PostOffice

preAcknowledge

public void preAcknowledge(Transaction tx,
                           MessageReference ref,
                           AckReason reason)

Specified by:

preAcknowledge in interface PostOffice

postAcknowledge

public void postAcknowledge(MessageReference ref,
                            AckReason reason)

Specified by:

postAcknowledge in interface PostOffice

scanAddresses

public void scanAddresses(MirrorController mirrorController)
                   throws Exception

Specified by:

scanAddresses in interface PostOffice

Throws:

Exception

onNotification

public void onNotification(Notification notification)

Specified by:

onNotification in interface NotificationListener

reloadAddressInfo

public void reloadAddressInfo(AddressInfo addressInfo)
                       throws Exception

Specified by:

reloadAddressInfo in interface PostOffice

Throws:

Exception

addAddressInfo

public boolean addAddressInfo(AddressInfo addressInfo)
                       throws Exception

Specified by:

addAddressInfo in interface PostOffice

Returns:

true if the address was added, false if it wasn't added

Throws:

Exception

updateQueue

@Deprecated
public QueueBinding updateQueue(SimpleString name,
                                RoutingType routingType,
                                Filter filter,
                                Integer maxConsumers,
                                Boolean purgeOnNoConsumers,
                                Boolean exclusive,
                                Boolean groupRebalance,
                                Integer groupBuckets,
                                SimpleString groupFirstKey,
                                Boolean nonDestructive,
                                Integer consumersBeforeDispatch,
                                Long delayBeforeDispatch,
                                SimpleString user,
                                Boolean configurationManaged)
                         throws Exception

Deprecated.

Specified by:

updateQueue in interface PostOffice

Throws:

Exception

updateQueue

@Deprecated
public QueueBinding updateQueue(SimpleString name,
                                RoutingType routingType,
                                Filter filter,
                                Integer maxConsumers,
                                Boolean purgeOnNoConsumers,
                                Boolean exclusive,
                                Boolean groupRebalance,
                                Integer groupBuckets,
                                SimpleString groupFirstKey,
                                Boolean nonDestructive,
                                Integer consumersBeforeDispatch,
                                Long delayBeforeDispatch,
                                SimpleString user,
                                Boolean configurationManaged,
                                Long ringSize)
                         throws Exception

Deprecated.

Specified by:

updateQueue in interface PostOffice

Throws:

Exception

updateQueue

public QueueBinding updateQueue(QueueConfiguration queueConfiguration)
                         throws Exception

Specified by:

updateQueue in interface PostOffice

Throws:

Exception

updateQueue

public QueueBinding updateQueue(QueueConfiguration queueConfiguration,
                                boolean forceUpdate)
                         throws Exception

Specified by:

updateQueue in interface PostOffice

forceUpdate - Setting to true will make null values override current values too

Returns:

Throws:

Exception

updateAddressInfo

public AddressInfo updateAddressInfo(SimpleString addressName,
                                     EnumSet<RoutingType> routingTypes)
                              throws Exception

Specified by:

updateAddressInfo in interface PostOffice

Throws:

Exception

removeAddressInfo

public AddressInfo removeAddressInfo(SimpleString address)
                              throws Exception

Specified by:

removeAddressInfo in interface PostOffice

Throws:

Exception

removeAddressInfo

public AddressInfo removeAddressInfo(SimpleString address,
                                     boolean force)
                              throws Exception

Specified by:

removeAddressInfo in interface PostOffice

Throws:

Exception

getAddressInfo

public AddressInfo getAddressInfo(SimpleString addressName)

Specified by:

getAddressInfo in interface PostOffice

listQueuesForAddress

public List<Queue> listQueuesForAddress(SimpleString address)
                                 throws Exception

Specified by:

listQueuesForAddress in interface PostOffice

Throws:

Exception

addBinding

public void addBinding(Binding binding)
                throws Exception

Specified by:

addBinding in interface PostOffice

Throws:

Exception

removeBinding

public Binding removeBinding(SimpleString uniqueName,
                             Transaction tx,
                             boolean deleteData)
                      throws Exception

Specified by:

removeBinding in interface PostOffice

Throws:

Exception

isAddressBound

public boolean isAddressBound(SimpleString address)
                       throws Exception

Specified by:

isAddressBound in interface BindingsFactory

Specified by:

isAddressBound in interface PostOffice

Throws:

Exception

getBindingsForAddress

public Bindings getBindingsForAddress(SimpleString address)
                               throws Exception

Description copied from interface: PostOffice

Differently to lookupBindings, this will always create a new element on the Queue if non-existent

Specified by:

getBindingsForAddress in interface PostOffice

Throws:

Exception

lookupBindingsForAddress

public Bindings lookupBindingsForAddress(SimpleString address)
                                  throws Exception

Description copied from interface: PostOffice

It will lookup the Binding without creating an item on the Queue if non-existent

Specified by:

lookupBindingsForAddress in interface PostOffice

Throws:

Exception

getBinding

public Binding getBinding(SimpleString name)

Specified by:

getBinding in interface PostOffice

getMatchingBindings

public Collection<Binding> getMatchingBindings(SimpleString address)
                                        throws Exception

Specified by:

getMatchingBindings in interface PostOffice

Throws:

Exception

getDirectBindings

public Collection<Binding> getDirectBindings(SimpleString address)
                                      throws Exception

Specified by:

getDirectBindings in interface PostOffice

Throws:

Exception

getAllBindings

public Stream<Binding> getAllBindings()

Specified by:

getAllBindings in interface PostOffice

route

public RoutingStatus route(Message message,
                           boolean direct)
                    throws Exception

Specified by:

route in interface PostOffice

Throws:

Exception

route

public RoutingStatus route(Message message,
                           Transaction tx,
                           boolean direct)
                    throws Exception

Specified by:

route in interface PostOffice

Throws:

Exception

route

public RoutingStatus route(Message message,
                           Transaction tx,
                           boolean direct,
                           boolean rejectDuplicates)
                    throws Exception

Specified by:

route in interface PostOffice

Throws:

Exception

route

public RoutingStatus route(Message message,
                           Transaction tx,
                           boolean direct,
                           boolean rejectDuplicates,
                           Binding binding)
                    throws Exception

Specified by:

route in interface PostOffice

Throws:

Exception

route

public RoutingStatus route(Message message,
                           RoutingContext context,
                           boolean direct)
                    throws Exception

Specified by:

route in interface PostOffice

Throws:

Exception

route

public RoutingStatus route(Message message,
                           RoutingContext context,
                           boolean direct,
                           boolean rejectDuplicates,
                           Binding bindingMove)
                    throws Exception

Specified by:

route in interface PostOffice

Throws:

Exception

reload

public MessageReference reload(Message message,
                               Queue queue,
                               Transaction tx)
                        throws Exception

Specified by:

reload in interface PostOffice

Throws:

Exception

redistribute

public Pair<RoutingContext,Message> redistribute(Message message,
                                                       Queue originatingQueue)
                                                throws Exception

The redistribution can't process the route right away as we may be dealing with a large message which will need to be processed on a different thread

Specified by:

redistribute in interface PostOffice

Throws:

Exception

getDuplicateIDCache

public DuplicateIDCache getDuplicateIDCache(SimpleString address)

Specified by:

getDuplicateIDCache in interface PostOffice

getDuplicateIDCache

public DuplicateIDCache getDuplicateIDCache(SimpleString address,
                                            int cacheSizeToUse)

Specified by:

getDuplicateIDCache in interface PostOffice

getDuplicateIDCaches

public ConcurrentMap<SimpleString,DuplicateIDCache> getDuplicateIDCaches()

getNotificationLock

public Object getNotificationLock()

Specified by:

getNotificationLock in interface PostOffice

getAddresses

public Set<SimpleString> getAddresses()

Specified by:

getAddresses in interface PostOffice

getMatchingQueue

public SimpleString getMatchingQueue(SimpleString address,
                                     RoutingType routingType)
                              throws Exception

Specified by:

getMatchingQueue in interface PostOffice

Throws:

Exception

getMatchingQueue

public SimpleString getMatchingQueue(SimpleString address,
                                     SimpleString queueName,
                                     RoutingType routingType)
                              throws Exception

Specified by:

getMatchingQueue in interface PostOffice

Throws:

Exception

sendQueueInfoToQueue

public void sendQueueInfoToQueue(SimpleString queueName,
                                 SimpleString address)
                          throws Exception

Specified by:

sendQueueInfoToQueue in interface PostOffice

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

processRoute

public void processRoute(Message message,
                         RoutingContext context,
                         boolean direct)
                  throws Exception

Specified by:

processRoute in interface PostOffice

Throws:

Exception

processReferences

public static void processReferences(List<MessageReference> refs,
                                     boolean direct)

processReference

public static void processReference(MessageReference ref,
                                    boolean direct)

storeDurableReference

public static void storeDurableReference(StorageManager storageManager,
                                         Message message,
                                         Transaction tx,
                                         Queue queue,
                                         boolean sync)
                                  throws Exception

Throws:

Exception

startExpiryScanner

public void startExpiryScanner()

The expiry scanner can't be started until the whole server has been started other wise you may get races

Specified by:

startExpiryScanner in interface PostOffice

startAddressQueueScanner

public void startAddressQueueScanner()

Specified by:

startAddressQueueScanner in interface PostOffice

createBindings

public Bindings createBindings(SimpleString address)

Specified by:

createBindings in interface BindingsFactory

getAddressManager

public AddressManager getAddressManager()

Specified by:

getAddressManager in interface PostOffice

getServer

public ActiveMQServer getServer()