com.azure.storage.common

Class AccountSasSignatureValues

java.lang.Object

com.azure.storage.common.AccountSasSignatureValues

public final class AccountSasSignatureValues
extends Object

AccountSasSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage account. Once all the values here are set appropriately, call generateSASQueryParameters to obtain a representation of the SAS which can actually be applied to blob urls. Note: that both this class and AccountSasQueryParameters exist because the former is mutable and a logical representation while the latter is immutable and used to generate actual REST requests.

Please see here for more conceptual information on SAS:

Please see here for further descriptions of the parameters, including which are required:

Please see here for additional samples.

Constructor Summary

Constructors

Constructor and Description
AccountSasSignatureValues() Initializes an AccountSasSignatureValues object with the version number set to the default and all other values empty.

Method Summary

Modifier and Type	Method and Description
static String	generateAccountSas(SharedKeyCredential sharedKeyCredential, AccountSasService accountSASService, AccountSasResourceType accountSASResourceType, AccountSasPermission accountSASPermission, OffsetDateTime expiryTime, OffsetDateTime startTime, String version, IpRange ipRange, SasProtocol sasProtocol) Shared method between service clients to generate an account SAS.
AccountSasQueryParameters	generateSasQueryParameters(SharedKeyCredential sharedKeyCredentials) Generates a AccountSasQueryParameters object which contains all SAS query parameters needed to make an actual REST request.
OffsetDateTime	getExpiryTime()
IpRange	getIpRange()
String	getPermissions()
SasProtocol	getProtocol()
String	getResourceTypes()
String	getServices()
OffsetDateTime	getStartTime()
String	getVersion()
AccountSasSignatureValues	setExpiryTime(OffsetDateTime expiryTime) Sets the time after which the SAS will no longer work.
AccountSasSignatureValues	setIpRange(IpRange ipRange) Sets the IpRange which determines the IP ranges that are allowed to use the SAS.
AccountSasSignatureValues	setPermissions(String permissions) Sets the operations the SAS user may perform.
AccountSasSignatureValues	setProtocol(SasProtocol protocol) Sets the SasProtocol which determines the HTTP protocol that will be used.
AccountSasSignatureValues	setResourceTypes(String resourceTypes) Sets the resource types accessible with this SAS.
AccountSasSignatureValues	setServices(String services) Sets the services accessible with this SAS.
AccountSasSignatureValues	setStartTime(OffsetDateTime startTime) Sets when the SAS will take effect.
AccountSasSignatureValues	setVersion(String version) Sets the service version that is targeted.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountSasSignatureValues

public AccountSasSignatureValues()

Initializes an AccountSasSignatureValues object with the version number set to the default and all other values empty.

Method Detail

generateAccountSas

public static String generateAccountSas(SharedKeyCredential sharedKeyCredential,
                                        AccountSasService accountSASService,
                                        AccountSasResourceType accountSASResourceType,
                                        AccountSasPermission accountSASPermission,
                                        OffsetDateTime expiryTime,
                                        OffsetDateTime startTime,
                                        String version,
                                        IpRange ipRange,
                                        SasProtocol sasProtocol)

Shared method between service clients to generate an account SAS.

Parameters:

sharedKeyCredential - The SharedKeyCredential shared key credential for the account SAS

accountSASService - The AccountSasService services for the account SAS

accountSASResourceType - An optional AccountSasResourceType resources for the account SAS

accountSASPermission - The AccountSasPermission permission for the account SAS

expiryTime - The OffsetDateTime expiry time for the account SAS

startTime - The OffsetDateTime start time for the account SAS

version - The String version for the account SAS

ipRange - An optional IpRange ip address range for the SAS

sasProtocol - An optional SasProtocol protocol for the SAS

Returns:

A string that represents the SAS token

Throws:

NullPointerException - If any of sharedKeyCredentials, services, resourceTypes, expiryTime, permissions or versions is null

getVersion

public String getVersion()

Returns:

the service version that is targeted, if null or empty the service version targeted by the library will be used.

setVersion

public AccountSasSignatureValues setVersion(String version)

Sets the service version that is targeted. Leave this null or empty to target the version used by the library.

Parameters:

version - Target version to set

Returns:

the updated AccountSasSignatureValues object.

getProtocol

public SasProtocol getProtocol()

Returns:

the SasProtocol which determines the HTTP protocol that will be used.

setProtocol

public AccountSasSignatureValues setProtocol(SasProtocol protocol)

Sets the SasProtocol which determines the HTTP protocol that will be used.

Parameters:

protocol - Protocol to set

Returns:

the updated AccountSasSignatureValues object.

getStartTime

public OffsetDateTime getStartTime()

Returns:

when the SAS will take effect.

setStartTime

public AccountSasSignatureValues setStartTime(OffsetDateTime startTime)

Sets when the SAS will take effect.

Parameters:

startTime - Start time to set

Returns:

the updated AccountSasSignatureValues object.

getExpiryTime

public OffsetDateTime getExpiryTime()

Returns:

the time after which the SAS will no longer work.

setExpiryTime

public AccountSasSignatureValues setExpiryTime(OffsetDateTime expiryTime)

Sets the time after which the SAS will no longer work.

Parameters:

expiryTime - Expiry time to set

Returns:

the updated AccountSasSignatureValues object.

getPermissions

public String getPermissions()

Returns:

the operations the SAS user may perform. Please refer to AccountSasPermission to help determine which permissions are allowed.

setPermissions

public AccountSasSignatureValues setPermissions(String permissions)

Sets the operations the SAS user may perform. Please refer to AccountSasPermission for help constructing the permissions string.

Parameters:

permissions - Permissions string to set

Returns:

the updated AccountSasSignatureValues object.

getIpRange

public IpRange getIpRange()

Returns:

the IpRange which determines the IP ranges that are allowed to use the SAS.

setIpRange

public AccountSasSignatureValues setIpRange(IpRange ipRange)

Sets the IpRange which determines the IP ranges that are allowed to use the SAS.

Parameters:

ipRange - Allowed IP range to set

Returns:

the updated AccountSasSignatureValues object.

getServices

public String getServices()

Returns:

the services accessible with this SAS. Please refer to AccountSasService to help determine which services are accessible.

setServices

public AccountSasSignatureValues setServices(String services)

Sets the services accessible with this SAS. Please refer to AccountSasService to construct this value.

Parameters:

services - Allowed services string to set

Returns:

the updated AccountSasSignatureValues object.

getResourceTypes

public String getResourceTypes()

Returns:

the resource types accessible with this SAS. Please refer to AccountSasResourceType to help determine the resource types that are accessible.

setResourceTypes

public AccountSasSignatureValues setResourceTypes(String resourceTypes)

Sets the resource types accessible with this SAS. Please refer to AccountSasResourceType to construct this value.

Parameters:

resourceTypes - Allowed resource types string to set

Returns:

the updated AccountSasSignatureValues object.

generateSasQueryParameters

public AccountSasQueryParameters generateSasQueryParameters(SharedKeyCredential sharedKeyCredentials)

Generates a AccountSasQueryParameters object which contains all SAS query parameters needed to make an actual REST request.

Parameters:

sharedKeyCredentials - Credentials for the storage account and corresponding primary or secondary key.

Returns:

AccountSasQueryParameters

Throws:

RuntimeException - If the HMAC-SHA256 signature for sharedKeyCredentials fails to generate.

NullPointerException - If any of sharedKeyCredentials, services, resourceTypes, expiryTime, permissions or versions is null