Package org.apache.activemq.broker

Class BrokerFilter

java.lang.Object

org.apache.activemq.broker.BrokerFilter

All Implemented Interfaces:

Broker, Region, Service

Direct Known Subclasses:

AbstractAuthenticationBroker, AbstractRuntimeConfigurationBroker, AdvisoryBroker, AuthorizationBroker, BrokerBroadcaster, CompositeDestinationBroker, ConnectionSplitBroker, DiscardingDLQBroker, DotFileInterceptorSupport, ForcePersistencyModeBroker, JaasCertificateAuthenticationBroker, JaasDualAuthenticationBroker, MutableBrokerFilter, PartitionBroker, SchedulerBroker, StatisticsBroker, SubQueueSelectorCacheBroker, TransactionBroker, UserIDBroker

public class BrokerFilter
extends Object
implements Broker

Allows you to intercept broker operation so that features such as security can be implemented as a pluggable filter.

Field Summary

Fields

Modifier and Type	Field	Description
protected Broker	next

Constructor Summary

Constructors

Constructor	Description
BrokerFilter(Broker next)

Method Summary

Modifier and Type	Method	Description
void	acknowledge(ConsumerBrokerExchange consumerExchange, 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, boolean createIfTemporary)	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	brokerServiceStarted()	called when the brokerService starts
void	commitTransaction(ConnectionContext context, TransactionId xid, boolean onePhase)	Commits a transaction.
void	fastProducer(ConnectionContext context, ProducerInfo producerInfo, ActiveMQDestination destination)	Called to notify a producer is too fast
void	forgetTransaction(ConnectionContext context, TransactionId transactionId)	Forgets a transaction.
void	gc()
Broker	getAdaptor(Class<?> type)	Get a Broker from the Broker Stack that is a particular class
ConnectionContext	getAdminConnectionContext()
BrokerId	getBrokerId()	Get the id of the broker
String	getBrokerName()	Get the name of the broker
long	getBrokerSequenceId()
BrokerService	getBrokerService()
Connection[]	getClients()
Map<ActiveMQDestination,Destination>	getDestinationMap()	Returns a reference to the concurrent hash map that holds known destinations, do not modify
Map<ActiveMQDestination,Destination>	getDestinationMap(ActiveMQDestination destination)	return a reference destination map of a region based on the destination type
ActiveMQDestination[]	getDestinations()
Set<Destination>	getDestinations(ActiveMQDestination destination)	Provide an exact or wildcard lookup of destinations in the region
Set<ActiveMQDestination>	getDurableDestinations()
ThreadPoolExecutor	getExecutor()
Broker	getNext()
BrokerInfo[]	getPeerBrokerInfos()	Get the BrokerInfo's of any connected Brokers
TransactionId[]	getPreparedTransactions(ConnectionContext context)	Gets a list of all the prepared xa transactions.
Broker	getRoot()	Ensure we get the Broker at the top of the Stack
Scheduler	getScheduler()
PListStore	getTempDataStore()
URI	getVmConnectorURI()
boolean	isExpired(MessageReference messageReference)	Determine if a message has expired -allows default behaviour to be overriden - as the timestamp set by the producer can be out of sync with the broker
boolean	isFaultTolerantConfiguration()
void	isFull(ConnectionContext context, Destination destination, Usage<?> usage)	Called when a Usage reaches a limit
boolean	isStopped()
void	messageConsumed(ConnectionContext context, MessageReference messageReference)	called when message is consumed
void	messageDelivered(ConnectionContext context, MessageReference messageReference)	Called when message is delivered to the broker
void	messageDiscarded(ConnectionContext context, Subscription sub, MessageReference messageReference)	Called when a message is discarded - e.g.
void	messageExpired(ConnectionContext context, MessageReference message, Subscription subscription)	A Message has Expired
Response	messagePull(ConnectionContext context, MessagePull pull)	Allows a consumer to pull a message from a queue
void	networkBridgeStarted(BrokerInfo brokerInfo, boolean createdByDuplex, String remoteIp)
void	networkBridgeStopped(BrokerInfo brokerInfo)
void	nowMasterBroker()	called when the broker becomes the master in a master/slave configuration
void	postProcessDispatch(MessageDispatch messageDispatch)	Notify the Broker that a dispatch has happened
int	prepareTransaction(ConnectionContext context, TransactionId xid)	Prepares a transaction.
void	preProcessDispatch(MessageDispatch messageDispatch)	Notify the Broker that a dispatch is going to happen
void	processConsumerControl(ConsumerBrokerExchange consumerExchange, ConsumerControl control)
void	processDispatchNotification(MessageDispatchNotification messageDispatchNotification)	Process a notification of a dispatch - used by a Slave Broker
void	reapplyInterceptor()
void	removeBroker(Connection connection, BrokerInfo info)	Remove a BrokerInfo
void	removeConnection(ConnectionContext context, ConnectionInfo info, 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(ProducerBrokerExchange producerExchange, Message messageSend)	Send a message to the broker to using the specified destination.
boolean	sendToDeadLetterQueue(ConnectionContext context, MessageReference messageReference, Subscription subscription, Throwable poisonCause)	A message needs to go the a DLQ
void	setAdminConnectionContext(ConnectionContext adminConnectionContext)	Sets the default administration connection context used when configuring the broker on startup or via JMX
void	slowConsumer(ConnectionContext context, Destination destination, Subscription subs)	Called when there is a slow consumer
void	start()
void	stop()
void	virtualDestinationAdded(ConnectionContext context, VirtualDestination virtualDestination)
void	virtualDestinationRemoved(ConnectionContext context, VirtualDestination virtualDestination)

Methods inherited from class java.lang.Object

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

Field Detail

next

protected final Broker next

Constructor Detail

BrokerFilter

public BrokerFilter(Broker next)

Method Detail

getNext

public Broker getNext()

getAdaptor

public Broker getAdaptor(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:

a Broker instance.

getDestinationMap

public Map<ActiveMQDestination,Destination> getDestinationMap()

Description copied from interface: Region

Returns a reference to the concurrent hash map that holds known destinations, do not modify

Specified by:

getDestinationMap in interface Region

getDestinationMap

public Map<ActiveMQDestination,Destination> getDestinationMap(ActiveMQDestination destination)

Description copied from interface: Broker

return a reference destination map of a region based on the destination type

Specified by:

getDestinationMap in interface Broker

Returns:

destination Map

getDestinations

public Set<Destination> 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.

acknowledge

public void acknowledge(ConsumerBrokerExchange consumerExchange,
                        MessageAck ack)
                 throws Exception

Description copied from interface: Region

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

Specified by:

acknowledge in interface Region

Parameters:

consumerExchange - the environment the operation is being executed under.

Throws:

Exception - TODO

messagePull

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

Description copied from interface: Region

Allows a consumer to pull a message from a queue

Specified by:

messagePull in interface Region

Throws:

Exception

addConnection

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

Description copied from interface: Broker

A client is establishing a connection with the broker.

Specified by:

addConnection in interface Broker

Throws:

Exception - TODO

addConsumer

public Subscription addConsumer(ConnectionContext context,
                                ConsumerInfo info)
                         throws 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:

Exception - TODO

addProducer

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

Description copied from interface: Broker

Adds a producer.

Specified by:

addProducer in interface Broker

Specified by:

addProducer in interface Region

Parameters:

context - the environment the operation is being executed under.

Throws:

Exception - TODO

commitTransaction

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

Description copied from interface: Broker

Commits a transaction.

Specified by:

commitTransaction in interface Broker

Throws:

Exception - TODO

removeSubscription

public void removeSubscription(ConnectionContext context,
                               RemoveSubscriptionInfo info)
                        throws 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:

Exception - TODO

getPreparedTransactions

public TransactionId[] getPreparedTransactions(ConnectionContext context)
                                        throws Exception

Description copied from interface: Broker

Gets a list of all the prepared xa transactions.

Specified by:

getPreparedTransactions in interface Broker

Parameters:

context - transaction ids

Returns:

array of TransactionId values

Throws:

Exception - TODO

prepareTransaction

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

Description copied from interface: Broker

Prepares a transaction. Only valid for xa transactions.

Specified by:

prepareTransaction in interface Broker

Returns:

id

Throws:

Exception - TODO

removeConnection

public void removeConnection(ConnectionContext context,
                             ConnectionInfo info,
                             Throwable error)
                      throws 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:

Exception - TODO

removeConsumer

public void removeConsumer(ConnectionContext context,
                           ConsumerInfo info)
                    throws 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:

Exception - TODO

removeProducer

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

Description copied from interface: Broker

Removes a producer.

Specified by:

removeProducer in interface Broker

Specified by:

removeProducer in interface Region

Parameters:

context - the environment the operation is being executed under.

Throws:

Exception - TODO

rollbackTransaction

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

Description copied from interface: Broker

Rollsback a transaction.

Specified by:

rollbackTransaction in interface Broker

Throws:

Exception - TODO

send

public void send(ProducerBrokerExchange producerExchange,
                 Message messageSend)
          throws 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:

producerExchange - the environment the operation is being executed under.

Throws:

Exception - TODO

beginTransaction

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

Description copied from interface: Broker

Starts a transaction.

Specified by:

beginTransaction in interface Broker

Throws:

Exception - TODO

forgetTransaction

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

Description copied from interface: Broker

Forgets a transaction.

Specified by:

forgetTransaction in interface Broker

Throws:

Exception

getClients

public Connection[] getClients()
                        throws Exception

Specified by:

getClients in interface Broker

Returns:

all clients added to the Broker.

Throws:

Exception - TODO

addDestination

public Destination addDestination(ConnectionContext context,
                                  ActiveMQDestination destination,
                                  boolean createIfTemporary)
                           throws 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:

Exception - TODO

removeDestination

public void removeDestination(ConnectionContext context,
                              ActiveMQDestination destination,
                              long timeout)
                       throws 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:

Exception - TODO

getDestinations

public ActiveMQDestination[] getDestinations()
                                      throws Exception

Specified by:

getDestinations in interface Broker

Returns:

all destinations added to the Broker.

Throws:

Exception - TODO

start

public void start()
           throws Exception

Specified by:

start in interface Service

Throws:

Exception

stop

public void stop()
          throws Exception

Specified by:

stop in interface Service

Throws:

Exception

addSession

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

Description copied from interface: Broker

Adds a session.

Specified by:

addSession in interface Broker

Throws:

Exception - TODO

removeSession

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

Description copied from interface: Broker

Removes a session.

Specified by:

removeSession in interface Broker

Throws:

Exception - TODO

getBrokerId

public BrokerId getBrokerId()

Description copied from interface: Broker

Get the id of the broker

Specified by:

getBrokerId in interface Broker

getBrokerName

public String getBrokerName()

Description copied from interface: Broker

Get the name of the broker

Specified by:

getBrokerName in interface Broker

gc

public void gc()

Specified by:

gc in interface Region

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

preProcessDispatch

public void preProcessDispatch(MessageDispatch messageDispatch)

Description copied from interface: Broker

Notify the Broker that a dispatch is going to happen

Specified by:

preProcessDispatch in interface Broker

postProcessDispatch

public void postProcessDispatch(MessageDispatch messageDispatch)

Description copied from interface: Broker

Notify the Broker that a dispatch has happened

Specified by:

postProcessDispatch in interface Broker

processDispatchNotification

public void processDispatchNotification(MessageDispatchNotification messageDispatchNotification)
                                 throws Exception

Description copied from interface: Region

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

Specified by:

processDispatchNotification in interface Region

Throws:

Exception - TODO

isStopped

public boolean isStopped()

Specified by:

isStopped in interface Broker

Returns:

true if the broker has stopped

getDurableDestinations

public Set<ActiveMQDestination> getDurableDestinations()

Specified by:

getDurableDestinations in interface Broker

Returns:

a Set of all durable destinations

addDestinationInfo

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

Description copied from interface: Broker

Add and process a DestinationInfo object

Specified by:

addDestinationInfo in interface Broker

Throws:

Exception

removeDestinationInfo

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

Description copied from interface: Broker

Remove and process a DestinationInfo object

Specified by:

removeDestinationInfo in interface Broker

Throws:

Exception

isFaultTolerantConfiguration

public boolean isFaultTolerantConfiguration()

Specified by:

isFaultTolerantConfiguration in interface Broker

Returns:

true if fault tolerant

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

getTempDataStore

public PListStore getTempDataStore()

Specified by:

getTempDataStore in interface Broker

Returns:

the temp data store

getVmConnectorURI

public URI getVmConnectorURI()

Specified by:

getVmConnectorURI in interface Broker

Returns:

the URI that can be used to connect to the local Broker

brokerServiceStarted

public void brokerServiceStarted()

Description copied from interface: Broker

called when the brokerService starts

Specified by:

brokerServiceStarted in interface Broker

getBrokerService

public BrokerService getBrokerService()

Specified by:

getBrokerService in interface Broker

Returns:

the BrokerService

isExpired

public boolean isExpired(MessageReference messageReference)

Description copied from interface: Broker

Determine if a message has expired -allows default behaviour to be overriden - as the timestamp set by the producer can be out of sync with the broker

Specified by:

isExpired in interface Broker

Returns:

true if the message is expired

messageExpired

public void messageExpired(ConnectionContext context,
                           MessageReference message,
                           Subscription subscription)

Description copied from interface: Broker

A Message has Expired

Specified by:

messageExpired in interface Broker

subscription - (may be null)

sendToDeadLetterQueue

public boolean sendToDeadLetterQueue(ConnectionContext context,
                                     MessageReference messageReference,
                                     Subscription subscription,
                                     Throwable poisonCause)

Description copied from interface: Broker

A message needs to go the a DLQ

Specified by:

sendToDeadLetterQueue in interface Broker

poisonCause - reason for dlq submission, may be null

Returns:

true if Message was placed in a DLQ false if discarded.

getRoot

public Broker getRoot()

Description copied from interface: Broker

Ensure we get the Broker at the top of the Stack

Specified by:

getRoot in interface Broker

Returns:

the broker at the top of the Stack

getBrokerSequenceId

public long getBrokerSequenceId()

Specified by:

getBrokerSequenceId in interface Broker

Returns:

the broker sequence id

fastProducer

public void fastProducer(ConnectionContext context,
                         ProducerInfo producerInfo,
                         ActiveMQDestination destination)

Description copied from interface: Broker

Called to notify a producer is too fast

Specified by:

fastProducer in interface Broker

isFull

public void isFull(ConnectionContext context,
                   Destination destination,
                   Usage<?> usage)

Description copied from interface: Broker

Called when a Usage reaches a limit

Specified by:

isFull in interface Broker

messageConsumed

public void messageConsumed(ConnectionContext context,
                            MessageReference messageReference)

Description copied from interface: Broker

called when message is consumed

Specified by:

messageConsumed in interface Broker

messageDelivered

public void messageDelivered(ConnectionContext context,
                             MessageReference messageReference)

Description copied from interface: Broker

Called when message is delivered to the broker

Specified by:

messageDelivered in interface Broker

messageDiscarded

public void messageDiscarded(ConnectionContext context,
                             Subscription sub,
                             MessageReference messageReference)

Description copied from interface: Broker

Called when a message is discarded - e.g. running low on memory This will happen only if the policy is enabled - e.g. non durable topics

Specified by:

messageDiscarded in interface Broker

slowConsumer

public void slowConsumer(ConnectionContext context,
                         Destination destination,
                         Subscription subs)

Description copied from interface: Broker

Called when there is a slow consumer

Specified by:

slowConsumer in interface Broker

virtualDestinationAdded

public void virtualDestinationAdded(ConnectionContext context,
                                    VirtualDestination virtualDestination)

Specified by:

virtualDestinationAdded in interface Broker

virtualDestinationRemoved

public void virtualDestinationRemoved(ConnectionContext context,
                                      VirtualDestination virtualDestination)

Specified by:

virtualDestinationRemoved in interface Broker

nowMasterBroker

public void nowMasterBroker()

Description copied from interface: Broker

called when the broker becomes the master in a master/slave configuration

Specified by:

nowMasterBroker in interface Broker

processConsumerControl

public void processConsumerControl(ConsumerBrokerExchange consumerExchange,
                                   ConsumerControl control)

Specified by:

processConsumerControl in interface Region

reapplyInterceptor

public void reapplyInterceptor()

Specified by:

reapplyInterceptor in interface Region

getScheduler

public Scheduler getScheduler()

Specified by:

getScheduler in interface Broker

getExecutor

public ThreadPoolExecutor getExecutor()

Specified by:

getExecutor in interface Broker

networkBridgeStarted

public void networkBridgeStarted(BrokerInfo brokerInfo,
                                 boolean createdByDuplex,
                                 String remoteIp)

Specified by:

networkBridgeStarted in interface Broker

networkBridgeStopped

public void networkBridgeStopped(BrokerInfo brokerInfo)

Specified by:

networkBridgeStopped in interface Broker