com.microsoft.azure.storage.blob

Class AccountSASSignatureValues

java.lang.Object

com.microsoft.azure.storage.blob.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 SASQueryParameters 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:

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
OffsetDateTime	expiryTime() The time after which the SAS will no longer work.
SASQueryParameters	generateSASQueryParameters(SharedKeyCredentials sharedKeyCredentials) Generates a SASQueryParameters object which contains all SAS query parameters needed to make an actual REST request.
IPRange	ipRange() IPRange
String	permissions() Specifies which operations the SAS user may perform.
SASProtocol	protocol() SASProtocol
String	resourceTypes() The values that indicate the resource types accessible with this SAS.
String	services() The values that indicate the services accessible with this SAS.
OffsetDateTime	startTime() When the SAS will take effect.
String	version() If null or empty, this defaults to the service version targeted by this version of the library.
AccountSASSignatureValues	withExpiryTime(OffsetDateTime expiryTime) The time after which the SAS will no longer work.
AccountSASSignatureValues	withIpRange(IPRange ipRange) IPRange
AccountSASSignatureValues	withPermissions(String permissions) Specifies which operations the SAS user may perform.
AccountSASSignatureValues	withProtocol(SASProtocol protocol) SASProtocol
AccountSASSignatureValues	withResourceTypes(String resourceTypes) The values that indicate the resource types accessible with this SAS.
AccountSASSignatureValues	withServices(String services) The values that indicate the services accessible with this SAS.
AccountSASSignatureValues	withStartTime(OffsetDateTime startTime) When the SAS will take effect.
AccountSASSignatureValues	withVersion(String version) If null or empty, this defaults to the service version targeted by this version of the library.

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

version

public String version()

If null or empty, this defaults to the service version targeted by this version of the library.

withVersion

public AccountSASSignatureValues withVersion(String version)

If null or empty, this defaults to the service version targeted by this version of the library.

protocol

public SASProtocol protocol()

SASProtocol

withProtocol

public AccountSASSignatureValues withProtocol(SASProtocol protocol)

SASProtocol

startTime

public OffsetDateTime startTime()

When the SAS will take effect.

withStartTime

public AccountSASSignatureValues withStartTime(OffsetDateTime startTime)

When the SAS will take effect.

expiryTime

public OffsetDateTime expiryTime()

The time after which the SAS will no longer work.

withExpiryTime

public AccountSASSignatureValues withExpiryTime(OffsetDateTime expiryTime)

The time after which the SAS will no longer work.

permissions

public String permissions()

Specifies which operations the SAS user may perform. Please refer to AccountSASPermission for help constructing the permissions string.

withPermissions

public AccountSASSignatureValues withPermissions(String permissions)

Specifies which operations the SAS user may perform. Please refer to AccountSASPermission for help constructing the permissions string.

ipRange

public IPRange ipRange()

IPRange

withIpRange

public AccountSASSignatureValues withIpRange(IPRange ipRange)

IPRange

services

public String services()

The values that indicate the services accessible with this SAS. Please refer to AccountSASService to construct this value.

withServices

public AccountSASSignatureValues withServices(String services)

The values that indicate the services accessible with this SAS. Please refer to AccountSASService to construct this value.

resourceTypes

public String resourceTypes()

The values that indicate the resource types accessible with this SAS. Please refer to AccountSASResourceType to construct this value.

withResourceTypes

public AccountSASSignatureValues withResourceTypes(String resourceTypes)

The values that indicate the resource types accessible with this SAS. Please refer to AccountSASResourceType to construct this value.

generateSASQueryParameters

public SASQueryParameters generateSASQueryParameters(SharedKeyCredentials sharedKeyCredentials)

Generates a SASQueryParameters 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:

SASQueryParameters