Package io.awspring.cloud.sqs.listener.source

Class AbstractPollingMessageSource<T,S>

java.lang.Object

io.awspring.cloud.sqs.listener.source.AbstractMessageConvertingMessageSource<T,S>

io.awspring.cloud.sqs.listener.source.AbstractPollingMessageSource<T,S>

All Implemented Interfaces:

ConfigurableContainerComponent, IdentifiableContainerComponent, AcknowledgementProcessingMessageSource<T>, MessageSource<T>, PollingMessageSource<T>, TaskExecutorAware, Lifecycle, Phased, SmartLifecycle

Direct Known Subclasses:

AbstractSqsMessageSource

public abstract class AbstractPollingMessageSource<T,S>
extends AbstractMessageConvertingMessageSource<T,S>
implements PollingMessageSource<T>, IdentifiableContainerComponent

Base PollingMessageSource implementation with SmartLifecycle capabilities.

Polling backpressure is handled the provided BackPressureHandler. The connected MessageSink should use the provided MessageProcessingContext.getAcknowledgmentCallback() to signal each message processing completion and enable further polling.

Message conversion capabilities are inherited by the AbstractMessageConvertingMessageSource superclass.

The AcknowledgementProcessor instance provides the AcknowledgementCallback to be set in the MessageProcessingContext and executed downstream when applicable.

Since:

3.0

Author:

Tomaz Fernandes

Field Summary

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
AbstractPollingMessageSource()

Method Summary

Modifier and Type	Method	Description
protected void	configureMessageSource(ContainerOptions<?,?> containerOptions)
protected MessageProcessingContext<T>	createContext()
protected void	doConfigure(ContainerOptions<?,?> containerOptions)	Override to configure subclasses.
protected abstract CompletableFuture<Collection<S>>	doPollForMessages(int messagesToRequest)
protected void	doStart()
protected void	doStop()
protected AcknowledgementCallback<T>	getAcknowledgementCallback()
protected AcknowledgementProcessor<T>	getAcknowledgmentProcessor()
String	getId()	Get the component id.
protected String	getPollingEndpointName()
boolean	isRunning()
Collection<Message<T>>	releaseUnusedPermits(int permits, Collection<Message<T>> msgs)
void	setAcknowledgementProcessor(AcknowledgementProcessor<T> acknowledgementProcessor)	Set the AcknowledgementProcessor instance that will process the message instances and provide the AcknowledgementCallback.
void	setAcknowledgementResultCallback(AsyncAcknowledgementResultCallback<T> acknowledgementResultCallback)	Set the AsyncAcknowledgementResultCallback that will be executed after messages are acknowledged, usually by a AcknowledgementExecutor.
void	setBackPressureHandler(BackPressureHandler backPressureHandler)	Set the BackPressureHandler that will be use to handle backpressure in this source.
void	setId(String id)	Set the component id.
void	setMessageSink(MessageSink<T> messageSink)	Set the MessageSink to be used as an output for this MessageSource.
void	setPollingEndpointName(String pollingEndpointName)	Set the endpoint name that will be polled by this source.
void	setTaskExecutor(TaskExecutor taskExecutor)	Set the task executor.
void	start()
void	stop()

Methods inherited from class io.awspring.cloud.sqs.listener.source.AbstractMessageConvertingMessageSource

configure, convertMessage, convertMessages, getMessageConversionContext, setupAcknowledgementForConversion

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.awspring.cloud.sqs.listener.ConfigurableContainerComponent

configure

Methods inherited from interface org.springframework.context.SmartLifecycle

getPhase, isAutoStartup, stop

Constructor Details

AbstractPollingMessageSource

public AbstractPollingMessageSource()

Method Details

configureMessageSource

protected void configureMessageSource(ContainerOptions<?,?> containerOptions)

Overrides:

configureMessageSource in class AbstractMessageConvertingMessageSource<T,S>

doConfigure

protected void doConfigure(ContainerOptions<?,?> containerOptions)

Override to configure subclasses.

Parameters:

containerOptions - the ContainerOptions for this source.

setId

public void setId(String id)

Description copied from interface: IdentifiableContainerComponent

Set the component id.

Specified by:

setId in interface IdentifiableContainerComponent

Parameters:

id - the id.

setPollingEndpointName

public void setPollingEndpointName(String pollingEndpointName)

Description copied from interface: PollingMessageSource

Set the endpoint name that will be polled by this source.

Specified by:

setPollingEndpointName in interface PollingMessageSource<T>

Parameters:

pollingEndpointName - the name.

setBackPressureHandler

public void setBackPressureHandler(BackPressureHandler backPressureHandler)

Description copied from interface: PollingMessageSource

Set the BackPressureHandler that will be use to handle backpressure in this source.

Specified by:

setBackPressureHandler in interface PollingMessageSource<T>

Parameters:

backPressureHandler - the handler.

setAcknowledgementProcessor

public void setAcknowledgementProcessor(AcknowledgementProcessor<T> acknowledgementProcessor)

Description copied from interface: AcknowledgementProcessingMessageSource

Set the AcknowledgementProcessor instance that will process the message instances and provide the AcknowledgementCallback.

Specified by:

setAcknowledgementProcessor in interface AcknowledgementProcessingMessageSource<T>

Parameters:

acknowledgementProcessor - the processor instance.

setAcknowledgementResultCallback

public void setAcknowledgementResultCallback(AsyncAcknowledgementResultCallback<T> acknowledgementResultCallback)

Description copied from interface: AcknowledgementProcessingMessageSource

Set the AsyncAcknowledgementResultCallback that will be executed after messages are acknowledged, usually by a AcknowledgementExecutor.

Specified by:

setAcknowledgementResultCallback in interface AcknowledgementProcessingMessageSource<T>

Parameters:

acknowledgementResultCallback - the callback instance.

setTaskExecutor

public void setTaskExecutor(TaskExecutor taskExecutor)

Description copied from interface: TaskExecutorAware

Set the task executor.

Specified by:

setTaskExecutor in interface TaskExecutorAware

Parameters:

taskExecutor - the task executor.

setMessageSink

public void setMessageSink(MessageSink<T> messageSink)

Description copied from interface: MessageSource

Set the MessageSink to be used as an output for this MessageSource.

Specified by:

setMessageSink in interface MessageSource<T>

Parameters:

messageSink - the message sink.

getId

public String getId()

Description copied from interface: IdentifiableContainerComponent

Get the component id.

Specified by:

getId in interface IdentifiableContainerComponent

Returns:

the id.

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

start

public void start()

Specified by:

start in interface Lifecycle

doStart

protected void doStart()

doPollForMessages

protected abstract CompletableFuture<Collection<S>> doPollForMessages(int messagesToRequest)

releaseUnusedPermits

public Collection<Message<T>> releaseUnusedPermits(int permits,
 Collection<Message<T>> msgs)

createContext

protected MessageProcessingContext<T> createContext()

getAcknowledgementCallback

protected AcknowledgementCallback<T> getAcknowledgementCallback()

getPollingEndpointName

protected String getPollingEndpointName()

getAcknowledgmentProcessor

protected AcknowledgementProcessor<T> getAcknowledgmentProcessor()

stop

public void stop()

Specified by:

stop in interface Lifecycle

doStop

protected void doStop()