BlobContainerClientBuilder.java
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.storage.blob;
import com.azure.core.annotation.ServiceClientBuilder;
import com.azure.core.credential.TokenCredential;
import com.azure.core.http.HttpClient;
import com.azure.core.http.HttpPipeline;
import com.azure.core.http.HttpPipelinePosition;
import com.azure.core.http.policy.HttpLogOptions;
import com.azure.core.http.policy.HttpPipelinePolicy;
import com.azure.core.util.ClientOptions;
import com.azure.core.util.Configuration;
import com.azure.core.util.CoreUtils;
import com.azure.core.util.logging.ClientLogger;
import com.azure.storage.blob.implementation.models.EncryptionScope;
import com.azure.storage.blob.implementation.util.BuilderHelper;
import com.azure.storage.blob.models.BlobContainerEncryptionScope;
import com.azure.storage.blob.models.CpkInfo;
import com.azure.storage.blob.models.CustomerProvidedKey;
import com.azure.storage.common.StorageSharedKeyCredential;
import com.azure.storage.common.implementation.connectionstring.StorageAuthenticationSettings;
import com.azure.storage.common.implementation.connectionstring.StorageConnectionString;
import com.azure.storage.common.implementation.connectionstring.StorageEndpoint;
import com.azure.storage.common.implementation.credentials.SasTokenCredential;
import com.azure.storage.common.policy.RequestRetryOptions;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
/**
* This class provides a fluent builder API to help aid the configuration and instantiation of {@link
* BlobContainerClient BlobContainerClients} and {@link BlobContainerAsyncClient BlobContainerAsyncClients}, call
* {@link #buildClient() buildClient} and {@link #buildAsyncClient() buildAsyncClient} respectively to construct an
* instance of the desired client.
*
* <p>
* The following information must be provided on this builder:
*
* <ul>
* <li>the endpoint through {@code .endpoint()}, including the container name, in the format of {@code
* https://{accountName}.blob.core.windows.net/{containerName}}.
* <li>the credential through {@code .credential()} or {@code .connectionString()} if the container is not publicly
* accessible.
* </ul>
*/
@ServiceClientBuilder(serviceClients = {BlobContainerClient.class, BlobContainerAsyncClient.class})
public final class BlobContainerClientBuilder {
private final ClientLogger logger = new ClientLogger(BlobContainerClientBuilder.class);
private String endpoint;
private String accountName;
private String containerName;
private CpkInfo customerProvidedKey;
private EncryptionScope encryptionScope;
private BlobContainerEncryptionScope blobContainerEncryptionScope;
private StorageSharedKeyCredential storageSharedKeyCredential;
private TokenCredential tokenCredential;
private SasTokenCredential sasTokenCredential;
private HttpClient httpClient;
private final List<HttpPipelinePolicy> perCallPolicies = new ArrayList<>();
private final List<HttpPipelinePolicy> perRetryPolicies = new ArrayList<>();
private HttpLogOptions logOptions;
private RequestRetryOptions retryOptions = new RequestRetryOptions();
private HttpPipeline httpPipeline;
private ClientOptions clientOptions = new ClientOptions();
private Configuration configuration;
private BlobServiceVersion version;
/**
* Creates a builder instance that is able to configure and construct {@link BlobContainerClient ContainerClients}
* and {@link BlobContainerAsyncClient ContainerAsyncClients}.
*/
public BlobContainerClientBuilder() {
logOptions = getDefaultHttpLogOptions();
}
/**
* Creates a {@link BlobContainerClient} from the configured options.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.BlobContainerClientBuilder.buildClient}
*
* @return a {@link BlobContainerClient} created from the configurations in this builder.
*/
public BlobContainerClient buildClient() {
return new BlobContainerClient(buildAsyncClient());
}
/**
* Creates a {@link BlobContainerAsyncClient} from the configured options.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.BlobContainerClientBuilder.buildAsyncClient}
*
* @return a {@link BlobContainerAsyncClient} created from the configurations in this builder.
*/
public BlobContainerAsyncClient buildAsyncClient() {
BuilderHelper.httpsValidation(customerProvidedKey, "customer provided key", endpoint, logger);
if (Objects.nonNull(customerProvidedKey) && Objects.nonNull(encryptionScope)) {
throw logger.logExceptionAsError(new IllegalArgumentException("Customer provided key and encryption "
+ "scope cannot both be set"));
}
/*
Implicit and explicit root container access are functionally equivalent, but explicit references are easier
to read and debug.
*/
String blobContainerName = CoreUtils.isNullOrEmpty(containerName)
? BlobContainerAsyncClient.ROOT_CONTAINER_NAME
: containerName;
BlobServiceVersion serviceVersion = version != null ? version : BlobServiceVersion.getLatest();
HttpPipeline pipeline = (httpPipeline != null) ? httpPipeline : BuilderHelper.buildPipeline(
storageSharedKeyCredential, tokenCredential, sasTokenCredential, endpoint, retryOptions, logOptions,
clientOptions, httpClient, perCallPolicies, perRetryPolicies, configuration, logger);
return new BlobContainerAsyncClient(pipeline, String.format("%s/%s", endpoint, blobContainerName),
serviceVersion, accountName, blobContainerName, customerProvidedKey, encryptionScope,
blobContainerEncryptionScope);
}
/**
* Sets the service endpoint, additionally parses it for information (SAS token, container name)
*
* @param endpoint URL of the service
* @return the updated BlobContainerClientBuilder object
* @throws IllegalArgumentException If {@code endpoint} is {@code null} or is a malformed URL.
*/
public BlobContainerClientBuilder endpoint(String endpoint) {
try {
URL url = new URL(endpoint);
BlobUrlParts parts = BlobUrlParts.parse(url);
this.accountName = parts.getAccountName();
this.containerName = parts.getBlobContainerName();
this.endpoint = BuilderHelper.getEndpoint(parts);
String sasToken = parts.getCommonSasQueryParameters().encode();
if (!CoreUtils.isNullOrEmpty(sasToken)) {
this.sasToken(sasToken);
}
} catch (MalformedURLException ex) {
throw logger.logExceptionAsError(
new IllegalArgumentException("The Azure Storage Blob endpoint url is malformed."));
}
return this;
}
/**
* Sets the {@link CustomerProvidedKey customer provided key} that is used to encrypt blob contents on the server.
*
* @param customerProvidedKey Customer provided key containing the encryption key information.
* @return the updated BlobContainerClientBuilder object
*/
public BlobContainerClientBuilder customerProvidedKey(CustomerProvidedKey customerProvidedKey) {
if (customerProvidedKey == null) {
this.customerProvidedKey = null;
} else {
this.customerProvidedKey = new CpkInfo()
.setEncryptionKey(customerProvidedKey.getKey())
.setEncryptionKeySha256(customerProvidedKey.getKeySha256())
.setEncryptionAlgorithm(customerProvidedKey.getEncryptionAlgorithm());
}
return this;
}
/**
* Sets the {@code encryption scope} that is used to encrypt blob contents on the server.
*
* @param encryptionScope Encryption scope containing the encryption key information.
* @return the updated BlobContainerClientBuilder object
*/
public BlobContainerClientBuilder encryptionScope(String encryptionScope) {
if (encryptionScope == null) {
this.encryptionScope = null;
} else {
this.encryptionScope = new EncryptionScope().setEncryptionScope(encryptionScope);
}
return this;
}
/**
* Sets the {@link BlobContainerEncryptionScope encryption scope} that is used to determine how blob contents are
* encrypted on the server.
*
* @param blobContainerEncryptionScope Encryption scope containing the encryption key information.
* @return the updated BlobContainerClientBuilder object
*/
public BlobContainerClientBuilder blobContainerEncryptionScope(
BlobContainerEncryptionScope blobContainerEncryptionScope) {
this.blobContainerEncryptionScope = blobContainerEncryptionScope;
return this;
}
/**
* Sets the {@link StorageSharedKeyCredential} used to authorize requests sent to the service.
*
* @param credential {@link StorageSharedKeyCredential}.
* @return the updated BlobContainerClientBuilder
* @throws NullPointerException If {@code credential} is {@code null}.
*/
public BlobContainerClientBuilder credential(StorageSharedKeyCredential credential) {
this.storageSharedKeyCredential = Objects.requireNonNull(credential, "'credential' cannot be null.");
this.tokenCredential = null;
this.sasTokenCredential = null;
return this;
}
/**
* Sets the {@link TokenCredential} used to authorize requests sent to the service.
*
* @param credential {@link TokenCredential}.
* @return the updated BlobContainerClientBuilder
* @throws NullPointerException If {@code credential} is {@code null}.
*/
public BlobContainerClientBuilder credential(TokenCredential credential) {
this.tokenCredential = Objects.requireNonNull(credential, "'credential' cannot be null.");
this.storageSharedKeyCredential = null;
this.sasTokenCredential = null;
return this;
}
/**
* Sets the SAS token used to authorize requests sent to the service.
*
* @param sasToken The SAS token to use for authenticating requests.
* @return the updated BlobContainerClientBuilder
* @throws NullPointerException If {@code sasToken} is {@code null}.
*/
public BlobContainerClientBuilder sasToken(String sasToken) {
this.sasTokenCredential = new SasTokenCredential(Objects.requireNonNull(sasToken,
"'sasToken' cannot be null."));
this.storageSharedKeyCredential = null;
this.tokenCredential = null;
return this;
}
/**
* Clears the credential used to authorize the request.
*
* <p>This is for containers that are publicly accessible.</p>
*
* @return the updated BlobContainerClientBuilder
*/
public BlobContainerClientBuilder setAnonymousAccess() {
this.storageSharedKeyCredential = null;
this.tokenCredential = null;
this.sasTokenCredential = null;
return this;
}
/**
* Sets the connection string to connect to the service.
*
* @param connectionString Connection string of the storage account.
* @return the updated BlobContainerClientBuilder
* @throws IllegalArgumentException If {@code connectionString} in invalid.
*/
public BlobContainerClientBuilder connectionString(String connectionString) {
StorageConnectionString storageConnectionString
= StorageConnectionString.create(connectionString, logger);
StorageEndpoint endpoint = storageConnectionString.getBlobEndpoint();
if (endpoint == null || endpoint.getPrimaryUri() == null) {
throw logger
.logExceptionAsError(new IllegalArgumentException(
"connectionString missing required settings to derive blob service endpoint."));
}
this.endpoint(endpoint.getPrimaryUri());
if (storageConnectionString.getAccountName() != null) {
this.accountName = storageConnectionString.getAccountName();
}
StorageAuthenticationSettings authSettings = storageConnectionString.getStorageAuthSettings();
if (authSettings.getType() == StorageAuthenticationSettings.Type.ACCOUNT_NAME_KEY) {
this.credential(new StorageSharedKeyCredential(authSettings.getAccount().getName(),
authSettings.getAccount().getAccessKey()));
} else if (authSettings.getType() == StorageAuthenticationSettings.Type.SAS_TOKEN) {
this.sasToken(authSettings.getSasToken());
}
return this;
}
/**
* Sets the name of the container.
*
* @param containerName Name of the container. If the value {@code null} or empty the root container, {@code $root}
* , will be used.
* @return the updated BlobContainerClientBuilder object
*/
public BlobContainerClientBuilder containerName(String containerName) {
this.containerName = containerName;
return this;
}
/**
* Sets the {@link HttpClient} to use for sending a receiving requests to and from the service.
*
* @param httpClient HttpClient to use for requests.
* @return the updated BlobContainerClientBuilder object
*/
public BlobContainerClientBuilder httpClient(HttpClient httpClient) {
if (this.httpClient != null && httpClient == null) {
logger.info("'httpClient' is being set to 'null' when it was previously configured.");
}
this.httpClient = httpClient;
return this;
}
/**
* Adds a pipeline policy to apply on each request sent. The policy will be added after the retry policy. If
* the method is called multiple times, all policies will be added and their order preserved.
*
* @param pipelinePolicy a pipeline policy
* @return the updated BlobContainerClientBuilder object
* @throws NullPointerException If {@code pipelinePolicy} is {@code null}.
*/
public BlobContainerClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy) {
Objects.requireNonNull(pipelinePolicy, "'pipelinePolicy' cannot be null");
if (pipelinePolicy.getPipelinePosition() == HttpPipelinePosition.PER_CALL) {
perCallPolicies.add(pipelinePolicy);
} else {
perRetryPolicies.add(pipelinePolicy);
}
return this;
}
/**
* Sets the {@link HttpLogOptions} for service requests.
*
* @param logOptions The logging configuration to use when sending and receiving HTTP requests/responses.
* @return the updated BlobContainerClientBuilder object
* @throws NullPointerException If {@code logOptions} is {@code null}.
*/
public BlobContainerClientBuilder httpLogOptions(HttpLogOptions logOptions) {
this.logOptions = Objects.requireNonNull(logOptions, "'logOptions' cannot be null.");
return this;
}
/**
* Gets the default Storage whitelist log headers and query parameters.
*
* @return the default http log options.
*/
public static HttpLogOptions getDefaultHttpLogOptions() {
return BuilderHelper.getDefaultHttpLogOptions();
}
/**
* Sets the configuration object used to retrieve environment configuration values during building of the client.
*
* @param configuration Configuration store used to retrieve environment configurations.
* @return the updated BlobContainerClientBuilder object
*/
public BlobContainerClientBuilder configuration(Configuration configuration) {
this.configuration = configuration;
return this;
}
/**
* Sets the request retry options for all the requests made through the client.
*
* @param retryOptions {@link RequestRetryOptions}.
* @return the updated BlobContainerClientBuilder object
* @throws NullPointerException If {@code retryOptions} is {@code null}.
*/
public BlobContainerClientBuilder retryOptions(RequestRetryOptions retryOptions) {
this.retryOptions = Objects.requireNonNull(retryOptions, "'retryOptions' cannot be null.");
return this;
}
/**
* Sets the client options for all the requests made through the client.
*
* @param clientOptions {@link ClientOptions}.
* @return the updated BlobContainerClientBuilder object
* @throws NullPointerException If {@code clientOptions} is {@code null}.
*/
public BlobContainerClientBuilder clientOptions(ClientOptions clientOptions) {
this.clientOptions = Objects.requireNonNull(clientOptions, "'clientOptions' cannot be null.");
return this;
}
/**
* Sets the {@link HttpPipeline} to use for the service client.
*
* If {@code pipeline} is set, all other settings are ignored, aside from {@link #endpoint(String) endpoint}.
*
* @param httpPipeline HttpPipeline to use for sending service requests and receiving responses.
* @return the updated BlobContainerClientBuilder object
*/
public BlobContainerClientBuilder pipeline(HttpPipeline httpPipeline) {
if (this.httpPipeline != null && httpPipeline == null) {
logger.info("HttpPipeline is being set to 'null' when it was previously configured.");
}
this.httpPipeline = httpPipeline;
return this;
}
/**
* Sets the {@link BlobServiceVersion} that is used when making API requests.
* <p>
* If a service version is not provided, the service version that will be used will be the latest known service
* version based on the version of the client library being used. If no service version is specified, updating to a
* newer version of the client library will have the result of potentially moving to a newer service version.
* <p>
* Targeting a specific service version may also mean that the service will return an error for newer APIs.
*
* @param version {@link BlobServiceVersion} of the service to be used when making requests.
* @return the updated BlobContainerClientBuilder object
*/
public BlobContainerClientBuilder serviceVersion(BlobServiceVersion version) {
this.version = version;
return this;
}
}