Merge with upstream and resolve conflicts.

Author: richardsmithsfdc

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "maven"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

README.md

@@ -25,7 +25,7 @@ For more information on using the amazon-sqs-java-extended-client-lib, see our g
   <dependency>
     <groupId>com.amazonaws</groupId>
     <artifactId>amazon-sqs-java-extended-client-lib</artifactId>
-    <version>2.0.2</version>
+    <version>2.0.4</version>
     <type>jar</type>
   </dependency>
 ```   
@@ -35,7 +35,7 @@ For more information on using the amazon-sqs-java-extended-client-lib, see our g
   <dependency>
     <groupId>com.amazonaws</groupId>
     <artifactId>amazon-sqs-java-extended-client-lib</artifactId>
-    <version>1.2.2</version>
+    <version>1.2.5</version>
     <type>jar</type>
   </dependency>
 ```      

pom.xml

@@ -37,7 +37,7 @@
   </developers>
 
   <properties>
-    <aws-java-sdk.version>2.14.19</aws-java-sdk.version>
+    <aws-java-sdk.version>2.20.153</aws-java-sdk.version>
   </properties>
 
   <dependencies>
@@ -66,15 +66,15 @@
     </dependency>
 
     <dependency>
-      <groupId>junit</groupId>
-      <artifactId>junit</artifactId>
-      <version>4.13.1</version>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter</artifactId>
+      <version>5.10.0</version>
       <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>org.mockito</groupId>
       <artifactId>mockito-core</artifactId>
-      <version>3.12.4</version>
+      <version>5.5.0</version>
       <scope>test</scope>
     </dependency>
   </dependencies>
@@ -84,7 +84,7 @@
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-compiler-plugin</artifactId>
-          <version>3.2</version>
+          <version>3.11.0</version>
           <configuration>
             <source>1.8</source>
             <target>1.8</target>
@@ -107,30 +107,31 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <version>3.1.2</version>
+      </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
-        <version>2.9.1</version>
+        <version>3.6.0</version>
         <executions>
           <execution>
             <id>attach-javadocs</id>
             <goals>
               <goal>jar</goal>
             </goals>
             <configuration>
-              <!--
-              TODO-RS: Java 8 is more strict about some javadoc tags.
-              We'll need to update quite a few to remove this workaround.
-              -->
-              <additionalparam>-Xdoclint:none</additionalparam>
+              <doclint>none</doclint>
             </configuration>
           </execution>
         </executions>
       </plugin>
       <plugin>
         <groupId>org.sonatype.plugins</groupId>
         <artifactId>nexus-staging-maven-plugin</artifactId>
-        <version>1.6.7</version>
+        <version>1.6.13</version>
         <extensions>true</extensions>
         <configuration>
           <serverId>ossrh</serverId>

src/main/java/com/amazon/sqs/javamessaging/AmazonSQSExtendedAsyncClient.java

@@ -14,6 +14,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
+import java.util.UUID;
 import java.util.concurrent.CompletableFuture;
 import java.util.stream.Collectors;
 import org.apache.commons.logging.Log;
@@ -469,7 +470,7 @@ private CompletableFuture<SendMessageBatchRequestEntry> storeMessageInS3(SendMes
                 clientConfiguration.usesLegacyReservedAttributeName()));
 
         // Store the message content in S3.
-        return payloadStore.storeOriginalPayload(messageContentStr)
+        return storeOriginalPayload(messageContentStr)
             .thenApply(largeMessagePointer -> {
                 batchEntryBuilder.messageBody(largeMessagePointer);
                 return batchEntryBuilder.build();
@@ -496,6 +497,14 @@ private CompletableFuture<SendMessageRequest> storeMessageInS3(SendMessageReques
             });
     }
 
