Complete integration of structured message decoder with all blob download methods

Copilot · gunjansingh-msft · Copilot · commit 1f6a04d8eb4b · 2025-09-09T11:21:48.000Z
Co-authored-by: gunjansingh-msft &lt;179915668+gunjansingh-msft@users.noreply.github.com&gt;
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobInputStreamOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobInputStreamOptions.java
@@ -7,6 +7,7 @@
 import com.azure.storage.blob.models.BlobRange;
 import com.azure.storage.blob.models.BlobRequestConditions;
 import com.azure.storage.blob.models.ConsistentReadControl;
+import com.azure.storage.common.implementation.contentvalidation.DownloadContentValidationOptions;
 
 /**
  * Extended options that may be passed when opening a blob input stream.
@@ -17,6 +18,7 @@ public class BlobInputStreamOptions {
     private BlobRequestConditions requestConditions;
     private Integer blockSize;
     private ConsistentReadControl consistentReadControl;
+    private DownloadContentValidationOptions contentValidationOptions;
 
     /**
      * Creates a new instance of {@link BlobInputStreamOptions}.
@@ -111,4 +113,24 @@ public BlobInputStreamOptions setConsistentReadControl(ConsistentReadControl con
         this.consistentReadControl = consistentReadControl;
         return this;
     }
+
+    /**
+     * Gets the {@link DownloadContentValidationOptions}.
+     *
+     * @return {@link DownloadContentValidationOptions}
+     */
+    public DownloadContentValidationOptions getContentValidationOptions() {
+        return contentValidationOptions;
+    }
+
+    /**
+     * Sets the {@link DownloadContentValidationOptions}.
+     *
+     * @param contentValidationOptions {@link DownloadContentValidationOptions}
+     * @return The updated options.
+     */
+    public BlobInputStreamOptions setContentValidationOptions(DownloadContentValidationOptions contentValidationOptions) {
+        this.contentValidationOptions = contentValidationOptions;
+        return this;
+    }
 }
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobSeekableByteChannelReadOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobSeekableByteChannelReadOptions.java
@@ -6,6 +6,7 @@
 import com.azure.core.annotation.Fluent;
 import com.azure.storage.blob.models.BlobRequestConditions;
 import com.azure.storage.blob.models.ConsistentReadControl;
+import com.azure.storage.common.implementation.contentvalidation.DownloadContentValidationOptions;
 
 import java.nio.channels.SeekableByteChannel;
 
@@ -18,6 +19,7 @@ public final class BlobSeekableByteChannelReadOptions {
     private BlobRequestConditions requestConditions;
     private Integer readSizeInBytes;
     private ConsistentReadControl consistentReadControl;
+    private DownloadContentValidationOptions contentValidationOptions;
 
     /**
      * Creates a new instance of {@link BlobSeekableByteChannelReadOptions}.
@@ -108,4 +110,24 @@ public BlobSeekableByteChannelReadOptions setConsistentReadControl(ConsistentRea
         this.consistentReadControl = consistentReadControl;
         return this;
     }
+
+    /**
+     * Gets the {@link DownloadContentValidationOptions}.
+     *
+     * @return {@link DownloadContentValidationOptions}
+     */
+    public DownloadContentValidationOptions getContentValidationOptions() {
+        return contentValidationOptions;
+    }
+
+    /**
+     * Sets the {@link DownloadContentValidationOptions}.
+     *
+     * @param contentValidationOptions {@link DownloadContentValidationOptions}
+     * @return The updated options.
+     */
+    public BlobSeekableByteChannelReadOptions setContentValidationOptions(DownloadContentValidationOptions contentValidationOptions) {
+        this.contentValidationOptions = contentValidationOptions;
+        return this;
+    }
 }
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/specialized/BlobAsyncClientBase.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/specialized/BlobAsyncClientBase.java
@@ -1263,6 +1263,57 @@ public Mono<BlobDownloadContentAsyncResponse> downloadContentWithResponse(Downlo
         }
     }
 
