Merge pull request #66 from rpmoore/master

MultiObject Delete Support w/Minor Documentation Addition

Author: hansdude

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

@@ -76,8 +76,7 @@ public void singleFilePut() throws IOException, URISyntaxException, XmlProcessin
 
             final String secondDigest = DigestUtils.sha256Hex(Files.newInputStream(tempDir.resolve(book)));
             assertThat(secondDigest, is(equalTo(digest)));
-        }
-        finally {
+        } finally {
             Util.deleteAllContents(client, bucketName);
         }
     }
@@ -89,7 +88,7 @@ public void randomDataFile() throws IOException, SignatureException, URISyntaxEx
         final long seed = 12345689;
         final int length = 2048;
 
-       sendAndVerifySingleFile(bucketName, randomFileName, seed, length);
+        sendAndVerifySingleFile(bucketName, randomFileName, seed, length);
     }
 
     @Test
@@ -173,8 +172,7 @@ public SeekableByteChannel buildChannel(final String key) throws IOException {
 
             final String secondDigest = DigestUtils.sha256Hex(Files.newInputStream(tempDir.resolve(fileName)));
             assertThat(secondDigest, is(equalTo(digest)));
-        }
-        finally {
+        } finally {
             Util.deleteAllContents(client, bucketName);
         }
     }

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

@@ -129,8 +129,7 @@ public void objectPersistedRegistration() throws IOException, SignatureException
             assertThat(getResponse.getRegistration().getId(), is(notNullValue()));
 
             assertThat(client.deleteObjectPersistedNotification(new DeleteObjectPersistedNotificationRequest(registrationId)), is(notNullValue()));
-        }
-        finally {
+        } finally {
             Util.deleteAllContents(client, bucketName);
         }
     }

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

