Added worm support

Author: rickle-msft

ChangeLog.txt

@@ -1,3 +1,6 @@
+XXXX.XX.XX Version X.X.X
+ * Support for write-once read-many containers.
+
 2018.02.05 Version 7.0.0
  * Support for 2017-07-29 REST version. Please see our REST api documentation and blogs for information about the related added features.
  * Added support for soft delete feature. If a delete retention policy is enabled through the set service properties API, then blobs or snapshots can be deleted softly and retained for a specified number of days, before being permanently removed by garbage collection.

microsoft-azure-storage-test/src/com/microsoft/azure/storage/blob/CloudBlobClientTests.java

@@ -77,6 +77,10 @@ public void testListContainers() throws StorageException, URISyntaxException {
             for (final CloudBlobContainer container : segment.getResults()) {
                 container.downloadAttributes();
                 assertEquals(CloudBlobContainer.class, container.getClass());
+                assertNotNull(container.getProperties().hasImmutabilityPolicy());
+                assertNotNull(container.getProperties().hasLegalHold());
+                assertFalse(container.getProperties().hasImmutabilityPolicy());
+                assertFalse(container.getProperties().hasLegalHold());
                 containerList.remove(container.getName());
             }
 

microsoft-azure-storage-test/src/com/microsoft/azure/storage/blob/CloudBlobContainerTests.java

@@ -316,6 +316,10 @@ public void testCloudBlobContainerExists() throws StorageException {
         this.container.create();
         assertTrue(this.container.exists());
         assertNotNull(this.container.getProperties().getEtag());
+        assertNotNull(this.container.getProperties().hasImmutabilityPolicy());
+        assertNotNull(this.container.getProperties().hasLegalHold());
+        assertFalse(this.container.getProperties().hasImmutabilityPolicy());
+        assertFalse(this.container.getProperties().hasLegalHold());
 
         this.container.delete();
         assertFalse(this.container.exists());
@@ -549,6 +553,8 @@ public void testCloudBlobContainerListBlobs() throws StorageException, IOExcepti
                     EnumSet.noneOf(BlobListingDetails.class), 150, token, null, null);
             for (ListBlobItem blob : result.getResults()) {
                 assertEquals(CloudBlockBlob.class, blob.getClass());
+                assertNotNull(((CloudBlockBlob)blob).getProperties().getCreatedTime());
+                assertTrue(((CloudBlockBlob)blob).getProperties().getCreatedTime().before(new Date()));
                 assertTrue(blobNames.remove(((CloudBlockBlob) blob).getName()));
             }
             token = result.getContinuationToken();

microsoft-azure-storage-test/src/com/microsoft/azure/storage/blob/CloudBlockBlobTests.java

@@ -99,6 +99,8 @@ public void testBlockBlobCreate() throws StorageException, URISyntaxException, I
         // Create again (should succeed)
         blob.uploadText("text");
         assertTrue(blob.exists());
+        assertNotNull(blob.getProperties().getCreatedTime());
+        assertTrue(blob.getProperties().getCreatedTime().before(new Date()));
 
         // Create again, specifying not to if it already exists
         // This should fail

microsoft-azure-storage/src/com/microsoft/azure/storage/Constants.java

@@ -650,7 +650,7 @@ public static class HeaderConstants {
         /**
          * The current storage version header value.
          */
-        public static final String TARGET_STORAGE_VERSION = "2017-07-29";
+        public static final String TARGET_STORAGE_VERSION = "2017-11-09";
 
         /**
          * The header that specifies the next visible time for a queue message.

microsoft-azure-storage/src/com/microsoft/azure/storage/blob/BlobConstants.java

@@ -150,6 +150,16 @@ final class BlobConstants {
      */
     public static final String CONTENT_TYPE_HEADER = Constants.PREFIX_FOR_STORAGE_HEADER + "blob-content-type";
 
+    /**
+     * The header that specifies the blob creation time.
+     */
+    public static final String CREATION_TIME_HEADER = Constants.PREFIX_FOR_STORAGE_HEADER + "creation-time";
+
+    /**
+     * XML element for the creation time.
+     */
+    public static final String CREATION_TIME_ELEMENT = "Creation-Time";
+
     /**
      * The number of default concurrent requests for parallel operation.
      */
@@ -170,6 +180,26 @@ final class BlobConstants {
      */
     public static final int DEFAULT_POLLING_INTERVAL_IN_SECONDS = 30;
 
+    /**
+     * The header that specifies the immutability policy for the resource.
+     */
+    public static final String HAS_IMMUTABILITY_POLICY_HEADER = Constants.PREFIX_FOR_STORAGE_HEADER + "has-immutability-policy";
+
+    /**
+     * The header that specifies the legal hold value for the resource.
+     */
+    public static final String HAS_LEGAL_HOLD_HEADER = Constants.PREFIX_FOR_STORAGE_HEADER + "has-legal-hold";
+
+    /**
+     * XML element for immutability policy.
+     */
+    public static final String HAS_IMMUTABILITY_POLICY_ELEMENT = "HasImmutabilityPolicy";
+
+    /**
+     * XML element for legal hold.
+     */
+    public static final String HAS_LEGAL_HOLD_ELEMENT = "HasLegalHold";
+
     /**
      * XML element for the latest.
      */

microsoft-azure-storage/src/com/microsoft/azure/storage/blob/BlobContainerProperties.java

@@ -28,6 +28,16 @@ public final class BlobContainerProperties {
      */
     private String etag;
 
+    /**
+     * Represents whether the container has an immutability policy.
+     */
+    private Boolean hasImmutabilityPolicy;
+
+    /**
+     * Represents whether the container has a legal hold.
+     */
+    private Boolean hasLegalHold;
+
     /**
      * Represents the container's last-modified time.
      */
@@ -69,6 +79,24 @@ public String getEtag() {
         return this.etag;
     }
 
+    /**
+     * Gets the hasImmutabilityPolicy value of the container.
+     *
+     * @return A <code>Boolean</code> which represents the hasImmutabilityPolicy value.
+     */
+    public Boolean hasImmutabilityPolicy() {
+        return this.hasImmutabilityPolicy;
+    }
+
+    /**
+     * Gets the hasLegalHold value of the container.
+     *
+     * @return A <code>Boolean</code> which represents the hasLegalHold value.
+     */
+    public Boolean hasLegalHold() {
+        return this.hasLegalHold;
+    }
+
     /**
      * Gets the last modified time on the container.
      *
@@ -128,6 +156,26 @@ protected void setEtag(final String etag) {
         this.etag = etag;
     }
 
+    /**
+     * Sets the hasImmutabilityPolicy value on the container.
+     *
+     * @param hasImmutabilityPolicy
+     *        A <code>Boolean</code> which represents the hasImmutabilityProperty value to set.
+     */
+    protected void setHasImmutabilityPolicy(final Boolean hasImmutabilityPolicy) {
+        this.hasImmutabilityPolicy = hasImmutabilityPolicy;
+    }
+
+    /**
+     * Sets the hasLegalHold value on the container.
+     *
+     * @param hasLegalHold
+     *        A <code>Boolean</code> which represents the hasLegalHold value to set.
+     */
+    protected void setHasLegalHold(final Boolean hasLegalHold) {
+        this.hasLegalHold= hasLegalHold;
+    }
+
     /**
      * Sets the last modified time on the container.
      *

microsoft-azure-storage/src/com/microsoft/azure/storage/blob/BlobListHandler.java

@@ -366,5 +366,8 @@ else if (BlobConstants.DELETED_TIME.equals(currentNode)) {
         else if (BlobConstants.REMAINING_RETENTION_DAYS.equals(currentNode)) {
             this.properties.setRemainingRetentionDays(Integer.parseInt(value));
         }
+        else if (BlobConstants.CREATION_TIME_ELEMENT.equals(currentNode)) {
+            this.properties.setCreatedTime(Utility.parseRFC1123DateFromStringInGMT(value));
+        }
     }
 }

microsoft-azure-storage/src/com/microsoft/azure/storage/blob/BlobProperties.java

@@ -72,6 +72,11 @@ public final class BlobProperties {
      */
     private CopyState copyState;
 
+    /**
+     * Represents the creation time for the blob, expressed as a UTC value.
+     */
+    private Date createdTime;
+
     /**
      * Represents the blob's ETag value.
      */
@@ -176,6 +181,7 @@ public BlobProperties(final BlobProperties other) {
         this.contentMD5 = other.contentMD5;
         this.contentType = other.contentType;
         this.copyState = other.copyState;
+        this.createdTime = other.createdTime;
         this.etag = other.etag;
         this.isBlobTierInferredTier = other.isBlobTierInferredTier;
         this.isIncrementalCopy = other.isIncrementalCopy;
@@ -288,6 +294,14 @@ public CopyState getCopyState() {
         return this.copyState;
     }
 
+    /**
+     * Gets the time when the blob was created.
+     * @return A {@link java.util.Date} object which represents the time when the blob was created.
+     */
+    public Date getCreatedTime() {
+        return this.createdTime;
+    }
+
     /**
      * Gets the ETag value for the blob.
      * <p>
@@ -521,6 +535,16 @@ protected void setCopyState(final CopyState copyState) {
         this.copyState = copyState;
     }
 
+    /**
+     * Sets the createdTime value for the blob
+     *
+     * @param createdTime
+     *        A <code>Date</code> which represents the time when the blob was created.
+     */
+    protected void setCreatedTime(final Date createdTime) {
+        this.createdTime = createdTime;
+    }
+
     /**
      * Sets the ETag value for the blob.
      * 

microsoft-azure-storage/src/com/microsoft/azure/storage/blob/BlobResponse.java

@@ -172,6 +172,12 @@ else if (properties.getPremiumPageBlobTier() != null  || properties.getStandardB
             properties.setTierChangeTime(new Date(tierChangeTime));
         }
 
+        // Get the creation time of the blob.
+        final long creationTime = request.getHeaderFieldDate(BlobConstants.CREATION_TIME_HEADER, 0);
+        if (creationTime != 0) {
+            properties.setCreatedTime(new Date(creationTime));
+        }
+
         final String incrementalCopyHeaderString =
                 request.getHeaderField(Constants.HeaderConstants.INCREMENTAL_COPY);
         if (!Utility.isNullOrEmpty(incrementalCopyHeaderString)) {
@@ -222,6 +228,17 @@ public static BlobContainerAttributes getBlobContainerAttributes(final HttpURLCo
 
         containerProperties.setPublicAccess(getPublicAccessLevel(request));
 
+        // Worm policy
+        String hasImmutability = request.getHeaderField(BlobConstants.HAS_IMMUTABILITY_POLICY_HEADER);
+        if (!Utility.isNullOrEmpty(hasImmutability)) {
+            containerProperties.setHasImmutabilityPolicy(Boolean.parseBoolean(hasImmutability));
+        }
+
+        String hasLegalHold = request.getHeaderField(BlobConstants.HAS_LEGAL_HOLD_HEADER);
+        if (!Utility.isNullOrEmpty(hasLegalHold)) {
+            containerProperties.setHasLegalHold(Boolean.parseBoolean(hasLegalHold));
+        }
+
         return containerAttributes;
     }