com.azure.storage.blob.sas

Class BlobSasPermission

java.lang.Object

com.azure.storage.blob.sas.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. 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

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	hasAddPermission()
boolean	hasCreatePermission()
boolean	hasDeletePermission()
boolean	hasReadPermission()
boolean	hasWritePermission()
static BlobSasPermission	parse(String permString) Creates a BlobSasPermission from the specified permissions string.
BlobSasPermission	setAddPermission(boolean hasAddPermission) Sets the add permission status.
BlobSasPermission	setCreatePermission(boolean hasCreatePermission) Sets the create permission status.
BlobSasPermission	setDeletePermission(boolean hasDeletePermission) Sets the delete permission status.
BlobSasPermission	setReadPermission(boolean hasReadPermission) Sets the read permission status.
BlobSasPermission	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

BlobSasPermission

public BlobSasPermission()

Initializes a BlobSasPermission object with all fields set to false.

Method Detail

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.

Throws:

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

hasReadPermission

public boolean hasReadPermission()

Returns:

the read permission status.

setReadPermission

public BlobSasPermission setReadPermission(boolean hasReadPermission)

Sets the read permission status.

Parameters:

hasReadPermission - Permission status to set

Returns:

the updated BlobSasPermission object.

hasAddPermission

public boolean hasAddPermission()

Returns:

the add permission status.

setAddPermission

public BlobSasPermission setAddPermission(boolean hasAddPermission)

Sets the add permission status.

Parameters:

hasAddPermission - Permission status to set

Returns:

the updated BlobSasPermission object.

hasCreatePermission

public boolean hasCreatePermission()

Returns:

the create permission status.

setCreatePermission

public BlobSasPermission setCreatePermission(boolean hasCreatePermission)

Sets the create permission status.

Parameters:

hasCreatePermission - Permission status to set

Returns:

the updated BlobSasPermission object.

hasWritePermission

public boolean hasWritePermission()

Returns:

the write permission status.

setWritePermission

public BlobSasPermission setWritePermission(boolean hasWritePermission)

Sets the write permission status.

Parameters:

hasWritePermission - Permission status to set

Returns:

the updated BlobSasPermission object.

hasDeletePermission

public boolean hasDeletePermission()

Returns:

the delete permission status.

setDeletePermission

public BlobSasPermission setDeletePermission(boolean hasDeletePermission)

Sets the delete permission status.

Parameters:

hasDeletePermission - 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 BlobSasPermission.