Package com.azure.storage.queue.sas

Class QueueServiceSasSignatureValues

java.lang.Object
com.azure.storage.queue.sas.QueueServiceSasSignatureValues
public final class QueueServiceSasSignatureValues extends Object
Used to initialize parameters for a Shared Access Signature (SAS) for an Azure Queue Storage service. Once all the values here are set, use the appropriate SAS generation method on the desired queue client to obtain a representation of the SAS which can then be applied to a new client using the .sasToken(String) method on the desired client builder.
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Gets the version of the service this SAS will target. If not specified, it will default to the version targeted by the library.
      Returns:
      the version of the service this SAS will target. If not specified, it will default to the version targeted by the library.

    • setVersion

      @Deprecated public QueueServiceSasSignatureValues setVersion(String version)
      Deprecated.
      The version is set to the latest version of sas. Users should stop calling this API as it is now treated as a no-op.
      Sets the version of the service this SAS will target. If not specified, it will default to the version targeted by the library.
      Parameters:
      version - Version to target
      Returns:
      the updated QueueServiceSasSignatureValues object

    • getProtocol

      public SasProtocol getProtocol()
      Gets the SasProtocol which determines the protocols allowed by the SAS.
      Returns:
      the SasProtocol which determines the protocols allowed by the SAS.

    • setProtocol

      public QueueServiceSasSignatureValues setProtocol(SasProtocol protocol)
      Sets the SasProtocol which determines the protocols allowed by the SAS.
      Parameters:
      protocol - Protocol for the SAS
      Returns:
      the updated QueueServiceSasSignatureValues object

    • getStartTime

      public OffsetDateTime getStartTime()
      Gets when the SAS will take effect.
      Returns:
      when the SAS will take effect.

    • setStartTime

      public QueueServiceSasSignatureValues setStartTime(OffsetDateTime startTime)
      Sets when the SAS will take effect.
      Parameters:
      startTime - When the SAS takes effect
      Returns:
      the updated QueueServiceSasSignatureValues object

    • getExpiryTime

      public OffsetDateTime getExpiryTime()
      Gets the time after which the SAS will no longer work.
      Returns:
      the time after which the SAS will no longer work.

    • setExpiryTime

      public QueueServiceSasSignatureValues setExpiryTime(OffsetDateTime expiryTime)
      Sets the time after which the SAS will no longer work.
      Parameters:
      expiryTime - When the SAS will no longer work
      Returns:
      the updated QueueServiceSasSignatureValues object

    • getPermissions

      public String getPermissions()
      Gets the permissions string allowed by the SAS. Please refer to QueueSasPermission for help determining the permissions allowed.
      Returns:
      the permissions string allowed by the SAS. Please refer to QueueSasPermission for help determining the permissions allowed.

    • setPermissions

      public QueueServiceSasSignatureValues setPermissions(QueueSasPermission permissions)
      Sets the permissions string allowed by the SAS. Please refer to QueueSasPermission for help constructing the permissions string.
      Parameters:
      permissions - Permissions for the SAS
      Returns:
      the updated QueueServiceSasSignatureValues object
      Throws:
      NullPointerException - if permissions is null.

    • getSasIpRange

      public SasIpRange getSasIpRange()
      Gets the SasIpRange which determines the IP ranges that are allowed to use the SAS.
      Returns:
      the SasIpRange which determines the IP ranges that are allowed to use the SAS.

    • setSasIpRange

      public QueueServiceSasSignatureValues setSasIpRange(SasIpRange sasIpRange)
      Sets the SasIpRange which determines the IP ranges that are allowed to use the SAS.
      Parameters:
      sasIpRange - Allowed IP range to set
      Returns:
      the updated QueueServiceSasSignatureValues object
      See Also:

    • getQueueName

      @Deprecated public String getQueueName()
      Deprecated.
      Queue name is now auto-populated by the SAS generation methods provided on the desired queue client.
      Gets the name of the queue this SAS may access.
      Returns:
      The name of the queue the SAS user may access.

    • setQueueName

      @Deprecated public QueueServiceSasSignatureValues setQueueName(String queueName)
      Deprecated.
      Please use the generateSas methods provided on the desired queue client that will auto-populate the queue name.
      Sets the name of the queue this SAS may access.
      Parameters:
      queueName - Canonical name of the object the SAS grants access
      Returns:
      the updated QueueServiceSasSignatureValues object

    • getId

      @Deprecated public String getId()
      Deprecated.
      Please use getIdentifier()
      Gets the name of the access policy on the queue this SAS references if any.
      Returns:
      the name of the access policy on the queue this SAS references if any. Please see here for more information.

    • getIdentifier

      public String getIdentifier()
      Sets the name of the access policy on the queue this SAS references if any.
      Returns:
      the name of the access policy on the queue this SAS references if any. Please see here for more information.

    • setIdentifier

      public QueueServiceSasSignatureValues setIdentifier(String identifier)
      Sets the name of the access policy on the queue this SAS references if any. Please see here for more information.
      Parameters:
      identifier - Name of the access policy
      Returns:
      the updated QueueServiceSasSignatureValues object

    • generateSasQueryParameters

      @Deprecated public QueueServiceSasQueryParameters generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)
      Deprecated.
      Please use the generateSas(QueueServiceSasSignatureValues) method on the desired queue client after initializing QueueServiceSasSignatureValues.
      Uses an account's shared key credential to sign these signature values to produce the proper SAS query parameters.

      Notes on SAS generation

      For samples, see class level JavaDocs.

      Parameters:
      storageSharedKeyCredentials - A StorageSharedKeyCredential object used to sign the SAS values.
      Returns:
      A new QueueServiceSasQueryParameters represented by the current builder.
      Throws:
      IllegalStateException - If the HMAC-SHA256 algorithm isn't supported, if the key isn't a valid Base64 encoded string, or the UTF-8 charset isn't supported.
      NullPointerException - If storageSharedKeyCredentials is null.