Class EncryptedBlobAsyncClient
- java.lang.Object
-
- com.azure.storage.blob.specialized.BlobAsyncClientBase
-
- com.azure.storage.blob.BlobAsyncClient
-
- com.azure.storage.blob.specialized.cryptography.EncryptedBlobAsyncClient
-
public class EncryptedBlobAsyncClient extends BlobAsyncClient
This class provides a client side encryption client that contains generic blob operations for Azure Storage Blobs. Operations allowed by the client are uploading, downloading and copying a blob, retrieving and setting metadata, retrieving and setting HTTP headers, and deleting and un-deleting a blob. The upload and download operation allow for encryption and decryption of the data client side. Note: setting metadata in particular is unsafe and should only be done so with caution.Please refer to the Azure Docs For Client-Side Encryption for more information.
This client is instantiated through
EncryptedBlobClientBuilder
For operations on a specific blob type (i.e. append, block, or page) use
getAppendBlobAsyncClient
,getBlockBlobAsyncClient
, orgetPageBlobAsyncClient
to construct a client that allows blob specific operations. Note, these types do not support client-side encryption, though decryption is possible in case the associated block/page/append blob contains encrypted data.Please refer to the Azure Docs for more information.
-
-
Field Summary
-
Fields inherited from class com.azure.storage.blob.BlobAsyncClient
BLOB_DEFAULT_HTBB_UPLOAD_BLOCK_SIZE, BLOB_DEFAULT_NUMBER_OF_BUFFERS
-
Fields inherited from class com.azure.storage.blob.specialized.BlobAsyncClientBase
accountName, azureBlobStorage, blobName, containerName, encryptionScope, serviceVersion
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EncryptedBlobAsyncClient
getCustomerProvidedKeyAsyncClient(CustomerProvidedKey customerProvidedKey)
Creates a newEncryptedBlobAsyncClient
with the specifiedcustomerProvidedKey
.EncryptedBlobAsyncClient
getEncryptionScopeAsyncClient(String encryptionScope)
Creates a newEncryptedBlobAsyncClient
with the specifiedencryptionScope
.Flux<ByteBuffer>
query(String expression)
Unsupported.Mono<BlobQueryAsyncResponse>
queryWithResponse(BlobQueryOptions queryOptions)
Unsupported.Mono<BlockBlobItem>
upload(Flux<ByteBuffer> data, ParallelTransferOptions parallelTransferOptions)
Creates a new block blob.Mono<BlockBlobItem>
upload(Flux<ByteBuffer> data, ParallelTransferOptions parallelTransferOptions, boolean overwrite)
Creates a new block blob, or updates the content of an existing block blob.Mono<Void>
uploadFromFile(String filePath)
Creates a new block blob with the content of the specified file.Mono<Void>
uploadFromFile(String filePath, boolean overwrite)
Creates a new block blob, or updates the content of an existing block blob, with the content of the specified file.Mono<Void>
uploadFromFile(String filePath, ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, BlobRequestConditions requestConditions)
Creates a new block blob, or updates the content of an existing block blob, with the content of the specified file.Mono<com.azure.core.http.rest.Response<BlockBlobItem>>
uploadFromFileWithResponse(BlobUploadFromFileOptions options)
Creates a new block blob, or updates the content of an existing block blob, with the content of the specified file.Mono<com.azure.core.http.rest.Response<BlockBlobItem>>
uploadWithResponse(BlobParallelUploadOptions options)
Creates a new block blob, or updates the content of an existing block blob.Mono<com.azure.core.http.rest.Response<BlockBlobItem>>
uploadWithResponse(Flux<ByteBuffer> data, ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, BlobRequestConditions requestConditions)
Creates a new block blob, or updates the content of an existing block blob.-
Methods inherited from class com.azure.storage.blob.BlobAsyncClient
getAppendBlobAsyncClient, getBlockBlobAsyncClient, getPageBlobAsyncClient, getSnapshotClient, getVersionClient, upload, upload, uploadFileResourceSupplier
-
Methods inherited from class com.azure.storage.blob.specialized.BlobAsyncClientBase
abortCopyFromUrl, abortCopyFromUrlWithResponse, beginCopy, beginCopy, beginCopy, copyFromUrl, copyFromUrlWithResponse, copyFromUrlWithResponse, createSnapshot, createSnapshotWithResponse, delete, deleteImmutabilityPolicy, deleteImmutabilityPolicyWithResponse, deleteWithResponse, download, downloadContent, downloadContentWithResponse, downloadStream, downloadStreamWithResponse, downloadToFile, downloadToFile, downloadToFileWithResponse, downloadToFileWithResponse, downloadToFileWithResponse, downloadWithResponse, exists, existsWithResponse, generateSas, generateSas, generateUserDelegationSas, generateUserDelegationSas, getAccountInfo, getAccountInfoWithResponse, getAccountName, getAccountUrl, getBlobName, getBlobUrl, getContainerAsyncClient, getContainerName, getCustomerProvidedKey, getEncryptionScope, getHttpPipeline, getProperties, getPropertiesWithResponse, getServiceVersion, getSnapshotId, getTags, getTagsWithResponse, getVersionId, isSnapshot, setAccessTier, setAccessTierWithResponse, setAccessTierWithResponse, setHttpHeaders, setHttpHeadersWithResponse, setImmutabilityPolicy, setImmutabilityPolicyWithResponse, setLegalHold, setLegalHoldWithResponse, setMetadata, setMetadataWithResponse, setTags, setTagsWithResponse, undelete, undeleteWithResponse
-
-
-
-
Method Detail
-
getEncryptionScopeAsyncClient
public EncryptedBlobAsyncClient getEncryptionScopeAsyncClient(String encryptionScope)
Creates a newEncryptedBlobAsyncClient
with the specifiedencryptionScope
.- Overrides:
getEncryptionScopeAsyncClient
in classBlobAsyncClient
- Parameters:
encryptionScope
- the encryption scope for the blob, passnull
to use no encryption scope.- Returns:
- a
EncryptedBlobAsyncClient
with the specifiedencryptionScope
.
-
getCustomerProvidedKeyAsyncClient
public EncryptedBlobAsyncClient getCustomerProvidedKeyAsyncClient(CustomerProvidedKey customerProvidedKey)
Creates a newEncryptedBlobAsyncClient
with the specifiedcustomerProvidedKey
.- Overrides:
getCustomerProvidedKeyAsyncClient
in classBlobAsyncClient
- Parameters:
customerProvidedKey
- theCustomerProvidedKey
for the blob, passnull
to use no customer provided key.- Returns:
- a
EncryptedBlobAsyncClient
with the specifiedcustomerProvidedKey
.
-
upload
public Mono<BlockBlobItem> upload(Flux<ByteBuffer> data, ParallelTransferOptions parallelTransferOptions)
Creates a new block blob. By default, this method will not overwrite an existing blob.Updating an existing block blob overwrites any existing blob metadata. Partial updates are not supported with this method; the content of the existing blob is overwritten with the new content. To perform a partial update of block blob's, use
stageBlock
andBlockBlobAsyncClient.commitBlockList(List)
on a regular blob client. For more information, see the Azure Docs for Put Block and the Azure Docs for Put Block List.The data passed need not support multiple subscriptions/be replayable as is required in other upload methods when retries are enabled, and the length of the data need not be known in advance. Therefore, this method should support uploading any arbitrary data source, including network streams. This behavior is possible because this method will perform some internal buffering as configured by the blockSize and numBuffers parameters, so while this method may offer additional convenience, it will not be as performant as other options, which should be preferred when possible.
Typically, the greater the number of buffers used, the greater the possible parallelism when transferring the data. Larger buffers means we will have to stage fewer blocks and therefore require fewer IO operations. The trade-offs between these values are context-dependent, so some experimentation may be required to optimize inputs for a given scenario.
Code Samples
ParallelTransferOptions parallelTransferOptions = new ParallelTransferOptions() .setBlockSizeLong(blockSize) .setMaxConcurrency(maxConcurrency); client.upload(data, parallelTransferOptions).subscribe(response -> System.out.printf("Uploaded BlockBlob MD5 is %s%n", Base64.getEncoder().encodeToString(response.getContentMd5())));
- Overrides:
upload
in classBlobAsyncClient
- Parameters:
data
- The data to write to the blob. Unlike other upload methods, this method does not require that theFlux
be replayable. In other words, it does not have to support multiple subscribers and is not expected to produce the same values across subscriptions.parallelTransferOptions
-ParallelTransferOptions
used to configure buffered uploading.- Returns:
- A reactive response containing the information of the uploaded block blob.
-
upload
public Mono<BlockBlobItem> upload(Flux<ByteBuffer> data, ParallelTransferOptions parallelTransferOptions, boolean overwrite)
Creates a new block blob, or updates the content of an existing block blob.Updating an existing block blob overwrites any existing blob metadata. Partial updates are not supported with this method; the content of the existing blob is overwritten with the new content. To perform a partial update of block blob's, use
stageBlock
andBlockBlobAsyncClient.commitBlockList(List)
on a regular blob client. For more information, see the Azure Docs for Put Block and the Azure Docs for Put Block List.The data passed need not support multiple subscriptions/be replayable as is required in other upload methods when retries are enabled, and the length of the data need not be known in advance. Therefore, this method should support uploading any arbitrary data source, including network streams. This behavior is possible because this method will perform some internal buffering as configured by the blockSize and numBuffers parameters, so while this method may offer additional convenience, it will not be as performant as other options, which should be preferred when possible.
Typically, the greater the number of buffers used, the greater the possible parallelism when transferring the data. Larger buffers means we will have to stage fewer blocks and therefore require fewer IO operations. The trade-offs between these values are context-dependent, so some experimentation may be required to optimize inputs for a given scenario.
Code Samples
ParallelTransferOptions parallelTransferOptions = new ParallelTransferOptions() .setBlockSizeLong(blockSize) .setMaxConcurrency(maxConcurrency); boolean overwrite = false; // Default behavior client.upload(data, parallelTransferOptions, overwrite).subscribe(response -> System.out.printf("Uploaded BlockBlob MD5 is %s%n", Base64.getEncoder().encodeToString(response.getContentMd5())));
- Overrides:
upload
in classBlobAsyncClient
- Parameters:
data
- The data to write to the blob. Unlike other upload methods, this method does not require that theFlux
be replayable. In other words, it does not have to support multiple subscribers and is not expected to produce the same values across subscriptions.parallelTransferOptions
-ParallelTransferOptions
used to configure buffered uploading.overwrite
- Whether to overwrite if the blob exists.- Returns:
- A reactive response containing the information of the uploaded block blob.
-
uploadWithResponse
public Mono<com.azure.core.http.rest.Response<BlockBlobItem>> uploadWithResponse(Flux<ByteBuffer> data, ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, BlobRequestConditions requestConditions)
Creates a new block blob, or updates the content of an existing block blob. Updating an existing block blob overwrites any existing blob metadata. Partial updates are not supported with this method; the content of the existing blob is overwritten with the new content. To perform a partial update of a block blob's, usestageBlock
andBlockBlobAsyncClient.commitBlockList(List)
, which this method uses internally. For more information, see the Azure Docs for Put Block and the Azure Docs for Put Block List.The data passed need not support multiple subscriptions/be replayable as is required in other upload methods when retries are enabled, and the length of the data need not be known in advance. Therefore, this method should support uploading any arbitrary data source, including network streams. This behavior is possible because this method will perform some internal buffering as configured by the blockSize and numBuffers parameters, so while this method may offer additional convenience, it will not be as performant as other options, which should be preferred when possible.
Typically, the greater the number of buffers used, the greater the possible parallelism when transferring the data. Larger buffers means we will have to stage fewer blocks and therefore require fewer IO operations. The trade-offs between these values are context-dependent, so some experimentation may be required to optimize inputs for a given scenario.
Code Samples
BlobHttpHeaders headers = new BlobHttpHeaders() .setContentMd5("data".getBytes(StandardCharsets.UTF_8)) .setContentLanguage("en-US") .setContentType("binary"); Map<String, String> metadata = new HashMap<>(Collections.singletonMap("metadata", "value")); BlobRequestConditions requestConditions = new BlobRequestConditions() .setLeaseId(leaseId) .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3)); ParallelTransferOptions parallelTransferOptions = new ParallelTransferOptions() .setBlockSizeLong(blockSize) .setMaxConcurrency(maxConcurrency); client.uploadWithResponse(data, parallelTransferOptions, headers, metadata, AccessTier.HOT, requestConditions) .subscribe(response -> System.out.printf("Uploaded BlockBlob MD5 is %s%n", Base64.getEncoder().encodeToString(response.getValue().getContentMd5())));
- Overrides:
uploadWithResponse
in classBlobAsyncClient
- Parameters:
data
- The data to write to the blob. Unlike other upload methods, this method does not require that theFlux
be replayable. In other words, it does not have to support multiple subscribers and is not expected to produce the same values across subscriptions.parallelTransferOptions
-ParallelTransferOptions
used to configure buffered uploading.headers
-BlobHttpHeaders
metadata
- Metadata to associate with the blob. If there is leading or trailing whitespace in any metadata key or value, it must be removed or encoded.tier
-AccessTier
for the destination blob.requestConditions
-BlobRequestConditions
- Returns:
- A reactive response containing the information of the uploaded block blob.
-
uploadWithResponse
public Mono<com.azure.core.http.rest.Response<BlockBlobItem>> uploadWithResponse(BlobParallelUploadOptions options)
Creates a new block blob, or updates the content of an existing block blob. Updating an existing block blob overwrites any existing blob metadata. Partial updates are not supported with this method; the content of the existing blob is overwritten with the new content. To perform a partial update of a block blob's, usestageBlock
andBlockBlobAsyncClient.commitBlockList(List)
, which this method uses internally. For more information, see the Azure Docs for Put Block and the Azure Docs for Put Block List.The data passed need not support multiple subscriptions/be replayable as is required in other upload methods when retries are enabled, and the length of the data need not be known in advance. Therefore, this method should support uploading any arbitrary data source, including network streams. This behavior is possible because this method will perform some internal buffering as configured by the blockSize and numBuffers parameters, so while this method may offer additional convenience, it will not be as performant as other options, which should be preferred when possible.
Typically, the greater the number of buffers used, the greater the possible parallelism when transferring the data. Larger buffers means we will have to stage fewer blocks and therefore require fewer IO operations. The trade-offs between these values are context-dependent, so some experimentation may be required to optimize inputs for a given scenario.
Code Samples
BlobHttpHeaders headers = new BlobHttpHeaders() .setContentMd5("data".getBytes(StandardCharsets.UTF_8)) .setContentLanguage("en-US") .setContentType("binary"); Map<String, String> metadata = new HashMap<>(Collections.singletonMap("metadata", "value")); Map<String, String> tags = new HashMap<>(Collections.singletonMap("tag", "value")); BlobRequestConditions requestConditions = new BlobRequestConditions() .setLeaseId(leaseId) .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3)); ParallelTransferOptions parallelTransferOptions = new ParallelTransferOptions() .setBlockSizeLong(blockSize) .setMaxConcurrency(maxConcurrency); client.uploadWithResponse(new BlobParallelUploadOptions(data) .setParallelTransferOptions(parallelTransferOptions).setHeaders(headers).setMetadata(metadata) .setTags(tags).setTier(AccessTier.HOT).setRequestConditions(requestConditions)) .subscribe(response -> System.out.printf("Uploaded BlockBlob MD5 is %s%n", Base64.getEncoder().encodeToString(response.getValue().getContentMd5())));
Flux
be replayable. In other words, it does not have to support multiple subscribers and is not expected to produce the same values across subscriptions.- Overrides:
uploadWithResponse
in classBlobAsyncClient
- Parameters:
options
-BlobParallelUploadOptions
- Returns:
- A reactive response containing the information of the uploaded block blob.
-
uploadFromFile
public Mono<Void> uploadFromFile(String filePath)
Creates a new block blob with the content of the specified file. By default, this method will not overwrite existing dataCode Samples
client.uploadFromFile(filePath) .doOnError(throwable -> System.err.printf("Failed to upload from file %s%n", throwable.getMessage())) .subscribe(completion -> System.out.println("Upload from file succeeded"));
- Overrides:
uploadFromFile
in classBlobAsyncClient
- Parameters:
filePath
- Path to the upload file- Returns:
- An empty response
-
uploadFromFile
public Mono<Void> uploadFromFile(String filePath, boolean overwrite)
Creates a new block blob, or updates the content of an existing block blob, with the content of the specified file.Code Samples
boolean overwrite = false; // Default behavior client.uploadFromFile(filePath, overwrite) .doOnError(throwable -> System.err.printf("Failed to upload from file %s%n", throwable.getMessage())) .subscribe(completion -> System.out.println("Upload from file succeeded"));
- Overrides:
uploadFromFile
in classBlobAsyncClient
- Parameters:
filePath
- Path to the upload fileoverwrite
- Whether to overwrite should the blob exist.- Returns:
- An empty response
-
uploadFromFile
public Mono<Void> uploadFromFile(String filePath, ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, BlobRequestConditions requestConditions)
Creates a new block blob, or updates the content of an existing block blob, with the content of the specified file.Code Samples
BlobHttpHeaders headers = new BlobHttpHeaders() .setContentMd5("data".getBytes(StandardCharsets.UTF_8)) .setContentLanguage("en-US") .setContentType("binary"); Map<String, String> metadata = new HashMap<>(Collections.singletonMap("metadata", "value")); BlobRequestConditions requestConditions = new BlobRequestConditions() .setLeaseId(leaseId) .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3)); ParallelTransferOptions parallelTransferOptions = new ParallelTransferOptions() .setBlockSizeLong(blockSize); client.uploadFromFile(filePath, parallelTransferOptions, headers, metadata, AccessTier.HOT, requestConditions) .doOnError(throwable -> System.err.printf("Failed to upload from file %s%n", throwable.getMessage())) .subscribe(completion -> System.out.println("Upload from file succeeded"));
- Overrides:
uploadFromFile
in classBlobAsyncClient
- Parameters:
filePath
- Path to the upload fileparallelTransferOptions
-ParallelTransferOptions
to use to upload from file.headers
-BlobHttpHeaders
metadata
- Metadata to associate with the blob. If there is leading or trailing whitespace in any metadata key or value, it must be removed or encoded.tier
-AccessTier
for the destination blob.requestConditions
-BlobRequestConditions
- Returns:
- An empty response
- Throws:
IllegalArgumentException
- IfblockSize
is less than 0 or greater than 4000 MBUncheckedIOException
- If an I/O error occurs
-
uploadFromFileWithResponse
public Mono<com.azure.core.http.rest.Response<BlockBlobItem>> uploadFromFileWithResponse(BlobUploadFromFileOptions options)
Creates a new block blob, or updates the content of an existing block blob, with the content of the specified file.Code Samples
BlobHttpHeaders headers = new BlobHttpHeaders() .setContentMd5("data".getBytes(StandardCharsets.UTF_8)) .setContentLanguage("en-US") .setContentType("binary"); Map<String, String> metadata = new HashMap<>(Collections.singletonMap("metadata", "value")); Map<String, String> tags = new HashMap<>(Collections.singletonMap("tag", "value")); BlobRequestConditions requestConditions = new BlobRequestConditions() .setLeaseId(leaseId) .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3)); ParallelTransferOptions parallelTransferOptions = new ParallelTransferOptions() .setBlockSizeLong(blockSize); client.uploadFromFileWithResponse(new BlobUploadFromFileOptions(filePath) .setParallelTransferOptions(parallelTransferOptions).setHeaders(headers).setMetadata(metadata).setTags(tags) .setTier(AccessTier.HOT).setRequestConditions(requestConditions)) .doOnError(throwable -> System.err.printf("Failed to upload from file %s%n", throwable.getMessage())) .subscribe(completion -> System.out.println("Upload from file succeeded"));
- Overrides:
uploadFromFileWithResponse
in classBlobAsyncClient
- Parameters:
options
-BlobUploadFromFileOptions
- Returns:
- A reactive response containing the information of the uploaded block blob.
- Throws:
IllegalArgumentException
- IfblockSize
is less than 0 or greater than 4000 MBUncheckedIOException
- If an I/O error occurs
-
query
public Flux<ByteBuffer> query(String expression)
Unsupported. Cannot query data encrypted on client side.- Overrides:
query
in classBlobAsyncClientBase
-
queryWithResponse
public Mono<BlobQueryAsyncResponse> queryWithResponse(BlobQueryOptions queryOptions)
Unsupported. Cannot query data encrypted on client side.- Overrides:
queryWithResponse
in classBlobAsyncClientBase
-
-