Package org.springframework.pulsar.listener

Class AbstractPulsarMessageListenerContainer<T>

java.lang.Object

org.springframework.pulsar.core.AbstractPulsarMessageContainer

org.springframework.pulsar.listener.AbstractPulsarMessageListenerContainer<T>

Type Parameters:

T - message type.

All Implemented Interfaces:

Aware, BeanNameAware, DisposableBean, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, Phased, SmartLifecycle, MessageListenerContainer, PulsarMessageListenerContainer

Direct Known Subclasses:

ConcurrentPulsarMessageListenerContainer, DefaultPulsarMessageListenerContainer

public abstract non-sealed class AbstractPulsarMessageListenerContainer<T>
extends AbstractPulsarMessageContainer
implements PulsarMessageListenerContainer

Base implementation for the PulsarMessageListenerContainer.

Author:

Soby Chacko, Alexander Preuß

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.pulsar.client.api.RedeliveryBackoff	ackTimeoutRedeliveryBackoff
protected ConsumerBuilderCustomizer<T>	consumerBuilderCustomizer
protected org.apache.pulsar.client.api.DeadLetterPolicy	deadLetterPolicy
protected final ReentrantLock	lifecycleLock
protected org.apache.pulsar.client.api.RedeliveryBackoff	negativeAckRedeliveryBackoff
protected PulsarConsumerErrorHandler<T>	pulsarConsumerErrorHandler

Fields inherited from class org.springframework.pulsar.core.AbstractPulsarMessageContainer

autoStartup, logger, running

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPulsarMessageListenerContainer(PulsarConsumerFactory<? super T> pulsarConsumerFactory, PulsarContainerProperties pulsarContainerProperties)

Method Summary

Modifier and Type	Method	Description
protected abstract void	doPause()
protected abstract void	doResume()
org.apache.pulsar.client.api.RedeliveryBackoff	getAckTimeoutkRedeliveryBackoff()
ConsumerBuilderCustomizer<T>	getConsumerBuilderCustomizer()
PulsarContainerProperties	getContainerProperties()
org.apache.pulsar.client.api.DeadLetterPolicy	getDeadLetterPolicy()
org.apache.pulsar.client.api.RedeliveryBackoff	getNegativeAckRedeliveryBackoff()
PulsarConsumerErrorHandler<T>	getPulsarConsumerErrorHandler()
PulsarConsumerFactory<T>	getPulsarConsumerFactory()
boolean	isAutoStartup()
protected boolean	isPaused()
boolean	isRunning()
void	pause()	Pause this container before the next poll().
void	resume()	Resume this container, if paused.
void	setAckTimeoutRedeliveryBackoff(org.apache.pulsar.client.api.RedeliveryBackoff redeliveryBackoff)
void	setAutoStartup(boolean autoStartup)
void	setConsumerCustomizer(ConsumerBuilderCustomizer<?> consumerBuilderCustomizer)	Set a consumer customizer on this container.
void	setDeadLetterPolicy(org.apache.pulsar.client.api.DeadLetterPolicy deadLetterPolicy)
void	setNegativeAckRedeliveryBackoff(org.apache.pulsar.client.api.RedeliveryBackoff redeliveryBackoff)
protected void	setPaused(boolean paused)
void	setPulsarConsumerErrorHandler(PulsarConsumerErrorHandler pulsarConsumerErrorHandler)
protected void	setRunning(boolean running)
void	setupMessageListener(Object messageListener)
final void	start()
void	stop()

Methods inherited from class org.springframework.pulsar.core.AbstractPulsarMessageContainer

doStart, doStop, getApplicationContext, getApplicationEventPublisher, getBeanName, getPhase, setApplicationContext, setApplicationEventPublisher, setBeanName, setPhase

Methods inherited from class java.lang.Object

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

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

destroy

Methods inherited from interface org.springframework.context.SmartLifecycle

getPhase, stop

Field Details

lifecycleLock

protected final ReentrantLock lifecycleLock

negativeAckRedeliveryBackoff

protected org.apache.pulsar.client.api.RedeliveryBackoff negativeAckRedeliveryBackoff

