Package com.azure.storage.queue.sas
Class QueueServiceSasSignatureValues
- java.lang.Object
-
- com.azure.storage.queue.sas.QueueServiceSasSignatureValues
-
public final class QueueServiceSasSignatureValues extends Object
Used to initialize parameters for a Shared Access Signature (SAS) for an Azure Queue Storage service. Once all the values here are set, use the appropriate SAS generation method on the desired queue client to obtain a representation of the SAS which can then be applied to a new client using the .sasToken(String) method on the desired client builder.- See Also:
- Storage SAS overview, Constructing a Service SAS
-
-
Constructor Summary
Constructors Constructor Description QueueServiceSasSignatureValues()
Deprecated.QueueServiceSasSignatureValues(String identifier)
Creates an object with the specified identifier.QueueServiceSasSignatureValues(OffsetDateTime expiryTime, QueueSasPermission permissions)
Creates an object with the specified expiry time and permissions
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description QueueServiceSasQueryParameters
generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)
Deprecated.Please use the generateSas(QueueServiceSasSignatureValues) method on the desired queue client after initializingQueueServiceSasSignatureValues
.OffsetDateTime
getExpiryTime()
String
getId()
Deprecated.Please usegetIdentifier()
String
getIdentifier()
String
getPermissions()
SasProtocol
getProtocol()
String
getQueueName()
Deprecated.Queue name is now auto-populated by the SAS generation methods provided on the desired queue client.SasIpRange
getSasIpRange()
OffsetDateTime
getStartTime()
String
getVersion()
QueueServiceSasSignatureValues
setExpiryTime(OffsetDateTime expiryTime)
Sets the time after which the SAS will no longer work.QueueServiceSasSignatureValues
setIdentifier(String identifier)
Sets the name of the access policy on the queue this SAS references if any.QueueServiceSasSignatureValues
setPermissions(QueueSasPermission permissions)
Sets the permissions string allowed by the SAS.QueueServiceSasSignatureValues
setProtocol(SasProtocol protocol)
Sets theSasProtocol
which determines the protocols allowed by the SAS.QueueServiceSasSignatureValues
setQueueName(String queueName)
Deprecated.Please use the generateSas methods provided on the desired queue client that will auto-populate the queue name.QueueServiceSasSignatureValues
setSasIpRange(SasIpRange sasIpRange)
Sets theSasIpRange
which determines the IP ranges that are allowed to use the SAS.QueueServiceSasSignatureValues
setStartTime(OffsetDateTime startTime)
Sets when the SAS will take effect.QueueServiceSasSignatureValues
setVersion(String version)
Deprecated.The version is set to the latest version of sas.
-
-
-
Constructor Detail
-
QueueServiceSasSignatureValues
@Deprecated public QueueServiceSasSignatureValues()
Deprecated.Creates an object with empty values for all fields.
-
QueueServiceSasSignatureValues
public QueueServiceSasSignatureValues(OffsetDateTime expiryTime, QueueSasPermission permissions)
Creates an object with the specified expiry time and permissions- Parameters:
expiryTime
- The time after which the SAS will no longer work.permissions
-QueueSasPermission
allowed by the SAS.
-
QueueServiceSasSignatureValues
public QueueServiceSasSignatureValues(String identifier)
Creates an object with the specified identifier.- Parameters:
identifier
- Name of the access policy.
-
-
Method Detail
-
getVersion
public String getVersion()
- Returns:
- the version of the service this SAS will target. If not specified, it will default to the version targeted by the library.
-
setVersion
@Deprecated public QueueServiceSasSignatureValues setVersion(String version)
Deprecated.The version is set to the latest version of sas. Users should stop calling this API as it is now treated as a no-op.Sets the version of the service this SAS will target. If not specified, it will default to the version targeted by the library.- Parameters:
version
- Version to target- Returns:
- the updated QueueServiceSasSignatureValues object
-
getProtocol
public SasProtocol getProtocol()
- Returns:
- the
SasProtocol
which determines the protocols allowed by the SAS.
-
setProtocol
public QueueServiceSasSignatureValues setProtocol(SasProtocol protocol)
Sets theSasProtocol
which determines the protocols allowed by the SAS.- Parameters:
protocol
- Protocol for the SAS- Returns:
- the updated QueueServiceSasSignatureValues object
-
getStartTime
public OffsetDateTime getStartTime()
- Returns:
- when the SAS will take effect.
-
setStartTime
public QueueServiceSasSignatureValues setStartTime(OffsetDateTime startTime)
Sets when the SAS will take effect.- Parameters:
startTime
- When the SAS takes effect- Returns:
- the updated QueueServiceSasSignatureValues object
-
getExpiryTime
public OffsetDateTime getExpiryTime()
- Returns:
- the time after which the SAS will no longer work.
-
setExpiryTime
public QueueServiceSasSignatureValues setExpiryTime(OffsetDateTime expiryTime)
Sets the time after which the SAS will no longer work.- Parameters:
expiryTime
- When the SAS will no longer work- Returns:
- the updated QueueServiceSasSignatureValues object
-
getPermissions
public String getPermissions()
- Returns:
- the permissions string allowed by the SAS. Please refer to
QueueSasPermission
for help determining the permissions allowed.
-
setPermissions
public QueueServiceSasSignatureValues setPermissions(QueueSasPermission permissions)
Sets the permissions string allowed by the SAS. Please refer toQueueSasPermission
for help constructing the permissions string.- Parameters:
permissions
- Permissions for the SAS- Returns:
- the updated QueueServiceSasSignatureValues object
- Throws:
NullPointerException
- ifpermissions
is null.
-
getSasIpRange
public SasIpRange getSasIpRange()
- Returns:
- the
SasIpRange
which determines the IP ranges that are allowed to use the SAS.
-
setSasIpRange
public QueueServiceSasSignatureValues setSasIpRange(SasIpRange sasIpRange)
Sets theSasIpRange
which determines the IP ranges that are allowed to use the SAS.- Parameters:
sasIpRange
- Allowed IP range to set- Returns:
- the updated QueueServiceSasSignatureValues object
- See Also:
- Specifying IP Address or IP range
-
getQueueName
@Deprecated public String getQueueName()
Deprecated.Queue name is now auto-populated by the SAS generation methods provided on the desired queue client.Gets the name of the queue this SAS may access.- Returns:
- The name of the queue the SAS user may access.
-
setQueueName
@Deprecated public QueueServiceSasSignatureValues setQueueName(String queueName)
Deprecated.Please use the generateSas methods provided on the desired queue client that will auto-populate the queue name.Sets the name of the queue this SAS may access.- Parameters:
queueName
- Canonical name of the object the SAS grants access- Returns:
- the updated QueueServiceSasSignatureValues object
-
getId
@Deprecated public String getId()
Deprecated.Please usegetIdentifier()
- Returns:
- the name of the access policy on the queue this SAS references if any. Please see here for more information.
-
getIdentifier
public String getIdentifier()
- Returns:
- the name of the access policy on the queue this SAS references if any. Please see here for more information.
-
setIdentifier
public QueueServiceSasSignatureValues setIdentifier(String identifier)
Sets the name of the access policy on the queue this SAS references if any. Please see here for more information.- Parameters:
identifier
- Name of the access policy- Returns:
- the updated QueueServiceSasSignatureValues object
-
generateSasQueryParameters
@Deprecated public QueueServiceSasQueryParameters generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)
Deprecated.Please use the generateSas(QueueServiceSasSignatureValues) method on the desired queue client after initializingQueueServiceSasSignatureValues
.Uses an account's shared key credential to sign these signature values to produce the proper SAS query parameters.Notes on SAS generation
- If
identifier
is set,expiryTime
and permissions should not be set. These values are inherited from the stored access policy. - Otherwise,
expiryTime
andpermissions
must be set.
For samples, see class level JavaDocs.
- Parameters:
storageSharedKeyCredentials
- AStorageSharedKeyCredential
object used to sign the SAS values.- Returns:
- A new
QueueServiceSasQueryParameters
represented by the current builder. - Throws:
IllegalStateException
- If the HMAC-SHA256 algorithm isn't supported, if the key isn't a valid Base64 encoded string, or the UTF-8 charset isn't supported.NullPointerException
- IfstorageSharedKeyCredentials
is null.
- If
-
-