Merge pull request #82 from RachelTucker/master

Added delete folder

Author: rpmoore

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

@@ -99,6 +99,29 @@ public void deleteBucket() throws IOException, SignatureException {
                 is(HeadBucketResponse.Status.DOESNTEXIST));
     }
 
+    @Test
+    public void deleteFolder() throws IOException, SignatureException, URISyntaxException, XmlProcessingException {
+        final String bucketName = "test_delete_folder";
+        try {
+            client.putBucket(new PutBucketRequest(bucketName));
+            Util.loadBookTestDataWithPrefix(client, bucketName, "folder/");
+
+            HeadObjectResponse response = client.headObject(new HeadObjectRequest(
+                    bucketName, "folder/beowulf.txt"));
+            assertThat(response.getStatus(),
+                    is(HeadObjectResponse.Status.EXISTS));
+
+            client.deleteFolder(new DeleteFolderRequest(bucketName, "folder"));
+
+            response = client.headObject(new HeadObjectRequest(
+                    bucketName, "folder/beowulf.txt"));
+            assertThat(response.getStatus(),
+                    is(HeadObjectResponse.Status.DOESNTEXIST));
+        } finally {
+            Util.deleteAllContents(client, bucketName);
+        }
+    }
+
     @Test
     public void emptyBucket() throws IOException, SignatureException {
         final String bucketName = "test_empty_bucket";

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

@@ -100,6 +100,20 @@ HeadBucketResponse headBucket(HeadBucketRequest request)
     DeleteBucketResponse deleteBucket(
             DeleteBucketRequest request) throws IOException, SignatureException;
 
+    /**
+     * Recursively deletes the specified folder from a DS3 endpoint.
+     * @param request The Delete Folder Request object used to customize the HTTP request.  The put bucket request object
+     *                has some options for customizing the request.  See {@link DeleteFolderRequest} for the full list of
+     *                options that can be configured.
+     * @return The response object is returned primarily to be consistent with the rest of the API.  Additional data
+     *         may be returned here in the future but nothing is currently.  See {@link DeleteFolderResponse} for the most
+     *         up to date information on what is returned.
+     * @throws IOException
+     * @throws SignatureException
+     */
+    DeleteFolderResponse deleteFolder(
+            DeleteFolderRequest request) throws IOException, SignatureException;
+
     /**
      * Deletes an object in a bucket from a DS3 endpoint
      * @param request The Put Bucket Request object used to customize the HTTP request.  The put bucket request object

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

@@ -66,6 +66,11 @@ public DeleteBucketResponse deleteBucket(final DeleteBucketRequest request) thro
         return new DeleteBucketResponse(this.netClient.getResponse(request));
     }
 
+    @Override
+    public DeleteFolderResponse deleteFolder(final DeleteFolderRequest request) throws IOException, SignatureException {
+        return new DeleteFolderResponse(this.netClient.getResponse(request));
+    }
+
     @Override
     public DeleteObjectResponse deleteObject(final DeleteObjectRequest request) throws IOException, SignatureException {
         return new DeleteObjectResponse(this.netClient.getResponse(request));

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

@@ -0,0 +1,41 @@
+/*
+ * ******************************************************************************
+ *   Copyright 2014-2015 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;
+
+import com.spectralogic.ds3client.HttpVerb;
+
+public class DeleteFolderRequest extends AbstractRequest {
+
+    private final String folderName;
+    private final String bucketName;
+
+    public DeleteFolderRequest(final String bucketName, final String folderName) {
+        this.bucketName = bucketName;
+        this.folderName = folderName;
+        getQueryParams().put("bucketId", this.bucketName);
+        getQueryParams().put("recursive", null);
+    }
+
+    public String getBucket() { return this.bucketName; }
+
+    public String getFolder() { return this.folderName; }
+
+    @Override
+    public String getPath() { return "/_rest_/folder/" + this.folderName; }
+
+    @Override
+    public HttpVerb getVerb() { return HttpVerb.DELETE; }
+}

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

@@ -0,0 +1,35 @@
+/*
+ * ******************************************************************************
+ *   Copyright 2014-2015 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;
+
+import com.spectralogic.ds3client.networking.WebResponse;
+import java.io.IOException;
+
+public class DeleteFolderResponse extends AbstractResponse {
+
+    public DeleteFolderResponse(final WebResponse response) throws IOException {
+        super(response);
+    }
+
+    @Override
+    protected void processResponse() throws IOException {
+        try {
+            this.checkStatusCode(204);
+        } finally {
+            this.getResponse().close();
+        }
+    }
+}

ds3-sdk/src/test/java/com/spectralogic/ds3client/Ds3Client_Test.java

@@ -186,6 +186,19 @@ public void deleteBucket() throws IOException, SignatureException {
             .deleteBucket(new DeleteBucketRequest("bucketName"));
     }
 
+    @Test
+    public void deleteFolder() throws IOException, SignatureException {
+        final Map<String, String> queryParams = new HashMap<>();
+        queryParams.put("bucketId", "bucketName");
+        queryParams.put("recursive", null);
+
+        MockNetwork
+                .expecting(HttpVerb.DELETE, "/_rest_/folder/folderName", queryParams, null)
+                .returning(204, "")
+                .asClient()
+                .deleteFolder(new DeleteFolderRequest("bucketName","folderName"));
+    }
+
     @Test
     public void deleteObject() throws IOException, SignatureException {
         MockNetwork