Class RedisListenerAnnotationBeanPostProcessor

java.lang.Object

org.springframework.data.redis.annotation.RedisListenerAnnotationBeanPostProcessor

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanPostProcessor, SmartInitializingSingleton, Ordered

public class RedisListenerAnnotationBeanPostProcessor
extends Object
implements BeanPostProcessor, BeanFactoryAware, Ordered, SmartInitializingSingleton

Bean post-processor that registers methods annotated with RedisListener to be subscribed to a Redis message listener container according to the attributes of the annotation.

Annotated methods can use flexible arguments as defined by RedisListener.

This post-processor is automatically registered by Spring's by the EnableRedisListeners annotation.

See the EnableRedisListeners javadocs for complete usage details.

Since:

4.1

Author:

Ilyass Bougati, Mark Paluch, Christoph Strobl

See Also:

• RedisListener

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.commons.logging.Log	logger

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
RedisListenerAnnotationBeanPostProcessor()

Method Summary

Modifier and Type	Method	Description
void	afterSingletonsInstantiated()
MethodRedisListenerEndpoint	createEndpoint(RedisListener redisListener, Method method, Object bean)
int	getOrder()
protected RedisMessageListenerContainer	getRedisMessageListenerContainer(RedisListener redisListener, Method method)
Object	postProcessAfterInitialization(Object bean, String beanName)
protected void	processRedisListener(RedisListener redisListener, Method method, Object bean)	Process the given RedisListener annotation on the given method, registering a corresponding endpoint for the given bean instance.
void	setBeanFactory(BeanFactory beanFactory)	Making a BeanFactory available is optional; if not set, endpoint registry has to be explicitly configured.
void	setEndpointRegistry(@Nullable RedisListenerEndpointRegistry endpointRegistry)	Set the RedisListenerEndpointRegistry that will hold the created endpoint.
void	setMessageHandlerMethodFactory(MessageHandlerMethodFactory messageHandlerMethodFactory)	Set the MessageHandlerMethodFactory to use to configure the message listener responsible to serve an endpoint detected by this processor.
void	setOrder(int order)

Methods inherited from class Object

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

Methods inherited from interface BeanPostProcessor

postProcessBeforeInitialization

Field Details

logger

protected final org.apache.commons.logging.Log logger

Constructor Details

RedisListenerAnnotationBeanPostProcessor

public RedisListenerAnnotationBeanPostProcessor()

Method Details

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

setOrder

public void setOrder(int order)

setEndpointRegistry

public void setEndpointRegistry(@Nullable RedisListenerEndpointRegistry endpointRegistry)

Set the RedisListenerEndpointRegistry that will hold the created endpoint.

setMessageHandlerMethodFactory

public void setMessageHandlerMethodFactory(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. It can be configured further to support additional method arguments or to customize conversion and validation support. See DefaultMessageHandlerMethodFactory Javadoc for more details.

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)

Making a BeanFactory available is optional; if not set, endpoint registry has to be explicitly configured.

Specified by:

setBeanFactory in interface BeanFactoryAware

afterSingletonsInstantiated

public void afterSingletonsInstantiated()

Specified by:

afterSingletonsInstantiated in interface SmartInitializingSingleton

postProcessAfterInitialization

public Object postProcessAfterInitialization(Object bean,
 String beanName)

Specified by:

postProcessAfterInitialization in interface BeanPostProcessor

processRedisListener

protected void processRedisListener(RedisListener redisListener,
 Method method,
 Object bean)

Process the given RedisListener annotation on the given method, registering a corresponding endpoint for the given bean instance.

Parameters:

redisListener - the annotation to process

method - the annotated method

bean - the instance to invoke the method on

getRedisMessageListenerContainer

protected RedisMessageListenerContainer getRedisMessageListenerContainer(RedisListener redisListener,
 Method method)

createEndpoint

public MethodRedisListenerEndpoint createEndpoint(RedisListener redisListener,
 Method method,
 Object bean)