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
FieldsModifier and TypeFieldDescriptionprotected org.apache.pulsar.client.api.RedeliveryBackoffprotected ConsumerBuilderCustomizer<T>protected org.apache.pulsar.client.api.DeadLetterPolicyprotected final Objectprotected org.apache.pulsar.client.api.RedeliveryBackoffprotected PulsarConsumerErrorHandler<T>Fields inherited from class org.springframework.pulsar.core.AbstractPulsarMessageContainer
autoStartup, logger, runningFields inherited from interface org.springframework.context.SmartLifecycle
DEFAULT_PHASE -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAbstractPulsarMessageListenerContainer(PulsarConsumerFactory<? super T> pulsarConsumerFactory, PulsarContainerProperties pulsarContainerProperties, io.micrometer.observation.ObservationRegistry observationRegistry) -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract voiddoPause()protected abstract voiddoResume()org.apache.pulsar.client.api.RedeliveryBackofforg.apache.pulsar.client.api.DeadLetterPolicyorg.apache.pulsar.client.api.RedeliveryBackoffio.micrometer.observation.ObservationRegistrybooleanprotected booleanisPaused()booleanvoidpause()Pause this container before the next poll().voidresume()Resume this container, if paused.voidsetAckTimeoutRedeliveryBackoff(org.apache.pulsar.client.api.RedeliveryBackoff redeliveryBackoff) voidsetAutoStartup(boolean autoStartup) voidsetConsumerCustomizer(ConsumerBuilderCustomizer<?> consumerBuilderCustomizer) Set a consumer customizer on this container.voidsetDeadLetterPolicy(org.apache.pulsar.client.api.DeadLetterPolicy deadLetterPolicy) voidsetNegativeAckRedeliveryBackoff(org.apache.pulsar.client.api.RedeliveryBackoff redeliveryBackoff) protected voidsetPaused(boolean paused) voidsetPulsarConsumerErrorHandler(PulsarConsumerErrorHandler pulsarConsumerErrorHandler) protected voidsetRunning(boolean running) voidsetupMessageListener(Object messageListener) final voidstart()voidstop()Methods inherited from class org.springframework.pulsar.core.AbstractPulsarMessageContainer
doStart, doStop, getApplicationContext, getApplicationEventPublisher, getBeanName, getPhase, setApplicationContext, setApplicationEventPublisher, setBeanName, setPhaseMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.springframework.pulsar.listener.MessageListenerContainer
destroyMethods inherited from interface org.springframework.context.SmartLifecycle
getPhase, stop
-
Field Details
-
lifecycleMonitor
-
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
-
consumerBuilderCustomizer
-
-
Constructor Details
-
AbstractPulsarMessageListenerContainer
protected AbstractPulsarMessageListenerContainer(PulsarConsumerFactory<? super T> pulsarConsumerFactory, PulsarContainerProperties pulsarContainerProperties, @Nullable io.micrometer.observation.ObservationRegistry observationRegistry)
-
-
Method Details
-
getPulsarConsumerFactory
-
getContainerProperties
- Specified by:
getContainerPropertiesin interfacePulsarMessageListenerContainer
-
getObservationRegistry
public io.micrometer.observation.ObservationRegistry getObservationRegistry() -
isRunning
public boolean isRunning() -
setRunning
protected void setRunning(boolean running) -
setupMessageListener
- Specified by:
setupMessageListenerin interfacePulsarMessageListenerContainer
-
isAutoStartup
public boolean isAutoStartup()- Specified by:
isAutoStartupin interfaceSmartLifecycle
-
setAutoStartup
public void setAutoStartup(boolean autoStartup) - Specified by:
setAutoStartupin interfaceMessageListenerContainer
-
start
public final void start() -
stop
public void stop() -
setNegativeAckRedeliveryBackoff
public void setNegativeAckRedeliveryBackoff(org.apache.pulsar.client.api.RedeliveryBackoff redeliveryBackoff) - Specified by:
setNegativeAckRedeliveryBackoffin interfacePulsarMessageListenerContainer
-
setAckTimeoutRedeliveryBackoff
public void setAckTimeoutRedeliveryBackoff(org.apache.pulsar.client.api.RedeliveryBackoff redeliveryBackoff) - Specified by:
setAckTimeoutRedeliveryBackoffin interfacePulsarMessageListenerContainer
-
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:
setDeadLetterPolicyin interfacePulsarMessageListenerContainer
-
getDeadLetterPolicy
public org.apache.pulsar.client.api.DeadLetterPolicy getDeadLetterPolicy() -
getPulsarConsumerErrorHandler
-
setPulsarConsumerErrorHandler
- Specified by:
setPulsarConsumerErrorHandlerin interfacePulsarMessageListenerContainer
-
setConsumerCustomizer
Description copied from interface:PulsarMessageListenerContainerSet a consumer customizer on this container.- Specified by:
setConsumerCustomizerin interfacePulsarMessageListenerContainer- Parameters:
consumerBuilderCustomizer-ConsumerBuilderCustomizer
-
getConsumerBuilderCustomizer
-
pause
public void pause()Description copied from interface:PulsarMessageListenerContainerPause this container before the next poll(). The next poll by the container will be disabled as long asPulsarMessageListenerContainer.resume()is not called.- Specified by:
pausein interfacePulsarMessageListenerContainer
-
resume
public void resume()Description copied from interface:PulsarMessageListenerContainerResume this container, if paused.- Specified by:
resumein interfacePulsarMessageListenerContainer
-
isPaused
protected boolean isPaused() -
setPaused
protected void setPaused(boolean paused) -
doPause
protected abstract void doPause() -
doResume
protected abstract void doResume()
-