Updated some naming and comments per review.

Author: Hans-Peter Klett

sdk/src/main/java/com/spectralogic/ds3client/helpers/ChunkTransferExecutor.java renamed to sdk/src/main/java/com/spectralogic/ds3client/helpers/ChunkTransferrer.java

@@ -34,22 +34,22 @@
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Executors;
 
-class ChunkTransferExecutor {
-    private final Transferrer transferrer;
+class ChunkTransferrer {
+    private final ItemTransferrer itemTransferrer;
     private final Ds3Client mainClient;
     private final JobPartTracker partTracker;
     private final int maxParallelRequests;
 
-    public static interface Transferrer {
+    public static interface ItemTransferrer {
         void transferItem(Ds3Client client, BulkObject ds3Object) throws SignatureException, IOException;
     }
 
-    public ChunkTransferExecutor(
-            final Transferrer transferrer,
+    public ChunkTransferrer(
+            final ItemTransferrer transferrer,
             final Ds3Client mainClient,
             final JobPartTracker partTracker,
             final int maxParallelRequests) {
-        this.transferrer = transferrer;
+        this.itemTransferrer = transferrer;
         this.mainClient = mainClient;
         this.partTracker = partTracker;
         this.maxParallelRequests = maxParallelRequests;
@@ -71,8 +71,8 @@ public void transferChunks(
                         tasks.add(executor.submit(new Callable<Object>() {
                             @Override
                             public Object call() throws Exception {
-                                ChunkTransferExecutor.this.transferrer.transferItem(client, ds3Object);
-                                ChunkTransferExecutor.this.partTracker.completePart(ds3Object.getName(), part);
+                                ChunkTransferrer.this.itemTransferrer.transferItem(client, ds3Object);
+                                ChunkTransferrer.this.partTracker.completePart(ds3Object.getName(), part);
                                 return null;
                             }
                         }));

sdk/src/main/java/com/spectralogic/ds3client/helpers/JobPartTracker.java

@@ -17,6 +17,11 @@
 
 import java.util.Map;
 
+/**
+ * This class manages parts for all of the objects in the job. It aggregates
+ * ObjectPartTracker implementations, which manage the parts for a single
+ * object.
+ */
 public class JobPartTracker {
     private final Map<String, ObjectPartTracker> trackers;
 

sdk/src/main/java/com/spectralogic/ds3client/helpers/JobState.java

@@ -37,7 +37,7 @@ public JobState(final ObjectChannelBuilder channelBuilder, final Collection<Obje
         this.channelCache = buildCache(channelBuilder);
         this.partTracker = JobPartTrackerFactory
             .buildPartTracker(Iterables.concat(filteredChunks))
-            .attachObjectCompletedListener(new ObjectCompletedListenerImplementation());
+            .attachObjectCompletedListener(new ObjectCompletedListenerImpl());
     }
 
     public boolean hasObjects() {
@@ -79,7 +79,7 @@ public JobPartTracker getPartTracker() {
         return partTracker;
     }
 
-    private final class ObjectCompletedListenerImplementation implements ObjectCompletedListener {
+    private final class ObjectCompletedListenerImpl implements ObjectCompletedListener {
         @Override
         public void objectCompleted(final String name) {
             JobState.this.objectsRemaining.decrementAndGet();

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

@@ -19,7 +19,7 @@
 import com.spectralogic.ds3client.commands.GetAvailableJobChunksRequest;
 import com.spectralogic.ds3client.commands.GetAvailableJobChunksResponse;
 import com.spectralogic.ds3client.commands.GetObjectRequest;
-import com.spectralogic.ds3client.helpers.ChunkTransferExecutor.Transferrer;
+import com.spectralogic.ds3client.helpers.ChunkTransferrer.ItemTransferrer;
 import com.spectralogic.ds3client.helpers.Ds3ClientHelpers.ObjectChannelBuilder;
 import com.spectralogic.ds3client.models.bulk.BulkObject;
 import com.spectralogic.ds3client.models.bulk.MasterObjectList;
@@ -37,14 +37,14 @@ public ReadJobImpl(final Ds3Client client, final MasterObjectList masterObjectLi
     public void transfer(final ObjectChannelBuilder channelBuilder)
             throws SignatureException, IOException, XmlProcessingException {
         try (final JobState jobState = new JobState(channelBuilder, this.masterObjectList.getObjects())) {
-            final ChunkTransferExecutor executor = new ChunkTransferExecutor(
+            final ChunkTransferrer chunkTransferrer = new ChunkTransferrer(
                 new GetObjectTransferrer(jobState),
                 this.client,
                 jobState.getPartTracker(),
                 this.maxParallelRequests
             );
             while (jobState.hasObjects()) {
-                transferNextChunks(executor);
+                transferNextChunks(chunkTransferrer);
             }
         } catch (final SignatureException | IOException | XmlProcessingException e) {
             throw e;
@@ -55,14 +55,14 @@ public void transfer(final ObjectChannelBuilder channelBuilder)
         }
     }
 
-    private void transferNextChunks(final ChunkTransferExecutor executor)
+    private void transferNextChunks(final ChunkTransferrer chunkTransferrer)
             throws IOException, SignatureException, XmlProcessingException, InterruptedException {
         final GetAvailableJobChunksResponse availableJobChunks =
             this.client.getAvailableJobChunks(new GetAvailableJobChunksRequest(this.masterObjectList.getJobId()));
         switch(availableJobChunks.getStatus()) {
         case AVAILABLE:
             final MasterObjectList availableMol = availableJobChunks.getMasterObjectList();
-            executor.transferChunks(availableMol.getNodes(), availableMol.getObjects());
+            chunkTransferrer.transferChunks(availableMol.getNodes(), availableMol.getObjects());
             break;
         case RETRYLATER:
             Thread.sleep(availableJobChunks.getRetryAfterSeconds() * 1000);
@@ -72,7 +72,7 @@ private void transferNextChunks(final ChunkTransferExecutor executor)
         }
     }
 
-    private final class GetObjectTransferrer implements Transferrer {
+    private final class GetObjectTransferrer implements ItemTransferrer {
         private final JobState jobState;
 
         private GetObjectTransferrer(final JobState jobState) {

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

@@ -19,7 +19,7 @@
 import com.spectralogic.ds3client.commands.AllocateJobChunkRequest;
 import com.spectralogic.ds3client.commands.AllocateJobChunkResponse;
 import com.spectralogic.ds3client.commands.PutObjectRequest;
-import com.spectralogic.ds3client.helpers.ChunkTransferExecutor.Transferrer;
+import com.spectralogic.ds3client.helpers.ChunkTransferrer.ItemTransferrer;
 import com.spectralogic.ds3client.helpers.Ds3ClientHelpers.ObjectChannelBuilder;
 import com.spectralogic.ds3client.models.bulk.BulkObject;
 import com.spectralogic.ds3client.models.bulk.MasterObjectList;
@@ -44,14 +44,14 @@ public void transfer(final ObjectChannelBuilder channelBuilder)
             throws SignatureException, IOException, XmlProcessingException {
         final List<Objects> filteredChunks = filterChunks(this.masterObjectList.getObjects());
         try (final JobState jobState = new JobState(channelBuilder, filteredChunks)) {
-            final ChunkTransferExecutor executor = new ChunkTransferExecutor(
+            final ChunkTransferrer chunkTransferrer = new ChunkTransferrer(
                 new PutObjectTransferrer(jobState),
                 this.client,
                 jobState.getPartTracker(),
                 this.maxParallelRequests
             );
             for (final Objects chunk : filteredChunks) {
-                executor.transferChunks(this.masterObjectList.getNodes(), Arrays.asList(filterChunk(allocateChunk(chunk))));
+                chunkTransferrer.transferChunks(this.masterObjectList.getNodes(), Arrays.asList(filterChunk(allocateChunk(chunk))));
             }
         } catch (final SignatureException | IOException | XmlProcessingException e) {
             throw e;
@@ -118,7 +118,7 @@ private static List<BulkObject> filterObjects(final List<BulkObject> list) {
         return filtered;
     }
 
-    private final class PutObjectTransferrer implements Transferrer {
+    private final class PutObjectTransferrer implements ItemTransferrer {
         private final JobState jobState;
 
         private PutObjectTransferrer(final JobState jobState) {