+    private CompletableFuture<String> storeOriginalPayload(String messageContentStr) {
+        String s3KeyPrefix = clientConfiguration.getS3KeyPrefix();
+        if (StringUtils.isBlank(s3KeyPrefix)) {
+            return payloadStore.storeOriginalPayload(messageContentStr);
+        }
+        return payloadStore.storeOriginalPayload(messageContentStr, s3KeyPrefix + UUID.randomUUID());
+    }
+
     private static <T extends AwsRequest.Builder> T appendUserAgent(final T builder) {
         return AmazonSQSExtendedClientUtil.appendUserAgent(builder, USER_AGENT_NAME, USER_AGENT_VERSION);
     }

src/main/java/com/amazon/sqs/javamessaging/AmazonSQSExtendedClient.java

@@ -29,6 +29,8 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
+import java.util.UUID;
+
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import software.amazon.awssdk.awscore.AwsRequest;
@@ -851,7 +853,7 @@ private SendMessageBatchRequestEntry storeMessageInS3(SendMessageBatchRequestEnt
                 clientConfiguration.usesLegacyReservedAttributeName()));
 
         // Store the message content in S3.
-        String largeMessagePointer = payloadStore.storeOriginalPayload(messageContentStr);
+        String largeMessagePointer = storeOriginalPayload(messageContentStr);
         batchEntryBuilder.messageBody(largeMessagePointer);
 
         return batchEntryBuilder.build();
@@ -871,13 +873,29 @@ private SendMessageRequest storeMessageInS3(SendMessageRequest sendMessageReques
                 clientConfiguration.usesLegacyReservedAttributeName()));
 
         // Store the message content in S3.
-        String largeMessagePointer = payloadStore.storeOriginalPayload(messageContentStr);
+        String largeMessagePointer = storeOriginalPayload(messageContentStr);
         sendMessageRequestBuilder.messageBody(largeMessagePointer);
 
         return sendMessageRequestBuilder.build();
     }
 
+    private String storeOriginalPayload(String messageContentStr) {
+        String s3KeyPrefix = clientConfiguration.getS3KeyPrefix();
+        if (StringUtils.isBlank(s3KeyPrefix)) {
+            return payloadStore.storeOriginalPayload(messageContentStr);
+        }
+        return payloadStore.storeOriginalPayload(messageContentStr, s3KeyPrefix + UUID.randomUUID());
+    }
+
+    @SuppressWarnings("unchecked")
     private static <T extends AwsRequest.Builder> T appendUserAgent(final T builder) {
         return AmazonSQSExtendedClientUtil.appendUserAgent(builder, USER_AGENT_NAME, USER_AGENT_VERSION);
     }
+
+	@Override
+	public void close() {
+		super.close();
+		this.clientConfiguration.getS3Client().close();
+	}    
+    
 }

src/main/java/com/amazon/sqs/javamessaging/AmazonSQSExtendedClientUtil.java

@@ -15,6 +15,7 @@
 import software.amazon.awssdk.services.sqs.model.MessageAttributeValue;
 import software.amazon.awssdk.services.sqs.model.SendMessageBatchRequestEntry;
 import software.amazon.awssdk.services.sqs.model.SendMessageRequest;
+import software.amazon.awssdk.utils.StringUtils;
 import software.amazon.payloadoffloading.PayloadS3Pointer;
 import software.amazon.payloadoffloading.Util;
 
@@ -165,4 +166,35 @@ private static int getMsgAttributesSize(Map<String, MessageAttributeValue> msgAt
         }
         return totalMsgAttributesSize;
     }
