com.azure.storage.blob.sas

Class BlobContainerSasPermission

java.lang.Object

com.azure.storage.blob.sas.BlobContainerSasPermission

public final class BlobContainerSasPermission
extends Object

This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a container. 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
BlobContainerSasPermission() Initializes an BlobContainerSasPermission object with all fields set to false.

Method Summary

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

BlobContainerSasPermission

public BlobContainerSasPermission()

Initializes an BlobContainerSasPermission object with all fields set to false.

Method Detail

parse

public static BlobContainerSasPermission parse(String permString)

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

Returns:

A BlobContainerSasPermission generated from the given String.

Throws:

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

hasReadPermission

public boolean hasReadPermission()

Returns:

the read permission status

setReadPermission

public BlobContainerSasPermission setReadPermission(boolean hasReadPermission)

Sets the read permission status.

Parameters:

hasReadPermission - Permission status to set

Returns:

the updated BlobContainerSasPermission object

hasAddPermission

public boolean hasAddPermission()

Returns:

the add permission status

setAddPermission

public BlobContainerSasPermission setAddPermission(boolean hasAddPermission)

Sets the add permission status.

Parameters:

hasAddPermission - Permission status to set

Returns:

the updated BlobContainerSasPermission object

hasCreatePermission

public boolean hasCreatePermission()

Returns:

the create permission status

setCreatePermission

public BlobContainerSasPermission setCreatePermission(boolean hasCreatePermission)

Sets the create permission status.

Parameters:

hasCreatePermission - Permission status to set

Returns:

the updated BlobContainerSasPermission object

hasWritePermission

public boolean hasWritePermission()

Returns:

the write permission status

setWritePermission

public BlobContainerSasPermission setWritePermission(boolean hasWritePermission)

Sets the write permission status.

Parameters:

hasWritePermission - Permission status to set

Returns:

the updated BlobContainerSasPermission object

hasDeletePermission

public boolean hasDeletePermission()

Returns:

the delete permission status

setDeletePermission

public BlobContainerSasPermission setDeletePermission(boolean hasDeletePermission)

Sets the delete permission status.

Parameters:

hasDeletePermission - Permission status to set

Returns:

the updated BlobContainerSasPermission object

hasListPermission

public boolean hasListPermission()

Returns:

the list permission status

setListPermission

public BlobContainerSasPermission setListPermission(boolean hasListPermission)

Sets the list permission status.

Parameters:

hasListPermission - Permission status to set

Returns:

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