docs(sqs): clarify acknowledgementMode interaction with custom container factory beans - #1683
Open
shubham-asthana wants to merge 1 commit into
Conversation
…ner factory beans When a custom SqsMessageListenerContainerFactory bean is declared under a name other than defaultSqsListenerContainerFactory, Spring Boot's autoconfiguration backs off, so @SqsListener methods relying on the default factory (e.g. to set acknowledgementMode) fail at startup with an unhelpful IllegalArgumentException. Document the workaround via factory or SqsListenerConfigurer#setDefaultListenerContainerFactoryBeanName, and add the missing setDefaultListenerContainerFactoryBeanName entry to the registrar attribute list. Fixes awspring#971
shubham-asthana
requested review from
MatejNedic,
maciejwalkowiak and
tomazfernandes
as code owners
August 18, 2026 11:26
github-actions
Bot
added
the
type: documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #971
When a custom
SqsMessageListenerContainerFactorybean is declared under a nameother than
defaultSqsListenerContainerFactory, Spring Boot's autoconfigurationbacks off and no bean is registered under the default name. Any
@SqsListenerrelying on the default factory - for example to use
acknowledgementMode- thenfails at startup with an unhelpful
IllegalArgumentException.This documents the two ways to resolve it (explicit
factoryproperty, or aSqsListenerConfigurercallingsetDefaultListenerContainerFactoryBeanName),and adds the missing
setDefaultListenerContainerFactoryBeanNameentry to theGlobal configuration for @SqsListenersattribute list, which wasn'tdocumented at all previously.
Builds on the discussion in #979, rewritten in third-person to match the doc's style.
Verified locally: built the
docsmodule with thedocs-classicprofile andconfirmed both additions render correctly in
sqs.html.