Class AbstractShareKafkaMessageListenerContainer<K,V>

java.lang.Object

org.springframework.kafka.listener.AbstractShareKafkaMessageListenerContainer<K,V>

Type Parameters:

K - the key type

V - the value type

All Implemented Interfaces:

Aware, BeanNameAware, DisposableBean, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, Phased, SmartLifecycle, GenericMessageListenerContainer<K,V>, MessageListenerContainer

Direct Known Subclasses:

ShareKafkaMessageListenerContainer

public abstract class AbstractShareKafkaMessageListenerContainer<K,V>
extends Object
implements GenericMessageListenerContainer<K,V>, BeanNameAware, ApplicationEventPublisherAware, ApplicationContextAware

Abstract base class for share consumer message listener containers.

Handles common lifecycle, configuration, and event publishing for containers using a ShareConsumerFactory.

Subclasses are responsible for implementing the actual consumer loop and message dispatch logic.

Since:

4.0

Author:

Soby Chacko

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_PHASE	The default SmartLifecycle phase for listener containers.
protected final ReentrantLock	lifecycleLock
protected final LogAccessor	logger
protected final ShareConsumerFactory<K,V>	shareConsumerFactory	The share consumer factory used to create consumer instances.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractShareKafkaMessageListenerContainer(ShareConsumerFactory<? super K, ? super V> shareConsumerFactory, ContainerProperties containerProperties)	Construct an instance with the provided factory and properties.

Method Summary

Modifier and Type	Method	Description
void	destroy()
protected abstract void	doStart()
protected abstract void	doStop()
@Nullable ApplicationContext	getApplicationContext()
@Nullable ApplicationEventPublisher	getApplicationEventPublisher()	Get the event publisher.
String	getBeanName()	Return the bean name.
ContainerProperties	getContainerProperties()	Return the container properties for this container.
@Nullable String	getGroupId()	Return the group.id property for this container whether specifically set on the container or via a consumer property on the consumer factory.
String	getListenerId()	The 'id' attribute of a @KafkaListener or the bean name for spring-managed containers.
int	getPhase()
boolean	isAutoStartup()
boolean	isRunning()
void	setApplicationContext(ApplicationContext applicationContext)
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
void	setAutoStartup(boolean autoStartup)	Set the autoStartup.
void	setBeanName(String name)
void	setPhase(int phase)
protected void	setRunning(boolean running)
void	setupMessageListener(Object messageListener)	Setup the message listener to use.
void	start()
void	stop()
void	stop(Runnable callback)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.kafka.listener.MessageListenerContainer

childStarted, childStopped, enforceRebalance, getAssignedPartitions, getAssignmentsByClientId, getContainerFor, getListenerInfo, getMainListenerId, isChildRunning, isContainerPaused, isInExpectedState, isPartitionPaused, isPartitionPauseRequested, isPauseRequested, metrics, pause, pausePartition, resume, resumePartition, stopAbnormally

Methods inherited from interface org.springframework.context.SmartLifecycle

isPauseable

Field Details

DEFAULT_PHASE

public static final int DEFAULT_PHASE

The default SmartLifecycle phase for listener containers.

See Also:

• Constant Field Values

shareConsumerFactory

protected final ShareConsumerFactory<K,V> shareConsumerFactory

The share consumer factory used to create consumer instances.

logger

protected final LogAccessor logger

lifecycleLock

protected final ReentrantLock lifecycleLock

Constructor Details

AbstractShareKafkaMessageListenerContainer

protected AbstractShareKafkaMessageListenerContainer(ShareConsumerFactory<? super K, ? super V> shareConsumerFactory,
 ContainerProperties containerProperties)

Construct an instance with the provided factory and properties.

Parameters:

shareConsumerFactory - the factory.

containerProperties - the properties.

Method Details

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

getApplicationContext

public @Nullable ApplicationContext getApplicationContext()

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface BeanNameAware

getBeanName

public String getBeanName()

Return the bean name.

Returns:

the bean name

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

getApplicationEventPublisher

public @Nullable ApplicationEventPublisher getApplicationEventPublisher()

Get the event publisher.

Returns:

the publisher

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle

setAutoStartup

public void setAutoStartup(boolean autoStartup)

Description copied from interface: MessageListenerContainer

Set the autoStartup.

Specified by:

setAutoStartup in interface MessageListenerContainer

Parameters:

autoStartup - the autoStartup to set.

See Also:

• SmartLifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle

setPhase

public void setPhase(int phase)

stop

public void stop(Runnable callback)

Specified by:

stop in interface SmartLifecycle

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

setRunning

protected void setRunning(boolean running)

getContainerProperties

public ContainerProperties getContainerProperties()

Description copied from interface: MessageListenerContainer

Return the container properties for this container.

Specified by:

getContainerProperties in interface MessageListenerContainer

Returns:

the properties.

getGroupId

public @Nullable String getGroupId()

Description copied from interface: MessageListenerContainer

Return the group.id property for this container whether specifically set on the container or via a consumer property on the consumer factory.

Specified by:

getGroupId in interface MessageListenerContainer

Returns:

the group id.

getListenerId

public String getListenerId()

Description copied from interface: MessageListenerContainer

The 'id' attribute of a @KafkaListener or the bean name for spring-managed containers.

Specified by:

getListenerId in interface MessageListenerContainer

Returns:

the id or bean name.

setupMessageListener

public void setupMessageListener(Object messageListener)

Description copied from interface: MessageListenerContainer

Setup the message listener to use. Throws an IllegalArgumentException if that message listener type is not supported.

Specified by:

setupMessageListener in interface MessageListenerContainer

Parameters:

messageListener - the object to wrapped to the MessageListener.

doStart

protected abstract void doStart()

doStop

protected abstract void doStop()

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

Specified by:

destroy in interface MessageListenerContainer