ackTimeoutRedeliveryBackoff

protected org.apache.pulsar.client.api.RedeliveryBackoff ackTimeoutRedeliveryBackoff

deadLetterPolicy

protected org.apache.pulsar.client.api.DeadLetterPolicy deadLetterPolicy

pulsarConsumerErrorHandler

protected PulsarConsumerErrorHandler<T> pulsarConsumerErrorHandler

consumerBuilderCustomizer

protected ConsumerBuilderCustomizer<T> consumerBuilderCustomizer

Constructor Details

AbstractPulsarMessageListenerContainer

protected AbstractPulsarMessageListenerContainer(PulsarConsumerFactory<? super T> pulsarConsumerFactory,
 PulsarContainerProperties pulsarContainerProperties)

Method Details

getPulsarConsumerFactory

public PulsarConsumerFactory<T> getPulsarConsumerFactory()

getContainerProperties

public PulsarContainerProperties getContainerProperties()

Specified by:

getContainerProperties in interface PulsarMessageListenerContainer

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

setRunning

protected void setRunning(boolean running)

setupMessageListener

public void setupMessageListener(Object messageListener)

Specified by:

setupMessageListener in interface PulsarMessageListenerContainer

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle

setAutoStartup

public void setAutoStartup(boolean autoStartup)

Specified by:

setAutoStartup in interface MessageListenerContainer

start

public final void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

setNegativeAckRedeliveryBackoff

public void setNegativeAckRedeliveryBackoff(org.apache.pulsar.client.api.RedeliveryBackoff redeliveryBackoff)

Specified by:

setNegativeAckRedeliveryBackoff in interface PulsarMessageListenerContainer

setAckTimeoutRedeliveryBackoff

public void setAckTimeoutRedeliveryBackoff(org.apache.pulsar.client.api.RedeliveryBackoff redeliveryBackoff)

Specified by:

setAckTimeoutRedeliveryBackoff in interface PulsarMessageListenerContainer

getNegativeAckRedeliveryBackoff

public org.apache.pulsar.client.api.RedeliveryBackoff getNegativeAckRedeliveryBackoff()

getAckTimeoutkRedeliveryBackoff

public org.apache.pulsar.client.api.RedeliveryBackoff getAckTimeoutkRedeliveryBackoff()

setDeadLetterPolicy

public void setDeadLetterPolicy(org.apache.pulsar.client.api.DeadLetterPolicy deadLetterPolicy)

Specified by:

setDeadLetterPolicy in interface PulsarMessageListenerContainer

getDeadLetterPolicy

public org.apache.pulsar.client.api.DeadLetterPolicy getDeadLetterPolicy()

getPulsarConsumerErrorHandler

public PulsarConsumerErrorHandler<T> getPulsarConsumerErrorHandler()

setPulsarConsumerErrorHandler

public void setPulsarConsumerErrorHandler(PulsarConsumerErrorHandler pulsarConsumerErrorHandler)

Specified by:

setPulsarConsumerErrorHandler in interface PulsarMessageListenerContainer

setConsumerCustomizer

public void setConsumerCustomizer(ConsumerBuilderCustomizer<?> consumerBuilderCustomizer)

Description copied from interface: PulsarMessageListenerContainer

Set a consumer customizer on this container.

Specified by:

setConsumerCustomizer in interface PulsarMessageListenerContainer

Parameters:

consumerBuilderCustomizer - ConsumerBuilderCustomizer

getConsumerBuilderCustomizer

public ConsumerBuilderCustomizer<T> getConsumerBuilderCustomizer()

pause

public void pause()

Description copied from interface: PulsarMessageListenerContainer

Pause this container before the next poll(). The next poll by the container will be disabled as long as PulsarMessageListenerContainer.resume() is not called.

Specified by:

pause in interface PulsarMessageListenerContainer

resume

public void resume()

Description copied from interface: PulsarMessageListenerContainer

Resume this container, if paused.

Specified by:

resume in interface PulsarMessageListenerContainer

isPaused

protected boolean isPaused()

setPaused

protected void setPaused(boolean paused)

doPause

protected abstract void doPause()

doResume

protected abstract void doResume()