Merge pull request #541 from RachelTucker/4_1_autogen

4.1 API

Author: rpmoore

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

@@ -19,24 +19,39 @@
 import com.spectralogic.ds3client.commands.interfaces.AbstractResponse;
 import com.spectralogic.ds3client.networking.Metadata;
 import com.spectralogic.ds3client.models.ChecksumType;
+import com.google.common.collect.ImmutableMap;
 
 public class HeadObjectResponse extends AbstractResponse {
 
     public enum Status { EXISTS, DOESNTEXIST, UNKNOWN }
 
+    private final ImmutableMap<Long, String> blobChecksums;
+
+    private final ChecksumType.Type blobChecksumType;
+
     private final Metadata metadata;
 
     private final long objectSize;
 
     private final Status status;
 
-    public HeadObjectResponse(final Metadata metadata, final long objectSize, final Status status, final String checksum, final ChecksumType.Type checksumType) {
+    public HeadObjectResponse(final ImmutableMap<Long, String> blobChecksums, final ChecksumType.Type blobChecksumType, final Metadata metadata, final long objectSize, final Status status, final String checksum, final ChecksumType.Type checksumType) {
         super(checksum, checksumType);
+        this.blobChecksums = blobChecksums;
+        this.blobChecksumType = blobChecksumType;
         this.metadata = metadata;
         this.objectSize = objectSize;
         this.status = status;
     }
 
+    public ImmutableMap<Long, String> getBlobChecksums() {
+        return this.blobChecksums;
+    }
+
+    public ChecksumType.Type getBlobChecksumType() {
+        return this.blobChecksumType;
+    }
+
     public Metadata getMetadata() {
         return this.metadata;
     }

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

@@ -18,13 +18,15 @@
 
 import com.spectralogic.ds3client.commands.interfaces.MetadataImpl;
 import com.spectralogic.ds3client.networking.Metadata;
+import com.google.common.collect.ImmutableMap;
+import com.spectralogic.ds3client.models.ChecksumType;
 import com.spectralogic.ds3client.commands.HeadObjectResponse;
 import com.spectralogic.ds3client.commands.parsers.interfaces.AbstractResponseParser;
 import com.spectralogic.ds3client.commands.parsers.utils.ResponseParserUtils;
 import com.spectralogic.ds3client.networking.WebResponse;
 import java.io.IOException;
 
-import static com.spectralogic.ds3client.commands.parsers.utils.ResponseParserUtils.getSizeFromHeaders;
+import static com.spectralogic.ds3client.commands.parsers.utils.ResponseParserUtils.*;
 
 public class HeadObjectResponseParser extends AbstractResponseParser<HeadObjectResponse> {
     private final int[] expectedStatusCodes = new int[]{200, 404};
@@ -37,10 +39,12 @@ public HeadObjectResponse parseXmlResponse(final WebResponse response) throws IO
             final long objectSize = getSizeFromHeaders(response.getHeaders());
             switch (statusCode) {
             case 200:
-                return new HeadObjectResponse(metadata, objectSize, HeadObjectResponse.Status.EXISTS, this.getChecksum(), this.getChecksumType());
+                final ChecksumType.Type blobChecksumType = getBlobChecksumType(response.getHeaders());
+                final ImmutableMap<Long, String> blobChecksumMap = getBlobChecksumMap(response.getHeaders());
+                return new HeadObjectResponse(blobChecksumMap, blobChecksumType, metadata, objectSize, HeadObjectResponse.Status.EXISTS, this.getChecksum(), this.getChecksumType());
 
             case 404:
-                return new HeadObjectResponse(metadata, objectSize, HeadObjectResponse.Status.DOESNTEXIST, this.getChecksum(), this.getChecksumType());
+                return new HeadObjectResponse(ImmutableMap.of(), ChecksumType.Type.NONE, metadata, objectSize, HeadObjectResponse.Status.DOESNTEXIST, this.getChecksum(), this.getChecksumType());
 
             default:
                 assert false: "validateStatusCode should have made it impossible to reach this line";

ds3-sdk/src/main/java/com/spectralogic/ds3client/commands/parsers/utils/ResponseParserUtils.java

@@ -17,6 +17,7 @@
 
 import com.google.common.base.Preconditions;
 import com.google.common.base.Strings;
+import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableSet;
 import com.spectralogic.ds3client.models.ChecksumType;
 import com.spectralogic.ds3client.models.Error;
@@ -41,6 +42,9 @@ public final class ResponseParserUtils {
     private final static Logger LOG = LoggerFactory.getLogger(ResponseParserUtils.class);
     final public static String UTF8 = "UTF-8";
 
+    private static final String BLOB_CHECKSUM_TYPE_HEADER = "ds3-blob-checksum-type";
+    private static final String BLOB_CHECKSUM_HEADER = "ds3-blob-checksum-offset-";
+
     private ResponseParserUtils() {
         // pass
     }
@@ -145,4 +149,72 @@ private static String readResponseString(final WebResponse response) throws IOEx
             return writer.toString();
         }
     }
+
+    /**
+     * Retrieves the blob checksum type from the response headers. If there is no blob checksum
+     * type header, than NONE is returned. If there is more than one value for the blob checksum
+     * type header, than an illegal argument exception is thrown.
+     */
+    public static ChecksumType.Type getBlobChecksumType(final Headers headers) {
+        final List<String> types = headers.get(BLOB_CHECKSUM_TYPE_HEADER);
+        switch (types.size()) {
+            case 0:
+                return ChecksumType.Type.NONE;
+            case 1:
+                return toBlobChecksumType(types.get(0));
+            default:
+                throw new IllegalArgumentException(String.format("Response has more than one header value for '%s'", BLOB_CHECKSUM_TYPE_HEADER));
+        }
+    }
+
+    /**
+     * Converts the response header value for {@code BLOB_CHECKSUM_TYPE_HEADER} into a {@code ChecksumType.Type}
+     */
+    static ChecksumType.Type toBlobChecksumType(final String checksumType) {
+        if (Guard.isStringNullOrEmpty(checksumType)) {
+            return ChecksumType.Type.NONE;
+        }
+        return ChecksumType.Type.valueOf(checksumType);
+    }
+
+    /**
+     * Retrieves a map of blob offset to blob checksum from response headers.
+     */
+    public static ImmutableMap<Long, String> getBlobChecksumMap(final Headers headers) {
+        if (headers.keys() == null) {
+            return ImmutableMap.of();
+        }
+
+        final ImmutableMap.Builder<Long, String> builder = ImmutableMap.builder();
+        headers.keys().stream()
+                .filter(key -> key.startsWith(BLOB_CHECKSUM_HEADER))
+                .forEach(key -> builder.put(getOffsetFromHeaderKey(key), getBlobChecksumValue(key, headers)));
+
+        return builder.build();
+    }
+
+    /**
+     * Retrieves the offset from the blob checksum header key. This assumes that the
+     * provided key has the prefix {@code BLOB_CHECKSUM_HEADER} and that the postfix can be
+     * converted into a Long.
+     */
+    private static Long getOffsetFromHeaderKey(final String key) {
+        final String offset = key.substring(BLOB_CHECKSUM_HEADER.length());
+        return Long.valueOf(offset);
+    }
+
+    /**
+     * Retrieves the value from the specified header key assuming there is at most one value.
+     * If there are no values for the key, then an empty string is returned.
+     * If there is more than one value for the given key, an illegal argument exception is thrown.
+     */
+    private static String getBlobChecksumValue(final String key, final Headers headers) {
+        final List<String> values = headers.get(key);
+        switch (values.size()) {
+            case 1:
+                return values.get(0);
+            default:
+                throw new IllegalArgumentException(String.format("Expected response to have 1 value for blob checksum header '%s', but found '%d' values", key, values.size()));
+        }
+    }
 }

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

@@ -20,6 +20,7 @@
 import com.spectralogic.ds3client.commands.interfaces.AbstractPaginationRequest;
 import java.util.UUID;
 import com.google.common.net.UrlEscapers;
+import com.spectralogic.ds3client.models.ReservedTaskType;
 import com.spectralogic.ds3client.models.TapeDriveState;
 import com.spectralogic.ds3client.models.TapeDriveType;
 
@@ -37,6 +38,8 @@ public class GetTapeDrivesSpectraS3Request extends AbstractPaginationRequest {
 
     private String partitionId;
 
+    private ReservedTaskType reservedTaskType;
+
     private String serialNumber;
 
     private TapeDriveState state;
@@ -103,6 +106,13 @@ public GetTapeDrivesSpectraS3Request withPartitionId(final String partitionId) {
     }
 
 
+    public GetTapeDrivesSpectraS3Request withReservedTaskType(final ReservedTaskType reservedTaskType) {
+        this.reservedTaskType = reservedTaskType;
+        this.updateQueryParam("reserved_task_type", reservedTaskType);
+        return this;
+    }
+
+
     public GetTapeDrivesSpectraS3Request withSerialNumber(final String serialNumber) {
         this.serialNumber = serialNumber;
         this.updateQueryParam("serial_number", serialNumber);
@@ -160,6 +170,11 @@ public String getPartitionId() {
     }
 
 
+    public ReservedTaskType getReservedTaskType() {
+        return this.reservedTaskType;
+    }
+
+
     public String getSerialNumber() {
         return this.serialNumber;
     }

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

@@ -30,10 +30,14 @@ public class ModifyDataPathBackendSpectraS3Request extends AbstractRequest {
 
     private boolean activated;
 
+    private boolean allowNewJobRequests;
+
     private Integer autoActivateTimeoutInMins;
 
     private AutoInspectMode autoInspect;
 
+    private int cacheAvailableRetryAfterInSeconds;
+
     private ImportConflictResolutionMode defaultImportConflictResolutionMode;
 
     private Priority defaultVerifyDataAfterImport;
@@ -62,6 +66,13 @@ public ModifyDataPathBackendSpectraS3Request withActivated(final boolean activat
     }
 
 
+    public ModifyDataPathBackendSpectraS3Request withAllowNewJobRequests(final boolean allowNewJobRequests) {
+        this.allowNewJobRequests = allowNewJobRequests;
+        this.updateQueryParam("allow_new_job_requests", allowNewJobRequests);
+        return this;
+    }
+
+
     public ModifyDataPathBackendSpectraS3Request withAutoActivateTimeoutInMins(final Integer autoActivateTimeoutInMins) {
         this.autoActivateTimeoutInMins = autoActivateTimeoutInMins;
         this.updateQueryParam("auto_activate_timeout_in_mins", autoActivateTimeoutInMins);
@@ -76,6 +87,13 @@ public ModifyDataPathBackendSpectraS3Request withAutoInspect(final AutoInspectMo
     }
 
 
+    public ModifyDataPathBackendSpectraS3Request withCacheAvailableRetryAfterInSeconds(final int cacheAvailableRetryAfterInSeconds) {
+        this.cacheAvailableRetryAfterInSeconds = cacheAvailableRetryAfterInSeconds;
+        this.updateQueryParam("cache_available_retry_after_in_seconds", cacheAvailableRetryAfterInSeconds);
+        return this;
+    }
+
+
     public ModifyDataPathBackendSpectraS3Request withDefaultImportConflictResolutionMode(final ImportConflictResolutionMode defaultImportConflictResolutionMode) {
         this.defaultImportConflictResolutionMode = defaultImportConflictResolutionMode;
         this.updateQueryParam("default_import_conflict_resolution_mode", defaultImportConflictResolutionMode);
@@ -141,6 +159,11 @@ public boolean getActivated() {
     }
 
 
+    public boolean getAllowNewJobRequests() {
+        return this.allowNewJobRequests;
+    }
+
+
     public Integer getAutoActivateTimeoutInMins() {
         return this.autoActivateTimeoutInMins;
     }
@@ -151,6 +174,11 @@ public AutoInspectMode getAutoInspect() {
     }
 
 
+    public int getCacheAvailableRetryAfterInSeconds() {
+        return this.cacheAvailableRetryAfterInSeconds;
+    }
+
+
     public ImportConflictResolutionMode getDefaultImportConflictResolutionMode() {
         return this.defaultImportConflictResolutionMode;
     }

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

@@ -19,6 +19,7 @@
 import com.spectralogic.ds3client.networking.HttpVerb;
 import com.spectralogic.ds3client.commands.interfaces.AbstractRequest;
 import com.spectralogic.ds3client.models.Quiesced;
+import com.spectralogic.ds3client.models.ReservedTaskType;
 import java.util.UUID;
 import com.google.common.net.UrlEscapers;
 
@@ -30,6 +31,8 @@ public class ModifyTapeDriveSpectraS3Request extends AbstractRequest {
 
     private Quiesced quiesced;
 
+    private ReservedTaskType reservedTaskType;
+
     // Constructor
 
 
@@ -51,6 +54,13 @@ public ModifyTapeDriveSpectraS3Request withQuiesced(final Quiesced quiesced) {
     }
 
 
+    public ModifyTapeDriveSpectraS3Request withReservedTaskType(final ReservedTaskType reservedTaskType) {
+        this.reservedTaskType = reservedTaskType;
+        this.updateQueryParam("reserved_task_type", reservedTaskType);
+        return this;
+    }
+
+
 
     @Override
     public HttpVerb getVerb() {
@@ -71,4 +81,9 @@ public Quiesced getQuiesced() {
         return this.quiesced;
     }
 
+
+    public ReservedTaskType getReservedTaskType() {
+        return this.reservedTaskType;
+    }
+
 }

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

@@ -27,6 +27,10 @@ public class ModifyTapePartitionSpectraS3Request extends AbstractRequest {
 
     private final String tapePartition;
 
+    private int minimumReadReservedDrives;
+
+    private int minimumWriteReservedDrives;
+
     private Quiesced quiesced;
 
     // Constructor
@@ -37,6 +41,20 @@ public ModifyTapePartitionSpectraS3Request(final String tapePartition) {
 
     }
 
+    public ModifyTapePartitionSpectraS3Request withMinimumReadReservedDrives(final int minimumReadReservedDrives) {
+        this.minimumReadReservedDrives = minimumReadReservedDrives;
+        this.updateQueryParam("minimum_read_reserved_drives", minimumReadReservedDrives);
+        return this;
+    }
+
+
+    public ModifyTapePartitionSpectraS3Request withMinimumWriteReservedDrives(final int minimumWriteReservedDrives) {
+        this.minimumWriteReservedDrives = minimumWriteReservedDrives;
+        this.updateQueryParam("minimum_write_reserved_drives", minimumWriteReservedDrives);
+        return this;
+    }
+
+
     public ModifyTapePartitionSpectraS3Request withQuiesced(final Quiesced quiesced) {
         this.quiesced = quiesced;
         this.updateQueryParam("quiesced", quiesced);
@@ -60,6 +78,16 @@ public String getTapePartition() {
     }
 
 
+    public int getMinimumReadReservedDrives() {
+        return this.minimumReadReservedDrives;
+    }
+
+
+    public int getMinimumWriteReservedDrives() {
+        return this.minimumWriteReservedDrives;
+    }
+
+
     public Quiesced getQuiesced() {
         return this.quiesced;
     }