Merge branch 'main' into feature/backpressure-limiter

Author: loicrouchon

.github/workflows/build.yml

@@ -2,9 +2,9 @@ name: Java CI with Maven
 
 on:
   push:
-    branches: [ main, 2.3.x, 2.4.x, 3.0.x, 3.1.x, 3.2.x ]
+    branches: [ main, 2.3.x, 2.4.x, 3.0.x, 3.1.x, 3.2.x, 3.3.x ]
   pull_request:
-    branches: [ main, 2.3.x, 2.4.x, 3.0.x, 3.1.x, 3.2.x ]
+    branches: [ main, 2.3.x, 2.4.x, 3.0.x, 3.1.x, 3.2.x, 3.3.x ]
 
 permissions:
   contents: read
@@ -14,7 +14,7 @@ jobs:
     name: Test with JDK ${{ matrix.version }}
     strategy:
       matrix:
-        version: [ 17.0.12, 21.0.4 ]
+        version: [ 17.0.12, 21.0.4, 24 ]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

Makefile

@@ -11,3 +11,6 @@ clean:
 
 docs:
 	mvnd verify -Pdocs-classic -DskipTests=true
+
+docs-full:
+	mvnd verify javadoc:aggregate -Pdocs-classic -DskipTests=true

README.md

@@ -6,14 +6,14 @@ Spring Cloud AWS simplifies using AWS managed services in a Spring and Spring Bo
 
 For a deep dive into the project, refer to the Spring Cloud AWS documentation:
 
