Added job recovery helpers and fixed /buckets

Author: Hans-Peter Klett

src/main/java/com/spectralogic/ds3client/commands/BulkRequest.java

@@ -65,7 +65,7 @@ public long getSize() {
 
     @Override
     public String getPath() {
-        return "/_rest_/buckets/" + this.bucket;
+        return "/_rest_/bucket/" + this.bucket;
     }
 
     @Override

src/main/java/com/spectralogic/ds3client/helpers/Ds3ClientHelpers.java

@@ -150,6 +150,26 @@ public abstract Ds3ClientHelpers.ReadJob startReadJob(final String bucket, final
     public abstract Ds3ClientHelpers.ReadJob startReadAllJob(final String bucket)
             throws SignatureException, IOException, XmlProcessingException;
 
+    /**
+     * Queries job information based on job id and returns a {@link ReadJob} that can resume the job.
+     * @throws SignatureException
+     * @throws IOException
+     * @throws XmlProcessingException
+     * @throws JobRecoveryException
+     */
+    public abstract Ds3ClientHelpers.WriteJob recoverWriteJob(final UUID jobId)
+            throws SignatureException, IOException, XmlProcessingException, JobRecoveryException;
+
+    /**
+     * Queries job information based on job id and returns a {@link WriteJob} that can resume the job.
+     * @throws SignatureException
+     * @throws IOException
+     * @throws XmlProcessingException
+     * @throws JobRecoveryException
+     */
+    public abstract Ds3ClientHelpers.ReadJob recoverReadJob(final UUID jobId)
+            throws SignatureException, IOException, XmlProcessingException, JobRecoveryException;
+
     /**
      * Ensures that a bucket exists.  The the bucket does not exist, it will be created.
      * @param bucket The name of the bucket to check that it exists.

src/main/java/com/spectralogic/ds3client/helpers/Ds3ClientHelpersImpl.java

@@ -15,15 +15,6 @@
 
 package com.spectralogic.ds3client.helpers;
 
-import com.google.common.collect.Lists;
-import com.spectralogic.ds3client.Ds3Client;
-import com.spectralogic.ds3client.commands.*;
-import com.spectralogic.ds3client.models.Contents;
-import com.spectralogic.ds3client.models.Ds3Object;
-import com.spectralogic.ds3client.models.ListBucketResult;
-import com.spectralogic.ds3client.models.MasterObjectList;
-import com.spectralogic.ds3client.serializer.XmlProcessingException;
-
 import java.io.IOException;
 import java.nio.file.FileVisitResult;
 import java.nio.file.Files;
@@ -33,10 +24,19 @@
 import java.security.SignatureException;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.UUID;
+
+import com.google.common.collect.Lists;
+import com.spectralogic.ds3client.Ds3Client;
+import com.spectralogic.ds3client.commands.*;
+import com.spectralogic.ds3client.models.*;
+import com.spectralogic.ds3client.serializer.XmlProcessingException;
 
 class Ds3ClientHelpersImpl extends Ds3ClientHelpers {
 
     private static final int DEFAULT_MAX_KEYS = 1000;
+    private static final String JOB_TYPE_PUT = "PUT";
+    private static final String JOB_TYPE_GET = "GET";
     private final Ds3Client client;
 
     Ds3ClientHelpersImpl(final Ds3Client client) {
@@ -74,11 +74,59 @@ public Ds3ClientHelpers.ReadJob startReadAllJob(final String bucket)
         return this.startReadJob(bucket, ds3Objects);
     }
 
+    @Override
+    public WriteJob recoverWriteJob(final UUID jobId) throws SignatureException, IOException, XmlProcessingException, JobRecoveryException {
+        try (final GetJobResponse job = this.client.getJob(new GetJobRequest(jobId))) {
+            final JobInfo jobInfo = job.getJobInfo();
+            checkJobType(JOB_TYPE_PUT, jobInfo.getRequestType());
+            return new WriteJobImpl(this.client, jobInfo.getJobId(), jobInfo.getBucketName(), job.getObjectsList());
+        }
+    }
+
+    @Override
+    public ReadJob recoverReadJob(final UUID jobId) throws SignatureException, IOException, XmlProcessingException, JobRecoveryException {
+        try (final GetJobResponse job = this.client.getJob(new GetJobRequest(jobId))) {
+            final JobInfo jobInfo = job.getJobInfo();
+            checkJobType(JOB_TYPE_GET, jobInfo.getRequestType());
+            return new ReadJobImpl(this.client, jobInfo.getJobId(), jobInfo.getBucketName(), convertFromJobObjectsList(job.getObjectsList()));
+        }
+    }
+
+    private static List<Objects> convertFromJobObjectsList(final List<JobObjects> jobObjectsList) {
+        final List<Objects> objectsList = new ArrayList<>(jobObjectsList.size());
+        for (final JobObjects jobObjects : jobObjectsList) {
+            objectsList.add(convertFromJobObjects(jobObjects));
+        }
+        return objectsList;
+    }
+
+    private static Objects convertFromJobObjects(final JobObjects jobObjects) {
+        final Objects objects = new Objects();
+        objects.setServerId(jobObjects.getServerId());
+        objects.setObject(concat(jobObjects.getObjectsInCache(), jobObjects.getObject()));
+        return objects;
+    }
+    
+    @SafeVarargs
+    private static <T> List<T> concat(final List<T>... lists) {
+        final List<T> result = new ArrayList<>();
+        for (final List<T> list : lists) {
+            result.addAll(list);
+        }
+        return result;
+    }
+
+    private static void checkJobType(final String expectedJobType, final String actualJobType) throws JobRecoveryException {
+        if (!actualJobType.equals(expectedJobType)) {
+            throw new JobRecoveryException(expectedJobType, actualJobType);
+        }
+    }
+
     @Override
     public void ensureBucketExists(final String bucket) throws IOException, SignatureException {
-        try (final HeadBucketResponse response = client.headBucket(new HeadBucketRequest(bucket))) {
+        try (final HeadBucketResponse response = this.client.headBucket(new HeadBucketRequest(bucket))) {
             if (response.getStatus() == HeadBucketResponse.Status.DOESNTEXIST) {
-                client.putBucket(new PutBucketRequest(bucket)).close();
+                this.client.putBucket(new PutBucketRequest(bucket)).close();
             }
         }
     }

src/main/java/com/spectralogic/ds3client/helpers/JobImpl.java

@@ -40,14 +40,14 @@ abstract class JobImpl implements Job {
     private final Ds3Client client;
     private final UUID jobId;
     private final String bucketName;
-    private final Iterable<Objects> objectLists;
+    private final Iterable<? extends Objects> objectLists;
 
     //TODO: client factory
     public JobImpl(
             final Ds3Client client,
             final UUID jobId,
             final String bucketName,
-            final Iterable<Objects> objectLists) {
+            final Iterable<? extends Objects> objectLists) {
         this.client = client;
         this.jobId = jobId;
         this.bucketName = bucketName;

src/main/java/com/spectralogic/ds3client/helpers/JobRecoveryException.java

@@ -0,0 +1,28 @@
+/*
+ * ******************************************************************************
+ *   Copyright 2014 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.helpers;
+
+public class JobRecoveryException extends Exception {
+    private static final long serialVersionUID = -4418169724222972364L;
+    
+    JobRecoveryException(final String expectedType, final String actualType) {
+        super(buildMessage(expectedType, actualType));
+    }
+
+    private static String buildMessage(final String expectedType, final String actualType) {
+        return String.format("Expected job type '%s' but the actual job was of type '%s'.", expectedType, actualType);
+    }
+}

src/main/java/com/spectralogic/ds3client/helpers/ReadJobImpl.java

@@ -36,7 +36,7 @@ public ReadJobImpl(
             final Ds3Client client,
             final UUID jobId,
             final String bucketName,
-            final Iterable<Objects> objectLists) {
+            final Iterable<? extends Objects> objectLists) {
         super(client, jobId, bucketName, objectLists);
     }
 

src/main/java/com/spectralogic/ds3client/helpers/WriteJobImpl.java

@@ -35,7 +35,7 @@ public WriteJobImpl(
             final Ds3Client client,
             final UUID jobId,
             final String bucketName,
-            final Iterable<Objects> objectLists) {
+            final Iterable<? extends Objects> objectLists) {
         super(client, jobId, bucketName, objectLists);
     }
 

src/test/java/com/spectralogic/ds3client/helpers/Ds3ClientHelpers_Test.java

@@ -28,7 +28,6 @@
 import java.util.UUID;
 
 import org.apache.commons.io.IOUtils;
-import org.hamcrest.Description;
 import org.junit.Assert;
 import org.junit.Test;
 import org.mockito.ArgumentMatcher;
@@ -199,15 +198,6 @@ public boolean matches(final Object argument) {
                         && putObjectRequest.getObjectName().equals(key)
                         && streamToString(stream).equals(contents);
             }
-            
-            @Override
-            public void describeTo(final Description description) {
-                description.appendText("PutObjectRequest(\"");
-                description.appendText(key);
-                description.appendText("\", \"");
-                description.appendText(contents);
-                description.appendText("\")");
-            }
         });
     }