@@ -110,8 +110,11 @@ public abstract DeleteBucketResponse deleteBucket(
      * @throws IOException
      * @throws SignatureException
      */
-    public abstract DeleteObjectResponse deleteObject(
-            DeleteObjectRequest request) throws IOException, SignatureException;
+    public abstract DeleteObjectResponse deleteObject(DeleteObjectRequest request)
+            throws IOException, SignatureException;
+
+    public abstract DeleteMultipleObjectsResponse deleteMultipleObjects(DeleteMultipleObjectsRequest request)
+            throws IOException, SignatureException;
 
     /**
      * Retrieves an object from DS3

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

@@ -71,6 +71,11 @@ public DeleteObjectResponse deleteObject(final DeleteObjectRequest request) thro
         return new DeleteObjectResponse(this.netClient.getResponse(request));
     }
 
+    @Override
+    public DeleteMultipleObjectsResponse deleteMultipleObjects(final DeleteMultipleObjectsRequest request) throws IOException, SignatureException {
+        return new DeleteMultipleObjectsResponse(this.netClient.getResponse(request));
+    }
+
     @Override
     public GetObjectResponse getObject(final GetObjectRequest request) throws IOException, SignatureException {
         return new GetObjectResponse(

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

@@ -197,11 +197,24 @@ private void addHeaders(final HttpRequest httpRequest) throws IOException, Signa
                 this.ds3Request.getContentType().toString(),
                 date,
                 canonicalizeAmzHeaders(this.ds3Request.getHeaders()),
-                UrlEscapers.urlFragmentEscaper().escape(this.ds3Request.getPath()),
+                canonicalizeResource(this.ds3Request.getPath(), this.ds3Request.getQueryParams()),
                 NetworkClientImpl.this.connectionDetails.getCredentials()
             )));
         }
-        
+
+
+        private String canonicalizeResource(final String path, final Map<String, String> queryParams) {
+
+            final StringBuilder canonicalizedResource = new StringBuilder();
+            canonicalizedResource.append(UrlEscapers.urlFragmentEscaper().escape(path));
+
+            if (queryParams.containsKey("delete")) {
+                canonicalizedResource.append("?delete");
+            }
+
+            return canonicalizedResource.toString();
+        }
+
 		private String canonicalizeAmzHeaders(
 				final Multimap<String, String> customHeaders) {
 			StringBuilder ret = new StringBuilder();

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

@@ -0,0 +1,99 @@
+/*
+ * ******************************************************************************
+ *   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;
+import com.spectralogic.ds3client.models.Contents;
+import com.spectralogic.ds3client.models.delete.Delete;
+import com.spectralogic.ds3client.models.delete.DeleteObject;
+import com.spectralogic.ds3client.serializer.XmlOutput;
+
+import java.io.ByteArrayInputStream;
+import java.io.InputStream;
+import java.util.ArrayList;
+import java.util.List;
+
+public class DeleteMultipleObjectsRequest extends AbstractRequest {
+
+    private final String bucketName;
+    private final List<String> objects;
+
+    private boolean quiet = false;
+
+    private long size;
+
+    public DeleteMultipleObjectsRequest(final String bucketName, final List<String> objects) {
+        this.bucketName = bucketName;
+        this.objects = objects;
+        this.getQueryParams().put("delete", null);
+    }
+
+    public DeleteMultipleObjectsRequest(final String bucketName, final Iterable<Contents> objs) {
+        this(bucketName, contentsToString(objs));
+    }
+
+    static private List<String> contentsToString(final Iterable<Contents> objs) {
+        final List<String> objKeyList = new ArrayList<>();
+        for (final Contents obj : objs) {
+            objKeyList.add(obj.getKey());
+        }
+        return objKeyList;
+    }
+
+    public DeleteMultipleObjectsRequest withQuiet(final boolean quiet) {
+        this.quiet = quiet;
+        return this;
+    }
+
+    @Override
+    public InputStream getStream() {
+
+        final Delete delete = new Delete();
+        delete.setQuiet(quiet);
+        final List<DeleteObject> deleteObjects = new ArrayList<>();
+
+        for(final String objName : objects) {
+            deleteObjects.add(new DeleteObject(objName));
+        }
+
+        delete.setDeleteObjectList(deleteObjects);
+
+        final String xmlOutput = XmlOutput.toXml(delete);
+        final byte[] stringBytes = xmlOutput.getBytes();
+        this.size = stringBytes.length;
+
+        return new ByteArrayInputStream(stringBytes);
+    }
+
+    @Override
+    public long getSize() {
+        return this.size;
+    }
+
+    @Override
+    public String getPath() {
+        return "/" + bucketName;
+    }
+
+    @Override
+    public HttpVerb getVerb() {
+        return HttpVerb.POST;
+    }
+
+    public List<String> getObjects() {
+        return objects;
+    }
+}

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

@@ -0,0 +1,52 @@
+/*
+ * ******************************************************************************
+ *   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.models.delete.DeleteResult;
+import com.spectralogic.ds3client.networking.WebResponse;
+import com.spectralogic.ds3client.serializer.XmlOutput;
+import org.apache.commons.io.IOUtils;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.StringWriter;
+
+public class DeleteMultipleObjectsResponse extends AbstractResponse {
+
+    private DeleteResult result;
+
+    public DeleteMultipleObjectsResponse(final WebResponse response) throws IOException {
+        super(response);
+    }
+
+    public DeleteResult getResult() {
+        return result;
+    }
+
+    @Override
+    protected void processResponse() throws IOException {
+        try {
+            this.checkStatusCode(200);
+            try (final InputStream content = getResponse().getResponseStream();
+                 final StringWriter writer = new StringWriter()) {
+                IOUtils.copy(content, writer, UTF8);
+                this.result = XmlOutput.fromXml(writer.toString(), DeleteResult.class);
+            }
+        } finally {
+            this.getResponse().close();
+        }
+    }
+}

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

@@ -59,7 +59,7 @@ public interface Job {
         public Job withMaxParallelRequests(int maxParallelRequests);
 
         /**
-         * Transfers the files in this job using the given seekable channel creator.
+         * Transfers the files in this job using the given seekable channel creator.  The is a blocking call.
          * @throws SignatureException
          * @throws IOException
          * @throws XmlProcessingException

ds3-sdk/src/main/java/com/spectralogic/ds3client/helpers/Ds3ClientHelpers.java

@@ -0,0 +1,48 @@
+/*
+ * ******************************************************************************
+ *   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.models.delete;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.util.List;
+
+public class Delete {
+
+    @JsonProperty("Quiet")
+    private boolean quiet;
+
+    @JsonProperty("Object")
+    private List<DeleteObject> deleteObjectList;
+
+    public Delete() {
+    }
+
+    public boolean isQuiet() {
+        return quiet;
+    }
+
+    public void setQuiet(final boolean quiet) {
+        this.quiet = quiet;
+    }
+
+    public List<DeleteObject> getDeleteObjectList() {
+        return deleteObjectList;
+    }
+
+    public void setDeleteObjectList(final List<DeleteObject> deleteObjectList) {
+        this.deleteObjectList = deleteObjectList;
+    }
+}