Created PutFolder command which wraps PutObject

Author: RachelTucker

ds3-sdk-integration/src/test/java/com/spectralogic/ds3client/helpers/FileSystemHelper_Test.java

@@ -15,10 +15,11 @@
 
 package com.spectralogic.ds3client.helpers;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
+import com.google.common.collect.ImmutableList;
 import com.spectralogic.ds3client.Ds3Client;
+import com.spectralogic.ds3client.commands.decorators.PutFolderRequest;
+import com.spectralogic.ds3client.commands.spectrads3.PutBulkJobSpectraS3Request;
+import com.spectralogic.ds3client.commands.spectrads3.PutBulkJobSpectraS3Response;
 import com.spectralogic.ds3client.helpers.events.SameThreadEventRunner;
 import com.spectralogic.ds3client.integration.Util;
 import com.spectralogic.ds3client.integration.test.helpers.TempStorageIds;
@@ -31,6 +32,8 @@
 import org.junit.Before;
 import org.junit.BeforeClass;
 import org.junit.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.io.BufferedReader;
 import java.io.IOException;
@@ -39,17 +42,15 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.UUID;
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.concurrent.atomic.AtomicLong;
 
 import static com.spectralogic.ds3client.integration.Util.deleteAllContents;
-
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertTrue;
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertNull;
-import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.*;
 
 public class FileSystemHelper_Test {
     private static final Logger LOG = LoggerFactory.getLogger(FileSystemHelper_Test.class);
@@ -313,4 +314,32 @@ public long getAvailableFileSpace(final Path path) throws IOException {
             throw new IOException("IOExceptionAtor");
         }
     }
+
+    @Test
+    public void createFolderWithSlash() throws IOException {
+        final String folderName = "FolderNameWithSlash/";
+
+        try {
+            final Ds3Object ds3Object = new Ds3Object(folderName, 0);
+            final PutBulkJobSpectraS3Response jobResponse = client.putBulkJobSpectraS3(new PutBulkJobSpectraS3Request(BUCKET_NAME, ImmutableList.of(ds3Object)));
+
+            client.putFolder(new PutFolderRequest(BUCKET_NAME, folderName, jobResponse.getMasterObjectList().getJobId()));
+        } finally {
+            deleteAllContents(client, BUCKET_NAME);
+        }
+    }
+
+    @Test
+    public void createFolderWithNoSlash() throws IOException {
+        final String folderName = "FolderNameNoSlash";
+
+        try {
+            final Ds3Object ds3Object = new Ds3Object(folderName + "/", 0);
+            final PutBulkJobSpectraS3Response jobResponse = client.putBulkJobSpectraS3(new PutBulkJobSpectraS3Request(BUCKET_NAME, ImmutableList.of(ds3Object)));
+
+            client.putFolder(new PutFolderRequest(BUCKET_NAME, folderName, jobResponse.getMasterObjectList().getJobId()));
+        } finally {
+            deleteAllContents(client, BUCKET_NAME);
+        }
+    }
 }

ds3-sdk/src/main/java/com/spectralogic/ds3client/Ds3Client.java

@@ -20,6 +20,8 @@
 import com.spectralogic.ds3client.annotations.Resource;
 import com.spectralogic.ds3client.annotations.ResponsePayloadModel;
 import com.spectralogic.ds3client.commands.*;
+import com.spectralogic.ds3client.commands.decorators.PutFolderRequest;
+import com.spectralogic.ds3client.commands.decorators.PutFolderResponse;
 import com.spectralogic.ds3client.commands.spectrads3.*;
 import com.spectralogic.ds3client.commands.spectrads3.notifications.*;
 import com.spectralogic.ds3client.models.JobNode;
