Package com.azure.storage.queue.sas
Class QueueSasPermission
- java.lang.Object
-
- com.azure.storage.queue.sas.QueueSasPermission
-
public final class QueueSasPermission extends Object
Constructs a string representing the permissions granted by an Azure Service SAS 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 withtoString
and set as the permissions field onQueueServiceSasSignatureValues
.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 Description QueueSasPermission()
Initializes aQueueSasPermission
object with all fields set to false.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
hasAddPermission()
Gets the add permission status.boolean
hasProcessPermission()
Gets the process permission status.boolean
hasReadPermission()
Gets the read permissions status.boolean
hasUpdatePermission()
Gets the update permission status.static QueueSasPermission
parse(String permissionString)
Creates aQueueSasPermission
from the specified permissions string.QueueSasPermission
setAddPermission(boolean hasAddPermission)
Sets the add permission status.QueueSasPermission
setProcessPermission(boolean hasProcessPermission)
Sets the process permission status.QueueSasPermission
setReadPermission(boolean hasReadPermission)
Sets the read permission status.QueueSasPermission
setUpdatePermission(boolean hasUpdatePermission)
Sets the update permission status.String
toString()
Converts the given permissions to aString
.
-
-
-
Constructor Detail
-
QueueSasPermission
public QueueSasPermission()
Initializes aQueueSasPermission
object with all fields set to false.
-
-
Method Detail
-
parse
public static QueueSasPermission parse(String permissionString)
Creates aQueueSasPermission
from the specified permissions string. This method will throw anIllegalArgumentException
if it encounters a character that does not correspond to a valid permission.- Parameters:
permissionString
- AString
which represents theQueueSasPermission
.- Returns:
- A
QueueSasPermission
generated from the givenString
. - Throws:
IllegalArgumentException
- IfpermissionString
contains a character other than r, a, u, or p.
-
hasReadPermission
public boolean hasReadPermission()
Gets the read permissions status.- Returns:
true
if SAS has permission to read metadata, properties, message count, peek at messages.false
, otherwise.
-
setReadPermission
public QueueSasPermission setReadPermission(boolean hasReadPermission)
Sets the read permission status.- Parameters:
hasReadPermission
-true
if SAS has permission to read metadata, properties, message count, peek at messages.false
, otherwise.- Returns:
- The updated QueueSasPermission object.
-
hasAddPermission
public boolean hasAddPermission()
Gets the add permission status.- Returns:
true
if SAS has permission to add messages to the queue.false
, otherwise.
-
setAddPermission
public QueueSasPermission setAddPermission(boolean hasAddPermission)
Sets the add permission status.- Parameters:
hasAddPermission
-true
if SAS has permission to add messages to the queue.false
, otherwise.- Returns:
- the updated QueueSasPermission object.
-
hasUpdatePermission
public boolean hasUpdatePermission()
Gets the update permission status.- Returns:
true
if SAS has permission to update messages in the queue.false
, otherwise.
-
setUpdatePermission
public QueueSasPermission setUpdatePermission(boolean hasUpdatePermission)
Sets the update permission status.Note: Use
setProcessPermission(true)
to get a particular message in the queue to update.- Parameters:
hasUpdatePermission
-true
if SAS has permission to update messages in the queue.false
, otherwise.- Returns:
- the updated QueueSasPermission object.
-
hasProcessPermission
public boolean hasProcessPermission()
Gets the process permission status.- Returns:
true
if SAS has permission to get and delete messages from the queue.false
, otherwise.
-
setProcessPermission
public QueueSasPermission setProcessPermission(boolean hasProcessPermission)
Sets the process permission status.- Parameters:
hasProcessPermission
-true
if SAS has permission to get and delete messages from the queue.false
, otherwise.- Returns:
- the updated QueueSasPermission object.
-
-