Package org.springframework.amqp.rabbit.listener

Class RabbitListenerEndpointRegistrar

java.lang.Object

org.springframework.amqp.rabbit.listener.RabbitListenerEndpointRegistrar

All Implemented Interfaces:

Aware, BeanFactoryAware, InitializingBean

public class RabbitListenerEndpointRegistrar
extends Object
implements BeanFactoryAware, InitializingBean

Helper bean for registering RabbitListenerEndpoint with a RabbitListenerEndpointRegistry.

Since:

1.4

Author:

Stephane Nicoll, Juergen Hoeller, Artem Bilan

See Also:

• RabbitListenerConfigurer

Constructor Summary

Constructors

Constructor	Description
RabbitListenerEndpointRegistrar()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
List<HandlerMethodArgumentResolver>	getCustomMethodArgumentResolvers()	Return the list of HandlerMethodArgumentResolver.
RabbitListenerEndpointRegistry	getEndpointRegistry()
MessageHandlerMethodFactory	getMessageHandlerMethodFactory()
Validator	getValidator()	Get the validator, if supplied.
protected void	registerAllEndpoints()
void	registerEndpoint(RabbitListenerEndpoint endpoint)	Register a new RabbitListenerEndpoint using the default RabbitListenerContainerFactory to create the underlying container.
void	registerEndpoint(RabbitListenerEndpoint endpoint, RabbitListenerContainerFactory<?> factory)	Register a new RabbitListenerEndpoint alongside the RabbitListenerContainerFactory to use to create the underlying container.
void	setBeanFactory(BeanFactory beanFactory)	A BeanFactory only needs to be available in conjunction with setContainerFactoryBeanName(java.lang.String).
void	setContainerFactory(RabbitListenerContainerFactory<?> containerFactory)	Set the RabbitListenerContainerFactory to use in case a RabbitListenerEndpoint is registered with a null container factory.
void	setContainerFactoryBeanName(String containerFactoryBeanName)	Set the bean name of the RabbitListenerContainerFactory to use in case a RabbitListenerEndpoint is registered with a null container factory.
void	setCustomMethodArgumentResolvers(HandlerMethodArgumentResolver... methodArgumentResolvers)	Add custom methods arguments resolvers to RabbitListenerAnnotationBeanPostProcessor Default empty list.
void	setEndpointRegistry(RabbitListenerEndpointRegistry endpointRegistry)	Set the RabbitListenerEndpointRegistry instance to use.
void	setMessageHandlerMethodFactory(MessageHandlerMethodFactory rabbitHandlerMethodFactory)	Set the MessageHandlerMethodFactory to use to configure the message listener responsible to serve an endpoint detected by this processor.
void	setValidator(Validator validator)	Set the validator to use if the default message handler factory is used.

Methods inherited from class java.lang.Object

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

Constructor Details

RabbitListenerEndpointRegistrar

public RabbitListenerEndpointRegistrar()

Method Details

setEndpointRegistry

public void setEndpointRegistry(RabbitListenerEndpointRegistry endpointRegistry)

Set the RabbitListenerEndpointRegistry instance to use.

Parameters:

endpointRegistry - the RabbitListenerEndpointRegistry instance to use.

getEndpointRegistry

@Nullable
public RabbitListenerEndpointRegistry getEndpointRegistry()

Returns:

the RabbitListenerEndpointRegistry instance for this registrar, may be null.

getCustomMethodArgumentResolvers

public List<HandlerMethodArgumentResolver> getCustomMethodArgumentResolvers()

Return the list of HandlerMethodArgumentResolver.

Returns:

the list of HandlerMethodArgumentResolver.

Since:

2.3.7

setCustomMethodArgumentResolvers

public void setCustomMethodArgumentResolvers(HandlerMethodArgumentResolver... methodArgumentResolvers)

Add custom methods arguments resolvers to RabbitListenerAnnotationBeanPostProcessor Default empty list.

Parameters:

methodArgumentResolvers - the methodArgumentResolvers to assign.

Since:

2.3.7

setMessageHandlerMethodFactory

public void setMessageHandlerMethodFactory(MessageHandlerMethodFactory rabbitHandlerMethodFactory)

Set the MessageHandlerMethodFactory to use to configure the message listener responsible to serve an endpoint detected by this processor.

By default, DefaultMessageHandlerMethodFactory is used and it can be configured further to support additional method arguments or to customize conversion and validation support. See DefaultMessageHandlerMethodFactory javadoc for more details.

Parameters:

rabbitHandlerMethodFactory - the MessageHandlerMethodFactory instance.

getMessageHandlerMethodFactory

public MessageHandlerMethodFactory getMessageHandlerMethodFactory()

Returns:

the custom MessageHandlerMethodFactory to use, if any.

setContainerFactory

public void setContainerFactory(RabbitListenerContainerFactory<?> containerFactory)

Set the RabbitListenerContainerFactory to use in case a RabbitListenerEndpoint is registered with a null container factory.

Alternatively, the bean name of the RabbitListenerContainerFactory to use can be specified for a lazy lookup, see setContainerFactoryBeanName(java.lang.String).

Parameters:

containerFactory - the RabbitListenerContainerFactory instance.

setContainerFactoryBeanName

public void setContainerFactoryBeanName(String containerFactoryBeanName)

Set the bean name of the RabbitListenerContainerFactory to use in case a RabbitListenerEndpoint is registered with a null container factory. Alternatively, the container factory instance can be registered directly: see setContainerFactory(RabbitListenerContainerFactory).

Parameters:

containerFactoryBeanName - the RabbitListenerContainerFactory bean name.

See Also:

• setBeanFactory(org.springframework.beans.factory.BeanFactory)

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)

A BeanFactory only needs to be available in conjunction with setContainerFactoryBeanName(java.lang.String).

Specified by:

setBeanFactory in interface BeanFactoryAware

Parameters:

beanFactory - the BeanFactory instance.

getValidator

@Nullable
public Validator getValidator()

Get the validator, if supplied.

Returns:

the validator.

Since:

2.3.7

setValidator

public void setValidator(Validator validator)

Set the validator to use if the default message handler factory is used.

Parameters:

validator - the validator.

Since:

2.3.7

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

registerAllEndpoints

protected void registerAllEndpoints()

registerEndpoint

public void registerEndpoint(RabbitListenerEndpoint endpoint,
 @Nullable
 RabbitListenerContainerFactory<?> factory)

Register a new RabbitListenerEndpoint alongside the RabbitListenerContainerFactory to use to create the underlying container.

The factory may be null if the default factory has to be used for that endpoint.

Parameters:

endpoint - the RabbitListenerEndpoint instance to register.

factory - the RabbitListenerContainerFactory to use.

registerEndpoint

public void registerEndpoint(RabbitListenerEndpoint endpoint)

Register a new RabbitListenerEndpoint using the default RabbitListenerContainerFactory to create the underlying container.

Parameters:

endpoint - the RabbitListenerEndpoint instance to register.

See Also:

• setContainerFactory(RabbitListenerContainerFactory)
• registerEndpoint(RabbitListenerEndpoint, RabbitListenerContainerFactory)