Package com.azure.storage.file.share.sas

Class ShareServiceSasSignatureValues

  • public final class ShareServiceSasSignatureValues
extends Object
    Used to initialize parameters for a Shared Access Signature (SAS) for an Azure File Storage service. Once all the values here are set, use the appropriate SAS generation method on the desired share/file/directory 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:
    Storage SAS overview, Constructing a Service SAS

    • Method Detail

      • getVersion

        public String getVersion()
        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 ShareServiceSasSignatureValues 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 FileServiceSasSignatureValues object

      • getProtocol

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

      • setProtocol

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

      • getStartTime

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

      • setStartTime

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

      • getExpiryTime

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

      • setExpiryTime

        public ShareServiceSasSignatureValues 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 FileServiceSasSignatureValues object

      • getPermissions

        public String getPermissions()
        Returns:
        the permissions string allowed by the SAS. Please refer to either ShareSasPermission or ShareFileSasPermission depending on the resource being accessed for help determining the permissions allowed.

      • setPermissions

        public ShareServiceSasSignatureValues setPermissions​(ShareSasPermission permissions)
        Sets the permissions allowed by the SAS. Share SASs are created when only share name is set on the builder.
        Parameters:
        permissions - Permissions for the share SAS.
        Returns:
        the updated FileServiceSasSignatureValues object.

      • getSasIpRange

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

      • getShareName

        @Deprecated
public String getShareName()
        Deprecated.
        Share name is now auto-populated by the SAS generation methods provided on the desired share/file/directory client.
        Gets the name of the share being made accessible.
        Returns:
        The name of the share being made accessible.

      • setShareName

        @Deprecated
public ShareServiceSasSignatureValues setShareName​(String shareName)
        Deprecated.
        Please use the generateSas methods provided on the desired share/file/directory client that will auto-populate the share name.
        Sets the name of the share being made accessible.
        Parameters:
        shareName - The name of the share being made accessible.
        Returns:
        the updated FileServiceSasSignatureValues object

      • getFilePath

        @Deprecated
public String getFilePath()
        Deprecated.
        File path is now auto-populated by the SAS generation methods provided on the desired file/directory client.
        Gets the path of the file or directory being made accessible. null or an empty string for a share SAS.
        Returns:
        The path of the file or directory being made accessible. null or an empty string for a share SAS.

      • setFilePath

        @Deprecated
public ShareServiceSasSignatureValues setFilePath​(String filePath)
        Deprecated.
        Please use the generateSas methods provided on the desired file/directory client that will auto-populate the file path.
        Sets the path of the file or directory being made accessible. Pass in null or an empty string for a share SAS.
        Parameters:
        filePath - The name of the share being made accessible.
        Returns:
        the updated FileServiceSasSignatureValues object

      • getCacheControl

        public String getCacheControl()
        Returns:
        the cache-control header for the SAS.

      • setCacheControl

        public ShareServiceSasSignatureValues setCacheControl​(String cacheControl)
        Sets the cache-control header for the SAS.
        Parameters:
        cacheControl - Cache-Control header value
        Returns:
        the updated FileServiceSasSignatureValues object

      • getContentDisposition

        public String getContentDisposition()
        Returns:
        the content-disposition header for the SAS.

      • setContentDisposition

        public ShareServiceSasSignatureValues setContentDisposition​(String contentDisposition)
        Sets the content-disposition header for the SAS.
        Parameters:
        contentDisposition - Content-Disposition header value
        Returns:
        the updated FileServiceSasSignatureValues object

      • getContentEncoding

        public String getContentEncoding()
        Returns:
        the content-encoding header for the SAS.

      • setContentEncoding

        public ShareServiceSasSignatureValues setContentEncoding​(String contentEncoding)
        Sets the content-encoding header for the SAS.
        Parameters:
        contentEncoding - Content-Encoding header value
        Returns:
        the updated FileServiceSasSignatureValues object

      • getContentLanguage

        public String getContentLanguage()
        Returns:
        the content-language header for the SAS.

      • setContentLanguage

        public ShareServiceSasSignatureValues setContentLanguage​(String contentLanguage)
        Sets the content-language header for the SAS.
        Parameters:
        contentLanguage - Content-Language header value
        Returns:
        the updated FileServiceSasSignatureValues object

      • getContentType

        public String getContentType()
        Returns:
        the content-type header for the SAS.

      • setContentType

        public ShareServiceSasSignatureValues setContentType​(String contentType)
        Sets the content-type header for the SAS.
        Parameters:
        contentType - Content-Type header value
        Returns:
        the updated FileServiceSasSignatureValues object