Class RabbitListenerAnnotationBeanPostProcessor
- All Implemented Interfaces:
Aware,BeanClassLoaderAware,BeanFactoryAware,BeanPostProcessor,SmartInitializingSingleton,EnvironmentAware,Ordered
- Direct Known Subclasses:
MultiRabbitListenerAnnotationBeanPostProcessor,RabbitListenerTestHarness
RabbitListener
to be invoked by a AMQP message listener container created under the cover
by a RabbitListenerContainerFactory
according to the parameters of the annotation.
Annotated methods can use flexible arguments as defined by RabbitListener.
This post-processor is automatically registered by Spring's
<rabbit:annotation-driven> XML element, and also by the EnableRabbit
annotation.
Auto-detect any RabbitListenerConfigurer instances in the container,
allowing for customization of the registry to be used, the default container
factory or for fine-grained control over endpoints registration. See
EnableRabbit Javadoc for complete usage details.
- Since:
- 1.4
- Author:
- Stephane Nicoll, Juergen Hoeller, Gary Russell, Alex Panchenko, Artem Bilan
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe bean name of the defaultRabbitListenerContainerFactory.static final StringFields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidprotected voidintgetOrder()protected StringnoBeanFoundMessage(Object target, String listenerBeanName, String requestedBeanName, Class<?> expectedClass) postProcessAfterInitialization(Object bean, String beanName) postProcessBeforeInitialization(Object bean, String beanName) protected Collection<Declarable>processAmqpListener(RabbitListener rabbitListener, Method method, Object bean, String beanName) protected Collection<Declarable>processListener(MethodRabbitListenerEndpoint endpoint, RabbitListener rabbitListener, Object bean, Object target, String beanName) protected StringresolveExpressionAsString(String value, String attribute) voidsetBeanClassLoader(ClassLoader classLoader) voidsetBeanFactory(BeanFactory beanFactory) Making aBeanFactoryavailable is optional; if not set,RabbitListenerConfigurerbeans won't get autodetected and anendpoint registryhas to be explicitly configured.voidsetCharset(Charset charset) Set a charset for byte[] to String method argument conversion.voidsetContainerFactoryBeanName(String containerFactoryBeanName) Set the name of theRabbitListenerContainerFactoryto use by default.voidsetEndpointRegistry(RabbitListenerEndpointRegistry endpointRegistry) Set theRabbitListenerEndpointRegistrythat will hold the created endpoint and manage the lifecycle of the related listener container.voidsetEnvironment(Environment environment) voidsetMessageHandlerMethodFactory(MessageHandlerMethodFactory messageHandlerMethodFactory) Set theMessageHandlerMethodFactoryto use to configure the message listener responsible to serve an endpoint detected by this processor.
-
Field Details
-
DEFAULT_RABBIT_LISTENER_CONTAINER_FACTORY_BEAN_NAME
The bean name of the defaultRabbitListenerContainerFactory.- See Also:
-
RABBIT_EMPTY_STRING_ARGUMENTS_PROPERTY
- See Also:
-
-
Constructor Details
-
RabbitListenerAnnotationBeanPostProcessor
public RabbitListenerAnnotationBeanPostProcessor()
-
-
Method Details
-
getOrder
public int getOrder() -
setEndpointRegistry
Set theRabbitListenerEndpointRegistrythat will hold the created endpoint and manage the lifecycle of the related listener container.- Parameters:
endpointRegistry- theRabbitListenerEndpointRegistryto set.
-
setContainerFactoryBeanName
Set the name of theRabbitListenerContainerFactoryto use by default.If none is specified, "rabbitListenerContainerFactory" is assumed to be defined.
- Parameters:
containerFactoryBeanName- theRabbitListenerContainerFactorybean name.
-
setMessageHandlerMethodFactory
Set theMessageHandlerMethodFactoryto use to configure the message listener responsible to serve an endpoint detected by this processor.By default,
DefaultMessageHandlerMethodFactoryis used and it can be configured further to support additional method arguments or to customize conversion and validation support. SeeDefaultMessageHandlerMethodFactoryJavadoc for more details.- Parameters:
messageHandlerMethodFactory- theMessageHandlerMethodFactoryinstance.
-
setBeanFactory
Making aBeanFactoryavailable is optional; if not set,RabbitListenerConfigurerbeans won't get autodetected and anendpoint registryhas to be explicitly configured.- Specified by:
setBeanFactoryin interfaceBeanFactoryAware- Parameters:
beanFactory- theBeanFactoryto be used.
-
setBeanClassLoader
- Specified by:
setBeanClassLoaderin interfaceBeanClassLoaderAware
-
setEnvironment
- Specified by:
setEnvironmentin interfaceEnvironmentAware
-
setCharset
Set a charset for byte[] to String method argument conversion.- Parameters:
charset- the charset (default UTF-8).- Since:
- 2.2
-
afterSingletonsInstantiated
public void afterSingletonsInstantiated()- Specified by:
afterSingletonsInstantiatedin interfaceSmartInitializingSingleton
-
postProcessBeforeInitialization
- Specified by:
postProcessBeforeInitializationin interfaceBeanPostProcessor- Throws:
BeansException
-
postProcessAfterInitialization
- Specified by:
postProcessAfterInitializationin interfaceBeanPostProcessor- Throws:
BeansException
-
processAmqpListener
protected Collection<Declarable> processAmqpListener(RabbitListener rabbitListener, Method method, Object bean, String beanName) -
processListener
protected Collection<Declarable> processListener(MethodRabbitListenerEndpoint endpoint, RabbitListener rabbitListener, Object bean, Object target, String beanName) -
assertBeanFactory
protected void assertBeanFactory() -
noBeanFoundMessage
-
resolveExpressionAsString
-