Class BrokerEventListener
- java.lang.Object
-
- org.springframework.amqp.rabbit.core.BrokerEventListener
-
- All Implemented Interfaces:
MessageListener,ConnectionListener,Aware,ApplicationEventPublisherAware,Lifecycle,Phased,SmartLifecycle
public class BrokerEventListener extends java.lang.Object implements MessageListener, ApplicationEventPublisherAware, ConnectionListener, SmartLifecycle
When the event-exchange-plugin is enabled (see https://www.rabbitmq.com/event-exchange.html), if an object of this type is declared as a bean, selected events will be published asBrokerEvents. Such events can then be consumed using anApplicationListeneror@EventListenermethod. AnAnonymousQueuewill be bound to theamq.rabbitmq.eventtopic exchange with the supplied keys.- Since:
- 2.1
- Author:
- Gary Russell
-
-
Field Summary
-
Fields inherited from interface org.springframework.context.SmartLifecycle
DEFAULT_PHASE
-
-
Constructor Summary
Constructors Constructor Description BrokerEventListener(ConnectionFactory connectionFactory, java.lang.String... eventKeys)Construct an instance using the supplied connection factory and event keys.BrokerEventListener(AbstractMessageListenerContainer container, java.lang.String... eventKeys)Construct an instance using the supplied listener container factory and event keys.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.ExceptiongetBindingsFailedException()Return any exception thrown when attempting to bind the queue to the event exchange.intgetPhase()booleanisAutoStartup()booleanisRunning()voidonCreate(Connection connection)Called when a new connection is established.voidonMessage(Message message)Delivers a single message.voidsetApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)voidsetAutoStartup(boolean autoStartup)voidsetPhase(int phase)voidstart()voidstop()-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.springframework.amqp.rabbit.connection.ConnectionListener
onClose, onFailed, onShutDown
-
Methods inherited from interface org.springframework.amqp.core.MessageListener
containerAckMode, isAsyncReplies, onMessageBatch
-
Methods inherited from interface org.springframework.context.SmartLifecycle
stop
-
-
-
-
Constructor Detail
-
BrokerEventListener
public BrokerEventListener(ConnectionFactory connectionFactory, java.lang.String... eventKeys)
Construct an instance using the supplied connection factory and event keys. Event keys are patterns to match routing keys for events published to theamq.rabbitmq.eventtopic exchange. They can therefore match wildcards; examples areuser.#, queue.created. Refer to the plugin documentation for information about available events. A single-threadedDirectMessageListenerContainerwill be created; its lifecycle will be controlled by this object'sSmartLifecyclemethods.- Parameters:
connectionFactory- the connection factory.eventKeys- the event keys.
-
BrokerEventListener
public BrokerEventListener(AbstractMessageListenerContainer container, java.lang.String... eventKeys)
Construct an instance using the supplied listener container factory and event keys. Event keys are patterns to match routing keys for events published to theamq.rabbitmq.eventtopic exchange. They can therefore match wildcards; examples areuser.#, queue.created. Refer to the plugin documentation for information about available events. The container's lifecycle will be not be controlled by this object'sSmartLifecyclemethods. The container should not be configured with queues or aMessageListener; those properties will be replaced.- Parameters:
container- the listener container.eventKeys- the event keys.
-
-
Method Detail
-
setApplicationEventPublisher
public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
- Specified by:
setApplicationEventPublisherin interfaceApplicationEventPublisherAware
-
getBindingsFailedException
@Nullable public java.lang.Exception getBindingsFailedException()
Return any exception thrown when attempting to bind the queue to the event exchange.- Returns:
- the exception.
-
getPhase
public int getPhase()
- Specified by:
getPhasein interfacePhased- Specified by:
getPhasein interfaceSmartLifecycle
-
setPhase
public void setPhase(int phase)
-
isAutoStartup
public boolean isAutoStartup()
- Specified by:
isAutoStartupin interfaceSmartLifecycle
-
setAutoStartup
public void setAutoStartup(boolean autoStartup)
-
onMessage
public void onMessage(Message message)
Description copied from interface:MessageListenerDelivers a single message.- Specified by:
onMessagein interfaceMessageListener- Parameters:
message- the message.
-
onCreate
public void onCreate(@Nullable Connection connection)
Description copied from interface:ConnectionListenerCalled when a new connection is established.- Specified by:
onCreatein interfaceConnectionListener- Parameters:
connection- the connection.
-
-