Package org.springframework.kafka.config
Class AbstractKafkaListenerContainerFactory<C extends AbstractMessageListenerContainer<K,V>,K,V>
java.lang.Object
org.springframework.kafka.config.AbstractKafkaListenerContainerFactory<C,K,V>
- Type Parameters:
C- theAbstractMessageListenerContainerimplementation type.K- the key type.V- the value type.
- All Implemented Interfaces:
org.springframework.beans.factory.Aware,org.springframework.beans.factory.InitializingBean,org.springframework.context.ApplicationContextAware,org.springframework.context.ApplicationEventPublisherAware,KafkaListenerContainerFactory<C>
- Direct Known Subclasses:
ConcurrentKafkaListenerContainerFactory
public abstract class AbstractKafkaListenerContainerFactory<C extends AbstractMessageListenerContainer<K,V>,K,V>
extends Object
implements KafkaListenerContainerFactory<C>, org.springframework.context.ApplicationEventPublisherAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware
Base
KafkaListenerContainerFactory for Spring's base container implementation.- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidcreateContainer(String... topics) Create and configure a container without a listener; used to create containers that are not used for KafkaListener annotations.createContainer(Pattern topicPattern) Create and configure a container without a listener; used to create containers that are not used for KafkaListener annotations.createContainer(TopicPartitionOffset... topicsAndPartitions) Create and configure a container without a listener; used to create containers that are not used for KafkaListener annotations.protected abstract CcreateContainerInstance(KafkaListenerEndpoint endpoint) Create an empty container instance.createListenerContainer(KafkaListenerEndpoint endpoint) Create aMessageListenerContainerfor the givenKafkaListenerEndpoint.ConsumerFactory<? super K,? super V> Obtain the properties template for this factory - set properties as needed and they will be copied to a final properties instance for the endpoint.protected voidinitializeContainer(C instance, KafkaListenerEndpoint endpoint) Further initialize the specified container.Return true if this endpoint creates a batch listener.voidsetAckDiscarded(Boolean ackDiscarded) Set to true to ack discards when a filter strategy is in use.voidsetAfterRollbackProcessor(AfterRollbackProcessor<? super K, ? super V> afterRollbackProcessor) Set a processor to invoke after a transaction rollback; typically will seek the unprocessed topic/partition to reprocess the records.voidsetApplicationContext(org.springframework.context.ApplicationContext applicationContext) voidsetApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher) voidsetAutoStartup(Boolean autoStartup) Specify anautoStartup booleanflag.voidsetBatchErrorHandler(BatchErrorHandler errorHandler) Deprecated, for removal: This API element is subject to removal in a future version.voidsetBatchInterceptor(BatchInterceptor<K, V> batchInterceptor) Set a batch interceptor to be called before and after calling the listener.voidsetBatchListener(Boolean batchListener) Set to true if this endpoint should create a batch listener.voidsetBatchToRecordAdapter(BatchToRecordAdapter<K, V> batchToRecordAdapter) Set aBatchToRecordAdapter.voidsetCommonErrorHandler(CommonErrorHandler commonErrorHandler) Set theCommonErrorHandlerwhich can handle errors for both record and batch listeners.voidsetConsumerFactory(ConsumerFactory<? super K, ? super V> consumerFactory) Specify aConsumerFactoryto use.voidsetContainerCustomizer(ContainerCustomizer<K, V, C> containerCustomizer) Set a customizer used to further configure a container after it has been created.voidsetCorrelationHeaderName(String correlationHeaderName) Set a custom header name for the correlation id.voidsetErrorHandler(ErrorHandler errorHandler) Deprecated, for removal: This API element is subject to removal in a future version.in favor ofsetCommonErrorHandler(CommonErrorHandler)voidsetMessageConverter(MessageConverter messageConverter) Set the message converter to use if dynamic argument type matching is needed.voidsetMissingTopicsFatal(boolean missingTopicsFatal) Set to false to allow the container to start even if any of the configured topics are not present on the broker.voidsetPhase(int phase) Specify aphaseto use.voidsetRecordFilterStrategy(RecordFilterStrategy<? super K, ? super V> recordFilterStrategy) Set the record filter strategy.voidsetRecordInterceptor(RecordInterceptor<K, V> recordInterceptor) Set an interceptor to be called before calling the listener.voidsetReplyHeadersConfigurer(ReplyHeadersConfigurer replyHeadersConfigurer) Set a configurer which will be invoked when creating a reply message.voidsetReplyTemplate(KafkaTemplate<?, ?> replyTemplate) Set theKafkaTemplateto use to send replies.
-
Field Details
-
logger
protected final org.springframework.core.log.LogAccessor logger
-
-
Constructor Details
-
AbstractKafkaListenerContainerFactory
public AbstractKafkaListenerContainerFactory()
-
-
Method Details
-
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
-
setConsumerFactory
Specify aConsumerFactoryto use.- Parameters:
consumerFactory- The consumer factory.
-
getConsumerFactory
-
setAutoStartup
Specify anautoStartup booleanflag.- Parameters:
autoStartup- true for auto startup.- See Also:
-
setPhase
public void setPhase(int phase) Specify aphaseto use.- Parameters:
phase- The phase.- See Also:
-
setMessageConverter
Set the message converter to use if dynamic argument type matching is needed.- Parameters:
messageConverter- the converter.
-
setRecordFilterStrategy
Set the record filter strategy.- Parameters:
recordFilterStrategy- the strategy.
-
setAckDiscarded
Set to true to ack discards when a filter strategy is in use.- Parameters:
ackDiscarded- the ackDiscarded.
-
isBatchListener
Return true if this endpoint creates a batch listener.- Returns:
- true for a batch listener.
- Since:
- 1.1
-
setBatchListener
Set to true if this endpoint should create a batch listener.- Parameters:
batchListener- true for a batch listener.- Since:
- 1.1
-
setApplicationEventPublisher
public void setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher) - Specified by:
setApplicationEventPublisherin interfaceorg.springframework.context.ApplicationEventPublisherAware
-
setReplyTemplate
Set theKafkaTemplateto use to send replies.- Parameters:
replyTemplate- the template.- Since:
- 2.0
-
setErrorHandler
Deprecated, for removal: This API element is subject to removal in a future version.in favor ofsetCommonErrorHandler(CommonErrorHandler)Set the error handler to call when the listener throws an exception.- Parameters:
errorHandler- the error handler.- Since:
- 2.2
- See Also:
-
setBatchErrorHandler
@Deprecated(since="2.8", forRemoval=true) public void setBatchErrorHandler(BatchErrorHandler errorHandler) Deprecated, for removal: This API element is subject to removal in a future version.in favor ofsetCommonErrorHandler(CommonErrorHandler)Set the batch error handler to call when the listener throws an exception.- Parameters:
errorHandler- the error handler.- Since:
- 2.2
- See Also:
-
setCommonErrorHandler
Set theCommonErrorHandlerwhich can handle errors for both record and batch listeners. Replaces the use ofGenericErrorHandlers.- Parameters:
commonErrorHandler- the handler.- Since:
- 2.8
-
setAfterRollbackProcessor
public void setAfterRollbackProcessor(AfterRollbackProcessor<? super K, ? super V> afterRollbackProcessor) Set a processor to invoke after a transaction rollback; typically will seek the unprocessed topic/partition to reprocess the records. The default does so, including the failed record.- Parameters:
afterRollbackProcessor- the processor.- Since:
- 1.3.5
-
setReplyHeadersConfigurer
Set a configurer which will be invoked when creating a reply message.- Parameters:
replyHeadersConfigurer- the configurer.- Since:
- 2.2
-
setMissingTopicsFatal
public void setMissingTopicsFatal(boolean missingTopicsFatal) Set to false to allow the container to start even if any of the configured topics are not present on the broker. Does not apply when topic patterns are configured. Default true;- Parameters:
missingTopicsFatal- the missingTopicsFatal.- Since:
- 2.3
-
getContainerProperties
Obtain the properties template for this factory - set properties as needed and they will be copied to a final properties instance for the endpoint.- Returns:
- the properties.
-
setRecordInterceptor
Set an interceptor to be called before calling the listener. Only used with record listeners.- Parameters:
recordInterceptor- the interceptor.- Since:
- 2.2.7
- See Also:
-
setBatchInterceptor
Set a batch interceptor to be called before and after calling the listener. Only used with batch listeners.- Parameters:
batchInterceptor- the interceptor.- Since:
- 2.7
- See Also:
-
setBatchToRecordAdapter
Set aBatchToRecordAdapter.- Parameters:
batchToRecordAdapter- the adapter.- Since:
- 2.4.2
-
setContainerCustomizer
Set a customizer used to further configure a container after it has been created.- Parameters:
containerCustomizer- the customizer.- Since:
- 2.3.4
-
setCorrelationHeaderName
Set a custom header name for the correlation id. DefaultKafkaHeaders.CORRELATION_ID. This header will be echoed back in any reply message.- Parameters:
correlationHeaderName- the header name.- Since:
- 3.0
-
afterPropertiesSet
public void afterPropertiesSet()- Specified by:
afterPropertiesSetin interfaceorg.springframework.beans.factory.InitializingBean
-
createListenerContainer
Description copied from interface:KafkaListenerContainerFactoryCreate aMessageListenerContainerfor the givenKafkaListenerEndpoint. Containers created using this method are added to the listener endpoint registry.- Specified by:
createListenerContainerin interfaceKafkaListenerContainerFactory<C extends AbstractMessageListenerContainer<K,V>> - Parameters:
endpoint- the endpoint to configure- Returns:
- the created container
-
createContainerInstance
Create an empty container instance.- Parameters:
endpoint- the endpoint.- Returns:
- the new container instance.
-
initializeContainer
Further initialize the specified container.Subclasses can inherit from this method to apply extra configuration if necessary.
- Parameters:
instance- the container instance to configure.endpoint- the endpoint.
-
createContainer
Description copied from interface:KafkaListenerContainerFactoryCreate and configure a container without a listener; used to create containers that are not used for KafkaListener annotations. Containers created using this method are not added to the listener endpoint registry.- Specified by:
createContainerin interfaceKafkaListenerContainerFactory<C extends AbstractMessageListenerContainer<K,V>> - Parameters:
topicsAndPartitions- the topicPartitions to assign.- Returns:
- the container.
-
createContainer
Description copied from interface:KafkaListenerContainerFactoryCreate and configure a container without a listener; used to create containers that are not used for KafkaListener annotations. Containers created using this method are not added to the listener endpoint registry.- Specified by:
createContainerin interfaceKafkaListenerContainerFactory<C extends AbstractMessageListenerContainer<K,V>> - Parameters:
topics- the topics.- Returns:
- the container.
-
createContainer
Description copied from interface:KafkaListenerContainerFactoryCreate and configure a container without a listener; used to create containers that are not used for KafkaListener annotations. Containers created using this method are not added to the listener endpoint registry.- Specified by:
createContainerin interfaceKafkaListenerContainerFactory<C extends AbstractMessageListenerContainer<K,V>> - Parameters:
topicPattern- the topicPattern.- Returns:
- the container.
-
setCommonErrorHandler(CommonErrorHandler)