Skip to content

docs(sqs): clarify acknowledgementMode interaction with custom container factory beans #1683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shubham-asthana wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −0
Open

docs(sqs): clarify acknowledgementMode interaction with custom container factory beans #1683

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/src/main/asciidoc/sqs.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -855,6 +855,10 @@ public void listen(String message) {

When using a Spring Boot application with auto-configuration, a default factory is provided if there are no other factory beans declared in the context.

NOTE: If a custom `SqsMessageListenerContainerFactory` bean is declared without the `defaultSqsListenerContainerFactory` name, Spring Boot's autoconfiguration backs off and no bean is registered under that name.
In that case, any `@SqsListener` relying on the default factory - for example to use annotation-level properties such as `acknowledgementMode` - must either set the `factory` property explicitly, or register a `SqsListenerConfigurer` bean calling `setDefaultListenerContainerFactoryBeanName` with the custom bean's name.
See <<Global configuration for @SqsListeners>> for more information.


===== Other annotation properties

Expand Down Expand Up @@ -2232,6 +2236,8 @@ The following attributes can be configured in the registrar:
- `setMessageHandlerMethodFactory` - provide a different factory to be used to create the `invocableHandlerMethod` instances that wrap the listener methods.
- `setListenerContainerRegistry` - provide a different `MessageListenerContainerRegistry` implementation to be used to register the `MessageListenerContainers`
- `setMessageListenerContainerRegistryBeanName` - provide a different bean name to be used to retrieve the `MessageListenerContainerRegistry`
- `setDefaultListenerContainerFactoryBeanName` - change the bean name looked up for the default `MessageListenerContainerFactory` (`defaultSqsListenerContainerFactory` by default).
This is useful when a custom factory bean is declared under a different name and `@SqsListener` methods should use it without specifying the `factory` property explicitly.
- `setJacksonMessageConverterMigration` - internal migration wiring for the Jackson 2 to Jackson 3 transition, not intended for application configuration.
- `setValidator` - set the `Validator` instance that will be used for payload validation in listener methods.
- `manageMessageConverters` - gives access to the list of message converters that will be used by ArgumentResolvers.
Expand Down