CommonSasQueryParameters Class

  • Reference
Package:
com.azure.storage.common.sas
Maven Artifact:
com.azure:azure-storage-common:12.27.1
  • java.lang.Object
    • com.azure.storage.common.sas.CommonSasQueryParameters

public class CommonSasQueryParameters

Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly by the user; it is only generated by the URLParts type. NOTE: Instances of this class are immutable to ensure thread safety.

Constructor Summary

Constructor Description
CommonSasQueryParameters(Map<String,String[]> queryParamsMap, boolean removeSasParametersFromMap)

Creates a new CommonSasQueryParameters object.

Method Summary

Modifier and Type Method and Description
String encode()

Encodes all SAS query parameters into a string that can be appended to a URL.
String getAgentObjectId()

Gets the AAD object ID of a user assumed to be unauthorized by the owner of the user delegation key to perform the action granted by the SAS token.
String getCacheControl()

Gets the Cache-Control header value when a client accesses the resource with this sas token.
String getContentDisposition()

Gets the Content-Disposition header value when a client accesses the resource with this sas token.
String getContentEncoding()

Gets the Content-Encoding header value when a client accesses the resource with this sas token.
String getContentLanguage()

Gets the Content-Language header value when a client accesses the resource with this sas token.
String getContentType()

Gets the Content-Type header value when a client accesses the resource with this sas token.
String getCorrelationId()

Gets the correlation id to correlate the storage audit logs with the audit logs used by the principal generating and distributing the SAS.
Integer getDirectoryDepth()

Gets the directory depth of the resource this SAS token authorizes.
String getEncryptionScope()

Gets the encryption scope that will be applied to any write operations performed with the sas.
OffsetDateTime getExpiryTime()

Gets the expiry time for this SAS token.
String getIdentifier()

Gets the signed identifier.
OffsetDateTime getKeyExpiry()

Gets the datetime when the key expires.
String getKeyObjectId()

Gets the object ID of the key.
String getKeyService()

Gets the services that are permitted by the key.
OffsetDateTime getKeyStart()

Gets the datetime when the key becomes active.
String getKeyTenantId()

Gets the tenant ID of the key.
String getKeyVersion()

Gets the service version that created the key.
String getPermissions()

Gets the SAS permissions in a raw format.
String getPreauthorizedAgentObjectId()

Gets the AAD object ID of a user assumed to be authorized by the owner of the user delegation key to perform the action granted by the SAS token.
SasProtocol getProtocol()

Gets the allowed HTTP protocol(s).
String getResource()

Gets the storage resource.
String getResourceTypes()

Gets the storage resource types being accessed (only for Account SAS).
SasIpRange getSasIpRange()

Gets the SasIpRange.
String getServices()

Gets the storage services being accessed (only for Account SAS).
String getSignature()

Gets the signature for the SAS token.
OffsetDateTime getStartTime()

Gets the start time for this SAS token.
String getVersion()

Gets the storage version.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CommonSasQueryParameters

public CommonSasQueryParameters(Map queryParamsMap, boolean removeSasParametersFromMap)

Creates a new CommonSasQueryParameters object.

Parameters:

queryParamsMap - All query parameters for the request as key-value pairs
removeSasParametersFromMap - When true, the SAS query parameters will be removed from queryParamsMap

Method Details

encode

public String encode()

Encodes all SAS query parameters into a string that can be appended to a URL.

Returns:

A String representing the SAS query parameters.

getAgentObjectId

public String getAgentObjectId()

Gets the AAD object ID of a user assumed to be unauthorized by the owner of the user delegation key to perform the action granted by the SAS token. The service will validate the SAS token and ensure that the owner of the user delegation key has the required permissions before granting access and the service will perform an additional POSIX ACL check to determine if this user is authorized to perform the requested operation.

Returns:

The AAD object ID of a user assumed to be unauthorized by the owner of the user delegation key to perform the action granted by the SAS token. The service will validate the SAS token and ensure that the owner of the user delegation key has the required permissions before granting access and the service will perform an additional POSIX ACL check to determine if this user is authorized to perform the requested operation.

getCacheControl

public String getCacheControl()

Gets the Cache-Control header value when a client accesses the resource with this sas token.

Returns:

The Cache-Control header value when a client accesses the resource with this sas token.

getContentDisposition

