Package com.azure.storage.common.sas

Class BaseSasQueryParameters

java.lang.Object
com.azure.storage.common.sas.BaseSasQueryParameters
Direct Known Subclasses:
AccountSasQueryParameters, BlobServiceSasQueryParameters, QueueServiceSasQueryParameters, ShareServiceSasQueryParameters
@Deprecated public abstract class BaseSasQueryParameters extends Object
Deprecated.
Please use the generateSas method on the desired client after initializing the appropriate SasSignatureValues 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 Details

    • version

      protected String version
      Deprecated.
      The Storage version.

    • protocol

      protected SasProtocol protocol
      Deprecated.
      The allowed HTTP/HTTPS protocols.

    • startTime

      protected OffsetDateTime startTime
      Deprecated.
      The start time for the SAS's validity.

    • expiryTime

      protected OffsetDateTime expiryTime
      Deprecated.
      The end time for the SAS's validity.

    • sasIpRange

      protected SasIpRange sasIpRange
      Deprecated.
      The IP range that the SAS validates.

    • permissions

      protected String permissions
      Deprecated.
      The permissions of the SAS.

    • signature

      protected String signature
      Deprecated.
      The signature of the SAS.

  • Constructor Details

    • 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 Details

    • 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 the SAS query parameters.