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 and Description
void	addBinding(Binding binding)
Set<SimpleString>	getAddresses()
Map<SimpleString,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
DuplicateIDCache	getDuplicateIDCache(SimpleString address)
Bindings	getMatchingBindings(SimpleString address)
Object	getNotificationLock()
boolean	isAddressBound(SimpleString address)
Bindings	lookupBindingsForAddress(SimpleString address) It will lookup the Binding without creating an item on the Queue if non-existent
void	processRoute(ServerMessage message, RoutingContext context, boolean direct)
Pair<RoutingContext,ServerMessage>	redistribute(ServerMessage message, Queue originatingQueue, Transaction tx)
Binding	removeBinding(SimpleString uniqueName, Transaction tx, boolean deleteData)
MessageReference	reroute(ServerMessage message, Queue queue, Transaction tx)
RoutingStatus	route(ServerMessage message, QueueCreator queueCreator, boolean direct)
RoutingStatus	route(ServerMessage message, QueueCreator queueCreator, RoutingContext context, boolean direct)
RoutingStatus	route(ServerMessage message, QueueCreator queueCreator, RoutingContext context, boolean direct, boolean rejectDuplicates)
RoutingStatus	route(ServerMessage message, QueueCreator queueCreator, Transaction tx, boolean direct)
RoutingStatus	route(ServerMessage message, QueueCreator queueCreator, Transaction tx, boolean direct, boolean rejectDuplicates)
void	sendQueueInfoToQueue(SimpleString queueName, SimpleString address)
void	startExpiryScanner()

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

isStarted, start, stop

Method Detail

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

Parameters:

address -

Throws:

Exception

getBindingsForAddress

Bindings getBindingsForAddress(SimpleString address)
                        throws Exception

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

Parameters:

address -

Throws:

Exception

getBinding

Binding getBinding(SimpleString uniqueName)

getMatchingBindings

Bindings getMatchingBindings(SimpleString address)
                      throws Exception

Throws:

Exception

getAllBindings

Map<SimpleString,Binding> getAllBindings()

route

RoutingStatus route(ServerMessage message,
                    QueueCreator queueCreator,
                    boolean direct)
             throws Exception

Throws:

Exception

route

RoutingStatus route(ServerMessage message,
                    QueueCreator queueCreator,
                    Transaction tx,
                    boolean direct)
             throws Exception

Throws:

Exception

route

RoutingStatus route(ServerMessage message,
                    QueueCreator queueCreator,
                    Transaction tx,
                    boolean direct,
                    boolean rejectDuplicates)
             throws Exception

Throws:

Exception

route

RoutingStatus route(ServerMessage message,
                    QueueCreator queueCreator,
                    RoutingContext context,
                    boolean direct)
             throws Exception

Throws:

Exception

route

RoutingStatus route(ServerMessage message,
                    QueueCreator queueCreator,
                    RoutingContext context,
                    boolean direct,
                    boolean rejectDuplicates)
             throws Exception

Throws:

Exception

reroute

MessageReference reroute(ServerMessage message,
                         Queue queue,
                         Transaction tx)
                  throws Exception

Throws:

Exception

redistribute

Pair<RoutingContext,ServerMessage> redistribute(ServerMessage message,
                                                Queue originatingQueue,
                                                Transaction tx)
                                         throws Exception

Throws:

Exception

processRoute

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

Throws:

Exception

getDuplicateIDCache

DuplicateIDCache getDuplicateIDCache(SimpleString address)

sendQueueInfoToQueue

void sendQueueInfoToQueue(SimpleString queueName,
                          SimpleString address)
                   throws Exception

Throws:

Exception

getNotificationLock

Object getNotificationLock()

startExpiryScanner

void startExpiryScanner()

isAddressBound

boolean isAddressBound(SimpleString address)
                throws Exception

Throws:

Exception

getAddresses

Set<SimpleString> getAddresses()