com.microsoft.azure.storage

Class StorageCredentialsSharedAccessSignature

java.lang.Object

com.microsoft.azure.storage.StorageCredentials

com.microsoft.azure.storage.StorageCredentialsSharedAccessSignature

public final class StorageCredentialsSharedAccessSignature
extends StorageCredentials

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

Constructor Summary

Constructors

Constructor and Description
StorageCredentialsSharedAccessSignature(String token) Creates an instance of the StorageCredentialsSharedAccessSignature 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(boolean exportSecrets) Returns a String that represents this instance, optionally including sensitive data.
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.
URI	transformUri(URI 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.

Methods inherited from class com.microsoft.azure.storage.StorageCredentials

getAccountName, isHttpsOnly, setHttpsOnly, transformUri, transformUri, tryParseCredentials, tryParseCredentials

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageCredentialsSharedAccessSignature

public StorageCredentialsSharedAccessSignature(String token)

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

Parameters:

token - A String that represents shared access signature token.

Method Detail

getToken

public String getToken()

Returns the shared access signature token.

Returns:

A String that contains the token.

toString

public String toString(boolean exportSecrets)

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

Specified by:

toString in class StorageCredentials

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(URI resourceUri,
                        OperationContext opContext)
                 throws URISyntaxException,
                        StorageException

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

Specified by:

transformUri in class StorageCredentials

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)
                        throws URISyntaxException,
                               StorageException

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

Specified by:

transformUri in class StorageCredentials

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.