Partager via

TableAccountSasPermission Class

  • Reference
Package:
com.azure.data.tables.sas
Maven Artifact:
com.azure:azure-data-tables:12.4.6
  • java.lang.Object
    • com.azure.data.tables.sas.TableAccountSasPermission

public final class 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

Constructor Description
TableAccountSasPermission()

Returns an instance of TableAccountSasPermission that has all fields set to false.

Method Summary

Modifier and Type Method and Description
boolean hasAddPermission()

Gets the add permission status.
boolean hasCreatePermission()

Gets the create permission status.
boolean hasDeletePermission()

Gets the delete permission status.
boolean hasDeleteVersionPermission()

Gets the delete version permission status.
boolean hasFilterTagsPermission()

Returns the filter tags permission status.
boolean hasListPermission()

Gets the list permission status.
boolean hasProcessMessages()

Gets the process messages permission.
boolean hasReadPermission()

Gets the read permission status.
boolean hasTagsPermission()

Returns the tags permission status.
boolean hasUpdatePermission()

Gets the update permission status.
boolean hasWritePermission()

Gets the write permission status.
static TableAccountSasPermission parse(String permissionsString)

Creates an TableAccountSasPermission from the specified permissions string.
TableAccountSasPermission setAddPermission(boolean hasAddPermission)

Sets the add permission status.
TableAccountSasPermission setCreatePermission(boolean hasCreatePermission)

Sets the create permission status.
TableAccountSasPermission setDeletePermission(boolean hasDeletePermission)

Sets the delete permission status.
TableAccountSasPermission setDeleteVersionPermission(boolean hasDeleteVersionPermission)

Sets the delete version permission status.
TableAccountSasPermission setFilterTagsPermission(boolean filterTagsPermission)

Sets the filter tags permission status.
TableAccountSasPermission setListPermission(boolean hasListPermission)

Sets the list permission status.
TableAccountSasPermission setProcessMessages(boolean hasProcessMessagesPermission)

Sets the process messages permission.
TableAccountSasPermission setReadPermission(boolean hasReadPermission)

Sets the read permission status.
TableAccountSasPermission setTagsPermission(boolean tagsPermission)

Sets the tags permission status.
TableAccountSasPermission setUpdatePermission(boolean hasUpdatePermission)

Sets the update permission status.
TableAccountSasPermission setWritePermission(boolean hasWritePermission)

Sets the write permission status.
String toString()

Converts the given permissions to a String.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

TableAccountSasPermission

public TableAccountSasPermission()

Returns an instance of TableAccountSasPermission that has all fields set to false.

Method Details

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.

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.

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.

hasDeleteVersionPermission

public boolean hasDeleteVersionPermission()

Gets the delete version permission status. Used to delete a blob version

Returns:

The delete version permission status.

hasFilterTagsPermission

public boolean hasFilterTagsPermission()

Returns the filter tags permission status. Used to filter blobs by their tags.

Returns:

The filter tags permission status. Used to filter blobs by their tags.

hasListPermission

public boolean hasListPermission()

Gets the list permission status. Valid for Service and Container resource types only.

Returns:

The list permission status.

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.

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.

hasTagsPermission

public boolean hasTagsPermission()

Returns the tags permission status. Used to read or write the tags on a blob.

Returns:

The tags permission status. Used to read or write the tags on a blob.

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.

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.

parse

public static TableAccountSasPermission parse(String permissionsString)

Creates an TableAccountSasPermission 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:

permissionsString - A String which represents the TableAccountSasPermission.

Returns:

An TableAccountSasPermission object generated from the given String.

setAddPermission

public TableAccountSasPermission setAddPermission(boolean hasAddPermission)

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.

setCreatePermission

public TableAccountSasPermission setCreatePermission(boolean hasCreatePermission)

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.

setDeletePermission

public TableAccountSasPermission setDeletePermission(boolean hasDeletePermission)

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.

setDeleteVersionPermission

public TableAccountSasPermission setDeleteVersionPermission(boolean hasDeleteVersionPermission)

Sets the delete version permission status. Used to delete a blob version

Parameters:

hasDeleteVersionPermission - The permission status to set.

Returns:

The updated TableAccountSasPermission object.

setFilterTagsPermission

public TableAccountSasPermission setFilterTagsPermission(boolean filterTagsPermission)

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.

setListPermission

public TableAccountSasPermission setListPermission(boolean hasListPermission)

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.

setProcessMessages

public TableAccountSasPermission setProcessMessages(boolean hasProcessMessagesPermission)

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.

setReadPermission

public TableAccountSasPermission setReadPermission(boolean hasReadPermission)

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.

setTagsPermission

public TableAccountSasPermission setTagsPermission(boolean tagsPermission)

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.

setUpdatePermission

public TableAccountSasPermission setUpdatePermission(boolean hasUpdatePermission)

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.

setWritePermission

public TableAccountSasPermission setWritePermission(boolean hasWritePermission)

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.

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. If all permissions are set to false, an empty string is returned from this method.

Overrides:

TableAccountSasPermission.toString()

Returns:

A String which represents the TableAccountSasPermission.

Applies to