com.microsoft.azure.storage

Class StorageCredentialsToken

java.lang.Object

com.microsoft.azure.storage.StorageCredentials

com.microsoft.azure.storage.StorageCredentialsToken

public final class StorageCredentialsToken
extends StorageCredentials

Represents storage account credentials, based on an authentication token, for accessing the Microsoft Azure storage services.

Constructor Summary

Constructors

Constructor and Description
StorageCredentialsToken(String accountName, String token) Creates an instance of the StorageCredentialsToken class, using the specified token.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAccountName() Gets the account name.
String	getToken() Gets the token.
boolean	isHttpsOnly() Gets whether this StorageCredentials object only allows access via HTTPS.
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.
void	updateToken(String token) Sets the token to be used when authenticating HTTPS requests.

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

transformUri, transformUri, tryParseCredentials

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageCredentialsToken

public StorageCredentialsToken(String accountName,
                       String token)

Creates an instance of the StorageCredentialsToken class, using the specified token. Token credentials must only be used with HTTPS requests on the blob and queue services. The specified token is stored as a String.

Parameters:

token - A String that represents the token.

Method Detail

isHttpsOnly

public boolean isHttpsOnly()

Gets whether this StorageCredentials object only allows access via HTTPS.

Overrides:

isHttpsOnly in class StorageCredentials

Returns:

A boolean representing whether this StorageCredentials object only allows access via HTTPS.

getToken

public String getToken()

Gets the token.

Returns:

A String that contains the token.

updateToken

public void updateToken(String token)

Sets the token to be used when authenticating HTTPS requests.

Parameters:

token - A String that represents the access token to be used when authenticating HTTPS requests.

getAccountName

public String getAccountName()

Gets the account name.

Overrides:

getAccountName in class StorageCredentials

Returns:

A String that contains the account name.

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)

Description copied from class: StorageCredentials

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.

transformUri

public StorageUri transformUri(StorageUri resourceUri,
                      OperationContext opContext)

Description copied from class: StorageCredentials

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.