com.azure.storage.queue

Class QueueSASPermission

java.lang.Object

com.azure.storage.queue.QueueSASPermission

public final class QueueSASPermission
extends java.lang.Object

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

Method Summary

Modifier and Type	Method and Description
boolean	getAdd()
boolean	getProcess()
boolean	getRead()
boolean	getUpdate()
static QueueSASPermission	parse(java.lang.String permString) Creates a QueueSASPermission from the specified permissions string.
QueueSASPermission	setAdd(boolean add) Sets the add permission status.
QueueSASPermission	setProcess(boolean process) Sets the process permission status.
QueueSASPermission	setRead(boolean read) Sets the read permission status.
QueueSASPermission	setUpdate(boolean update) Sets the update permission status.
java.lang.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

QueueSASPermission

public QueueSASPermission()

Initializes a QueueSASPermission object with all fields set to false.

Method Detail

parse

public static QueueSASPermission parse(java.lang.String permString)

Creates a QueueSASPermission 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 QueueSASPermission.

Returns:

A QueueSASPermission generated from the given String.

Throws:

java.lang.IllegalArgumentException - If permString contains a character other than r, a, u, or p.

getRead

public boolean getRead()

Returns:

the read permission status.

setRead

public QueueSASPermission setRead(boolean read)

Sets the read permission status.

Parameters:

read - Permission status to set

Returns:

the updated QueueSASPermission object.

getAdd

public boolean getAdd()

Returns:

the add permission status.

setAdd

public QueueSASPermission setAdd(boolean add)

Sets the add permission status.

Parameters:

add - Permission status to set

Returns:

the updated QueueSASPermission object.

getUpdate

public boolean getUpdate()

Returns:

the update permission status.

setUpdate

public QueueSASPermission setUpdate(boolean update)

Sets the update permission status.

Parameters:

update - Permission status to set

Returns:

the updated QueueSASPermission object.

getProcess

public boolean getProcess()

Returns:

the process permission status.

setProcess

public QueueSASPermission setProcess(boolean process)

Sets the process permission status.

Parameters:

process - Permission status to set

Returns:

the updated QueueSASPermission object.

toString

public java.lang.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 java.lang.Object

Returns:

A String which represents the QueueSASPermission.