com.microsoft.azure.storage.blob

Class ContainerSASPermission

java.lang.Object

com.microsoft.azure.storage.blob.ContainerSASPermission

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	add() Specifies Add access granted.
boolean	create() Specifies Create access granted.
boolean	delete() Specifies Delete access granted.
boolean	list() Specifies List access granted.
static ContainerSASPermission	parse(String permString) Creates an ContainerSASPermission from the specified permissions string.
boolean	read() Specifies Read access granted.
String	toString() Converts the given permissions to a String.
ContainerSASPermission	withAdd(boolean add) Specifies Add access granted.
ContainerSASPermission	withCreate(boolean create) Specifies Create access granted.
ContainerSASPermission	withDelete(boolean delete) Specifies Delete access granted.
ContainerSASPermission	withList(boolean list) Specifies List access granted.
ContainerSASPermission	withRead(boolean read) Specifies Read access granted.
ContainerSASPermission	withWrite(boolean write) Specifies Write access granted.
boolean	write() Specifies Write access granted.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerSASPermission

public ContainerSASPermission()

Initializes an ContainerSASPermssion object with all fields set to false.

Method Detail

parse

public static ContainerSASPermission parse(String permString)

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

Returns:

A ContainerSASPermission generated from the given String.

read

public boolean read()

Specifies Read access granted.

withRead

public ContainerSASPermission withRead(boolean read)

Specifies Read access granted.

add

public boolean add()

Specifies Add access granted.

withAdd

public ContainerSASPermission withAdd(boolean add)

Specifies Add access granted.

create

public boolean create()

Specifies Create access granted.

withCreate

public ContainerSASPermission withCreate(boolean create)

Specifies Create access granted.

write

public boolean write()

Specifies Write access granted.

withWrite

public ContainerSASPermission withWrite(boolean write)

Specifies Write access granted.

delete

public boolean delete()

Specifies Delete access granted.

withDelete

public ContainerSASPermission withDelete(boolean delete)

Specifies Delete access granted.

list

public boolean list()

Specifies List access granted.

withList

public ContainerSASPermission withList(boolean list)

Specifies List access granted.

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