Reponame (#4)

* Renamed classes and methods

Author: adam-aws

README.md

@@ -1,6 +1,6 @@
-## Large Payload Offloading Java Common Library For AWS
+## Payload Offloading Java Common Library For AWS
 
-The **Large Payload Offloading Java Common Library For AWS** enables you to manage payloads with Amazon S3. 
+The **Payload Offloading Java Common Library For AWS** enables you to manage payloads with Amazon S3. 
 For example, this is useful for storing and retrieving payloads with size greater than the current SQS/SNS limit of 256 KB, up to a maximum of 2 GB.
 
 You can use this library to:

pom.xml

@@ -8,12 +8,12 @@
     <artifactId>payloadoffloading-common</artifactId>
     <version>1.0.0</version>
     <packaging>jar</packaging>
-    <name>Large payload offloading common library for AWS</name>
+    <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>
-    <url>https://github.com/awslabs/large-payload-offloading-java-common-lib-for-aws</url>
+    <url>https://github.com/awslabs/payload-offloading-java-common-lib-for-aws</url>
 
     <scm>
-        <url>https://github.com/awslabs/large-payload-offloading-java-common-lib-for-aws</url>
+        <url>https://github.com/awslabs/payload-offloading-java-common-lib-for-aws</url>
     </scm>
 
     <licenses>
@@ -105,11 +105,11 @@
             <distributionManagement>
                 <snapshotRepository>
                     <id>ossrh</id>
-                    <url>https://oss.sonatype.org/content/repositories/snapshots</url>
+                    <url>https://aws.oss.sonatype.org/content/repositories/snapshots</url>
                 </snapshotRepository>
                 <repository>
                     <id>ossrh</id>
-                    <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
+                    <url>https://aws.oss.sonatype.org/service/local/staging/deploy/maven2/</url>
                 </repository>
             </distributionManagement>
             <build>

src/main/java/com/amazonaws/largepayloadoffloading/CountingOutputStream.java renamed to src/main/java/com/amazonaws/payloadoffloading/CountingOutputStream.java

@@ -1,4 +1,4 @@
-package com.amazonaws.largepayloadoffloading;
+package com.amazonaws.payloadoffloading;
 
 import java.io.OutputStream;
 

src/main/java/com/amazonaws/largepayloadoffloading/JsonDataConverter.java renamed to src/main/java/com/amazonaws/payloadoffloading/JsonDataConverter.java

@@ -1,4 +1,4 @@
-package com.amazonaws.largepayloadoffloading;
+package com.amazonaws.payloadoffloading;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.DeserializationFeature;

src/main/java/com/amazonaws/largepayloadoffloading/PayloadS3Pointer.java renamed to src/main/java/com/amazonaws/payloadoffloading/PayloadS3Pointer.java

@@ -1,4 +1,4 @@
-package com.amazonaws.largepayloadoffloading;
+package com.amazonaws.payloadoffloading;
 
 import com.amazonaws.AmazonClientException;
 import org.apache.commons.logging.Log;

src/main/java/com/amazonaws/largepayloadoffloading/LargePayloadStorageConfiguration.java renamed to src/main/java/com/amazonaws/payloadoffloading/PayloadStorageConfiguration.java

@@ -1,4 +1,4 @@
-package com.amazonaws.largepayloadoffloading;
+package com.amazonaws.payloadoffloading;
 
 import com.amazonaws.AmazonClientException;
 import com.amazonaws.annotation.NotThreadSafe;
@@ -8,104 +8,104 @@
 import org.apache.commons.logging.LogFactory;
 
 /**
- * Amazon large payload storage configuration options such as Amazon S3 client,
- * bucket name, and payload size threshold for large payloads.
+ * Amazon payload storage configuration options such as Amazon S3 client,
+ * bucket name, and payload size threshold for payloads.
  */
 @NotThreadSafe
-public class LargePayloadStorageConfiguration {
-    private static final Log LOG = LogFactory.getLog(LargePayloadStorageConfiguration.class);
+public class PayloadStorageConfiguration {
+    private static final Log LOG = LogFactory.getLog(PayloadStorageConfiguration.class);
 
     private AmazonS3 s3;
     private String s3BucketName;
     private int payloadSizeThreshold = 0;
     private boolean alwaysThroughS3 = false;
-    private boolean largePayloadSupport = 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 SSEAwsKeyManagementParams sseAwsKeyManagementParams;
 
-    public LargePayloadStorageConfiguration() {
+    public PayloadStorageConfiguration() {
         s3 = null;
         s3BucketName = null;
         sseAwsKeyManagementParams = null;
     }
 
-    public LargePayloadStorageConfiguration(LargePayloadStorageConfiguration other) {
+    public PayloadStorageConfiguration(PayloadStorageConfiguration other) {
         this.s3 = other.getAmazonS3Client();
         this.s3BucketName = other.getS3BucketName();
         this.sseAwsKeyManagementParams = other.getSSEAwsKeyManagementParams();
-        this.largePayloadSupport = other.isLargePayloadSupportEnabled();
+        this.payloadSupport = other.isPayloadSupportEnabled();
         this.alwaysThroughS3 = other.isAlwaysThroughS3();
         this.payloadSizeThreshold = other.getPayloadSizeThreshold();
     }
 
     /**
-     * Enables support for large payloads .
+     * Enables support for payloads .
      *
-     * @param s3           Amazon S3 client which is going to be used for storing large payload.
-     * @param s3BucketName Name of the bucket which is going to be used for storing large payload.
+     * @param s3           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 setLargePayloadSupportEnabled(AmazonS3 s3, String s3BucketName) {
+    public void setPayloadSupportEnabled(AmazonS3 s3, String s3BucketName) {
         if (s3 == null || s3BucketName == null) {
             String errorMessage = "S3 client and/or S3 bucket name cannot be null.";
             LOG.error(errorMessage);
             throw new AmazonClientException(errorMessage);
         }
-        if (isLargePayloadSupportEnabled()) {
-            LOG.warn("Large-payload support is already enabled. Overwriting AmazonS3Client and S3BucketName.");
+        if (isPayloadSupportEnabled()) {
+            LOG.warn("Payload support is already enabled. Overwriting AmazonS3Client and S3BucketName.");
         }
         this.s3 = s3;
         this.s3BucketName = s3BucketName;
-        this.largePayloadSupport = true;
-        LOG.info("Large-payload support enabled.");
+        this.payloadSupport = true;
+        LOG.info("Payload support enabled.");
     }
 
     /**
-     * Enables support for large payload.
+     * Enables support for payload.
      *
-     * @param s3           Amazon S3 client which is going to be used for storing large payloads.
-     * @param s3BucketName Name of the bucket which is going to be used for storing large payloads.
+     * @param s3           Amazon S3 client which is going to be used for storing payloads.
+     * @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 LargePayloadStorageConfiguration object.
+     * @return the updated PayloadStorageConfiguration object.
      */
-    public LargePayloadStorageConfiguration withLargePayloadSupportEnabled(AmazonS3 s3, String s3BucketName) {
-        setLargePayloadSupportEnabled(s3, s3BucketName);
+    public PayloadStorageConfiguration withPayloadSupportEnabled(AmazonS3 s3, String s3BucketName) {
+        setPayloadSupportEnabled(s3, s3BucketName);
         return this;
     }
 
     /**
-     * Disables support for large payloads.
+     * Disables support for payloads.
      */
-    public void setLargePayloadSupportDisabled() {
+    public void setPayloadSupportDisabled() {
         s3 = null;
         s3BucketName = null;
-        largePayloadSupport = false;
-        LOG.info("Large-payload support disabled.");
+        payloadSupport = false;
+        LOG.info("Payload support disabled.");
     }
 
     /**
-     * Disables support for large payload.
+     * Disables support for payload.
      *
-     * @return the updated LargePayloadStorageConfiguration object.
+     * @return the updated PayloadStorageConfiguration object.
      */
-    public LargePayloadStorageConfiguration withLargePayloadSupportDisabled() {
-        setLargePayloadSupportDisabled();
+    public PayloadStorageConfiguration withPayloadSupportDisabled() {
+        setPayloadSupportDisabled();
         return this;
     }
 
     /**
-     * Check if the support for large payloads if enabled.
+     * Check if the support for payloads if enabled.
      *
-     * @return true if support for large payloads is enabled.
+     * @return true if support for payloads is enabled.
      */
-    public boolean isLargePayloadSupportEnabled() {
-        return largePayloadSupport;
+    public boolean isPayloadSupportEnabled() {
+        return payloadSupport;
     }
 
     /**
-     * Gets the Amazon S3 client which is being used for storing large payloads.
+     * Gets the Amazon S3 client which is being used for storing payloads.
      *
      * @return Reference to the Amazon S3 client which is being used.
      */
@@ -114,7 +114,7 @@ public AmazonS3 getAmazonS3Client() {
     }
 
     /**
-     * Gets the name of the S3 bucket which is being used for storing large payload.
+     * Gets the name of the S3 bucket which is being used for storing payload.
      *
      * @return The name of the bucket which is being used.
      */
@@ -144,9 +144,9 @@ public void setSSEAwsKeyManagementParams(SSEAwsKeyManagementParams sseAwsKeyMana
      * Sets the the S3 SSE-KMS encryption params of S3 objects under configured S3 bucket name.
      *
      * @param sseAwsKeyManagementParams The S3 SSE-KMS params used for encryption.
-     * @return the updated LargePayloadStorageConfiguration object
+     * @return the updated PayloadStorageConfiguration object
      */
-    public LargePayloadStorageConfiguration withSSEAwsKeyManagementParams(SSEAwsKeyManagementParams sseAwsKeyManagementParams) {
+    public PayloadStorageConfiguration withSSEAwsKeyManagementParams(SSEAwsKeyManagementParams sseAwsKeyManagementParams) {
         setSSEAwsKeyManagementParams(sseAwsKeyManagementParams);
         return this;
     }
@@ -156,9 +156,9 @@ public LargePayloadStorageConfiguration withSSEAwsKeyManagementParams(SSEAwsKeyM
      *
      * @param payloadSizeThreshold Payload size threshold to be used for storing in Amazon S3.
      *                             Default: 256KB.
-     * @return the updated LargePayloadStorageConfiguration object.
+     * @return the updated PayloadStorageConfiguration object.
      */
-    public LargePayloadStorageConfiguration withPayloadSizeThreshold(int payloadSizeThreshold) {
+    public PayloadStorageConfiguration withPayloadSizeThreshold(int payloadSizeThreshold) {
         setPayloadSizeThreshold(payloadSizeThreshold);
         return this;
     }
@@ -187,9 +187,9 @@ public void setPayloadSizeThreshold(int payloadSizeThreshold) {
      *
      * @param alwaysThroughS3 Whether or not all payloads regardless of their size
      *                        should be stored in Amazon S3. Default: false
-     * @return the updated LargePayloadStorageConfiguration object.
+     * @return the updated PayloadStorageConfiguration object.
      */
-    public LargePayloadStorageConfiguration withAlwaysThroughS3(boolean alwaysThroughS3) {
+    public PayloadStorageConfiguration withAlwaysThroughS3(boolean alwaysThroughS3) {
         setAlwaysThroughS3(alwaysThroughS3);
         return this;
     }

src/main/java/com/amazonaws/largepayloadoffloading/LargePayloadStore.java renamed to src/main/java/com/amazonaws/payloadoffloading/PayloadStore.java

@@ -1,12 +1,12 @@
-package com.amazonaws.largepayloadoffloading;
+package com.amazonaws.payloadoffloading;
 
 import com.amazonaws.AmazonClientException;
 import com.amazonaws.AmazonServiceException;
 
 /**
  * An AWS storage service that supports saving high payload sizes.
  */
-public interface LargePayloadStore {
+public interface PayloadStore {
     /**
      * Stores payload in a store that has higher payload size limit than that is supported by original payload store.
      *
@@ -16,7 +16,7 @@ public interface LargePayloadStore {
      * @throws AmazonClientException  If any internal errors are encountered on the client side while
      *                                attempting to make the request or handle the response. For example
      *                                if a network connection is not available.
-     * @throws AmazonServiceException If an error response is returned by actual LargePayloadStore indicating
+     * @throws AmazonServiceException If an error response is returned by actual PayloadStore indicating
      *                                either a problem with the data in the request, or a server side issue.
      */
     String storeOriginalPayload(String payload, Long payloadContentSize);
@@ -30,7 +30,7 @@ public interface LargePayloadStore {
      * @throws AmazonClientException  If any internal errors are encountered on the client side while
      *                                attempting to make the request or handle the response. For example
      *                                if payloadPointer is invalid or a network connection is not available.
-     * @throws AmazonServiceException If an error response is returned by actual LargePayloadStore indicating
+     * @throws AmazonServiceException If an error response is returned by actual PayloadStore indicating
      *                                a server side issue.
      */
     String getOriginalPayload(String payloadPointer);
@@ -41,9 +41,9 @@ public interface LargePayloadStore {
      *
      * @param payloadPointer
      * @throws AmazonClientException  If any internal errors are encountered on the client side while
-     *                                attempting to make the request or handle the response to/from LargePayloadStore.
+     *                                attempting to make the request or handle the response to/from PayloadStore.
      *                                For example, if payloadPointer is invalid or a network connection is not available.
-     * @throws AmazonServiceException If an error response is returned by actual LargePayloadStore indicating
+     * @throws AmazonServiceException If an error response is returned by actual PayloadStore indicating
      *                                a server side issue.
      */
     void deleteOriginalPayload(String payloadPointer);

src/main/java/com/amazonaws/largepayloadoffloading/S3BackedLargePayloadStore.java renamed to src/main/java/com/amazonaws/payloadoffloading/S3BackedPayloadStore.java

@@ -1,4 +1,4 @@
-package com.amazonaws.largepayloadoffloading;
+package com.amazonaws.payloadoffloading;
 
 import com.amazonaws.services.s3.model.SSEAwsKeyManagementParams;
 import org.apache.commons.logging.Log;
@@ -7,21 +7,21 @@
 import java.util.UUID;
 
 /**
- * S3 based implementation for LargePayloadStore.
+ * S3 based implementation for PayloadStore.
  */
-public class S3BackedLargePayloadStore implements LargePayloadStore {
-    private static final Log LOG = LogFactory.getLog(S3BackedLargePayloadStore.class);
+public class S3BackedPayloadStore implements PayloadStore {
+    private static final Log LOG = LogFactory.getLog(S3BackedPayloadStore.class);
 
     private final String s3BucketName;
     private final S3Dao s3Dao;
     private final SSEAwsKeyManagementParams sseAwsKeyManagementParams;
 
-    public S3BackedLargePayloadStore(S3Dao s3Dao, String s3BucketName) {
+    public S3BackedPayloadStore(S3Dao s3Dao, String s3BucketName) {
         this(s3Dao, s3BucketName, null);
     }
 
-    public S3BackedLargePayloadStore(S3Dao s3Dao, String s3BucketName,
-                                     SSEAwsKeyManagementParams sseAwsKeyManagementParams) {
+    public S3BackedPayloadStore(S3Dao s3Dao, String s3BucketName,
+                                SSEAwsKeyManagementParams sseAwsKeyManagementParams) {
         this.s3BucketName = s3BucketName;
         this.s3Dao = s3Dao;
         this.sseAwsKeyManagementParams = sseAwsKeyManagementParams;

src/main/java/com/amazonaws/largepayloadoffloading/S3Dao.java renamed to src/main/java/com/amazonaws/payloadoffloading/S3Dao.java

@@ -1,4 +1,4 @@
-package com.amazonaws.largepayloadoffloading;
+package com.amazonaws.payloadoffloading;
 
 import com.amazonaws.AmazonClientException;
 import com.amazonaws.AmazonServiceException;

src/main/java/com/amazonaws/largepayloadoffloading/Util.java renamed to src/main/java/com/amazonaws/payloadoffloading/Util.java

@@ -1,4 +1,4 @@
-package com.amazonaws.largepayloadoffloading;
+package com.amazonaws.payloadoffloading;
 
 import com.amazonaws.AmazonClientException;
 import com.amazonaws.util.VersionInfoUtils;