com.azure.storage.common.sas

Class BaseSasQueryParameters

java.lang.Object

com.azure.storage.common.sas.BaseSasQueryParameters

Direct Known Subclasses:

AccountSasQueryParameters

Deprecated.

Please use the generateSas method on the desired client after initializing the appropriate SasSignatureValues object.

@Deprecated
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 Deprecated.
protected String	permissions Deprecated.
protected SasProtocol	protocol Deprecated.
protected SasIpRange	sasIpRange Deprecated.
protected String	signature Deprecated.
protected OffsetDateTime	startTime Deprecated.
protected String	version Deprecated.

Constructor Summary

Constructors

Constructor and Description
BaseSasQueryParameters(Map<String,String[]> queryParamsMap, boolean removeSASParametersFromMap) Deprecated. Please use SasSignatureValues
BaseSasQueryParameters(String version, SasProtocol protocol, OffsetDateTime startTime, OffsetDateTime expiryTime, SasIpRange sasIpRange, String permissions, String signature) Deprecated. Please use SasSignatureValues

Method Summary

Modifier and Type	Method and Description
abstract String	encode() Deprecated. Please use the generateSas method on the desired client after initializing the appropriate SasSignatureValues object.
protected String	formatQueryParameterDate(OffsetDateTime dateTime) Deprecated. Please use SasSignatureValues
OffsetDateTime	getExpiryTime() Deprecated. Please use SasSignatureValues
String	getPermissions() Deprecated. Please use SasSignatureValues
SasProtocol	getProtocol() Deprecated. Please use SasSignatureValues
protected String	getQueryParameter(Map<String,String[]> parameters, String name, boolean remove) Deprecated. Please use SasSignatureValues
protected <T> T	getQueryParameter(Map<String,String[]> parameters, String name, boolean remove, Function<String,T> converter) Deprecated. Please use SasSignatureValues
SasIpRange	getSasIpRange() Deprecated. Please use SasSignatureValues
String	getSignature() Deprecated. Please use SasSignatureValues
OffsetDateTime	getStartTime() Deprecated. Please use SasSignatureValues
String	getVersion() Deprecated. Please use SasSignatureValues
protected void	tryAppendQueryParameter(StringBuilder sb, String param, Object value) Deprecated. Please use SasSignatureValues

Methods inherited from class java.lang.Object

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

Field Detail

version

protected String version

Deprecated.

protocol

protected SasProtocol protocol

Deprecated.

startTime

protected OffsetDateTime startTime

Deprecated.

expiryTime

protected OffsetDateTime expiryTime

Deprecated.

sasIpRange

protected SasIpRange sasIpRange

Deprecated.

permissions

protected String permissions

Deprecated.

signature

protected String signature

Deprecated.

Constructor Detail

BaseSasQueryParameters

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

Deprecated. Please use SasSignatureValues

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

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

Deprecated. Please use SasSignatureValues

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

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

Deprecated. Please use SasSignatureValues

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

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

Deprecated. Please use SasSignatureValues

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

@Deprecated
public String getVersion()

Deprecated. Please use SasSignatureValues

Returns:

The storage version

getProtocol

@Deprecated
public SasProtocol getProtocol()

Deprecated. Please use SasSignatureValues

Returns:

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

getStartTime

@Deprecated
public OffsetDateTime getStartTime()

Deprecated. Please use SasSignatureValues

Returns:

The start time for this SAS token or null.

getExpiryTime

@Deprecated
public OffsetDateTime getExpiryTime()

Deprecated. Please use SasSignatureValues

Returns:

The expiry time for this SAS token.

getSasIpRange

@Deprecated
public SasIpRange getSasIpRange()

Deprecated. Please use SasSignatureValues

Returns:

SasIpRange

getPermissions

@Deprecated
public String getPermissions()

Deprecated. Please use SasSignatureValues

Returns:

Please refer to *SASPermission classes for more details.

getSignature

@Deprecated
public String getSignature()

Deprecated. Please use SasSignatureValues

Returns:

The signature for the SAS token.

tryAppendQueryParameter

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

Deprecated. Please use SasSignatureValues

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

@Deprecated
protected String formatQueryParameterDate(OffsetDateTime dateTime)

Deprecated. Please use SasSignatureValues

Formats date time SAS query parameters.

Parameters:

dateTime - The SAS date time.

Returns:

A String representing the SAS date time.

encode

@Deprecated
public abstract String encode()

Deprecated. Please use the generateSas method on the desired client after initializing the appropriate SasSignatureValues object.

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

Returns:

A String representing all SAS query parameters.