Package org.springframework.kafka.listener.adapter

Class AbstractDelegatingMessageListenerAdapter<T>

java.lang.Object

org.springframework.kafka.listener.adapter.AbstractDelegatingMessageListenerAdapter<T>

Type Parameters:

T - the delegate type.

All Implemented Interfaces:

ConsumerSeekAware, DelegatingMessageListener<T>

Direct Known Subclasses:

AbstractFilteringMessageListener, AbstractRetryingMessageListenerAdapter, KafkaBackoffAwareMessageListenerAdapter

public abstract class AbstractDelegatingMessageListenerAdapter<T>
extends Object
implements ConsumerSeekAware, DelegatingMessageListener<T>

Top level class for all listener adapters.

Since:

1.1

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.kafka.listener.ConsumerSeekAware

ConsumerSeekAware.ConsumerSeekCallback

Field Summary

Fields

Modifier and Type	Field	Description
protected final T	delegate
protected final ListenerType	delegateType
protected final org.springframework.core.log.LogAccessor	logger

Constructor Summary

Constructors

Constructor	Description
AbstractDelegatingMessageListenerAdapter(T delegate)

Method Summary

Modifier and Type	Method	Description
T	getDelegate()	Return the delegate.
void	onIdleContainer(Map<org.apache.kafka.common.TopicPartition,Long> assignments, ConsumerSeekAware.ConsumerSeekCallback callback)	If the container is configured to emit idle container events, this method is called when the container idle event is emitted - allowing a seek operation.
void	onPartitionsAssigned(Map<org.apache.kafka.common.TopicPartition,Long> assignments, ConsumerSeekAware.ConsumerSeekCallback callback)	When using group management, called when partition assignments change.
void	onPartitionsRevoked(Collection<org.apache.kafka.common.TopicPartition> partitions)	When using group management, called when partition assignments are revoked.
void	registerSeekCallback(ConsumerSeekAware.ConsumerSeekCallback callback)	Register the callback to use when seeking at some arbitrary time.

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.ConsumerSeekAware

onFirstPoll, unregisterSeekCallback

Field Details

logger

protected final org.springframework.core.log.LogAccessor logger

delegate

protected final T delegate

delegateType

protected final ListenerType delegateType

Constructor Details

AbstractDelegatingMessageListenerAdapter

public AbstractDelegatingMessageListenerAdapter(T delegate)

Method Details

getDelegate

public T getDelegate()

Description copied from interface: DelegatingMessageListener

Return the delegate.

Specified by:

getDelegate in interface DelegatingMessageListener<T>

Returns:

the delegate.

registerSeekCallback

public void registerSeekCallback(ConsumerSeekAware.ConsumerSeekCallback callback)

Description copied from interface: ConsumerSeekAware

Register the callback to use when seeking at some arbitrary time. When used with a ConcurrentMessageListenerContainer or the same listener instance in multiple containers listeners should store the callback in a ThreadLocal.

Specified by:

registerSeekCallback in interface ConsumerSeekAware

Parameters:

callback - the callback.

onPartitionsAssigned

public void onPartitionsAssigned(Map<org.apache.kafka.common.TopicPartition,Long> assignments,
 ConsumerSeekAware.ConsumerSeekCallback callback)

Description copied from interface: ConsumerSeekAware

When using group management, called when partition assignments change.

Specified by:

onPartitionsAssigned in interface ConsumerSeekAware

Parameters:

assignments - the new assignments and their current offsets.

callback - the callback to perform an initial seek after assignment.

onPartitionsRevoked

public void onPartitionsRevoked(Collection<org.apache.kafka.common.TopicPartition> partitions)

Description copied from interface: ConsumerSeekAware

When using group management, called when partition assignments are revoked. Listeners should discard any callback saved from ConsumerSeekAware.registerSeekCallback(ConsumerSeekCallback) on this thread.

Specified by:

onPartitionsRevoked in interface ConsumerSeekAware

Parameters:

partitions - the partitions that have been revoked.

onIdleContainer

public void onIdleContainer(Map<org.apache.kafka.common.TopicPartition,Long> assignments,
 ConsumerSeekAware.ConsumerSeekCallback callback)

Description copied from interface: ConsumerSeekAware

If the container is configured to emit idle container events, this method is called when the container idle event is emitted - allowing a seek operation.

Specified by:

onIdleContainer in interface ConsumerSeekAware

Parameters:

assignments - the new assignments and their current offsets.

callback - the callback to perform a seek.