+
+    public static String trimAndValidateS3KeyPrefix(String s3KeyPrefix) {
+        String trimmedPrefix = StringUtils.trimToEmpty(s3KeyPrefix);
+
+        if (trimmedPrefix.length() > SQSExtendedClientConstants.MAX_S3_KEY_PREFIX_LENGTH) {
+            String errorMessage = "The S3 key prefix length must not be greater than "
+                                  + SQSExtendedClientConstants.MAX_S3_KEY_PREFIX_LENGTH;
+            LOG.error(errorMessage);
+            throw SdkClientException.create(errorMessage);
+        }
+
+        if (trimmedPrefix.startsWith(".") || trimmedPrefix.startsWith("/")) {
+            String errorMessage = "The S3 key prefix must not starts with '.' or '/'";
+            LOG.error(errorMessage);
+            throw SdkClientException.create(errorMessage);
+        }
+
+        if (trimmedPrefix.contains("..")) {
+            String errorMessage = "The S3 key prefix must not contains the string '..'";
+            LOG.error(errorMessage);
+            throw SdkClientException.create(errorMessage);
+        }
+
+        if (SQSExtendedClientConstants.INVALID_S3_PREFIX_KEY_CHARACTERS_PATTERN.matcher(trimmedPrefix).find()) {
+            String errorMessage = "The S3 key prefix contain invalid characters. The allowed characters are: letters, digits, '/', '_', '-', and '.'";
+            LOG.error(errorMessage);
+            throw SdkClientException.create(errorMessage);
+        }
+
+        return trimmedPrefix;
+    }
 }

src/main/java/com/amazon/sqs/javamessaging/ExtendedAsyncClientConfiguration.java

@@ -3,6 +3,7 @@
 import software.amazon.awssdk.annotations.NotThreadSafe;
 import software.amazon.awssdk.services.s3.S3AsyncClient;
 import software.amazon.awssdk.services.s3.model.ObjectCannedACL;
+import software.amazon.awssdk.utils.StringUtils;
 import software.amazon.payloadoffloading.PayloadStorageAsyncConfiguration;
 import software.amazon.payloadoffloading.ServerSideEncryptionStrategy;
 
@@ -16,6 +17,7 @@ public class ExtendedAsyncClientConfiguration extends PayloadStorageAsyncConfigu
     private boolean cleanupS3Payload = true;
     private boolean useLegacyReservedAttributeName = true;
     private boolean ignorePayloadNotFound = false;
