com.azure.storage.blob.BlobUrlParts Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-storage-blob Show documentation
Show all versions of azure-storage-blob Show documentation
This module contains client library for Microsoft Azure Blob Storage.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.storage.blob;
import com.azure.core.util.UrlBuilder;
import com.azure.core.util.CoreUtils;
import com.azure.core.util.logging.ClientLogger;
import com.azure.storage.blob.implementation.util.ModelHelper;
import com.azure.storage.blob.sas.BlobServiceSasQueryParameters;
import com.azure.storage.common.Utility;
import com.azure.storage.common.implementation.SasImplUtils;
import com.azure.storage.common.sas.CommonSasQueryParameters;
import com.azure.storage.common.implementation.Constants;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;
/**
* This class represents the components that make up an Azure Storage Container/Blob URL. You may parse an
* existing URL into its parts with the {@link #parse(URL)} class. You may construct a URL from parts by calling {@link
* #toUrl()}.
*/
public final class BlobUrlParts {
private static final ClientLogger LOGGER = new ClientLogger(BlobUrlParts.class);
private String scheme;
private String host;
private String containerName;
private String blobName;
private String snapshot;
private String versionId;
private String accountName;
private boolean isIpUrl;
private CommonSasQueryParameters commonSasQueryParameters;
private Map unparsedParameters;
/**
* Initializes a BlobUrlParts object which helps aid in the construction of a Blob Storage URL.
*/
public BlobUrlParts() {
unparsedParameters = new HashMap<>();
}
/**
* Gets the accountname, ex. "myaccountname".
*
* @return the account name.
*/
public String getAccountName() {
return accountName;
}
/**
* Sets the account name.
*
* @param accountName The account name.
* @return the updated BlobURLParts object.
*/
public BlobUrlParts setAccountName(String accountName) {
this.accountName = accountName;
return this;
}
/**
* Gets the URL scheme, ex. "https".
*
* @return the URL scheme.
*/
public String getScheme() {
return scheme;
}
/**
* Sets the URL scheme, ex. "https".
*
* @param scheme The URL scheme.
* @return the updated BlobUrlParts object.
*/
public BlobUrlParts setScheme(String scheme) {
this.scheme = scheme;
return this;
}
/**
* Gets the URL host, ex. "account.blob.core.windows.net" or "127.0.0.1:10000".
*
* @return the URL host.
*/
public String getHost() {
return host;
}
/**
* Sets the URL host, ex. "account.blob.core.windows.net" or "127.0.0.1:10000".
*
* @param host The URL host.
* @return the updated BlobUrlParts object.
*/
public BlobUrlParts setHost(String host) {
this.host = host;
try {
this.isIpUrl = ModelHelper.determineAuthorityIsIpStyle(host);
} catch (MalformedURLException e) {
throw LOGGER.logExceptionAsError(new IllegalStateException("Authority is malformed. Host: "
+ host, e));
}
return this;
}
/**
* Gets the container name that will be used as part of the URL path.
*
* @return the container name.
*/
public String getBlobContainerName() {
return containerName;
}
/**
* Sets the container name that will be used as part of the URL path.
*
* @param containerName The container nme.
* @return the updated BlobUrlParts object.
*/
public BlobUrlParts setContainerName(String containerName) {
this.containerName = containerName;
return this;
}
/**
* Decodes and gets the blob name that will be used as part of the URL path.
*
* @return the decoded blob name.
*/
public String getBlobName() {
return (blobName == null) ? null : Utility.urlDecode(blobName);
}
/**
* Sets the blob name that will be used as part of the URL path.
*
* @param blobName The blob name. If the blob name contains special characters, pass in the url encoded version
* of the blob name.
* @return the updated BlobUrlParts object.
*/
public BlobUrlParts setBlobName(String blobName) {
this.blobName = Utility.urlEncode(Utility.urlDecode(blobName));
return this;
}
/**
* Gets the snapshot identifier that will be used as part of the query string if set.
*
* @return the snapshot identifier.
*/
public String getSnapshot() {
return snapshot;
}
/**
* Sets the snapshot identifier that will be used as part of the query string if set.
*
* @param snapshot The snapshot identifier.
* @return the updated BlobUrlParts object.
*/
public BlobUrlParts setSnapshot(String snapshot) {
this.snapshot = snapshot;
return this;
}
/**
* Gets the version identifier that will be used as part of the query string if set.
*
* @return the version identifier.
*/
public String getVersionId() {
return versionId;
}
/**
* Sets the version identifier that will be used as part of the query string if set.
*
* @param versionId The version identifier.
* @return the updated BlobUrlParts object.
*/
public BlobUrlParts setVersionId(String versionId) {
this.versionId = versionId;
return this;
}
/**
* Gets the {@link BlobServiceSasQueryParameters} representing the SAS query parameters
*
* @return the {@link BlobServiceSasQueryParameters} of the URL
* @deprecated Please use {@link #getCommonSasQueryParameters()}
*/
@Deprecated
public BlobServiceSasQueryParameters getSasQueryParameters() {
String encodedSas = commonSasQueryParameters.encode();
return new BlobServiceSasQueryParameters(SasImplUtils.parseQueryString(encodedSas), true);
}
/**
* Sets the {@link BlobServiceSasQueryParameters} representing the SAS query parameters.
*
* @param blobServiceSasQueryParameters The SAS query parameters.
* @return the updated BlobUrlParts object.
* @deprecated Please use {@link #setCommonSasQueryParameters(CommonSasQueryParameters)}
*/
@Deprecated
public BlobUrlParts setSasQueryParameters(BlobServiceSasQueryParameters blobServiceSasQueryParameters) {
String encodedBlobSas = blobServiceSasQueryParameters.encode();
this.commonSasQueryParameters = new CommonSasQueryParameters(SasImplUtils.parseQueryString(encodedBlobSas),
true);
return this;
}
/**
* Gets the {@link CommonSasQueryParameters} representing the SAS query parameters that will be used to
* generate the SAS token for this URL.
*
* @return the {@link CommonSasQueryParameters} of the URL
*/
public CommonSasQueryParameters getCommonSasQueryParameters() {
return commonSasQueryParameters;
}
/**
* Sets the {@link CommonSasQueryParameters} representing the SAS query parameters that will be used to
* generate the SAS token for this URL.
*
* @param commonSasQueryParameters The SAS query parameters.
* @return the updated BlobUrlParts object.
*/
public BlobUrlParts setCommonSasQueryParameters(CommonSasQueryParameters commonSasQueryParameters) {
this.commonSasQueryParameters = commonSasQueryParameters;
return this;
}
/**
* Sets the {@link CommonSasQueryParameters} representing the SAS query parameters that will be used to
* generate the SAS token for this URL.
*
* @param queryParams The SAS query parameter string.
* @return the updated BlobUrlParts object.
*/
public BlobUrlParts parseSasQueryParameters(String queryParams) {
this.commonSasQueryParameters = new CommonSasQueryParameters(SasImplUtils.parseQueryString(queryParams), true);
return this;
}
/**
* Gets the query string parameters that aren't part of the SAS token that will be used by this URL.
*
* @return the non-SAS token query string values.
*/
public Map getUnparsedParameters() {
return unparsedParameters;
}
/**
* Sets the query string parameters that aren't part of the SAS token that will be used by this URL.
*
* @param unparsedParameters The non-SAS token query string values.
* @return the updated BlobUrlParts object.
*/
public BlobUrlParts setUnparsedParameters(Map unparsedParameters) {
this.unparsedParameters = unparsedParameters;
return this;
}
/**
* Converts the blob URL parts to a {@link URL}.
*
* @return A {@code URL} to the blob resource composed of all the elements in this object.
* @throws IllegalStateException The fields present on the BlobUrlParts object were insufficient to construct a
* valid URL or were ill-formatted.
*/
public URL toUrl() {
UrlBuilder url = new UrlBuilder().setScheme(this.scheme).setHost(this.host);
StringBuilder path = new StringBuilder();
if (CoreUtils.isNullOrEmpty(this.containerName) && this.blobName != null) {
this.containerName = BlobContainerAsyncClient.ROOT_CONTAINER_NAME;
}
if (this.isIpUrl) {
path.append(this.accountName);
}
if (this.containerName != null) {
path.append("/").append(this.containerName);
if (this.blobName != null) {
path.append("/").append(this.blobName);
}
}
url.setPath(path.toString());
if (this.snapshot != null) {
url.setQueryParameter(Constants.UrlConstants.SNAPSHOT_QUERY_PARAMETER, this.snapshot);
}
if (this.versionId != null) {
url.setQueryParameter(Constants.UrlConstants.VERSIONID_QUERY_PARAMETER, this.versionId);
}
if (this.commonSasQueryParameters != null) {
String encodedSAS = this.commonSasQueryParameters.encode();
if (encodedSAS.length() != 0) {
url.setQuery(encodedSAS);
}
}
for (Map.Entry entry : this.unparsedParameters.entrySet()) {
// The commas are intentionally encoded.
url.setQueryParameter(entry.getKey(),
Utility.urlEncode(String.join(",", entry.getValue())));
}
try {
return url.toUrl();
} catch (MalformedURLException ex) {
throw LOGGER.logExceptionAsError(new IllegalStateException("The URL parts created a malformed URL.", ex));
}
}
/**
* Parses a string into a BlobUrlParts.
*
* Query parameters will be parsed into two properties, {@link BlobServiceSasQueryParameters} which contains
* all SAS token related values and {@link #getUnparsedParameters() unparsedParameters} which is all other query
* parameters.
*
* If a URL points to a blob in the root container, and the root container is referenced implicitly, i.e. there
* is no path element for the container, the name of this blob in the root container will be set as the
* containerName field in the resulting {@code BlobURLParts}.
*
* @param url The {@code URL} to be parsed.
* @return A {@link BlobUrlParts} object containing all the components of a BlobURL.
* @throws IllegalArgumentException If {@code url} is a malformed {@link URL}.
*/
public static BlobUrlParts parse(String url) {
try {
return parse(new URL(url));
} catch (MalformedURLException e) {
throw new IllegalArgumentException("Invalid URL format. URL: " + url, e);
}
}
/**
* Parses an existing URL into a BlobUrlParts.
*
* Query parameters will be parsed into two properties, {@link BlobServiceSasQueryParameters} which contains
* all SAS token related values and {@link #getUnparsedParameters() unparsedParameters} which is all other query
* parameters.
*
* If a URL points to a blob in the root container, and the root container is referenced implicitly, i.e. there
* is no path element for the container, the name of this blob in the root container will be set as the
* containerName field in the resulting {@code BlobURLParts}.
*
* @param url The {@code URL} to be parsed.
* @return A {@link BlobUrlParts} object containing all the components of a BlobURL.
*/
public static BlobUrlParts parse(URL url) {
BlobUrlParts parts = new BlobUrlParts().setScheme(url.getProtocol());
try {
if (ModelHelper.determineAuthorityIsIpStyle(url.getAuthority())) {
parseIpUrl(url, parts);
} else {
parseNonIpUrl(url, parts);
}
} catch (MalformedURLException e) {
throw LOGGER.logExceptionAsError(new IllegalStateException("Authority is malformed. Host: "
+ url.getAuthority(), e));
}
Map queryParamsMap = SasImplUtils.parseQueryString(url.getQuery());
String[] snapshotArray = queryParamsMap.remove("snapshot");
if (snapshotArray != null) {
parts.setSnapshot(snapshotArray[0]);
}
String[] versionIdArray = queryParamsMap.remove("versionid");
if (versionIdArray != null) {
parts.setVersionId(versionIdArray[0]);
}
CommonSasQueryParameters commonSasQueryParameters = new CommonSasQueryParameters(queryParamsMap, true);
return parts.setCommonSasQueryParameters(commonSasQueryParameters)
.setUnparsedParameters(queryParamsMap);
}
/*
* Parse the IP url into its host, account name, container name, and blob name.
*/
private static void parseIpUrl(URL url, BlobUrlParts parts) {
parts.setHost(url.getAuthority());
parts.isIpUrl = true;
String path = url.getPath();
int previousIndex = 0;
if (!path.isEmpty() && path.charAt(0) == '/') {
previousIndex = 1;
}
int index = path.indexOf('/', previousIndex);
if (index == -1) {
// The entire path is the account name.
parts.setAccountName(path.substring(previousIndex));
return;
}
parts.setAccountName(path.substring(previousIndex, index));
previousIndex = index + 1;
index = path.indexOf('/', previousIndex);
if (index == -1) {
// Container name was the last part of the path, substring the rest of the path and return.
parts.setContainerName(path.substring(previousIndex));
return;
}
parts.setContainerName(path.substring(previousIndex, index));
parts.setBlobName(path.substring(index + 1));
}
/*
* Parse the non-IP url into its host, account name, container name, and blob name.
*/
private static void parseNonIpUrl(URL url, BlobUrlParts parts) {
String host = url.getHost();
parts.setHost(host);
//Parse host to get account name
// host will look like this : .blob.core.windows.net
if (!CoreUtils.isNullOrEmpty(host)) {
int accountNameIndex = host.indexOf('.');
if (accountNameIndex == -1) {
// host only contains account name
parts.setAccountName(host);
} else {
// if host is separated by .
parts.setAccountName(host.substring(0, accountNameIndex));
}
}
// find the container & blob names (if any)
String path = url.getPath();
if (!CoreUtils.isNullOrEmpty(path)) {
// if the path starts with a slash remove it
if (path.charAt(0) == '/') {
path = path.substring(1);
}
int containerEndIndex = path.indexOf('/');
if (containerEndIndex == -1) {
// path contains only a container name and no blob name
parts.setContainerName(path);
} else {
// path contains the container name up until the slash and blob name is everything after the slash
parts.setContainerName(path.substring(0, containerEndIndex));
parts.setBlobName(path.substring(containerEndIndex + 1));
}
}
parts.isIpUrl = false;
}
}