+    /**
+     * Reads the entire blob with content validation options. Uploading data must be done from the {@link BlockBlobClient}, {@link
+     * PageBlobClient}, or {@link AppendBlobClient}.
+     *
+     * <p><strong>Code Samples</strong></p>
+     *
+     * <pre>{@code
+     * DownloadRetryOptions options = new DownloadRetryOptions().setMaxRetryRequests(5);
+     * DownloadContentValidationOptions validationOptions = new DownloadContentValidationOptions()
+     *     .setStructuredMessageValidationEnabled(true);
+     *
+     * client.downloadContentWithResponse(options, null, validationOptions).subscribe(response -> {
+     *     BinaryData content = response.getValue();
+     *     System.out.println(content.toString());
+     * });
+     * }</pre>
+     *
+     * <p>For more information, see the
+     * <a href="https://docs.microsoft.com/rest/api/storageservices/get-blob">Azure Docs</a></p>
+     *
+     * <p>This method supports downloads up to 2GB of data. Content will be buffered in memory. If the blob is larger,
+     * use {@link #downloadStreamWithResponse(BlobRange, DownloadRetryOptions, BlobRequestConditions, boolean, DownloadContentValidationOptions)}
+     * to download larger blobs.</p>
+     *
+     * @param options {@link DownloadRetryOptions}
+     * @param requestConditions {@link BlobRequestConditions}
+     * @param contentValidationOptions {@link DownloadContentValidationOptions} options for content validation
+     * @return A reactive response containing the blob data.
+     */
+    @ServiceMethod(returns = ReturnType.SINGLE)
+    public Mono<BlobDownloadContentAsyncResponse> downloadContentWithResponse(DownloadRetryOptions options,
+        BlobRequestConditions requestConditions, DownloadContentValidationOptions contentValidationOptions) {
+        try {
+            return withContext(context -> {
+                if (contentValidationOptions != null && (contentValidationOptions.isStructuredMessageValidationEnabled() || contentValidationOptions.isMd5ValidationEnabled())) {
+                    return downloadStreamWithResponse(null, options, requestConditions, false, contentValidationOptions, context)
+                        .flatMap(r -> BinaryData.fromFlux(r.getValue())
+                            .map(data -> new BlobDownloadContentAsyncResponse(r.getRequest(), r.getStatusCode(), r.getHeaders(),
+                                data, r.getDeserializedHeaders())));
+                } else {
+                    return downloadStreamWithResponse(null, options, requestConditions, false, context)
+                        .flatMap(r -> BinaryData.fromFlux(r.getValue())
+                            .map(data -> new BlobDownloadContentAsyncResponse(r.getRequest(), r.getStatusCode(), r.getHeaders(),
+                                data, r.getDeserializedHeaders())));
+                }
+            });
+        } catch (RuntimeException ex) {
+            return monoError(LOGGER, ex);
+        }
+    }
+
     Mono<BlobDownloadAsyncResponse> downloadStreamWithResponse(BlobRange range, DownloadRetryOptions options,
         BlobRequestConditions requestConditions, boolean getRangeContentMd5, Context context) {
         BlobRange finalRange = range == null ? new BlobRange(0) : range;
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/specialized/BlobClientBase.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/specialized/BlobClientBase.java
@@ -91,6 +91,7 @@
 import com.azure.storage.common.implementation.SasImplUtils;
 import com.azure.storage.common.implementation.StorageImplUtils;
 import com.azure.storage.common.implementation.StorageSeekableByteChannel;
+import com.azure.storage.common.implementation.contentvalidation.DownloadContentValidationOptions;
 import reactor.core.publisher.Mono;
 
 import java.io.IOException;
@@ -511,7 +512,14 @@ public BlobInputStream openInputStream(BlobInputStreamOptions options, Context c
         com.azure.storage.common.ParallelTransferOptions parallelTransferOptions
             = new com.azure.storage.common.ParallelTransferOptions().setBlockSizeLong((long) chunkSize);
         BiFunction<BlobRange, BlobRequestConditions, Mono<BlobDownloadAsyncResponse>> downloadFunc = (chunkRange,
-            conditions) -> client.downloadStreamWithResponse(chunkRange, null, conditions, false, contextFinal);
+            conditions) -> {
+                DownloadContentValidationOptions contentValidationOptions = options.getContentValidationOptions();
+                if (contentValidationOptions != null && (contentValidationOptions.isStructuredMessageValidationEnabled() || contentValidationOptions.isMd5ValidationEnabled())) {
+                    return client.downloadStreamWithResponse(chunkRange, null, conditions, false, contentValidationOptions, contextFinal);
+                } else {
+                    return client.downloadStreamWithResponse(chunkRange, null, conditions, false, contextFinal);
+                }
+            };
         return ChunkedDownloadUtils
             .downloadFirstChunk(range, parallelTransferOptions, requestConditions, downloadFunc, true)
             .flatMap(tuple3 -> {
@@ -586,9 +594,22 @@ public BlobSeekableByteChannelReadResult openSeekableByteChannelRead(BlobSeekabl
         BlobProperties properties;
         BlobDownloadResponse response;
         try (ByteBufferBackedOutputStreamUtil dstStream = new ByteBufferBackedOutputStreamUtil(initialRange)) {
-            response = this.downloadStreamWithResponse(dstStream,
-                new BlobRange(initialPosition, (long) initialRange.remaining()), null /*downloadRetryOptions*/,
-                options.getRequestConditions(), false, null, context);
+            DownloadContentValidationOptions contentValidationOptions = options.getContentValidationOptions();
+            if (contentValidationOptions != null && (contentValidationOptions.isStructuredMessageValidationEnabled() || contentValidationOptions.isMd5ValidationEnabled())) {
+                BlobDownloadAsyncResponse asyncResponse = this.client.downloadStreamWithResponse(
+                    new BlobRange(initialPosition, (long) initialRange.remaining()), null /*downloadRetryOptions*/,
+                    options.getRequestConditions(), false, contentValidationOptions, context).block();
+                if (asyncResponse != null) {
+                    // Convert async response to sync response with structured message decoding applied
+                    response = new BlobDownloadResponse(asyncResponse);
+                } else {
+                    throw LOGGER.logExceptionAsError(new RuntimeException("Download response was null"));
+                }
+            } else {
+                response = this.downloadStreamWithResponse(dstStream,
+                    new BlobRange(initialPosition, (long) initialRange.remaining()), null /*downloadRetryOptions*/,
+                    options.getRequestConditions(), false, null, context);
+            }
             properties = ModelHelper.buildBlobPropertiesResponse(response).getValue();
         } catch (IOException e) {
             throw LOGGER.logExceptionAsError(new UncheckedIOException(e));
diff --git a/sdk/storage/azure-storage-blob/src/test/java/com/azure/storage/blob/specialized/BlobAsyncClientBaseStructuredMessageTests.java b/sdk/storage/azure-storage-blob/src/test/java/com/azure/storage/blob/specialized/BlobAsyncClientBaseStructuredMessageTests.java
@@ -8,6 +8,7 @@
 import com.azure.storage.blob.models.BlobRequestConditions;
 import com.azure.storage.blob.models.DownloadRetryOptions;
 import com.azure.storage.blob.options.BlobDownloadToFileOptions;
+import com.azure.storage.blob.options.BlobInputStreamOptions;
 import com.azure.storage.common.implementation.contentvalidation.DownloadContentValidationOptions;
 import com.azure.storage.common.implementation.structuredmessage.StructuredMessageDecoder;
 import com.azure.storage.common.implementation.structuredmessage.StructuredMessageEncoder;
@@ -105,6 +106,19 @@ public void testStructuredMessageEncoderDecoderIntegration() throws IOException
         assertArrayEquals(originalData, decodedBytes);
     }
 
+    @Test
+    public void testBlobInputStreamOptionsWithContentValidation() {
+        // Test setting content validation options on BlobInputStreamOptions
+        DownloadContentValidationOptions contentValidationOptions = new DownloadContentValidationOptions()
+            .setStructuredMessageValidationEnabled(true);
+            
+        BlobInputStreamOptions options = new BlobInputStreamOptions()
+            .setContentValidationOptions(contentValidationOptions);
+        
+        assertNotNull(options.getContentValidationOptions());
+        assertTrue(options.getContentValidationOptions().isStructuredMessageValidationEnabled());
+    }
+
     @Test
     public void testStructuredMessageValidationWithCrc64() throws IOException {
         // Test that CRC64 validation works
