Share via

StorageCredentialsSharedAccessSignature Class

  • Reference
Package:
com.microsoft.azure.storage
  • java.lang.Object

public class StorageCredentialsSharedAccessSignature extends StorageCredentials

Represents storage credentials for delegated access to Blob service resources via a shared access signature.

Constructor Summary

Constructor Description
StorageCredentialsSharedAccessSignature(final String token)

Creates an instance of the class using the specified shared access signature token.

Method Summary

Modifier and Type Method and Description
String getToken()

Returns the shared access signature token.
String toString(final boolean exportSecrets)

Returns a that represents this instance, optionally including sensitive data.
URI transformUri(final URI resourceUri, final OperationContext opContext)

Transforms a resource URI into a shared access signature URI, by appending a shared access token and using the specified operation context.
StorageUri transformUri(StorageUri resourceUri, OperationContext opContext)

Transforms a resource URI into a shared access signature URI, by appending a shared access token and using the specified operation context.

Inherited Members

StorageCredentials.getAccountName() StorageCredentials.isHttpsOnly() StorageCredentials.setHttpsOnly(boolean httpsOnly) StorageCredentials.transformUri(final URI resourceUri) StorageCredentials.transformUri(StorageUri resourceUri) StorageCredentials.tryParseCredentials(final Map<String, String> settings) StorageCredentials.tryParseCredentials(final String connectionString)

Constructor Details

StorageCredentialsSharedAccessSignature

public StorageCredentialsSharedAccessSignature(final String token)

Creates an instance of the class using the specified shared access signature token.

Parameters:

token - A String that represents shared access signature token.

Method Details

getToken

public String getToken()

Returns the shared access signature token.

Returns:

A String that contains the token.

toString

public String toString(final boolean exportSecrets)

Returns a that represents this instance, optionally including sensitive data.

Parameters:

exportSecrets -

true to include sensitive data in the return string; otherwise, false.

Returns:

A String that represents this object, optionally including sensitive data.

transformUri

public URI transformUri(final URI resourceUri, final OperationContext opContext)

Transforms a resource URI into a shared access signature URI, by appending a shared access token and using the specified operation context.

Parameters:

resourceUri - A java.net.URI object that represents the resource URI to be transformed.
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

A java.net.URI object that represents the signature, including the resource URI and the shared access token.

Throws:

StorageException - If a storage service error occurred.
URISyntaxException - If the resource URI is not properly formatted.

transformUri

public StorageUri transformUri(StorageUri resourceUri, OperationContext opContext)

Transforms a resource URI into a shared access signature URI, by appending a shared access token and using the specified operation context.

Parameters:

resourceUri - A StorageUri object that represents the resource URI to be transformed.
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

A StorageUri object that represents the signature, including the resource URI and the shared access token.

Throws:

StorageException - If a storage service error occurred.
URISyntaxException - If the resource URI is not properly formatted.

Applies to