@@ -35,6 +37,8 @@ public interface Ds3Client extends Closeable {
 
     ConnectionDetails getConnectionDetails();
 
+    PutFolderResponse putFolder(final PutFolderRequest request)
+            throws IOException;
 
 
     AbortMultiPartUploadResponse abortMultiPartUpload(final AbortMultiPartUploadRequest request)

ds3-sdk/src/main/java/com/spectralogic/ds3client/Ds3ClientImpl.java

@@ -18,6 +18,8 @@
 
 import java.io.IOException;
 import com.spectralogic.ds3client.commands.*;
+import com.spectralogic.ds3client.commands.decorators.PutFolderRequest;
+import com.spectralogic.ds3client.commands.decorators.PutFolderResponse;
 import com.spectralogic.ds3client.commands.parsers.*;
 import com.spectralogic.ds3client.commands.spectrads3.*;
 import com.spectralogic.ds3client.commands.spectrads3.notifications.*;
@@ -45,6 +47,12 @@ public ConnectionDetails getConnectionDetails() {
         return this.netClient.getConnectionDetails();
     }
 
+    @Override
+    public PutFolderResponse putFolder(final PutFolderRequest request) throws IOException {
+        final PutObjectResponse response = putObject(request.getPutObjectRequest());
+        return new PutFolderResponse(response);
+    }
+
     @Override
     public AbortMultiPartUploadResponse abortMultiPartUpload(final AbortMultiPartUploadRequest request) throws IOException {
         return new AbortMultiPartUploadResponseParser().response(this.netClient.getResponse(request));

ds3-sdk/src/main/java/com/spectralogic/ds3client/commands/decorators/PutFolderRequest.java

@@ -0,0 +1,48 @@
+/*
+ * ******************************************************************************
+ *   Copyright 2014-2017 Spectra Logic Corporation. All Rights Reserved.
+ *   Licensed under the Apache License, Version 2.0 (the "License"). You may not use
+ *   this file except in compliance with the License. A copy of the License is located at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   or in the "license" file accompanying this file.
+ *   This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ *   CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ *   specific language governing permissions and limitations under the License.
+ * ****************************************************************************
+ */
+
+package com.spectralogic.ds3client.commands.decorators;
+
+import com.spectralogic.ds3client.commands.PutObjectRequest;
+
+import java.util.UUID;
+
+/**
+ * Decorates the {@link com.spectralogic.ds3client.commands.PutObjectRequest} and is used to
+ * ensure the correct creation of a folder using the Put Object command.
+ *
+ * A folder is created by putting an object with no content, of zero size, and with the
+ * content-length=0.  Also, the name of the folder must end with a slash '/'
+ */
+public class PutFolderRequest {
+
+    private final PutObjectRequest putObjectRequest;
+
+    public PutFolderRequest(final String bucketName, final String folderName, final UUID job) {
+        putObjectRequest = new PutObjectRequest(bucketName, ensureEndsWithSlash(folderName), job, 0, 0, null);
+        putObjectRequest.getHeaders().put("Content-Length", "0");
+    }
+
+    private static String ensureEndsWithSlash(final String bucketName) {
+        if (bucketName.endsWith("/")) {
+            return bucketName;
+        }
+        return bucketName + "/";
+    }
+
+    public PutObjectRequest getPutObjectRequest() {
+        return putObjectRequest;
+    }
+}

ds3-sdk/src/main/java/com/spectralogic/ds3client/commands/decorators/PutFolderResponse.java

@@ -0,0 +1,29 @@
+/*
+ * ******************************************************************************
+ *   Copyright 2014-2017 Spectra Logic Corporation. All Rights Reserved.
+ *   Licensed under the Apache License, Version 2.0 (the "License"). You may not use
+ *   this file except in compliance with the License. A copy of the License is located at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   or in the "license" file accompanying this file.
+ *   This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ *   CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ *   specific language governing permissions and limitations under the License.
+ * ****************************************************************************
+ */
+
+package com.spectralogic.ds3client.commands.decorators;
+
+import com.spectralogic.ds3client.commands.PutObjectResponse;
+
+/**
+ * Decorates the {@link com.spectralogic.ds3client.commands.PutObjectResponse} and is used
+ * by command {@link com.spectralogic.ds3client.Ds3Client#putFolder(PutFolderRequest)}
+ */
+public class PutFolderResponse extends PutObjectResponse {
+
+    public PutFolderResponse(final PutObjectResponse response) {
+        super(response.getChecksum(), response.getChecksumType());
+    }
+}