com.microsoft.azure.storage.blob.SASQueryParameters 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
The Azure Storage Java Blob library.
/*
* Copyright Microsoft Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.microsoft.azure.storage.blob;
import java.net.UnknownHostException;
import java.time.OffsetDateTime;
import java.util.Map;
import static com.microsoft.azure.storage.blob.Utility.safeURLEncode;
/**
* Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly
* by the user; it is only generated by the {@link AccountSASSignatureValues} and {@link ServiceSASSignatureValues}
* types. Once generated, it can be set on a {@link BlobURLParts} object to be constructed as part of a URL or it can
* be encoded into a {@code String} and appended to a URL directly (though caution should be taken here in case there
* are existing query parameters, which might affect the appropriate means of appending these query parameters).
* NOTE: Instances of this class are immutable to ensure thread safety.
*/
public final class SASQueryParameters {
private final String version;
private final String services;
private final String resourceTypes;
private final SASProtocol protocol;
private final OffsetDateTime startTime;
private final OffsetDateTime expiryTime;
private final IPRange ipRange;
private final String identifier;
private final String resource;
private final String permissions;
private final String signature;
private final String cacheControl;
private final String contentDisposition;
private final String contentEncoding;
private final String contentLanguage;
private final String contentType;
/**
* Creates a new {@link SASQueryParameters} object.
*
* @param queryParamsMap
* All query parameters for the request as key-value pairs
* @param removeSASParametersFromMap
* When {@code true}, the SAS query parameters will be removed from queryParamsMap
*/
SASQueryParameters(Map queryParamsMap, boolean removeSASParametersFromMap)
throws UnknownHostException {
String[] queryValue = queryParamsMap.get("sv");
if (queryValue != null) {
this.version = queryValue[0];
if (removeSASParametersFromMap) {
queryParamsMap.remove("sv");
}
} else {
this.version = null;
}
queryValue = queryParamsMap.get("ss");
if (queryValue != null) {
this.services = queryValue[0];
if (removeSASParametersFromMap) {
queryParamsMap.remove("ss");
}
} else {
this.services = null;
}
queryValue = queryParamsMap.get("srt");
if (queryValue != null) {
this.resourceTypes = queryValue[0];
if (removeSASParametersFromMap) {
queryParamsMap.remove("srt");
}
} else {
this.resourceTypes = null;
}
queryValue = queryParamsMap.get("spr");
if (queryValue != null) {
this.protocol = SASProtocol.parse(queryValue[0]);
if (removeSASParametersFromMap) {
queryParamsMap.remove("spr");
}
} else {
this.protocol = null;
}
queryValue = queryParamsMap.get("st");
if (queryValue != null) {
this.startTime = Utility.parseDate(queryValue[0]);
if (removeSASParametersFromMap) {
queryParamsMap.remove("st");
}
} else {
this.startTime = null;
}
queryValue = queryParamsMap.get("se");
if (queryValue != null) {
this.expiryTime = Utility.parseDate(queryValue[0]);
if (removeSASParametersFromMap) {
queryParamsMap.remove("se");
}
} else {
this.expiryTime = null;
}
queryValue = queryParamsMap.get("sip");
if (queryValue != null) {
this.ipRange = IPRange.parse(queryValue[0]);
if (removeSASParametersFromMap) {
queryParamsMap.remove("sip");
}
} else {
this.ipRange = null;
}
queryValue = queryParamsMap.get("si");
if (queryValue != null) {
this.identifier = queryValue[0];
if (removeSASParametersFromMap) {
queryParamsMap.remove("si");
}
} else {
this.identifier = null;
}
queryValue = queryParamsMap.get("sr");
if (queryValue != null) {
this.resource = queryValue[0];
if (removeSASParametersFromMap) {
queryParamsMap.remove("sr");
}
} else {
this.resource = null;
}
queryValue = queryParamsMap.get("sp");
if (queryValue != null) {
this.permissions = queryValue[0];
if (removeSASParametersFromMap) {
queryParamsMap.remove("sp");
}
} else {
this.permissions = null;
}
queryValue = queryParamsMap.get("sig");
if (queryValue != null) {
this.signature = queryValue[0];
if (removeSASParametersFromMap) {
queryParamsMap.remove("sig");
}
} else {
this.signature = null;
}
queryValue = queryParamsMap.get("rscc");
if (queryValue != null) {
this.cacheControl = queryValue[0];
if (removeSASParametersFromMap) {
queryParamsMap.remove("rscc");
}
} else {
this.cacheControl = null;
}
queryValue = queryParamsMap.get("rscd");
if (queryValue != null) {
this.contentDisposition = queryValue[0];
if (removeSASParametersFromMap) {
queryParamsMap.remove("rscd");
}
} else {
this.contentDisposition = null;
}
queryValue = queryParamsMap.get("rsce");
if (queryValue != null) {
this.contentEncoding = queryValue[0];
if (removeSASParametersFromMap) {
queryParamsMap.remove("rsce");
}
} else {
this.contentEncoding = null;
}
queryValue = queryParamsMap.get("rscl");
if (queryValue != null) {
this.contentLanguage = queryValue[0];
if (removeSASParametersFromMap) {
queryParamsMap.remove("rscl");
}
} else {
this.contentLanguage = null;
}
queryValue = queryParamsMap.get("rsct");
if (queryValue != null) {
this.contentType = queryValue[0];
if (removeSASParametersFromMap) {
queryParamsMap.remove("rsct");
}
} else {
this.contentType = null;
}
}
/**
* Creates a new {@link SASQueryParameters} object. These objects are only created internally by
* *SASSignatureValues classes.
*
* @param version
* A {@code String} representing the storage version.
* @param services
* A {@code String} representing the storage services being accessed (only for Account SAS).
* @param resourceTypes
* A {@code String} representing the storage resource types being accessed (only for Account SAS).
* @param protocol
* A {@code String} representing the allowed HTTP protocol(s) or {@code null}.
* @param startTime
* A {@code java.util.Date} representing the start time for this SAS token or {@code null}.
* @param expiryTime
* A {@code java.util.Date} representing the expiry time for this SAS token.
* @param ipRange
* A {@link IPRange} representing the range of valid IP addresses for this SAS token or {@code null}.
* @param identifier
* A {@code String} representing the signed identifier (only for Service SAS) or {@code null}.
* @param resource
* A {@code String} representing the storage container or blob (only for Service SAS).
* @param permissions
* A {@code String} representing the storage permissions or {@code null}.
* @param signature
* A {@code String} representing the signature for the SAS token.
*/
SASQueryParameters(String version, String services, String resourceTypes, SASProtocol protocol,
OffsetDateTime startTime, OffsetDateTime expiryTime, IPRange ipRange, String identifier,
String resource, String permissions, String signature, String cacheControl, String contentDisposition,
String contentEncoding, String contentLanguage, String contentType) {
this.version = version;
this.services = services;
this.resourceTypes = resourceTypes;
this.protocol = protocol;
this.startTime = startTime;
this.expiryTime = expiryTime;
this.ipRange = ipRange;
this.identifier = identifier;
this.resource = resource;
this.permissions = permissions;
this.signature = signature;
this.cacheControl = cacheControl;
this.contentDisposition = contentDisposition;
this.contentEncoding = contentEncoding;
this.contentLanguage = contentLanguage;
this.contentType = contentType;
}
/**
* @return The storage version
*/
public String version() {
return version;
}
/**
* @return The storage services being accessed (only for Account SAS). Please refer to {@link AccountSASService} for
* more details.
*/
public String services() {
return services;
}
/**
* @return The storage resource types being accessed (only for Account SAS). Please refer to
* {@link AccountSASResourceType} for more details.
*/
public String resourceTypes() {
return resourceTypes;
}
/**
* @return The allowed HTTP protocol(s) or {@code null}. Please refer to {@link SASProtocol} for more details.
*/
public SASProtocol protocol() {
return protocol;
}
/**
* @return The start time for this SAS token or {@code null}.
*/
public OffsetDateTime startTime() {
return startTime;
}
/**
* @return The expiry time for this SAS token.
*/
public OffsetDateTime expiryTime() {
return expiryTime;
}
/**
* @return {@link IPRange}
*/
public IPRange ipRange() {
return ipRange;
}
/**
* @return The signed identifier (only for {@link ServiceSASSignatureValues}) or {@code null}. Please see
* here
* for more information.
*/
public String identifier() {
return identifier;
}
/**
* @return The storage container or blob (only for {@link ServiceSASSignatureValues}).
*/
public String resource() {
return resource;
}
/**
* @return Please refer to {@link AccountSASPermission}, {@link BlobSASPermission}, or {@link ContainerSASPermission}
* for more details.
*/
public String permissions() {
return permissions;
}
/**
* @return The signature for the SAS token.
*/
public String signature() {
return signature;
}
/**
* @return The Cache-Control header value when a client accesses the resource with this sas token.
*/
public String cacheControl() {
return cacheControl;
}
/**
* @return The Content-Disposition header value when a client accesses the resource with this sas token.
*/
public String contentDisposition() {
return contentDisposition;
}
/**
* @return The Content-Encoding header value when a client accesses the resource with this sas token.
*/
public String contentEncoding() {
return contentEncoding;
}
/**
* @return The Content-Language header value when a client accesses the resource with this sas token.
*/
public String contentLanguage() {
return contentLanguage;
}
/**
* @return The Content-Type header value when a client accesses the resource with this sas token.
*/
public String contentType() {
return contentType;
}
private void tryAppendQueryParameter(StringBuilder sb, String param, Object value) {
if (value != null) {
if (sb.length() == 0) {
sb.append('?');
} else {
sb.append('&');
}
sb.append(safeURLEncode(param)).append('=').append(safeURLEncode(value.toString()));
}
}
/**
* Encodes all SAS query parameters into a string that can be appended to a URL.
*
* @return A {@code String} representing all SAS query parameters.
*/
public String encode() {
/*
We should be url-encoding each key and each value, but because we know all the keys and values will encode to
themselves, we cheat except for the signature value.
*/
String[] params = {"sv", "ss", "srt", "spr", "st", "se", "sip", "si", "sr", "sp", "sig", "rscc", "rscd", "rsce",
"rscl", "rsct"};
StringBuilder sb = new StringBuilder();
for (String param : params) {
switch (param) {
case "sv":
tryAppendQueryParameter(sb, param, this.version);
break;
case "ss":
tryAppendQueryParameter(sb, param, this.services);
break;
case "srt":
tryAppendQueryParameter(sb, param, this.resourceTypes);
break;
case "spr":
tryAppendQueryParameter(sb, param, this.protocol);
break;
case "st":
tryAppendQueryParameter(sb, param,
this.startTime == null ? null : Utility.ISO8601UTCDateFormatter.format(this.startTime));
break;
case "se":
tryAppendQueryParameter(sb, param,
this.expiryTime == null ? null : Utility.ISO8601UTCDateFormatter.format(this.expiryTime));
break;
case "sip":
tryAppendQueryParameter(sb, param, this.ipRange);
break;
case "si":
tryAppendQueryParameter(sb, param, this.identifier);
break;
case "sr":
tryAppendQueryParameter(sb, param, this.resource);
break;
case "sp":
tryAppendQueryParameter(sb, param, this.permissions);
break;
case "sig":
tryAppendQueryParameter(sb, param, this.signature);
break;
case "rscc":
tryAppendQueryParameter(sb, param, this.cacheControl);
break;
case "rscd":
tryAppendQueryParameter(sb, param, this.contentDisposition);
break;
case "rsce":
tryAppendQueryParameter(sb, param, this.contentEncoding);
break;
case "rscl":
tryAppendQueryParameter(sb, param, this.contentLanguage);
break;
case "rsct":
tryAppendQueryParameter(sb, param, this.contentType);
break;
}
}
return sb.toString();
}
}