Package org.springframework.amqp.rabbit.listener

Class RabbitListenerEndpointRegistry

java.lang.Object

org.springframework.amqp.rabbit.listener.RabbitListenerEndpointRegistry

All Implemented Interfaces:

EventListener, Aware, DisposableBean, ApplicationContextAware, ApplicationListener<ContextRefreshedEvent>, Lifecycle, Phased, SmartLifecycle

public class RabbitListenerEndpointRegistry
extends Object
implements DisposableBean, SmartLifecycle, ApplicationContextAware, ApplicationListener<ContextRefreshedEvent>

Creates the necessary MessageListenerContainer instances for the registered endpoints. Also manages the lifecycle of the listener containers, in particular within the lifecycle of the application context.

Contrary to MessageListenerContainers created manually, listener containers managed by registry are not beans in the application context and are not candidates for autowiring. Use getListenerContainers() if you need to access this registry's listener containers for management purposes. If you need to access to a specific message listener container, use getListenerContainer(String) with the id of the endpoint.

Since:

1.4

Author:

Stephane Nicoll, Juergen Hoeller, Artem Bilan, Gary Russell

See Also:

• RabbitListenerEndpoint
• MessageListenerContainer
• RabbitListenerContainerFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected final Log	logger

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
RabbitListenerEndpointRegistry()

Method Summary

Modifier and Type	Method	Description
protected MessageListenerContainer	createListenerContainer(RabbitListenerEndpoint endpoint, RabbitListenerContainerFactory<?> factory)	Create and start a new MessageListenerContainer using the specified factory.
void	destroy()
MessageListenerContainer	getListenerContainer(String id)	Return the MessageListenerContainer with the specified id or null if no such container exists.
Set<String>	getListenerContainerIds()	Return the ids of the managed MessageListenerContainer instance(s).
Collection<MessageListenerContainer>	getListenerContainers()
int	getPhase()
boolean	isAutoStartup()
boolean	isRunning()
void	onApplicationEvent(ContextRefreshedEvent event)
void	registerListenerContainer(RabbitListenerEndpoint endpoint, RabbitListenerContainerFactory<?> factory)	Create a message listener container for the given RabbitListenerEndpoint.
void	registerListenerContainer(RabbitListenerEndpoint endpoint, RabbitListenerContainerFactory<?> factory, boolean startImmediately)	Create a message listener container for the given RabbitListenerEndpoint.
void	setApplicationContext(ApplicationContext applicationContext)
void	start()
void	stop()
void	stop(Runnable callback)
MessageListenerContainer	unregisterListenerContainer(String id)	Remove a listener container from the registry.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationListener

supportsAsyncExecution

Field Details

logger

protected final Log logger

Constructor Details

RabbitListenerEndpointRegistry

public RabbitListenerEndpointRegistry()

Method Details

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

getListenerContainer

public MessageListenerContainer getListenerContainer(String id)

Return the MessageListenerContainer with the specified id or null if no such container exists.

Parameters:

id - the id of the container

Returns:

the container or null if no container with that id exists

See Also:

• RabbitListenerEndpoint.getId()
• getListenerContainerIds()

getListenerContainerIds

public Set<String> getListenerContainerIds()

Return the ids of the managed MessageListenerContainer instance(s).

Returns:

the ids.

Since:

1.5.2

See Also:

• getListenerContainer(String)

getListenerContainers

public Collection<MessageListenerContainer> getListenerContainers()

Returns:

the managed MessageListenerContainer instance(s).

registerListenerContainer

public void registerListenerContainer(RabbitListenerEndpoint endpoint,
 RabbitListenerContainerFactory<?> factory)

Create a message listener container for the given RabbitListenerEndpoint.

This create the necessary infrastructure to honor that endpoint in regard to its configuration.

Parameters:

endpoint - the endpoint to add

factory - the listener factory to use

See Also:

• registerListenerContainer(RabbitListenerEndpoint, RabbitListenerContainerFactory, boolean)

registerListenerContainer

public void registerListenerContainer(RabbitListenerEndpoint endpoint,
 RabbitListenerContainerFactory<?> factory,
 boolean startImmediately)

Create a message listener container for the given RabbitListenerEndpoint.

This create the necessary infrastructure to honor that endpoint in regard to its configuration.

The startImmediately flag determines if the container should be started immediately.

Parameters:

endpoint - the endpoint to add.

factory - the RabbitListenerContainerFactory to use.

startImmediately - start the container immediately if necessary

See Also:

• getListenerContainers()
• getListenerContainer(String)

createListenerContainer

protected MessageListenerContainer createListenerContainer(RabbitListenerEndpoint endpoint,
 RabbitListenerContainerFactory<?> factory)

Create and start a new MessageListenerContainer using the specified factory.

Parameters:

endpoint - the endpoint to create a MessageListenerContainer.

factory - the RabbitListenerContainerFactory to use.

Returns:

the MessageListenerContainer.

unregisterListenerContainer

@Nullable
public MessageListenerContainer unregisterListenerContainer(String id)

Remove a listener container from the registry.

Parameters:

id - the container id.

Returns:

the container, or null if there is no registration matching the id.

Since:

2.0.6

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

getPhase

public int getPhase()

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface SmartLifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

onApplicationEvent

public void onApplicationEvent(ContextRefreshedEvent event)

Specified by:

onApplicationEvent in interface ApplicationListener<ContextRefreshedEvent>