com.microsoft.azure.storage.blob

Class BlobSASPermission

java.lang.Object

com.microsoft.azure.storage.blob.BlobSASPermission

public final class BlobSASPermission
extends Object

This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a blob. 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 a ServiceSASSignatureValues 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.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	add Specifies Add access granted.
boolean	create Specifies Create access granted.
boolean	delete Specifies Delete access granted.
boolean	read Specifies Read access granted.
boolean	write Specifies Write access granted.

Constructor Summary

Constructors

Constructor and Description
BlobSASPermission() Initializes a BlobSASPermission object with all fields set to false.

Method Summary

Modifier and Type	Method and Description
static BlobSASPermission	parse(String permString) Creates a BlobSASPermission from the specified permissions string.
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

Field Detail

read

public boolean read

Specifies Read access granted.

add

public boolean add

Specifies Add access granted.

create

public boolean create

Specifies Create access granted.

write

public boolean write

Specifies Write access granted.

delete

public boolean delete

Specifies Delete access granted.

Constructor Detail

BlobSASPermission

public BlobSASPermission()

Initializes a BlobSASPermission object with all fields set to false.

Method Detail

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 BlobSASPermission.

parse

public static BlobSASPermission parse(String permString)

Creates a BlobSASPermission 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:

permString - A String which represents the BlobSASPermission.

Returns:

A BlobSASPermission generated from the given String.