Package com.azure.storage.blob.sas

Class BlobContainerSasPermission

  • public final class BlobContainerSasPermission
extends Object
    This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a container. Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation. It is possible to construct the permissions string without this class, but the order of the permissions is particular and this class guarantees correctness.

    • Constructor Detail

      • BlobContainerSasPermission

        public BlobContainerSasPermission()
        Initializes an BlobContainerSasPermission object with all fields set to false.

    • Method Detail

      • parse

        public static BlobContainerSasPermission parse​(String permissionString)
        Creates an BlobContainerSasPermission from the specified permissions string. This method will throw an IllegalArgumentException if it encounters a character that does not correspond to a valid permission.
        Parameters:
        permissionString - A String which represents the BlobContainerSasPermission.
        Returns:
        A BlobContainerSasPermission generated from the given String.
        Throws:
        IllegalArgumentException - If permString contains a character other than r, a, c, w, d, x, l, t or i.

      • hasReadPermission

        public boolean hasReadPermission()
        Returns:
        the read permission status

      • setReadPermission

        public BlobContainerSasPermission setReadPermission​(boolean hasReadPermission)
        Sets the read permission status.
        Parameters:
        hasReadPermission - Permission status to set
        Returns:
        the updated BlobContainerSasPermission object

      • hasAddPermission

        public boolean hasAddPermission()
        Returns:
        the add permission status

      • setAddPermission

        public BlobContainerSasPermission setAddPermission​(boolean hasAddPermission)
        Sets the add permission status.
        Parameters:
        hasAddPermission - Permission status to set
        Returns:
        the updated BlobContainerSasPermission object

      • hasCreatePermission

        public boolean hasCreatePermission()
        Returns:
        the create permission status

      • setCreatePermission

        public BlobContainerSasPermission setCreatePermission​(boolean hasCreatePermission)
        Sets the create permission status.
        Parameters:
        hasCreatePermission - Permission status to set
        Returns:
        the updated BlobContainerSasPermission object

      • hasWritePermission

        public boolean hasWritePermission()
        Returns:
        the write permission status

      • setWritePermission

        public BlobContainerSasPermission setWritePermission​(boolean hasWritePermission)
        Sets the write permission status.
        Parameters:
        hasWritePermission - Permission status to set
        Returns:
        the updated BlobContainerSasPermission object

      • hasDeletePermission

        public boolean hasDeletePermission()
        Returns:
        the delete permission status

      • setDeletePermission

        public BlobContainerSasPermission setDeletePermission​(boolean hasDeletePermission)
        Sets the delete permission status.
        Parameters:
        hasDeletePermission - Permission status to set
        Returns:
        the updated BlobContainerSasPermission object

      • hasDeleteVersionPermission

        public boolean hasDeleteVersionPermission()
        Returns:
        the delete version permission status

      • setDeleteVersionPermission

        public BlobContainerSasPermission setDeleteVersionPermission​(boolean hasDeleteVersionPermission)
        Sets the delete version permission status.
        Parameters:
        hasDeleteVersionPermission - Permission status to set
        Returns:
        the updated BlobContainerSasPermission object

      • hasListPermission

        public boolean hasListPermission()
        Returns:
        the list permission status

      • setListPermission

        public BlobContainerSasPermission setListPermission​(boolean hasListPermission)
        Sets the list permission status.
        Parameters:
        hasListPermission - Permission status to set
        Returns:
        the updated BlobContainerSasPermission object

      • hasTagsPermission

        public boolean hasTagsPermission()
        Returns:
        the tags permission status.

      • setTagsPermission

        public BlobContainerSasPermission setTagsPermission​(boolean tagsPermission)
        Sets the tags permission status.
        Parameters:
        tagsPermission - Permission status to set
        Returns:
        the updated BlobContainerSasPermission object.

      • hasMovePermission

        public boolean hasMovePermission()
        Returns:
        the move permission status.

      • setMovePermission

        public BlobContainerSasPermission setMovePermission​(boolean hasMovePermission)
        Sets the move permission status.
        Parameters:
        hasMovePermission - Permission status to set
        Returns:
        the updated BlobContainerSasPermission object.

      • hasExecutePermission

        public boolean hasExecutePermission()
        Returns:
        the execute permission status.

      • setExecutePermission

        public BlobContainerSasPermission setExecutePermission​(boolean hasExecutePermission)
        Sets the execute permission status.
        Parameters:
        hasExecutePermission - Permission status to set
        Returns:
        the updated BlobContainerSasPermission object.

      • hasFilterPermission

        public boolean hasFilterPermission()
        Returns:
        the filter permission status.

      • setFilterPermission

        public BlobContainerSasPermission setFilterPermission​(boolean hasFilterPermission)
        Sets the filter permission status.
        Parameters:
        hasFilterPermission - Permission status to set
        Returns:
        the updated BlobSasPermission object.

      • hasImmutabilityPolicyPermission

        public boolean hasImmutabilityPolicyPermission()
        Returns:
        the set immutability policy permission status.

      • setImmutabilityPolicyPermission

        public BlobContainerSasPermission setImmutabilityPolicyPermission​(boolean immutabilityPolicyPermission)
        Sets the set immutability policy permission status.
        Parameters:
        immutabilityPolicyPermission - Permission status to set
        Returns:
        the updated BlobSasPermission object.

      • toString

        public String toString()
        Converts the given permissions to a String. Using this method will guarantee the permissions are in an order accepted by the service.
        Overrides:
        toString in class Object
        Returns:
        A String which represents the BlobContainerSasPermission.