Resolving issue #375 StorageClass header is not added to upload request (#398)

Author: pzavadska

aws-android-sdk-s3/src/main/java/com/amazonaws/mobileconnectors/s3/transferutility/TransferDBUtil.java

@@ -119,7 +119,8 @@ public Uri insertSingleTransferRecord(TransferType type, String bucket, String k
      */
     public Uri insertSingleTransferRecord(TransferType type, String bucket, String key, File file,
             ObjectMetadata metadata, CannedAccessControlList cannedAcl) {
-        final ContentValues values = generateContentValuesForSinglePartTransfer(type, bucket, key, file,
+        final ContentValues values = generateContentValuesForSinglePartTransfer(type, bucket, key,
+                file,
                 metadata, cannedAcl);
         return transferDBBase.insert(transferDBBase.getContentUri(), values);
     }
@@ -195,9 +196,9 @@ public int updateBytesTotalForDownload(int id, long bytes) {
      * Updates the state but do not notify TransferService to refresh its
      * transfer record list. Therefore, only TransferObserver knows the state
      * change of the transfer record. If the new state is STATE_FAILED, we need
-     * to check the original state, because "pause", "cancel" and
-     * "disconnect network" actions may also cause failure message of the
-     * threads, but these are not actual failure of transfers.
+     * to check the original state, because "pause", "cancel" and "disconnect
+     * network" actions may also cause failure message of the threads, but these
+     * are not actual failure of transfers.
      *
      * @param id The id of the transfer.
      * @param state The new state of the transfer.
@@ -209,12 +210,12 @@ public int updateState(int id, TransferState state) {
         if (TransferState.FAILED.equals(state)) {
             return transferDBBase.update(getRecordUri(id), values, TransferTable.COLUMN_STATE
                     + " not in (?,?,?,?,?) ", new String[] {
-                    TransferState.COMPLETED.toString(),
-                    TransferState.PENDING_NETWORK_DISCONNECT.toString(),
-                    TransferState.PAUSED.toString(),
-                    TransferState.CANCELED.toString(),
-                    TransferState.WAITING_FOR_NETWORK.toString()
-                    });
+                            TransferState.COMPLETED.toString(),
+                            TransferState.PENDING_NETWORK_DISCONNECT.toString(),
+                            TransferState.PAUSED.toString(),
+                            TransferState.CANCELED.toString(),
+                            TransferState.WAITING_FOR_NETWORK.toString()
+            });
         } else {
             return transferDBBase.update(getRecordUri(id), values, null, null);
         }
@@ -275,11 +276,12 @@ public int updateNetworkDisconnected() {
                 TransferState.PENDING_NETWORK_DISCONNECT.toString());
         return transferDBBase.update(transferDBBase.getContentUri(), values,
                 TransferTable.COLUMN_STATE
-                        + " in (?,?,?)", new String[] {
+                        + " in (?,?,?)",
+                new String[] {
                         TransferState.IN_PROGRESS.toString(),
                         TransferState.RESUMED_WAITING.toString(),
                         TransferState.WAITING.toString()
-                        });
+                });
     }
 
     /**
@@ -293,10 +295,11 @@ public int updateNetworkConnected() {
         values.put(TransferTable.COLUMN_STATE, TransferState.RESUMED_WAITING.toString());
         return transferDBBase.update(transferDBBase.getContentUri(), values,
                 TransferTable.COLUMN_STATE
-                        + " in (?,?)", new String[] {
+                        + " in (?,?)",
+                new String[] {
                         TransferState.PENDING_NETWORK_DISCONNECT.toString(),
                         TransferState.WAITING_FOR_NETWORK.toString()
-                        });
+                });
     }
 
     /**
@@ -318,7 +321,7 @@ public int setAllRunningRecordsToPausedBeforeShutdownService() {
                         TransferState.PENDING_PAUSE.toString(),
                         TransferState.RESUMED_WAITING.toString(),
                         TransferState.WAITING.toString()
-                    });
+                });
     }
 
     /**
@@ -403,7 +406,7 @@ public Cursor queryAllTransfersWithType(TransferType type) {
         } else {
             return transferDBBase.query(transferDBBase.getContentUri(), null,
                     TransferTable.COLUMN_TYPE + "=?", new String[] {
-                        type.toString()
+                            type.toString()
                     }, null);
         }
     }
@@ -423,7 +426,7 @@ public Cursor queryTransfersWithTypeAndState(TransferType type, TransferState st
         } else {
             return transferDBBase.query(getStateUri(state), null, TransferTable.COLUMN_TYPE + "=?",
                     new String[] {
-                        type.toString()
+                            type.toString()
                     }, null);
         }
     }
@@ -436,7 +439,7 @@ public Cursor queryTransfersWithTypeAndState(TransferType type, TransferState st
      * @return A Cursor pointing to records in the database in any of the given states.
      */
     public Cursor queryTransfersWithTypeAndStates(TransferType type,
-                                                  TransferState[] states) {
+            TransferState[] states) {
         final String selection;
         final String[] selectionArgs;
         int index = 0;
@@ -487,7 +490,8 @@ public long queryBytesTransferredByMainUploadId(int mainUploadId) {
         try {
             c = transferDBBase.query(getPartUri(mainUploadId), null, null, null, null);
             while (c.moveToNext()) {
-                final String state = c.getString(c.getColumnIndexOrThrow(TransferTable.COLUMN_STATE));
+                final String state = c
+                        .getString(c.getColumnIndexOrThrow(TransferTable.COLUMN_STATE));
                 if (TransferState.PART_COMPLETED.equals(TransferState.getState(state))) {
                     bytesTotal += c.getLong(c
                             .getColumnIndexOrThrow(TransferTable.COLUMN_BYTES_TOTAL));
@@ -564,7 +568,8 @@ public List<UploadPartRequest> getNonCompletedPartRequestsFromDB(int mainUploadI
                         .withId(c.getInt(c.getColumnIndexOrThrow(TransferTable.COLUMN_ID)))
                         .withMainUploadId(
                                 c.getInt(c
-                                        .getColumnIndexOrThrow(TransferTable.COLUMN_MAIN_UPLOAD_ID)))
+                                        .getColumnIndexOrThrow(
+                                                TransferTable.COLUMN_MAIN_UPLOAD_ID)))
                         .withBucketName(
                                 c.getString(c
                                         .getColumnIndexOrThrow(TransferTable.COLUMN_BUCKET_NAME)))
@@ -573,11 +578,13 @@ public List<UploadPartRequest> getNonCompletedPartRequestsFromDB(int mainUploadI
                         .withFile(new File(
                                 c.getString(c.getColumnIndexOrThrow(TransferTable.COLUMN_FILE))))
                         .withFileOffset(
-                                c.getLong(c.getColumnIndexOrThrow(TransferTable.COLUMN_FILE_OFFSET)))
+                                c.getLong(
+                                        c.getColumnIndexOrThrow(TransferTable.COLUMN_FILE_OFFSET)))
                         .withPartNumber(
                                 c.getInt(c.getColumnIndexOrThrow(TransferTable.COLUMN_PART_NUM)))
                         .withPartSize(
-                                c.getLong(c.getColumnIndexOrThrow(TransferTable.COLUMN_BYTES_TOTAL)))
+                                c.getLong(
+                                        c.getColumnIndexOrThrow(TransferTable.COLUMN_BYTES_TOTAL)))
                         .withLastPart(1 == c.getInt(c
                                 .getColumnIndexOrThrow(TransferTable.COLUMN_IS_LAST_PART)));
                 list.add(putPartRequest);
@@ -591,8 +598,8 @@ public List<UploadPartRequest> getNonCompletedPartRequestsFromDB(int mainUploadI
     }
 
     /**
-     * Queries waiting for network partUpload tasks of a multipart upload and returns
-     * true if one such partUpload tasks
+     * Queries waiting for network partUpload tasks of a multipart upload and
+     * returns true if one such partUpload tasks
      *
      * @param mainUploadId The mainUploadId of a multipart upload task
      * @return If a partUpload task waiting for network exist
@@ -602,7 +609,8 @@ public boolean checkWaitingForNetworkPartRequestsFromDB(int mainUploadId) {
         Cursor c = null;
 
         try {
-            c = transferDBBase.query(getPartUri(mainUploadId), null, TransferTable.COLUMN_STATE + "=?",
+            c = transferDBBase.query(getPartUri(mainUploadId), null,
+                    TransferTable.COLUMN_STATE + "=?",
                     new String[] {
                             TransferState.WAITING_FOR_NETWORK.toString()
                     }, null);
@@ -703,11 +711,15 @@ private ContentValues generateContentValuesForObjectMetadata(ObjectMetadata meta
                 metadata.getContentDisposition());
         values.put(TransferTable.COLUMN_SSE_ALGORITHM, metadata.getSSEAlgorithm());
         values.put(TransferTable.COLUMN_SSE_KMS_KEY, metadata.getSSEAwsKmsKeyId());
-        values.put(TransferTable.COLUMN_EXPIRATION_TIME_RULE_ID, metadata.getExpirationTimeRuleId());
+        values.put(TransferTable.COLUMN_EXPIRATION_TIME_RULE_ID,
+                metadata.getExpirationTimeRuleId());
         if (metadata.getHttpExpiresDate() != null) {
             values.put(TransferTable.COLUMN_HTTP_EXPIRES_DATE,
                     String.valueOf(metadata.getHttpExpiresDate().getTime()));
         }
+        if (metadata.getStorageClass() != null) {
+            values.put(TransferTable.COLUMN_HEADER_STORAGE_CLASS, metadata.getStorageClass());
+        }
 
         return values;
     }
@@ -816,4 +828,3 @@ static TransferDBBase getTransferDBBase() {
         return transferDBBase;
     }
 }
-

aws-android-sdk-s3/src/main/java/com/amazonaws/mobileconnectors/s3/transferutility/TransferDatabaseHelper.java

@@ -22,7 +22,7 @@
 class TransferDatabaseHelper extends SQLiteOpenHelper {
 
     private static final String DATABASE_NAME = "awss3transfertable.db";
-    private static final int DATABASE_VERSION = 4;
+    private static final int DATABASE_VERSION = 5;
 
     private int version;
 

aws-android-sdk-s3/src/main/java/com/amazonaws/mobileconnectors/s3/transferutility/TransferRecord.java

@@ -68,6 +68,7 @@ class TransferRecord {
     public String headerContentEncoding;
     public String headerCacheControl;
     public String headerExpire;
+    public String headerStorageClass;
 
     /**
      * The following were added in 2.2.6 to support object metdata
@@ -147,6 +148,8 @@ public void updateFromDB(Cursor c) {
         this.sseKMSKey = c.getString(c.getColumnIndexOrThrow(TransferTable.COLUMN_SSE_KMS_KEY));
         this.md5 = c.getString(c.getColumnIndexOrThrow(TransferTable.COLUMN_CONTENT_MD5));
         this.cannedAcl = c.getString(c.getColumnIndexOrThrow(TransferTable.COLUMN_CANNED_ACL));
+        this.headerStorageClass = c
+                .getString(c.getColumnIndexOrThrow(TransferTable.COLUMN_HEADER_STORAGE_CLASS));
     }
 
     /**
@@ -287,7 +290,8 @@ public String toString() {
                 .append("isLastPart:").append(isLastPart).append(",")
                 .append("partNumber:").append(partNumber).append(",")
                 .append("multipartId:").append(multipartId).append(",")
-                .append("eTag:").append(eTag)
+                .append("eTag:").append(eTag).append(",")
+                .append("storageClass:").append(headerStorageClass)
                 .append("]");
         return sb.toString();
     }

aws-android-sdk-s3/src/main/java/com/amazonaws/mobileconnectors/s3/transferutility/TransferTable.java

@@ -153,6 +153,11 @@ class TransferTable {
      */
     public static final String COLUMN_HEADER_CACHE_CONTROL = "header_cache_control";
 
+    /**
+     * User specified storage class
+     */
+    public static final String COLUMN_HEADER_STORAGE_CLASS = "header_storage_class";
+
     /**
      * ============ Below added in 2.2.6 for support for metadata ============
      */
@@ -244,6 +249,7 @@ public static void onCreate(SQLiteDatabase database, int version) {
     private static final int TABLE_VERSION_2 = 2;
     private static final int TABLE_VERSION_3 = 3;
     private static final int TABLE_VERSION_4 = 4;
+    private static final int TABLE_VERSION_5 = 5;
 
     /**
      * Upgrades the database.
@@ -264,6 +270,9 @@ public static void onUpgrade(SQLiteDatabase database, int oldVersion,
         if (oldVersion < TABLE_VERSION_4 && newVersion >= TABLE_VERSION_4) {
             addVersion4Columns(database);
         }
+        if (oldVersion < TABLE_VERSION_5 && newVersion >= TABLE_VERSION_5) {
+            addVersion5Columns(database);
+        }
     }
 
     /**
@@ -297,11 +306,20 @@ private static void addVersion3Columns(SQLiteDatabase database) {
     }
 
     /**
-     * Adds columns that were introduced in version 3 to the database
+     * Adds columns that were introduced in version 4 to the database
      */
     private static void addVersion4Columns(SQLiteDatabase database) {
         final String addCannedAcl = "ALTER TABLE " + TABLE_TRANSFER +
                 " ADD COLUMN " + COLUMN_CANNED_ACL + " text;";
         database.execSQL(addCannedAcl);
     }
+
+    /**
+     * Adds columns that were introduced in version 5 to the database
+     */
+    private static void addVersion5Columns(SQLiteDatabase database) {
+        final String addCannedAcl = "ALTER TABLE " + TABLE_TRANSFER +
+                " ADD COLUMN " + COLUMN_HEADER_STORAGE_CLASS + " text;";
+        database.execSQL(addCannedAcl);
+    }
 }

aws-android-sdk-s3/src/main/java/com/amazonaws/mobileconnectors/s3/transferutility/UploadTask.java

@@ -15,7 +15,6 @@
 
 package com.amazonaws.mobileconnectors.s3.transferutility;
 
-
 import com.amazonaws.AmazonClientException;
 import com.amazonaws.mobileconnectors.s3.transferutility.TransferService.NetworkInfoReceiver;
 import com.amazonaws.retry.RetryUtils;
@@ -122,14 +121,16 @@ private Boolean uploadMultipartAndWaitForCompletion() throws ExecutionException
         }
         updater.updateProgress(upload.id, bytesAlreadyTransferrd, upload.bytesTotal);
 
-        final List<UploadPartRequest> requestList = dbUtil.getNonCompletedPartRequestsFromDB(upload.id,
+        final List<UploadPartRequest> requestList = dbUtil.getNonCompletedPartRequestsFromDB(
+                upload.id,
                 upload.multipartId);
         LOGGER.debug("multipart upload " + upload.id + " in " + requestList.size() + " parts.");
         final ArrayList<Future<Boolean>> futures = new ArrayList<Future<Boolean>>();
         for (final UploadPartRequest request : requestList) {
             TransferUtility.appendMultipartTransferServiceUserAgentString(request);
             request.setGeneralProgressListener(updater.newProgressListener(upload.id));
-            futures.add(TransferThreadPool.submitTask(new UploadPartTask(request, s3, dbUtil, networkInfo)));
+            futures.add(TransferThreadPool
+                    .submitTask(new UploadPartTask(request, s3, dbUtil, networkInfo)));
         }
         try {
             boolean isSuccess = true;
@@ -161,10 +162,12 @@ private Boolean uploadMultipartAndWaitForCompletion() throws ExecutionException
             // handle pause, cancel, etc
             boolean isNetworkInterrupted = false;
             if (ee.getCause() != null && ee.getCause() instanceof Exception) {
-                // check for network interruption and pause the transfer instead of failing them
+                // check for network interruption and pause the transfer instead
+                // of failing them
                 isNetworkInterrupted = dbUtil.checkWaitingForNetworkPartRequestsFromDB(upload.id);
                 if (isNetworkInterrupted) {
-                    LOGGER.debug("Network Connection Interrupted: Transfer " + upload.id + " waits for network");
+                    LOGGER.debug("Network Connection Interrupted: Transfer " + upload.id
+                            + " waits for network");
                     updater.updateState(upload.id, TransferState.WAITING_FOR_NETWORK);
                     return false;
                 }
@@ -225,8 +228,10 @@ private Boolean uploadSinglePartAndWaitForCompletion() {
                 return false;
             } else if (e.getCause() != null && e.getCause() instanceof AmazonClientException
                     && !networkInfo.isNetworkConnected()) {
-                // check for network interruption and pause the transfer instead of failing them
-                LOGGER.debug("Network Connection Interrupted: Transfer " + upload.id + " waits for network");
+                // check for network interruption and pause the transfer instead
+                // of failing them
+                LOGGER.debug("Network Connection Interrupted: Transfer " + upload.id
+                        + " waits for network");
                 updater.updateState(upload.id, TransferState.WAITING_FOR_NETWORK);
                 return false;
             } else if (e.getCause() != null && e.getCause() instanceof IOException
@@ -245,7 +250,8 @@ private Boolean uploadSinglePartAndWaitForCompletion() {
     private void completeMultiPartUpload(int mainUploadId, String bucket,
             String key, String multipartId) {
         final List<PartETag> partETags = dbUtil.queryPartETagsOfUpload(mainUploadId);
-        final CompleteMultipartUploadRequest completeRequest = new CompleteMultipartUploadRequest(bucket,
+        final CompleteMultipartUploadRequest completeRequest = new CompleteMultipartUploadRequest(
+                bucket,
                 key, multipartId, partETags);
         TransferUtility.appendMultipartTransferServiceUserAgentString(completeRequest);
         s3.completeMultipartUpload(completeRequest);
@@ -261,13 +267,14 @@ private String initiateMultipartUpload(PutObjectRequest putObjectRequest) {
         InitiateMultipartUploadRequest initiateMultipartUploadRequest = null;
         initiateMultipartUploadRequest = new InitiateMultipartUploadRequest(
                 putObjectRequest.getBucketName(), putObjectRequest.getKey())
-                .withCannedACL(putObjectRequest.getCannedAcl())
-                .withObjectMetadata(putObjectRequest.getMetadata())
-                .withSSEAwsKeyManagementParams(
+                        .withCannedACL(putObjectRequest.getCannedAcl())
+                        .withObjectMetadata(putObjectRequest.getMetadata())
+                        .withSSEAwsKeyManagementParams(
                                 putObjectRequest.getSSEAwsKeyManagementParams());
         TransferUtility
                 .appendMultipartTransferServiceUserAgentString(initiateMultipartUploadRequest);
-        final String uploadId = s3.initiateMultipartUpload(initiateMultipartUploadRequest).getUploadId();
+        final String uploadId = s3.initiateMultipartUpload(initiateMultipartUploadRequest)
+                .getUploadId();
         return uploadId;
     }
 
@@ -301,6 +308,9 @@ private PutObjectRequest createPutObjectRequest(TransferRecord upload) {
         } else {
             om.setContentType(Mimetypes.getInstance().getMimetype(file));
         }
+        if (upload.headerStorageClass != null) {
+            putObjectRequest.setStorageClass(upload.headerStorageClass);
+        }
         if (upload.expirationTimeRuleId != null) {
             om.setExpirationTimeRuleId(upload.expirationTimeRuleId);
         }
@@ -320,7 +330,6 @@ private PutObjectRequest createPutObjectRequest(TransferRecord upload) {
             putObjectRequest
                     .setSSEAwsKeyManagementParams(new SSEAwsKeyManagementParams(upload.sseKMSKey));
         }
-
         putObjectRequest.setMetadata(om);
         putObjectRequest.setCannedAcl(getCannedAclFromString(upload.cannedAcl));