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

Class AbstractSqsMessageSource<T>

java.lang.Object

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

io.awspring.cloud.sqs.listener.source.AbstractPollingMessageSource<T,software.amazon.awssdk.services.sqs.model.Message>

io.awspring.cloud.sqs.listener.source.AbstractSqsMessageSource<T>

Type Parameters:

T - the Message payload type.

All Implemented Interfaces:

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

Direct Known Subclasses:

FifoSqsMessageSource, StandardSqsMessageSource

public abstract class AbstractSqsMessageSource<T>
extends AbstractPollingMessageSource<T,software.amazon.awssdk.services.sqs.model.Message>
implements SqsAsyncClientAware

MessageSource implementation for polling messages from a SQS queue and converting them to messaging Message.

A MessageListenerContainer can contain many sources, and each source polls from a single queue.

Note that currently the payload is not converted here and is returned as String. The actual conversion to the SqsListener argument type happens on InvocableHandlerMethod invocation.

Since:

3.0

Author:

Tomaz Fernandes

Field Summary

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
AbstractSqsMessageSource()

Method Summary

Modifier and Type	Method	Description
protected AcknowledgementExecutor<T>	createAcknowledgementExecutorInstance()
protected AcknowledgementExecutor<T>	createAndConfigureAcknowledgementExecutor(QueueAttributes queueAttributes)
protected void	customizeRequest(software.amazon.awssdk.services.sqs.model.ReceiveMessageRequest.Builder builder)
protected void	doConfigure(ContainerOptions<?,?> containerOptions)	Override to configure subclasses.
protected CompletableFuture<Collection<software.amazon.awssdk.services.sqs.model.Message>>	doPollForMessages(int maxNumberOfMessages)
protected void	doStart()
void	setSqsAsyncClient(software.amazon.awssdk.services.sqs.SqsAsyncClient sqsAsyncClient)	Set the SqsAsyncClient instance.

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

configureMessageSource, createContext, doStop, getAcknowledgementCallback, getAcknowledgmentProcessor, getId, getPollingEndpointName, isRunning, releaseUnusedPermits, setAcknowledgementProcessor, setAcknowledgementResultCallback, setBackPressureHandler, setId, setMessageSink, setPollingEndpointName, setTaskExecutor, start, 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

AbstractSqsMessageSource

public AbstractSqsMessageSource()

Method Details

setSqsAsyncClient

public void setSqsAsyncClient(software.amazon.awssdk.services.sqs.SqsAsyncClient sqsAsyncClient)

Description copied from interface: SqsAsyncClientAware

Set the SqsAsyncClient instance.

Specified by:

setSqsAsyncClient in interface SqsAsyncClientAware

Parameters:

sqsAsyncClient - the instance.

doConfigure

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

Description copied from class: AbstractPollingMessageSource

Override to configure subclasses.

Overrides:

doConfigure in class AbstractPollingMessageSource<T,software.amazon.awssdk.services.sqs.model.Message>

Parameters:

containerOptions - the ContainerOptions for this source.

doStart

protected void doStart()

Overrides:

doStart in class AbstractPollingMessageSource<T,software.amazon.awssdk.services.sqs.model.Message>

createAndConfigureAcknowledgementExecutor

protected AcknowledgementExecutor<T> createAndConfigureAcknowledgementExecutor(QueueAttributes queueAttributes)

createAcknowledgementExecutorInstance

protected AcknowledgementExecutor<T> createAcknowledgementExecutorInstance()

doPollForMessages

protected CompletableFuture<Collection<software.amazon.awssdk.services.sqs.model.Message>> doPollForMessages(int maxNumberOfMessages)

Specified by:

doPollForMessages in class AbstractPollingMessageSource<T,software.amazon.awssdk.services.sqs.model.Message>

customizeRequest

protected void customizeRequest(software.amazon.awssdk.services.sqs.model.ReceiveMessageRequest.Builder builder)