Class KafkaListenerAnnotationBeanPostProcessor<K,V>
- Type Parameters:
K- the key type.V- the value type.
- All Implemented Interfaces:
org.springframework.beans.factory.Aware,org.springframework.beans.factory.config.BeanPostProcessor,org.springframework.beans.factory.InitializingBean,org.springframework.beans.factory.SmartInitializingSingleton,org.springframework.context.ApplicationContextAware,org.springframework.core.Ordered
KafkaListener
to be invoked by a Kafka message listener container created under the covers
by a KafkaListenerContainerFactory
according to the parameters of the annotation.
Annotated methods can use flexible arguments as defined by KafkaListener.
This post-processor is automatically registered by Spring's EnableKafka
annotation.
Auto-detect any KafkaListenerConfigurer 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
EnableKafka Javadoc for complete usage details.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfacePost processes each set of annotation attributes. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe bean name of the defaultKafkaListenerContainerFactory.Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidprotected voidReturn theKafkaListenerEndpointRegistrar.org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactoryReturn the configured handler factory.intgetOrder()protected StringnoBeanFoundMessage(Object target, String listenerBeanName, String requestedBeanName, Class<?> expectedClass) postProcessAfterInitialization(Object bean, String beanName) postProcessBeforeInitialization(Object bean, String beanName) protected voidprocessKafkaListener(KafkaListener kafkaListener, Method method, Object bean, String beanName) protected voidprocessListener(MethodKafkaListenerEndpoint<?, ?> endpoint, KafkaListener kafkaListener, Object bean, String beanName, String[] topics, TopicPartitionOffset[] tps) voidsetApplicationContext(org.springframework.context.ApplicationContext applicationContext) voidsetBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory) Making aBeanFactoryavailable is optional; if not set,KafkaListenerConfigurerbeans won't get autodetected and anendpoint registryhas to be explicitly configured.voidsetCharset(Charset charset) Set a charset to use when converting byte[] to String in method arguments and other String/byte[] conversions.voidsetDefaultContainerFactoryBeanName(String containerFactoryBeanName) Set the name of theKafkaListenerContainerFactoryto use by default.voidsetEndpointRegistry(KafkaListenerEndpointRegistry endpointRegistry) Set theKafkaListenerEndpointRegistrythat will hold the created endpoint and manage the lifecycle of the related listener container.voidsetMessageHandlerMethodFactory(org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory messageHandlerMethodFactory) Set theMessageHandlerMethodFactoryto use to configure the message listener responsible to serve an endpoint detected by this processor.
-
Field Details
-
DEFAULT_KAFKA_LISTENER_CONTAINER_FACTORY_BEAN_NAME
The bean name of the defaultKafkaListenerContainerFactory.- See Also:
-
-
Constructor Details
-
KafkaListenerAnnotationBeanPostProcessor
public KafkaListenerAnnotationBeanPostProcessor()
-
-
Method Details
-
getOrder
public int getOrder()- Specified by:
getOrderin interfaceorg.springframework.core.Ordered
-
setEndpointRegistry
Set theKafkaListenerEndpointRegistrythat will hold the created endpoint and manage the lifecycle of the related listener container.- Parameters:
endpointRegistry- theKafkaListenerEndpointRegistryto set.
-
setDefaultContainerFactoryBeanName
Set the name of theKafkaListenerContainerFactoryto use by default.If none is specified, "kafkaListenerContainerFactory" is assumed to be defined.
- Parameters:
containerFactoryBeanName- theKafkaListenerContainerFactorybean name.
-
setMessageHandlerMethodFactory
public void setMessageHandlerMethodFactory(org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory messageHandlerMethodFactory) 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.
-
getMessageHandlerMethodFactory
public org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory getMessageHandlerMethodFactory()Return the configured handler factory.- Returns:
- the factory.
- Since:
- 2.5.7
-
getEndpointRegistrar
Return theKafkaListenerEndpointRegistrar.- Returns:
- the registrar.
- Since:
- 2.9.3
-
setApplicationContext
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext) throws org.springframework.beans.BeansException - Specified by:
setApplicationContextin interfaceorg.springframework.context.ApplicationContextAware- Throws:
org.springframework.beans.BeansException
-
setBeanFactory
public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory) Making aBeanFactoryavailable is optional; if not set,KafkaListenerConfigurerbeans won't get autodetected and anendpoint registryhas to be explicitly configured.- Parameters:
beanFactory- theBeanFactoryto be used.
-
setCharset
Set a charset to use when converting byte[] to String in method arguments and other String/byte[] conversions. Default UTF-8.- Parameters:
charset- the charset.- Since:
- 2.2
-
afterPropertiesSet
- Specified by:
afterPropertiesSetin interfaceorg.springframework.beans.factory.InitializingBean- Throws:
Exception
-
afterSingletonsInstantiated
public void afterSingletonsInstantiated()- Specified by:
afterSingletonsInstantiatedin interfaceorg.springframework.beans.factory.SmartInitializingSingleton
-
postProcessBeforeInitialization
public Object postProcessBeforeInitialization(Object bean, String beanName) throws org.springframework.beans.BeansException - Specified by:
postProcessBeforeInitializationin interfaceorg.springframework.beans.factory.config.BeanPostProcessor- Throws:
org.springframework.beans.BeansException
-
postProcessAfterInitialization
public Object postProcessAfterInitialization(Object bean, String beanName) throws org.springframework.beans.BeansException - Specified by:
postProcessAfterInitializationin interfaceorg.springframework.beans.factory.config.BeanPostProcessor- Throws:
org.springframework.beans.BeansException
-
processKafkaListener
protected void processKafkaListener(KafkaListener kafkaListener, Method method, Object bean, String beanName) -
processListener
protected void processListener(MethodKafkaListenerEndpoint<?, ?> endpoint, KafkaListener kafkaListener, Object bean, String beanName, String[] topics, TopicPartitionOffset[] tps) -
assertBeanFactory
protected void assertBeanFactory() -
noBeanFoundMessage
-