public String getContentDisposition()

Gets the Content-Disposition header value when a client accesses the resource with this sas token.

Returns:

The Content-Disposition header value when a client accesses the resource with this sas token.

getContentEncoding

public String getContentEncoding()

Gets the Content-Encoding header value when a client accesses the resource with this sas token.

Returns:

The Content-Encoding header value when a client accesses the resource with this sas token.

getContentLanguage

public String getContentLanguage()

Gets the Content-Language header value when a client accesses the resource with this sas token.

Returns:

The Content-Language header value when a client accesses the resource with this sas token.

getContentType

public String getContentType()

Gets the Content-Type header value when a client accesses the resource with this sas token.

Returns:

The Content-Type header value when a client accesses the resource with this sas token.

getCorrelationId

public String getCorrelationId()

Gets the correlation id to correlate the storage audit logs with the audit logs used by the principal generating and distributing the SAS.

Returns:

The correlation id to correlate the storage audit logs with the audit logs used by the principal generating and distributing the SAS.

getDirectoryDepth

public Integer getDirectoryDepth()

Gets the directory depth of the resource this SAS token authorizes.

Returns:

The directory depth of the resource this SAS token authorizes.

getEncryptionScope

public String getEncryptionScope()

Gets the encryption scope that will be applied to any write operations performed with the sas.

Returns:

An encryption scope that will be applied to any write operations performed with the sas.

getExpiryTime

public OffsetDateTime getExpiryTime()

Gets the expiry time for this SAS token.

Returns:

The expiry time for this SAS token.

getIdentifier

public String getIdentifier()

Gets the signed identifier.

Please see here for more information.

Returns:

The signed identifier.

getKeyExpiry

public OffsetDateTime getKeyExpiry()

Gets the datetime when the key expires.

Returns:

the datetime when the key expires.

getKeyObjectId

public String getKeyObjectId()

Gets the object ID of the key.

Returns:

the object ID of the key.

getKeyService

public String getKeyService()

Gets the services that are permitted by the key.

Returns:

the services that are permitted by the key.

getKeyStart

public OffsetDateTime getKeyStart()

Gets the datetime when the key becomes active.

Returns:

the datetime when the key becomes active.

getKeyTenantId

public String getKeyTenantId()

Gets the tenant ID of the key.

Returns:

the tenant ID of the key.

getKeyVersion

public String getKeyVersion()

Gets the service version that created the key.

Returns:

the service version that created the key.

getPermissions

public String getPermissions()

Gets the SAS permissions in a raw format.

Please refer to *SASPermission classes for more details.

Returns:

The SAS permissions in a raw format.

getPreauthorizedAgentObjectId

public String getPreauthorizedAgentObjectId()

Gets the AAD object ID of a user assumed to be authorized by the owner of the user delegation key to perform the action granted by the SAS token. The service will validate the SAS token and ensure that the owner of the user delegation key has the required permissions before granting access but no additional permission check for the agent object id will be performed.

Returns:

The AAD object ID of a user assumed to be authorized by the owner of the user delegation key to perform the action granted by the SAS token. The service will validate the SAS token and ensure that the owner of the user delegation key has the required permissions before granting access but no additional permission check for the agent object id will be performed.

getProtocol

public SasProtocol getProtocol()

Gets the allowed HTTP protocol(s).

Please refer to SasProtocol for more details.

Returns:

The allowed HTTP protocol(s) or null.

getResource

public String getResource()

Gets the storage resource.

Returns:

The storage resource.

getResourceTypes

public String getResourceTypes()

Gets the storage resource types being accessed (only for Account SAS).

Please refer to AccountSasResourceType for more details.

Returns:

The storage resource types being accessed (only for Account SAS).

getSasIpRange

public SasIpRange getSasIpRange()

Gets the SasIpRange.

Returns:

getServices

public String getServices()

Gets the storage services being accessed (only for Account SAS).

Please refer to AccountSasService for more details.

Returns:

The storage services being accessed (only for Account SAS).

getSignature

public String getSignature()

Gets the signature for the SAS token.

Returns:

The signature for the SAS token.

getStartTime

public OffsetDateTime getStartTime()

Gets the start time for this SAS token.

Returns:

The start time for this SAS token or null.

getVersion

public String getVersion()

Gets the storage version.

Returns:

The storage version

Applies to