com.azure.storage.common.sas

Class BaseSasQueryParameters

java.lang.Object

com.azure.storage.common.sas.BaseSasQueryParameters

Direct Known Subclasses:

AccountSasQueryParameters

public abstract class BaseSasQueryParameters
extends Object

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 SASSignatureValues type. Once generated, it can be set on a ClientBuilder object to be constructed as part of a URL or it can be encoded into a 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.

Field Summary

Fields

Modifier and Type	Field and Description
protected OffsetDateTime	expiryTime
protected String	permissions
protected SasProtocol	protocol
protected SasIpRange	sasIpRange
protected String	signature
protected OffsetDateTime	startTime
protected String	version

Constructor Summary

Constructors

Constructor and Description
BaseSasQueryParameters(Map<String,String[]> queryParamsMap, boolean removeSASParametersFromMap) Creates a new BaseSasQueryParameters object.
BaseSasQueryParameters(String version, SasProtocol protocol, OffsetDateTime startTime, OffsetDateTime expiryTime, SasIpRange sasIpRange, String permissions, String signature) Creates a new BaseSasQueryParameters object.

Method Summary

Modifier and Type	Method and Description
abstract String	encode() Encodes all SAS query parameters into a string that can be appended to a URL.
protected String	formatQueryParameterDate(OffsetDateTime dateTime) Formats date time SAS query parameters.
OffsetDateTime	getExpiryTime()
String	getPermissions()
SasProtocol	getProtocol()
protected String	getQueryParameter(Map<String,String[]> parameters, String name, boolean remove) Helper method to get a query parameter
protected <T> T	getQueryParameter(Map<String,String[]> parameters, String name, boolean remove, Function<String,T> converter) Helper method to get a query parameter
SasIpRange	getSasIpRange()
String	getSignature()
OffsetDateTime	getStartTime()
String	getVersion()
protected void	tryAppendQueryParameter(StringBuilder sb, String param, Object value) Shared helper method to append a SAS query parameter.

Methods inherited from class java.lang.Object

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

Field Detail

version

protected String version

protocol

protected SasProtocol protocol

startTime

protected OffsetDateTime startTime

expiryTime

protected OffsetDateTime expiryTime

sasIpRange

protected SasIpRange sasIpRange

permissions

protected String permissions

signature

protected String signature

Constructor Detail

BaseSasQueryParameters

public BaseSasQueryParameters(Map<String,String[]> queryParamsMap,
                              boolean removeSASParametersFromMap)

Creates a new BaseSasQueryParameters object.

Parameters:

queryParamsMap - All query parameters for the request as key-value pairs

removeSASParametersFromMap - When true, the SAS query parameters will be removed from queryParamsMap

BaseSasQueryParameters

public BaseSasQueryParameters(String version,
                              SasProtocol protocol,
                              OffsetDateTime startTime,
                              OffsetDateTime expiryTime,
                              SasIpRange sasIpRange,
                              String permissions,
                              String signature)

Creates a new BaseSasQueryParameters object. These objects are only created internally by SASSignatureValues classes.

Parameters:

version - A String representing the storage version.

protocol - A String representing the allowed HTTP protocol(s) or null.

startTime - A java.util.Date representing the start time for this SAS token or null.

expiryTime - A java.util.Date representing the expiry time for this SAS token.

sasIpRange - A SasIpRange representing the range of valid IP addresses for this SAS token or null.

permissions - A String representing the storage permissions or null.

signature - A String representing the signature for the SAS token.

Method Detail

getQueryParameter

protected String getQueryParameter(Map<String,String[]> parameters,
                                   String name,
                                   boolean remove)

Helper method to get a query parameter

Parameters:

parameters - A Map of parameters to values to search.

name - The name of parameter to find.

remove - Whether or not to remove the parameter from the map.

Returns:

A String representing the query parameter

getQueryParameter

protected <T> T getQueryParameter(Map<String,String[]> parameters,
                                  String name,
                                  boolean remove,
                                  Function<String,T> converter)

Helper method to get a query parameter

Type Parameters:

T - The object type.

Parameters:

parameters - A Map of parameters to values to search.

name - The name of parameter to find.

remove - Whether or not to remove the parameter from the map.

converter - Function that transforms the value to a String.

Returns:

The object

getVersion

public String getVersion()

Returns:

The storage version

getProtocol

public SasProtocol getProtocol()

Returns:

The allowed HTTP protocol(s) or null. Please refer to SasProtocol for more details.

getStartTime

public OffsetDateTime getStartTime()

Returns:

The start time for this SAS token or null.

getExpiryTime

public OffsetDateTime getExpiryTime()

Returns:

The expiry time for this SAS token.

getSasIpRange

public SasIpRange getSasIpRange()

Returns:

SasIpRange

getPermissions

public String getPermissions()

Returns:

Please refer to *SASPermission classes for more details.

getSignature

public String getSignature()

Returns:

The signature for the SAS token.

tryAppendQueryParameter

protected void tryAppendQueryParameter(StringBuilder sb,
                                       String param,
                                       Object value)

Shared helper method to append a SAS query parameter.

Parameters:

sb - The StringBuilder to append to.

param - The String parameter to append.

value - The value of the parameter to append.

formatQueryParameterDate

protected String formatQueryParameterDate(OffsetDateTime dateTime)

Formats date time SAS query parameters.

Parameters:

dateTime - The SAS date time.

Returns:

A String representing the SAS date time.

encode

public abstract String encode()

Encodes all SAS query parameters into a string that can be appended to a URL.

Returns:

A String representing all SAS query parameters.