com.microsoft.azure.storage.blob

Class ServiceSASSignatureValues

java.lang.Object

com.microsoft.azure.storage.blob.ServiceSASSignatureValues

public final class ServiceSASSignatureValues
extends Object

ServiceSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage service. 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 more details on each value, including which are required.

Field Summary

Fields

Modifier and Type	Field and Description
String	blobName The name of the container the SAS user may access.
String	cacheControl The cache-control header for the SAS.
String	containerName The name of the container the SAS user may access.
String	contentDisposition The content-disposition header for the SAS.
String	contentEncoding The content-encoding header for the SAS.
String	contentLanguage The content-language header for the SAS.
String	contentType The content-type header for the SAS.
OffsetDateTime	expiryTime The time after which the SAS will no longer work.
String	identifier The name of the access policy on the container this SAS references if any.
IPRange	ipRange IPRange
String	permissions Please refer to either ContainerSASPermission or BlobSASPermission depending on the resource being accessed for help constructing the permissions string.
SASProtocol	protocol SASProtocol
OffsetDateTime	startTime When the SAS will take effect.
String	version The version of the service this SAS will target.

Constructor Summary

Constructors

Constructor and Description
ServiceSASSignatureValues() Creates an object with empty values for all fields.

Method Summary

Modifier and Type	Method and Description
SASQueryParameters	generateSASQueryParameters(SharedKeyCredentials sharedKeyCredentials) Uses an account's shared key credential to sign these signature values to produce the proper SAS query parameters.

Methods inherited from class java.lang.Object

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

Field Detail

version

public String version

The version of the service this SAS will target. If not specified, it will default to the version targeted by the library.

protocol

public SASProtocol protocol

SASProtocol

startTime

public OffsetDateTime startTime

When the SAS will take effect.

expiryTime

public OffsetDateTime expiryTime

The time after which the SAS will no longer work.

permissions

public String permissions

Please refer to either ContainerSASPermission or BlobSASPermission depending on the resource being accessed for help constructing the permissions string.

ipRange

public IPRange ipRange

IPRange

containerName

public String containerName

The name of the container the SAS user may access.

blobName

public String blobName

The name of the container the SAS user may access.

identifier

public String identifier

The name of the access policy on the container this SAS references if any. Please see here for more information.

cacheControl

public String cacheControl

The cache-control header for the SAS.

contentDisposition

public String contentDisposition

The content-disposition header for the SAS.

contentEncoding

public String contentEncoding

The content-encoding header for the SAS.

contentLanguage

public String contentLanguage

The content-language header for the SAS.

contentType

public String contentType

The content-type header for the SAS.

Constructor Detail

ServiceSASSignatureValues

public ServiceSASSignatureValues()

Creates an object with empty values for all fields.

Method Detail

generateSASQueryParameters

public SASQueryParameters generateSASQueryParameters(SharedKeyCredentials sharedKeyCredentials)

Uses an account's shared key credential to sign these signature values to produce the proper SAS query parameters.

Parameters:

sharedKeyCredentials - A SharedKeyCredentials object used to sign the SAS values.

Returns:

SASQueryParameters