+    private String s3KeyPrefix = "";
 
     public ExtendedAsyncClientConfiguration() {
         this.setPayloadSizeThreshold(SQSExtendedClientConstants.DEFAULT_MESSAGE_SIZE_THRESHOLD);
@@ -26,6 +28,7 @@ public ExtendedAsyncClientConfiguration(ExtendedAsyncClientConfiguration other)
         this.cleanupS3Payload = other.doesCleanupS3Payload();
         this.useLegacyReservedAttributeName = other.usesLegacyReservedAttributeName();
         this.ignorePayloadNotFound = other.ignoresPayloadNotFound();
+        this.s3KeyPrefix = other.s3KeyPrefix;
     }
 
     /**
@@ -117,6 +120,36 @@ public ExtendedAsyncClientConfiguration withIgnorePayloadNotFound(boolean ignore
         setIgnorePayloadNotFound(ignorePayloadNotFound);
         return this;
     }
+    /**
+     * Sets a string that will be used as prefix of the S3 Key.
+     *
+     * @param s3KeyPrefix
+     *         A S3 key prefix value
+     */
+    public void setS3KeyPrefix(String s3KeyPrefix) {
+        this.s3KeyPrefix = AmazonSQSExtendedClientUtil.trimAndValidateS3KeyPrefix(s3KeyPrefix);
+    }
+
+    /**
+     * Sets a string that will be used as prefix of the S3 Key.
+     *
+     * @param s3KeyPrefix
+     *         A S3 key prefix value
+     *
+     * @return the updated ExtendedClientConfiguration object.
+     */
+    public ExtendedAsyncClientConfiguration withS3KeyPrefix(String s3KeyPrefix) {
+        setS3KeyPrefix(s3KeyPrefix);
+        return this;
+    }
+
+    /**
+     * Gets the S3 key prefix
+     * @return the prefix value which is being used for compose the S3 key.
+     */
+    public String getS3KeyPrefix() {
+        return this.s3KeyPrefix;
+    }
 
     /**
      * Checks whether or not clean up large objects in S3 is enabled.

src/main/java/com/amazon/sqs/javamessaging/ExtendedClientConfiguration.java

@@ -15,6 +15,8 @@
 
 package com.amazon.sqs.javamessaging;
 
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 import software.amazon.awssdk.annotations.NotThreadSafe;
 import software.amazon.awssdk.services.s3.S3Client;
 import software.amazon.awssdk.services.s3.model.ObjectCannedACL;
@@ -28,10 +30,12 @@
  */
 @NotThreadSafe
 public class ExtendedClientConfiguration extends PayloadStorageConfiguration {
+    private static final Log LOG = LogFactory.getLog(ExtendedClientConfiguration.class);
 
     private boolean cleanupS3Payload = true;
     private boolean useLegacyReservedAttributeName = true;
     private boolean ignorePayloadNotFound = false;
+    private String s3KeyPrefix = "";
 
     public ExtendedClientConfiguration() {
         super();
@@ -43,6 +47,7 @@ public ExtendedClientConfiguration(ExtendedClientConfiguration other) {
         this.cleanupS3Payload = other.doesCleanupS3Payload();
         this.useLegacyReservedAttributeName = other.usesLegacyReservedAttributeName();
         this.ignorePayloadNotFound = other.ignoresPayloadNotFound();
+        this.s3KeyPrefix = other.s3KeyPrefix;
     }
 
     /**
@@ -128,6 +133,37 @@ public ExtendedClientConfiguration withIgnorePayloadNotFound(boolean ignorePaylo
         return this;
     }
 
+    /**
+     * Sets a string that will be used as prefix of the S3 Key.
+     *
+     * @param s3KeyPrefix
+     *         A S3 key prefix value
+     */
+    public void setS3KeyPrefix(String s3KeyPrefix) {
+        this.s3KeyPrefix = AmazonSQSExtendedClientUtil.trimAndValidateS3KeyPrefix(s3KeyPrefix);
+    }
+
+    /**
+     * Sets a string that will be used as prefix of the S3 Key.
+     *
+     * @param s3KeyPrefix
+     *         A S3 key prefix value
+     *
+     * @return the updated ExtendedClientConfiguration object.
+     */
+    public ExtendedClientConfiguration withS3KeyPrefix(String s3KeyPrefix) {
+        setS3KeyPrefix(s3KeyPrefix);
+        return this;
+    }
+
+    /**
+     * Gets the S3 key prefix
+     * @return the prefix value which is being used for compose the S3 key.
+     */
+    public String getS3KeyPrefix() {
+        return this.s3KeyPrefix;
+    }
+
     /**
      * Checks whether or not clean up large objects in S3 is enabled.
      *

src/main/java/com/amazon/sqs/javamessaging/SQSExtendedClientConstants.java

@@ -16,6 +16,8 @@
 package com.amazon.sqs.javamessaging;
 
 
+import java.util.regex.Pattern;
+
 public class SQSExtendedClientConstants {
     // This constant is shared with SNSExtendedClient
     // SNS team should be notified of any changes made to this
@@ -31,4 +33,12 @@ public class SQSExtendedClientConstants {
 
     public static final String S3_BUCKET_NAME_MARKER = "-..s3BucketName..-";
     public static final String S3_KEY_MARKER = "-..s3Key..-";
+
+    public static final int UUID_LENGTH = 36;
+
+    public static final int MAX_S3_KEY_LENGTH = 1024;
+
+    public static final int MAX_S3_KEY_PREFIX_LENGTH = MAX_S3_KEY_LENGTH - UUID_LENGTH;
+
+    public static final Pattern INVALID_S3_PREFIX_KEY_CHARACTERS_PATTERN = Pattern.compile("[^a-zA-Z0-9./_-]");
 }