public final class QueueSasPermission extends Object
toString
and set as the permissions field on
QueueServiceSasSignatureValues
.
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 and Description |
---|
QueueSasPermission()
Initializes a
QueueSasPermission object with all fields set to false. |
Modifier and Type | Method and 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 permString)
Creates a
QueueSasPermission 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 a
String . |
public QueueSasPermission()
QueueSasPermission
object with all fields set to false.public static QueueSasPermission parse(String permString)
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.permString
- A String
which represents the QueueSasPermission
.QueueSasPermission
generated from the given String
.IllegalArgumentException
- If permString
contains a character other than r, a, u, or p.public boolean hasReadPermission()
true
if SAS has permission to read metadata, properties, message count, peek at messages.
false
, otherwise.public QueueSasPermission setReadPermission(boolean hasReadPermission)
hasReadPermission
- true
if SAS has permission to read metadata, properties, message count, peek at
messages. false
, otherwise.public boolean hasAddPermission()
true
if SAS has permission to add messages to the queue. false
, otherwise.public QueueSasPermission setAddPermission(boolean hasAddPermission)
hasAddPermission
- true
if SAS has permission to add messages to the queue. false
,
otherwise.public boolean hasUpdatePermission()
true
if SAS has permission to update messages in the queue. false
, otherwise.public QueueSasPermission setUpdatePermission(boolean hasUpdatePermission)
Note: Use setProcessPermission(true)
to get a particular message in
the queue to update.
hasUpdatePermission
- true
if SAS has permission to update messages in the queue. false
,
otherwise.public boolean hasProcessPermission()
true
if SAS has permission to get and delete messages from the queue. false
, otherwise.public QueueSasPermission setProcessPermission(boolean hasProcessPermission)
hasProcessPermission
- true
if SAS has permission to get and delete messages from the queue.
false
, otherwise.Copyright © 2021 Microsoft Corporation. All rights reserved.