com.azure.storage.file.share.sas

Class ShareFileSasPermission

java.lang.Object

com.azure.storage.file.share.sas.ShareFileSasPermission

public final class ShareFileSasPermission
extends Object

Constructs a string representing the permissions granted by a Service SAS to a file. 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 ShareServiceSasSignatureValues.

It is possible to construct the permissions string without this class, but the order of the permissions is particular and this class guarantees correctness.

See Also:

ShareServiceSasSignatureValues, Permissions for a file

Constructor Summary

Constructors

Constructor and Description
ShareFileSasPermission() Initializes an ShareFileSasPermission object with all fields set to false.

Method Summary

Modifier and Type	Method and Description
boolean	hasCreatePermission() Gets the create permission status.
boolean	hasDeletePermission() Gets the delete permission status.
boolean	hasReadPermission() Gets the read permission status.
boolean	hasWritePermission() Gets the write permission status.
static ShareFileSasPermission	parse(String permissionString) Creates an ShareFileSasPermission from the specified permissions string.
ShareFileSasPermission	setCreatePermission(boolean hasCreatePermission) Sets the create permission status.
ShareFileSasPermission	setDeletePermission(boolean hasDeletePermission) Sets the delete permission status.
ShareFileSasPermission	setReadPermission(boolean hasReadPermission) Sets the read permission status.
ShareFileSasPermission	setWritePermission(boolean hasWritePermission) Sets the write permission status.
String	toString() Converts the given permissions to a String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ShareFileSasPermission

public ShareFileSasPermission()

Initializes an ShareFileSasPermission object with all fields set to false.

Method Detail

parse

public static ShareFileSasPermission parse(String permissionString)

Creates an ShareFileSasPermission 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 ShareFileSasPermission.

Returns:

A ShareFileSasPermission generated from the given String.

Throws:

IllegalArgumentException - If permissionString contains a character other than r, c, w, or d.

hasReadPermission

public boolean hasReadPermission()

Gets the read permission status.

Returns:

true if the SAS can read the content, properties, and metadata for a file. Can use the file as the source of a copy operation. false, otherwise.

setReadPermission

public ShareFileSasPermission setReadPermission(boolean hasReadPermission)

Sets the read permission status.

Parameters:

hasReadPermission - true if the SAS can read the content, properties, and metadata for a file. Can use the file as the source of a copy operation. false, otherwise.

Returns:

the updated ShareFileSasPermission object

hasCreatePermission

public boolean hasCreatePermission()

Gets the create permission status.

Returns:

true if SAS can create a new file or copy a file to a new file. false, otherwise.

setCreatePermission

public ShareFileSasPermission setCreatePermission(boolean hasCreatePermission)

Sets the create permission status.

Parameters:

hasCreatePermission - true if SAS can create a new file or copy a file to a new file. false, otherwise.

Returns:

the updated ShareFileSasPermission object

hasWritePermission

public boolean hasWritePermission()

Gets the write permission status.

Returns:

true if SAS can write content, properties, or metadata to the file. Or, use the file as the destination of a copy operation. false, otherwise.

setWritePermission

public ShareFileSasPermission setWritePermission(boolean hasWritePermission)

Sets the write permission status.

Parameters:

hasWritePermission - true if SAS can write content, properties, or metadata to the file. Or, use the file as the destination of a copy operation. false, otherwise.

Returns:

the updated ShareFileSasPermission object

hasDeletePermission

public boolean hasDeletePermission()

Gets the delete permission status.

Returns:

true if SAS can delete a file. false, otherwise.

setDeletePermission

public ShareFileSasPermission setDeletePermission(boolean hasDeletePermission)

Sets the delete permission status.

Parameters:

hasDeletePermission - true if SAS can delete a file. false, otherwise.

Returns:

the updated ShareFileSasPermission 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 ShareFileSasPermission.