Package com.github.ambry.cloud.azure

Class ADAuthBasedStorageClient

java.lang.Object

com.github.ambry.cloud.azure.StorageClient

com.github.ambry.cloud.azure.ADAuthBasedStorageClient

public class ADAuthBasedStorageClient
extends StorageClient

StorageClient implementation for AD based authentication.

Field Summary

Fields inherited from class com.github.ambry.cloud.azure.StorageClient

azureMetrics

Constructor Summary

Constructors

Constructor	Description
ADAuthBasedStorageClient(com.azure.storage.blob.BlobServiceClient blobServiceClient, com.azure.storage.blob.batch.BlobBatchClient blobBatchClient, AzureMetrics azureMetrics, AzureBlobLayoutStrategy blobLayoutStrategy)	Constructor for ADAuthBasedStorageClient object for testing.
ADAuthBasedStorageClient(com.github.ambry.config.CloudConfig cloudConfig, AzureCloudConfig azureCloudConfig, AzureMetrics azureMetrics, AzureBlobLayoutStrategy blobLayoutStrategy)	Constructor for ADAuthBasedStorageClient object.

Method Summary

Modifier and Type	Method	Description
protected com.azure.storage.blob.BlobServiceClient	buildBlobServiceClient(com.azure.core.http.HttpClient httpClient, com.azure.core.util.Configuration configuration, com.azure.storage.common.policy.RequestRetryOptions retryOptions, AzureCloudConfig azureCloudConfig)	Build BlobServiceClient.
protected boolean	handleExceptionAndHintRetry(com.azure.storage.blob.models.BlobStorageException blobStorageException)	Check if the exception can be handled and return a flag indicating if it can be retried.
protected void	validateABSAuthConfigs(AzureCloudConfig azureCloudConfig)	Validate that all the required configs for ABS authentication are present.

Methods inherited from class com.github.ambry.cloud.azure.StorageClient

createBlobStorageClient, deleteBatch, downloadWithResponse, getPropertiesWithResponse, getStorageClient, setClientReferences, setMetadataWithResponse, uploadWithResponse, uploadWithResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ADAuthBasedStorageClient

public ADAuthBasedStorageClient(com.github.ambry.config.CloudConfig cloudConfig,
                                AzureCloudConfig azureCloudConfig,
                                AzureMetrics azureMetrics,
                                AzureBlobLayoutStrategy blobLayoutStrategy)

Constructor for ADAuthBasedStorageClient object.

Parameters:

cloudConfig - CloudConfig object.

azureCloudConfig - AzureCloudConfig object.

azureMetrics - AzureMetrics object.

blobLayoutStrategy - AzureBlobLayoutStrategy object.

ADAuthBasedStorageClient

public ADAuthBasedStorageClient(com.azure.storage.blob.BlobServiceClient blobServiceClient,
                                com.azure.storage.blob.batch.BlobBatchClient blobBatchClient,
                                AzureMetrics azureMetrics,
                                AzureBlobLayoutStrategy blobLayoutStrategy)

Constructor for ADAuthBasedStorageClient object for testing.

Parameters:

blobServiceClient - BlobServiceClient object.

blobBatchClient - BlobBatchClient object.

azureMetrics - AzureMetrics object.

blobLayoutStrategy - AzureBlobLayoutStrategy object.

Method Detail

buildBlobServiceClient

protected com.azure.storage.blob.BlobServiceClient buildBlobServiceClient(com.azure.core.http.HttpClient httpClient,
                                                                          com.azure.core.util.Configuration configuration,
                                                                          com.azure.storage.common.policy.RequestRetryOptions retryOptions,
                                                                          AzureCloudConfig azureCloudConfig)
                                                                   throws java.net.MalformedURLException,
                                                                          java.lang.InterruptedException,
                                                                          java.util.concurrent.ExecutionException

Description copied from class: StorageClient

Build BlobServiceClient.

Specified by:

buildBlobServiceClient in class StorageClient

Parameters:

httpClient - HttpClient object.

configuration - Configuration object.

retryOptions - RetryOptions object.

azureCloudConfig - AzureCloudConfig object.

Returns:

BlobServiceClient object.

Throws:

java.net.MalformedURLException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

validateABSAuthConfigs

protected void validateABSAuthConfigs(AzureCloudConfig azureCloudConfig)

Description copied from class: StorageClient

Validate that all the required configs for ABS authentication are present.

Specified by:

validateABSAuthConfigs in class StorageClient

Parameters:

azureCloudConfig - AzureCloudConfig object.

handleExceptionAndHintRetry

protected boolean handleExceptionAndHintRetry(com.azure.storage.blob.models.BlobStorageException blobStorageException)

Description copied from class: StorageClient

Check if the exception can be handled and return a flag indicating if it can be retried. Note that if this method changes state of this class, then it should do it in a thread safe way.

Specified by:

handleExceptionAndHintRetry in class StorageClient

Parameters:

blobStorageException - BlobStorageException object.

Returns:

true if the operation can be retried. false otherwise.