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

Interface PostOffice

All Superinterfaces:

ActiveMQComponent

All Known Implementing Classes:

PostOfficeImpl

public interface PostOffice
extends ActiveMQComponent

A PostOffice instance maintains a mapping of a String address to a Queue. Multiple Queue instances can be bound with the same String address.

Given a message and an address a PostOffice instance will route that message to all the Queue instances that are registered with that address.

Addresses can be any String instance.

A Queue instance can only be bound against a single address in the post office.

Method Summary

Modifier and Type	Method	Description
boolean	addAddressInfo(AddressInfo addressInfo)	Returns true if the address was added, false if it wasn't added.
void	addBinding(Binding binding)
LocalQueueBinding	findLocalBinding(long bindingID)
default Queue	findQueue(long bindingID)
Set<SimpleString>	getAddresses()
AddressInfo	getAddressInfo(SimpleString address)
default AddressManager	getAddressManager()
Stream<Binding>	getAllBindings()
Binding	getBinding(SimpleString uniqueName)
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 idCacheSize)
Collection<Binding>	getMatchingBindings(SimpleString address)
SimpleString	getMatchingQueue(SimpleString address, RoutingType routingType)
SimpleString	getMatchingQueue(SimpleString address, SimpleString queueName, RoutingType routingType)
MirrorController	getMirrorControlSource()
Object	getNotificationLock()
boolean	isAddressBound(SimpleString address)
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	postAcknowledge(MessageReference ref, AckReason reason)
default void	preAcknowledge(Transaction tx, MessageReference ref, AckReason reason)
void	processRoute(Message message, RoutingContext context, boolean direct)
Pair<RoutingContext,Message>	redistribute(Message message, Queue originatingQueue)
MessageReference	reload(Message message, Queue queue, Transaction tx)
default void	reloadAddressInfo(AddressInfo addressInfo)
AddressInfo	removeAddressInfo(SimpleString address)
AddressInfo	removeAddressInfo(SimpleString address, boolean force)
Binding	removeBinding(SimpleString uniqueName, Transaction tx, boolean deleteData)
default MessageReference	reroute(Message message, Queue queue, Transaction tx)	Deprecated.
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 binding)
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)
default void	scanAddresses(MirrorController mirrorController)
void	sendQueueInfoToQueue(SimpleString queueName, SimpleString address)
PostOffice	setMirrorControlSource(MirrorController mirrorControllerSource)
void	startAddressQueueScanner()
void	startExpiryScanner()
AddressInfo	updateAddressInfo(SimpleString addressName, EnumSet<RoutingType> routingTypes)
QueueBinding	updateQueue(QueueConfiguration queueConfiguration)
QueueBinding	updateQueue(QueueConfiguration queueConfiguration, boolean forceUpdate)	Update a queue's configuration.
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 interface org.apache.activemq.artemis.core.server.ActiveMQComponent

asyncStop, isStarted, start, stop

Method Details

addAddressInfo

boolean addAddressInfo(AddressInfo addressInfo)
                throws Exception

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

Returns:

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

Throws:

Exception

reloadAddressInfo

default void reloadAddressInfo(AddressInfo addressInfo)
                        throws Exception

Throws:

Exception

removeAddressInfo

AddressInfo removeAddressInfo(SimpleString address)
                       throws Exception

Throws:

Exception

removeAddressInfo

AddressInfo removeAddressInfo(SimpleString address,
 boolean force)
                       throws Exception

Throws:

Exception

getAddressInfo

AddressInfo getAddressInfo(SimpleString address)

updateAddressInfo

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

Throws:

Exception

updateQueue

@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)
                  throws Exception

Deprecated.

Throws:

Exception

updateQueue

@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)
                  throws Exception

Deprecated.

Throws:

Exception

updateQueue

QueueBinding updateQueue(QueueConfiguration queueConfiguration)
                  throws Exception

Throws:

Exception

updateQueue

QueueBinding updateQueue(QueueConfiguration queueConfiguration,
 boolean forceUpdate)
                  throws Exception

Update a queue's configuration.

Parameters:

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

Throws:

Exception

listQueuesForAddress

List<Queue> listQueuesForAddress(SimpleString address)
                          throws Exception

Throws:

Exception

addBinding

void addBinding(Binding binding)
         throws Exception

Throws:

Exception

removeBinding

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

Throws:

Exception

lookupBindingsForAddress

Bindings lookupBindingsForAddress(SimpleString address)
                           throws Exception

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

Throws:

Exception

findLocalBinding

LocalQueueBinding findLocalBinding(long bindingID)

findQueue

default Queue findQueue(long bindingID)

getBindingsForAddress

Bindings getBindingsForAddress(SimpleString address)
                        throws Exception

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

Throws:

Exception

getBinding

Binding getBinding(SimpleString uniqueName)

getMatchingBindings

Collection<Binding> getMatchingBindings(SimpleString address)
                                 throws Exception

Throws:

Exception

getDirectBindings

Collection<Binding> getDirectBindings(SimpleString address)
                               throws Exception

Throws:

Exception

getAllBindings

Stream<Binding> getAllBindings()

getMatchingQueue

SimpleString getMatchingQueue(SimpleString address,
 RoutingType routingType)
                       throws Exception

Throws:

Exception

getMatchingQueue

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

Throws:

Exception

route

RoutingStatus route(Message message,
 boolean direct)
             throws Exception

Throws:

Exception

route

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

Throws:

Exception

route

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

Throws:

Exception

route

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

Throws:

Exception

route

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

Throws:

Exception

route

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

Throws:

Exception

reroute

@Deprecated
default MessageReference reroute(Message message,
 Queue queue,
 Transaction tx)
                          throws Exception

Deprecated.

This method was renamed as reload, use the new method instead

Throws:

Exception

reload

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

Throws:

Exception

redistribute

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

Throws:

Exception

processRoute

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

Throws:

Exception

getDuplicateIDCache

DuplicateIDCache getDuplicateIDCache(SimpleString address)

getDuplicateIDCache

DuplicateIDCache getDuplicateIDCache(SimpleString address,
 int idCacheSize)

sendQueueInfoToQueue

void sendQueueInfoToQueue(SimpleString queueName,
 SimpleString address)
                   throws Exception

Throws:

Exception

getNotificationLock

Object getNotificationLock()

startExpiryScanner

void startExpiryScanner()

startAddressQueueScanner

void startAddressQueueScanner()

isAddressBound

boolean isAddressBound(SimpleString address)
                throws Exception

Throws:

Exception

getAddresses

Set<SimpleString> getAddresses()

getMirrorControlSource

MirrorController getMirrorControlSource()

setMirrorControlSource

PostOffice setMirrorControlSource(MirrorController mirrorControllerSource)

postAcknowledge

void postAcknowledge(MessageReference ref,
 AckReason reason)

scanAddresses

default void scanAddresses(MirrorController mirrorController)
                    throws Exception

Throws:

Exception

getAddressManager

default AddressManager getAddressManager()

preAcknowledge

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