Package com.azure.data.tables.sas
Class TableAccountSasPermission
java.lang.Object
com.azure.data.tables.sas.TableAccountSasPermission
This is a helper class to construct a string representing the permissions granted by an Account SAS. Setting a value
to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the
values are set, this should be serialized with
toString()
and set as the permissions field on an
TableAccountSasSignatureValues
object.
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 Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Gets the add permission status.boolean
Gets the create permission status.boolean
Gets the delete permission status.boolean
Gets the delete version permission status.boolean
boolean
Gets the list permission status.boolean
Gets the process messages permission.boolean
Gets the read permission status.boolean
boolean
Gets the update permission status.boolean
Gets the write permission status.static TableAccountSasPermission
Creates anTableAccountSasPermission
from the specified permissions string.setAddPermission
(boolean hasAddPermission) Sets the add permission status.setCreatePermission
(boolean hasCreatePermission) Sets the create permission status.setDeletePermission
(boolean hasDeletePermission) Sets the delete permission status.setDeleteVersionPermission
(boolean hasDeleteVersionPermission) Sets the delete version permission status.setFilterTagsPermission
(boolean filterTagsPermission) Sets the filter tags permission status.setListPermission
(boolean hasListPermission) Sets the list permission status.setProcessMessages
(boolean hasProcessMessagesPermission) Sets the process messages permission.setReadPermission
(boolean hasReadPermission) Sets the read permission status.setTagsPermission
(boolean tagsPermission) Sets the tags permission status.setUpdatePermission
(boolean hasUpdatePermission) Sets the update permission status.setWritePermission
(boolean hasWritePermission) Sets the write permission status.toString()
Converts the given permissions to aString
.
-
Constructor Details
-
TableAccountSasPermission
public TableAccountSasPermission()
-
-
Method Details
-
parse
Creates anTableAccountSasPermission
from the specified permissions string. This method will throw anIllegalArgumentException
if it encounters a character that does not correspond to a valid permission.- Parameters:
permissionsString
- AString
which represents theaccount permissions
.- Returns:
- An
TableAccountSasPermission
object generated from the givenString
. - Throws:
IllegalArgumentException
- IfpermString
contains a character other than r, w, d, x, l, a, c, u, p, t or f.
-
hasReadPermission
public boolean hasReadPermission()Gets the read permission status. Valid for all signed resources types (Service, Container, and Object). Permits read permissions to the specified resource type.- Returns:
- The read permission status.
-
setReadPermission
Sets the read permission status. Valid for all signed resources types (Service, Container, and Object). Permits read permissions to the specified resource type.- Parameters:
hasReadPermission
- The permission status to set.- Returns:
- The updated
TableAccountSasPermission
object.
-
hasAddPermission
public boolean hasAddPermission()Gets the add permission status. Valid for the following Object resource types only: queue messages, table entities, and append blobs.- Returns:
- The add permission status.
-
setAddPermission
Sets the add permission status. Valid for the following Object resource types only: queue messages, table entities, and append blobs.- Parameters:
hasAddPermission
- The permission status to set.- Returns:
- The updated
TableAccountSasPermission
object.
-
hasCreatePermission
public boolean hasCreatePermission()Gets the create permission status. Valid for the following Object resource types only: blobs and files. Users can create new blobs or files, but may not overwrite existing blobs or files.- Returns:
- The create permission status.
-
setCreatePermission
Sets the create permission status. Valid for the following Object resource types only: blobs and files. Users can create new blobs or files, but may not overwrite existing blobs or files.- Parameters:
hasCreatePermission
- The permission status to set.- Returns:
- The updated
TableAccountSasPermission
object.
-
hasWritePermission
public boolean hasWritePermission()Gets the write permission status. Valid for all signed resources types (Service, Container, and Object). Permits write permissions to the specified resource type.- Returns:
- The write permission status.
-
setWritePermission
Sets the write permission status. Valid for all signed resources types (Service, Container, and Object). Permits write permissions to the specified resource type.- Parameters:
hasWritePermission
- The permission status to set.- Returns:
- The updated
TableAccountSasPermission
object.
-
hasDeletePermission
public boolean hasDeletePermission()Gets the delete permission status. Valid for Container and Object resource types, except for queue messages.- Returns:
- The delete permission status.
-
setDeletePermission
Sets the delete permission status. Valid for Container and Object resource types, except for queue messages.- Parameters:
hasDeletePermission
- The permission status to set.- Returns:
- The updated
TableAccountSasPermission
object.
-
hasDeleteVersionPermission
public boolean hasDeleteVersionPermission()Gets the delete version permission status. Used to delete a blob version- Returns:
- The delete version permission status.
-
setDeleteVersionPermission
Sets the delete version permission status. Used to delete a blob version- Parameters:
hasDeleteVersionPermission
- The permission status to set.- Returns:
- The updated
TableAccountSasPermission
object.
-
hasListPermission
public boolean hasListPermission()Gets the list permission status. Valid for Service and Container resource types only.- Returns:
- The list permission status.
-
setListPermission
Sets the list permission status. Valid for Service and Container resource types only.- Parameters:
hasListPermission
- The permission status to set.- Returns:
- The updated
TableAccountSasPermission
object.
-
hasUpdatePermission
public boolean hasUpdatePermission()Gets the update permission status. Valid for the following Object resource types only: queue messages and table entities.- Returns:
- The update permission status.
-
setUpdatePermission
Sets the update permission status. Valid for the following Object resource types only: queue messages and table entities.- Parameters:
hasUpdatePermission
- The permission status to set.- Returns:
- The updated
TableAccountSasPermission
object.
-
hasProcessMessages
public boolean hasProcessMessages()Gets the process messages permission. Valid for the following Object resource type only: queue messages.- Returns:
- The process messages permission status.
-
setProcessMessages
Sets the process messages permission. Valid for the following Object resource type only: queue messages.- Parameters:
hasProcessMessagesPermission
- The permission status to set.- Returns:
- The updated
TableAccountSasPermission
object.
-
hasTagsPermission
public boolean hasTagsPermission()- Returns:
- The tags permission status. Used to read or write the tags on a blob.
-
setTagsPermission
Sets the tags permission status.- Parameters:
tagsPermission
- The permission status to set. Used to read or write the tags on a blob.- Returns:
- The updated
TableAccountSasPermission
object.
-
hasFilterTagsPermission
public boolean hasFilterTagsPermission()- Returns:
- The filter tags permission status. Used to filter blobs by their tags.
-
setFilterTagsPermission
Sets the filter tags permission status. Used to filter blobs by their tags.- Parameters:
filterTagsPermission
- The permission status to set.- Returns:
- The updated
TableAccountSasPermission
object.
-
toString
Converts the given permissions to aString
. Using this method will guarantee the permissions are in an order accepted by the service. If all permissions are set to false, an empty string is returned from this method.- Overrides:
toString
in classObject
- Returns:
- A
String
which represents theTableAccountSasPermission
.
-