Class RedisListenerEndpointRegistrar

java.lang.Object

org.springframework.data.redis.config.RedisListenerEndpointRegistrar

All Implemented Interfaces:

Aware, BeanFactoryAware, InitializingBean

public class RedisListenerEndpointRegistrar
extends Object
implements BeanFactoryAware, InitializingBean

Helper bean for registering RedisListenerEndpoint instances with a RedisListenerEndpointRegistry.

Provides convenient methods to register endpoints and configure the underlying infrastructure, such as the MessageHandlerMethodFactory and MessageConverter.

Since:

4.1

Author:

Ilyass Bougati, Mark Paluch

Constructor Summary

Constructors

Constructor	Description
RedisListenerEndpointRegistrar()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
void	apply(List<RedisListenerConfigurer> configurers)
@Nullable RedisListenerEndpointRegistry	getEndpointRegistry()	Return the RedisListenerEndpointRegistry instance for this registrar, may be null.
MessageHandlerMethodFactory	getMessageHandlerMethodFactory()	Return the MessageHandlerMethodFactory to use.
protected void	registerAllEndpoints()	Register all queued endpoints directly with the underlying registry.
void	registerEndpoint(RedisListenerEndpoint endpoint, RedisMessageListenerContainer container)	Register a new RedisListenerEndpoint alongside the RedisMessageListenerContainer.
void	setBeanFactory(BeanFactory beanFactory)
void	setConversionService(@Nullable ConversionService conversionService)	Set the ConversionService to use for payload conversion.
void	setCustomArgumentResolvers(List<HandlerMethodArgumentResolver> customArgumentResolvers)	Set custom resolvers to support custom controller method arguments.
void	setEndpointRegistry(@Nullable RedisListenerEndpointRegistry endpointRegistry)	Set the RedisListenerEndpointRegistry instance to use.
void	setMessageConverter(@Nullable MessageConverter messageConverter)	Set the MessageConverter to use for payload conversion.
void	setMessageHandlerMethodFactory(@Nullable MessageHandlerMethodFactory messageHandlerMethodFactory)	Set the MessageHandlerMethodFactory to use to configure the message listener responsible to serve an endpoint detected by this processor.
void	setValidator(@Nullable Validator validator)	Set the Validator to use for payload validation.

Methods inherited from class Object

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

Constructor Details

RedisListenerEndpointRegistrar

public RedisListenerEndpointRegistrar()

Method Details

setEndpointRegistry

public void setEndpointRegistry(@Nullable RedisListenerEndpointRegistry endpointRegistry)

Set the RedisListenerEndpointRegistry instance to use.

Parameters:

endpointRegistry - the RedisListenerEndpointRegistry

getEndpointRegistry

public @Nullable RedisListenerEndpointRegistry getEndpointRegistry()

Return the RedisListenerEndpointRegistry instance for this registrar, may be null.

setMessageHandlerMethodFactory

public void setMessageHandlerMethodFactory(@Nullable MessageHandlerMethodFactory messageHandlerMethodFactory)

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.

getMessageHandlerMethodFactory

public MessageHandlerMethodFactory getMessageHandlerMethodFactory()

Return the MessageHandlerMethodFactory to use.

If no custom factory is set, a default one will be created based on the configured ConversionService, MessageConverter, and Validator.

Returns:

the MessageHandlerMethodFactory

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)

Specified by:

setBeanFactory in interface BeanFactoryAware

setCustomArgumentResolvers

public void setCustomArgumentResolvers(List<HandlerMethodArgumentResolver> customArgumentResolvers)

Set custom resolvers to support custom controller method arguments.

Parameters:

customArgumentResolvers - the list of resolvers to configure

setValidator

public void setValidator(@Nullable Validator validator)

Set the Validator to use for payload validation.

Parameters:

validator - the Validator to configure

setConversionService

public void setConversionService(@Nullable ConversionService conversionService)

Set the ConversionService to use for payload conversion.

Parameters:

conversionService - the ConversionService to configure. Can be null to use the default.

setMessageConverter

public void setMessageConverter(@Nullable MessageConverter messageConverter)

Set the MessageConverter to use for payload conversion.

Parameters:

messageConverter - the MessageConverter to configure

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

registerAllEndpoints

protected void registerAllEndpoints()

Register all queued endpoints directly with the underlying registry.

registerEndpoint

public void registerEndpoint(RedisListenerEndpoint endpoint,
 RedisMessageListenerContainer container)

Register a new RedisListenerEndpoint alongside the RedisMessageListenerContainer.

If the underlying RedisListenerEndpointRegistry is already active, the endpoint is registered and started immediately. Otherwise, it is queued and registered once the registry becomes active.

Parameters:

endpoint - the RedisListenerEndpoint to register

apply

public void apply(List<RedisListenerConfigurer> configurers)