S3AsyncClient Support

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>software.amazon.payloadoffloading</groupId>
     <artifactId>payloadoffloading-common</artifactId>
-    <version>2.1.2</version>
+    <version>2.2.0</version>
     <packaging>jar</packaging>
     <name>Payload offloading common library for AWS</name>
     <description>Common library between extended Amazon AWS clients to save payloads up to 2GB on Amazon S3.</description>

src/main/java/software/amazon/payloadoffloading/PayloadStorageAsyncConfiguration.java

@@ -0,0 +1,153 @@
+package software.amazon.payloadoffloading;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import software.amazon.awssdk.annotations.NotThreadSafe;
+import software.amazon.awssdk.core.exception.SdkClientException;
+import software.amazon.awssdk.services.s3.S3AsyncClient;
+import software.amazon.awssdk.services.s3.S3Client;
+import software.amazon.awssdk.services.s3.model.ObjectCannedACL;
+
+/**
+ * <p>Amazon payload storage configuration options such as asynchronous Amazon S3 client,
+ * bucket name, and payload size threshold for payloads.</p>
+ *
+ * <p>Server side encryption is optional and can be enabled using with {@link #withServerSideEncryption(ServerSideEncryptionStrategy)}
+ * or {@link #setServerSideEncryptionStrategy(ServerSideEncryptionStrategy)}</p>
+ *
+ * <p>There are two possible options for server side encrption. This can be using a customer managed key or AWS managed CMK.</p>
+ *
+ * Example usage:
+ *
+ * <pre>
+ *     withServerSideEncryption(ServerSideEncrptionFactory.awsManagedCmk())
+ * </pre>
+ *
+ * or
+ *
+ * <pre>
+ *     withServerSideEncryption(ServerSideEncrptionFactory.customerKey(YOUR_CUSTOMER_ID))
+ * </pre>
+ *
+ * @see software.amazon.payloadoffloading.ServerSideEncryptionFactory
+ */
+@NotThreadSafe
+public class PayloadStorageAsyncConfiguration extends PayloadStorageConfigurationBase {
+    private static final Logger LOG = LoggerFactory.getLogger(PayloadStorageAsyncConfiguration.class);
+
+    private S3AsyncClient s3Async;
+
+    public PayloadStorageAsyncConfiguration() {
+        s3Async = null;
+    }
+
+    public PayloadStorageAsyncConfiguration(PayloadStorageAsyncConfiguration other) {
+        super(other);
+        this.s3Async = other.getS3AsyncClient();
+    }
+
+    /**
+     * Enables support for payloads using asynchronous storage.
+     *
+     * @param s3Async      Amazon S3 client which is going to be used for storing payload.
+     * @param s3BucketName Name of the bucket which is going to be used for storing payload.
+     *                     The bucket must be already created and configured in s3.
+     */
+    public void setPayloadSupportEnabled(S3AsyncClient s3Async, String s3BucketName) {
+        if (s3Async == null || s3BucketName == null) {
+            String errorMessage = "S3 client and/or S3 bucket name cannot be null.";
+            LOG.error(errorMessage);
+            throw SdkClientException.create(errorMessage);
+        }
+        super.setPayloadSupportEnabled(s3BucketName);
+        this.s3Async = s3Async;
+    }
+
+    /**
+     * Enables support for payload.
+     *
+     * @param s3Async      Amazon S3 client which is going to be used for storing payload.
+     * @param s3BucketName Name of the bucket which is going to be used for storing payloads.
+     *                     The bucket must be already created and configured in s3.
+     * @return the updated PayloadStorageAsyncConfiguration object.
+     */
+    public PayloadStorageAsyncConfiguration withPayloadSupportEnabled(S3AsyncClient s3Async, String s3BucketName) {
+        setPayloadSupportEnabled(s3Async, s3BucketName);
+        return this;
+    }
+
+    /**
+     * Disables support for payloads.
+     */
+    public void setPayloadSupportDisabled() {
+        super.setPayloadSupportDisabled();
+        s3Async = null;
+        LOG.info("Payload support disabled.");
+    }
+
+    /**
+     * Disables support for payload.
+     *
+     * @return the updated PayloadStorageAsyncConfiguration object.
+     */
+    public PayloadStorageAsyncConfiguration withPayloadSupportDisabled() {
+        setPayloadSupportDisabled();
+        return this;
+    }
+
+    /**
+     * Gets the Amazon S3 async client which is being used for storing payloads.
+     *
+     * @return Reference to the Amazon S3 async client which is being used.
+     */
+    public S3AsyncClient getS3AsyncClient() {
+        return s3Async;
+    }
+
+    /**
+     * Sets the payload size threshold for storing payloads in Amazon S3.
+     *
+     * @param payloadSizeThreshold Payload size threshold to be used for storing in Amazon S3.
+     *                             Default: 256KB.
+     * @return the updated PayloadStorageAsyncConfiguration object.
+     */
+    public PayloadStorageAsyncConfiguration withPayloadSizeThreshold(int payloadSizeThreshold) {
+        setPayloadSizeThreshold(payloadSizeThreshold);
+        return this;
+    }
+
+    /**
+     * Sets whether or not all payloads regardless of their size should be stored in Amazon S3.
+     *
+     * @param alwaysThroughS3 Whether or not all payloads regardless of their size
+     *                        should be stored in Amazon S3. Default: false
+     * @return the updated PayloadStorageAsyncConfiguration object.
+     */
+    public PayloadStorageAsyncConfiguration withAlwaysThroughS3(boolean alwaysThroughS3) {
+        setAlwaysThroughS3(alwaysThroughS3);
+        return this;
+    }
+
+    /**
+     * Sets which method of server side encryption should be used, if required.
+     *
+     * This is optional, it is set only when you want to configure S3 server side encryption with KMS.
+     *
+     * @param serverSideEncryptionStrategy The method of encryption required for S3 server side encryption with KMS.
+     * @return the updated PayloadStorageAsyncConfiguration object.
+     */
+    public PayloadStorageAsyncConfiguration withServerSideEncryption(ServerSideEncryptionStrategy serverSideEncryptionStrategy) {
+        setServerSideEncryptionStrategy(serverSideEncryptionStrategy);
+        return this;
+    }
+
+    /**
+     * Configures the ACL to apply to the Amazon S3 putObject request.
+     * @param objectCannedACL
+     *            The ACL to be used when storing objects in Amazon S3
+     */
+    public PayloadStorageAsyncConfiguration withObjectCannedACL(ObjectCannedACL objectCannedACL) {
+        setObjectCannedACL(objectCannedACL);
+        return this;
+    }
+}