-| Version                   | Reference Docs                                                                                   | API Docs                                                                               |
-|---------------------------|--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|
-| Spring Cloud AWS 3.3.0-M1 | [Reference Docs](https://docs.awspring.io/spring-cloud-aws/docs/3.3.0-M1/reference/html/index.html) | [API Docs](https://docs.awspring.io/spring-cloud-aws/docs/3.3.0-M1/apidocs/index.html) | 
-| Spring Cloud AWS 3.2.1    | [Reference Docs](https://docs.awspring.io/spring-cloud-aws/docs/3.2.1/reference/html/index.html) | [API Docs](https://docs.awspring.io/spring-cloud-aws/docs/3.2.0/apidocs/index.html)    | 
-| Spring Cloud AWS 3.1.1    | [Reference Docs](https://docs.awspring.io/spring-cloud-aws/docs/3.1.1/reference/html/index.html) | [API Docs](https://docs.awspring.io/spring-cloud-aws/docs/3.1.1/apidocs/index.html)    | 
-| Spring Cloud AWS 3.0.4    | [Reference Docs](https://docs.awspring.io/spring-cloud-aws/docs/3.0.4/reference/html/index.html) | [API Docs](https://docs.awspring.io/spring-cloud-aws/docs/3.0.4/apidocs/index.html)    | 
-| Spring Cloud AWS 2.4.4    | [Reference Docs](https://docs.awspring.io/spring-cloud-aws/docs/2.4.4/reference/html/index.html) | [API Docs](https://docs.awspring.io/spring-cloud-aws/docs/2.4.4/apidocs/index.html)    | 
-| Spring Cloud AWS 2.3.5    | [Reference Docs](https://docs.awspring.io/spring-cloud-aws/docs/2.3.5/reference/html/index.html) | [API Docs](https://docs.awspring.io/spring-cloud-aws/docs/2.3.5/apidocs/index.html)    |
+| Version                | Reference Docs                                                                                   | API Docs                                                                            |
+|------------------------|--------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|
+| Spring Cloud AWS 3.3.0 | [Reference Docs](https://docs.awspring.io/spring-cloud-aws/docs/3.3.0/reference/html/index.html) | [API Docs](https://docs.awspring.io/spring-cloud-aws/docs/3.3.0/apidocs/index.html) | 
+| Spring Cloud AWS 3.2.1 | [Reference Docs](https://docs.awspring.io/spring-cloud-aws/docs/3.2.1/reference/html/index.html) | [API Docs](https://docs.awspring.io/spring-cloud-aws/docs/3.2.1/apidocs/index.html) | 
+| Spring Cloud AWS 3.1.1 | [Reference Docs](https://docs.awspring.io/spring-cloud-aws/docs/3.1.1/reference/html/index.html) | [API Docs](https://docs.awspring.io/spring-cloud-aws/docs/3.1.1/apidocs/index.html) | 
+| Spring Cloud AWS 3.0.4 | [Reference Docs](https://docs.awspring.io/spring-cloud-aws/docs/3.0.4/reference/html/index.html) | [API Docs](https://docs.awspring.io/spring-cloud-aws/docs/3.0.4/apidocs/index.html) | 
+| Spring Cloud AWS 2.4.4 | [Reference Docs](https://docs.awspring.io/spring-cloud-aws/docs/2.4.4/reference/html/index.html) | [API Docs](https://docs.awspring.io/spring-cloud-aws/docs/2.4.4/apidocs/index.html) | 
+| Spring Cloud AWS 2.3.5 | [Reference Docs](https://docs.awspring.io/spring-cloud-aws/docs/2.3.5/reference/html/index.html) | [API Docs](https://docs.awspring.io/spring-cloud-aws/docs/2.3.5/apidocs/index.html) |
 
 ## Sponsors
 
@@ -31,7 +31,8 @@ This project has dependency and transitive dependencies on Spring Projects. The
 | 2.4.x (maintenance mode)  	 | [2021.0.x](https://github.com/spring-cloud/spring-cloud-release/wiki/Spring-Cloud-2021.0-Release-Notes) (3.1/Jubilee) | 2.6.x, 2.7.x | 5.3.x            | 1.x          |
 | 3.0.x                       | [2022.0.x](https://github.com/spring-cloud/spring-cloud-release/wiki/Spring-Cloud-2022.0-Release-Notes) (4.0/Kilburn) | 3.0.x, 3.1.x | 6.0.x            | 2.x          |
 | 3.1.x                       | [2023.0.x](https://github.com/spring-cloud/spring-cloud-release/wiki/Spring-Cloud-2023.0-Release-Notes) (4.0/Kilburn) | 3.2.x        | 6.1.x            | 2.x          |
-| 3.2.1                       | [2023.0.x](https://github.com/spring-cloud/spring-cloud-release/wiki/Spring-Cloud-2023.0-Release-Notes) (4.0/Kilburn) | 3.2.x, 3.3.x | 6.1.x            | 2.x          |
+| 3.2.x                       | [2023.0.x](https://github.com/spring-cloud/spring-cloud-release/wiki/Spring-Cloud-2023.0-Release-Notes) (4.0/Kilburn) | 3.2.x, 3.3.x | 6.1.x            | 2.x          |
+| 3.3.x                       | [2024.0.x](https://github.com/spring-cloud/spring-cloud-release/wiki/Spring-Cloud-2024.0-Release-Notes)               | 3.4.x        | 6.2.x            | 2.x          |
 
 **Note**: 3.0.0-M2 is the last version compatible with Spring Boot 2.7.x and Spring Cloud 3.1. Starting from 3.0.0-M3, project has switched to Spring Boot 3.0.
 

docs/pom.xml

@@ -6,7 +6,7 @@
 	<parent>
 		<groupId>io.awspring.cloud</groupId>
 		<artifactId>spring-cloud-aws</artifactId>
-		<version>3.3.0-SNAPSHOT</version>
+		<version>3.4.0-SNAPSHOT</version>
 	</parent>
 	<artifactId>spring-cloud-aws-docs</artifactId>
 	<packaging>pom</packaging>

docs/src/main/asciidoc/_configprops.adoc

@@ -95,7 +95,8 @@
 |spring.cloud.aws.sqs.listener.max-concurrent-messages |  | The maximum concurrent messages that can be processed simultaneously for each queue. Note that if acknowledgement batching is being used, the actual maximum number of messages inflight might be higher.
 |spring.cloud.aws.sqs.listener.max-messages-per-poll |  | The maximum number of messages to be retrieved in a single poll to SQS.
 |spring.cloud.aws.sqs.listener.poll-timeout |  | The maximum amount of time for a poll to SQS.
-|spring.cloud.aws.sqs.queue-not-found-strategy |  | 
+|spring.cloud.aws.sqs.listener.max-delay-between-polls |  | The maximum amount of time to wait between consecutive polls to SQS.
+|spring.cloud.aws.sqs.queue-not-found-strategy |  |
 |spring.cloud.aws.sqs.region |  | Overrides the default region.
 
 |===

docs/src/main/asciidoc/s3.adoc

@@ -129,7 +129,7 @@ try (OutputStream outputStream = s3Resource.getOutputStream()) {
 
 === S3 Client Side Encryption
 
-AWS offers encryption library which is integrated inside of S3 Client called https://docs.aws.amazon.com/amazon-s3-encryption-client/latest/developerguide/what-is-s3-encryption-client.html [S3EncryptionClient].
+AWS offers encryption library which is integrated inside of S3 Client called https://docs.aws.amazon.com/amazon-s3-encryption-client/latest/developerguide/what-is-s3-encryption-client.html[S3EncryptionClient].
 With encryption client you are going to encrypt your files before sending them to S3 bucket.
 
 To autoconfigure Encryption Client simply add the following dependency.
@@ -145,7 +145,7 @@ To autoconfigure Encryption Client simply add the following dependency.
 
 We are supporting 3 types of encryption.
 
-1. To configure encryption via KMS key specify 'spring.cloud.aws.s3.encryption.keyId' with KMS key arn and this key will be used to encrypt your files.
+1. To configure encryption via KMS key specify `spring.cloud.aws.s3.encryption.key-id` with KMS key arn and this key will be used to encrypt your files.
 
 Also, following dependency is required.
 [source,xml]
@@ -158,10 +158,11 @@ Also, following dependency is required.
 ----
 
 
-2. Asymmetric encryption is possible via RSA to enable it you will have to implement 'io.awspring.cloud.autoconfigure.s3.S3RsaProvider'
+2. Asymmetric encryption is possible via RSA to enable it you will have to implement `io.awspring.cloud.autoconfigure.s3.S3RsaProvider`
 
-!Note you will have to manage storing private and public keys yourself otherwise you won't be able to decrypt the data later.
-Example of simple RSAProvider:
+NOTE: You will have to store private and public keys yourself otherwise you won't be able to decrypt the data later.
+
+Example of simple `S3RsaProvider`:
 
 [source,java,indent=0]
 ----
@@ -185,8 +186,9 @@ public class MyRsaProvider implements S3RsaProvider {
 
 3. Last option is if you want to use symmetric algorithm, this is possible via `io.awspring.cloud.autoconfigure.s3.S3AesProvider`
 
-!Note you will have to manage storing storing private key!
-Example of simple AESProvider:
+NOTE: Ensure the private key is stored using secure storage mechanisms that prevent unauthorized access.
+
+Example of simple `S3AesProvider`:
 
 [source,java,indent=0]
 ----

docs/src/main/asciidoc/secrets-manager.adoc

@@ -40,6 +40,13 @@ To load multiple secrets, separate their names with `;`:
 spring.config.import=aws-secretsmanager:/secrets/database-secrets;/secrets/webclient-secrets
 ----
 
+If you have the requirement to load secrets from another AWS account you can achieve this using the secret's ARN.
+
+[source,properties]
+----
+spring.config.import=aws-secretsmanager:arn:aws:secretsmanager:eu-central-1:0123456789:secret:secrets/database-secrets
+----
+
 If some secrets are required, and other ones are optional, list them as separate entries in `spring.config.import` property:
 
 [source,properties]

docs/src/main/asciidoc/sqs.adoc

@@ -42,6 +42,8 @@ public class SqsApplication {
 }
 ----
 
+IMPORTANT: Due to a classloader related https://github.com/awspring/spring-cloud-aws/issues/657[issue] it is currently not possible to use @SqsListener together with Spring Boot DevTools.
+
 Without Spring Boot, it's necessary to import the `SqsBootstrapConfiguration` class in a `@Configuration`, as well as declare a `SqsMessageListenerContainerFactory` bean.
 
 [source, java]
@@ -592,6 +594,8 @@ MessageListenerContainer<Object> myListenerContainer(SqsAsyncClient sqsAsyncClie
 The simplest way to consume `SQS` messages is by annotating a method in a `@Component` class with the `@SqsListener` annotation.
 The framework will then create the `MessageListenerContainer` and set a `MessagingMessageListenerAdapter` to invoke the method when a message is received.
 
+IMPORTANT: Due to a classloader related https://github.com/awspring/spring-cloud-aws/issues/657[issue] it is currently not possible to use @SqsListener together with Spring Boot DevTools.
+
 When using `Spring Boot` with `auto-configuration`, no configuration is necessary.
 
 Most attributes on the annotation can be resolved from SpEL `(#{...})` or property placeholders `(${...})`.
@@ -639,6 +643,16 @@ public void listen(@SnsNotificationMessage List<Pojo> pojos) {
 }
 ----
 
+Since 3.3.1 you can also retrieve the subject of the SNS message through the `@SnsNotificationSubject` annotation.
+
+[source, java]
+----
+@SqsListener("my-queue")
+public void listen(@SnsNotificationSubject String subject, @SnsNotificationMessage Pojo pojo) {
+	System.out.println("received message for subject %s: %s".formatted(subject, pojo));
+}
+----
+
 ===== Specifying a MessageListenerContainerFactory
 A `MessageListenerContainerFactory` can be specified through the `factory` property.
 Such factory will then be used to create the container for the annotated method.
@@ -802,6 +816,7 @@ The Spring Boot Starter for SQS provides the following auto-configuration proper
 | <<maxConcurrentMessages, `spring.cloud.aws.sqs.listener.max-inflight-messages-per-queue`>> | Maximum number of inflight messages per queue. | No | 10
 | <<maxMessagesPerPoll, `spring.cloud.aws.sqs.listener.max-messages-per-poll`>> | Maximum number of messages to be received per poll. | No | 10
 | <<pollTimeout, `spring.cloud.aws.sqs.listener.poll-timeout`>> | Maximum amount of time to wait for messages in a poll. | No | 10 seconds
+| <<maxDelayBetweenPolls, `spring.cloud.aws.sqs.listener.max-delay-between-polls`>> | Maximum amount of time to wait between polls. | No | 10 seconds
 | `spring.cloud.aws.sqs.queue-not-found-strategy`  | The strategy to be used by SqsTemplate and SqsListeners when a queue does not exist. | No | CREATE
 |===
 
@@ -1233,6 +1248,34 @@ If the error handler execution succeeds, i.e. no error is thrown from the error
 IMPORTANT: If the message should not be acknowledged and the `ON_SUCCESS` acknowledgement mode is set, it's important to propagate the error.
 For simply executing an action in case of errors, an `interceptor` should be used instead, checking the presence of the `throwable` argument for detecting a failed execution.
 
+==== Immediate Retry Error Handler
+As mentioned in <<Error Handling>>, by default, messages that cause an error in the listener are only retried after the visibility timeout has expired.
+
+Starting with version 3.4, Spring Cloud AWS SQS includes the `ImmediateRetryAsyncErrorHandler`, which sets the visibility timeout to zero to enable immediate retry of failed messages.
+
+When using auto-configured factory, simply declare a `@Bean` and the error handler will be set
+
+[source, java]
+----
+@Bean
+public AsyncErrorHandler<Object> asyncErrorHandler() {
+    return new ImmediateRetryAsyncErrorHandler<>();
+}
+----
+
+Alternatively, `ImmediateRetryAsyncErrorHandler` can be set in the `MessageListenerContainerFactory` or directly in the `MessageListenerContainer`:
+
+[source, java]
+----
+@Bean
+public SqsMessageListenerContainerFactory<Object> defaultSqsListenerContainerFactory() {
+    return SqsMessageListenerContainerFactory
+        .builder()
+        .sqsAsyncClientSupplier(BaseSqsIntegrationTest::createAsyncClient)
+        .errorHandler(new ImmediateRetryAsyncErrorHandler<>())
+        .build();
+}
+----
 
 === Message Conversion and Payload Deserialization
 
@@ -1715,7 +1758,10 @@ Following IAM permissions are required by Spring Cloud AWS SQS:
 
 [cols="2"]
 |===
-| Send message to Queue
+| To access the queue by its name or ARN instead of the URL
+| `sqs:GetQueueUrl`
+
+| Send message to queue
 | `sqs:SendMessage`
 
 | Receive message from queue
@@ -1727,9 +1773,6 @@ Following IAM permissions are required by Spring Cloud AWS SQS:
 | To use sqsListener with SimpleMessageListenerContainerFactory you will need to add as well
 | `sqs:GetQueueAttributes`
 
-| To use SqsListener with Sqs name instead of ARN you will need
-| `sqs:GetQueueUrl`
-
 |===
 
 Sample IAM policy granting access to SQS:

pom.xml

@@ -12,7 +12,7 @@
 
 	<groupId>io.awspring.cloud</groupId>
 	<artifactId>spring-cloud-aws</artifactId>
-	<version>3.3.0-SNAPSHOT</version>
+	<version>3.4.0-SNAPSHOT</version>
 	<packaging>pom</packaging>
 	<name>Spring Cloud AWS</name>
 
@@ -134,7 +134,7 @@
 					</links>
 					<author>true</author>
 					<header>${project.name}</header>
-					<reportOutputDirectory>${project.build.directory}/site/${project.version}/apidocs</reportOutputDirectory>
+					<outputDirectory>${project.build.directory}/site/${project.version}/</outputDirectory>
 					<source>17</source>
 				</configuration>
 			</plugin>

spring-cloud-aws-autoconfigure/pom.xml

@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>io.awspring.cloud</groupId>
 		<artifactId>spring-cloud-aws</artifactId>
-		<version>3.3.0-SNAPSHOT</version>
+		<version>3.4.0-SNAPSHOT</version>
 	</parent>
 
 	<artifactId>spring-cloud-aws-autoconfigure</artifactId>