src/main/java/software/amazon/payloadoffloading/PayloadStorageConfiguration.java

@@ -8,7 +8,7 @@
 import software.amazon.awssdk.services.s3.model.ObjectCannedACL;
 
 /**
- * <p>Amazon payload storage configuration options such as Amazon S3 client,
+ * <p>Amazon payload storage configuration options such as synchronous Amazon S3 client,
  * bucket name, and payload size threshold for payloads.</p>
  *
  * <p>Server side encryption is optional and can be enabled using with {@link #withServerSideEncryption(ServerSideEncryptionStrategy)}
@@ -31,38 +31,18 @@
  * @see software.amazon.payloadoffloading.ServerSideEncryptionFactory
  */
 @NotThreadSafe
-public class PayloadStorageConfiguration {
+public class PayloadStorageConfiguration extends PayloadStorageConfigurationBase {
     private static final Logger LOG = LoggerFactory.getLogger(PayloadStorageConfiguration.class);
 
     private S3Client s3;
-    private String s3BucketName;
-    private int payloadSizeThreshold = 0;
-    private boolean alwaysThroughS3 = false;
-    private boolean payloadSupport = false;
-    /**
-     * This field is optional, it is set only when we want to configure S3 Server Side Encryption with KMS.
-     */
-    private ServerSideEncryptionStrategy serverSideEncryptionStrategy;
-    /**
-     * This field is optional, it is set only when we want to add access control list to Amazon S3 buckets and objects
-     */
-    private ObjectCannedACL objectCannedACL;
 
     public PayloadStorageConfiguration() {
         s3 = null;
-        s3BucketName = null;
-        serverSideEncryptionStrategy = null;
-        objectCannedACL = null;
     }
 
     public PayloadStorageConfiguration(PayloadStorageConfiguration other) {
+        super(other);
         this.s3 = other.getS3Client();
-        this.s3BucketName = other.getS3BucketName();
-        this.payloadSupport = other.isPayloadSupportEnabled();
-        this.alwaysThroughS3 = other.isAlwaysThroughS3();
-        this.payloadSizeThreshold = other.getPayloadSizeThreshold();
-        this.serverSideEncryptionStrategy = other.getServerSideEncryptionStrategy();
-        this.objectCannedACL = other.getObjectCannedACL();
     }
 
     /**
@@ -78,13 +58,8 @@ public void setPayloadSupportEnabled(S3Client s3, String s3BucketName) {
             LOG.error(errorMessage);
             throw SdkClientException.create(errorMessage);
         }
-        if (isPayloadSupportEnabled()) {
-            LOG.warn("Payload support is already enabled. Overwriting AmazonS3Client and S3BucketName.");
-        }
+        super.setPayloadSupportEnabled(s3BucketName);
         this.s3 = s3;
-        this.s3BucketName = s3BucketName;
-        this.payloadSupport = true;
-        LOG.info("Payload support enabled.");
     }
 
     /**
@@ -104,10 +79,8 @@ public PayloadStorageConfiguration withPayloadSupportEnabled(S3Client s3, String
      * Disables support for payloads.
      */
     public void setPayloadSupportDisabled() {
+        super.setPayloadSupportDisabled();
         s3 = null;
-        s3BucketName = null;
-        payloadSupport = false;
-        LOG.info("Payload support disabled.");
     }
 
     /**
@@ -120,15 +93,6 @@ public PayloadStorageConfiguration withPayloadSupportDisabled() {
         return this;
     }
 
-    /**
-     * Check if the support for payloads if enabled.
-     *
-     * @return true if support for payloads is enabled.
-     */
-    public boolean isPayloadSupportEnabled() {
-        return payloadSupport;
-    }
-
     /**
      * Gets the Amazon S3 client which is being used for storing payloads.
      *
@@ -138,15 +102,6 @@ public S3Client getS3Client() {
         return s3;
     }
 
-    /**
-     * Gets the name of the S3 bucket which is being used for storing payload.
-     *
-     * @return The name of the bucket which is being used.
-     */
-    public String getS3BucketName() {
-        return s3BucketName;
-    }
-
     /**
      * Sets the payload size threshold for storing payloads in Amazon S3.
      *
@@ -159,25 +114,6 @@ public PayloadStorageConfiguration withPayloadSizeThreshold(int payloadSizeThres
         return this;
     }
 
-    /**
-     * Gets the payload size threshold for storing payloads in Amazon S3.
-     *
-     * @return payload size threshold which is being used for storing in Amazon S3. Default: 256KB.
-     */
-    public int getPayloadSizeThreshold() {
-        return payloadSizeThreshold;
-    }
-
-    /**
-     * Sets the payload size threshold for storing payloads in Amazon S3.
-     *
-     * @param payloadSizeThreshold Payload size threshold to be used for storing in Amazon S3.
-     *                             Default: 256KB.
-     */
-    public void setPayloadSizeThreshold(int payloadSizeThreshold) {
-        this.payloadSizeThreshold = payloadSizeThreshold;
-    }
-
     /**
      * Sets whether or not all payloads regardless of their size should be stored in Amazon S3.
      *
@@ -190,25 +126,6 @@ public PayloadStorageConfiguration withAlwaysThroughS3(boolean alwaysThroughS3)
         return this;
     }
 
-    /**
-     * Checks whether or not all payloads regardless of their size are being stored in Amazon S3.
-     *
-     * @return True if all payloads regardless of their size are being stored in Amazon S3. Default: false
-     */
-    public boolean isAlwaysThroughS3() {
-        return alwaysThroughS3;
-    }
-
-    /**
-     * Sets whether or not all payloads regardless of their size should be stored in Amazon S3.
-     *
-     * @param alwaysThroughS3 Whether or not all payloads regardless of their size
-     *                        should be stored in Amazon S3. Default: false
-     */
-    public void setAlwaysThroughS3(boolean alwaysThroughS3) {
-        this.alwaysThroughS3 = alwaysThroughS3;
-    }
-
     /**
      * Sets which method of server side encryption should be used, if required.
      *
@@ -222,35 +139,6 @@ public PayloadStorageConfiguration withServerSideEncryption(ServerSideEncryption
         return this;
     }
 
-    /**
-     * Sets which method of server side encryption should be use, if required.
-     *
-     * This is optional, it is set only when you want to configure S3 Server Side Encryption with KMS.
-     *
-     * @param serverSideEncryptionStrategy The method of encryption required for S3 server side encryption with KMS.
-     */
-    public void setServerSideEncryptionStrategy(ServerSideEncryptionStrategy serverSideEncryptionStrategy) {
-        this.serverSideEncryptionStrategy = serverSideEncryptionStrategy;
-    }
-
-    /**
-     * The method of service side encryption which should be used, if required.
-     *
-     * @return The server side encryption method required. Default null.
-     */
-    public ServerSideEncryptionStrategy getServerSideEncryptionStrategy() {
-        return this.serverSideEncryptionStrategy;
-    }
-
-    /**
-     * Configures the ACL to apply to the Amazon S3 putObject request.
-     * @param objectCannedACL
-     *            The ACL to be used when storing objects in Amazon S3
-     */
-    public void setObjectCannedACL(ObjectCannedACL objectCannedACL) {
-        this.objectCannedACL = objectCannedACL;
-    }
-
     /**
      * Configures the ACL to apply to the Amazon S3 putObject request.
      * @param objectCannedACL
@@ -260,20 +148,4 @@ public PayloadStorageConfiguration withObjectCannedACL(ObjectCannedACL objectCan
         setObjectCannedACL(objectCannedACL);
         return this;
     }
-
-    /**
-     * Checks whether an ACL have been configured for storing objects in Amazon S3.
-     * @return True if ACL is defined
-     */
-    public boolean isObjectCannedACLDefined() {
-        return null != objectCannedACL;
-    }
-
-    /**
-     * Gets the AWS ACL to apply to the Amazon S3 putObject request.
-     * @return Amazon S3 object ACL
-     */
-    public ObjectCannedACL getObjectCannedACL() {
-        return objectCannedACL;
-    }
 }