com.microsoft.azure.storage

Class StorageCredentialsAccountAndKey

java.lang.Object

com.microsoft.azure.storage.StorageCredentials

com.microsoft.azure.storage.StorageCredentialsAccountAndKey

public final class StorageCredentialsAccountAndKey
extends StorageCredentials

Represents storage account credentials, based on storage account and access key, for accessing the Microsoft Azure storage services.

Constructor Summary

Constructors

Constructor and Description
StorageCredentialsAccountAndKey(String accountName, byte[] key) Creates an instance of the StorageCredentialsAccountAndKey class, using the specified storage account name and access key; the specified access key is in the form of a byte array.
StorageCredentialsAccountAndKey(String accountName, String key) Creates an instance of the StorageCredentialsAccountAndKey class, using the specified storage account name and access key; the specified access key is stored as a String.

Method Summary

Methods

Modifier and Type	Method and Description
String	exportBase64EncodedKey() Exports the value of the access key to a Base64-encoded string.
byte[]	exportKey() Exports the value of the access key to an array of bytes.
String	getAccountName() Gets the account name.
Mac	getHmac256() Gets the HmacSha256 associated with the account key.
void	setAccountName(String accountName) Sets the account name.
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	updateKey(byte[] key) Sets the name of the access key to be used when signing the request.
void	updateKey(String key) Sets the name of the access key to be used when signing the request.

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

isHttpsOnly, transformUri, transformUri, tryParseCredentials

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageCredentialsAccountAndKey

public StorageCredentialsAccountAndKey(String accountName,
                               byte[] key)

Creates an instance of the StorageCredentialsAccountAndKey class, using the specified storage account name and access key; the specified access key is in the form of a byte array.

Parameters:

accountName - A String that represents the name of the storage account.

key - An array of bytes that represent the account access key.

StorageCredentialsAccountAndKey

public StorageCredentialsAccountAndKey(String accountName,
                               String key)

Creates an instance of the StorageCredentialsAccountAndKey class, using the specified storage account name and access key; the specified access key is stored as a String.

Parameters:

accountName - A String that represents the name of the storage account.

key - A String that represents the Base-64-encoded account access key.

Method Detail

getAccountName

public String getAccountName()

Gets the account name.

Overrides:

getAccountName in class StorageCredentials

Returns:

A String that contains the account name.

exportBase64EncodedKey

public String exportBase64EncodedKey()

Exports the value of the access key to a Base64-encoded string.

Returns:

A String that represents the Base64-encoded access key.

exportKey

public byte[] exportKey()

Exports the value of the access key to an array of bytes.

Returns:

A byte array that represents the access key.

setAccountName

public void setAccountName(String accountName)

Sets the account name.

Parameters:

accountName - A String that contains the account name.

updateKey

public void updateKey(String key)

Sets the name of the access key to be used when signing the request.

Parameters:

key - A String that represents the name of the access key to be used when signing the request.

updateKey

public void updateKey(byte[] key)

Sets the name of the access key to be used when signing the request.

Parameters:

key - A String that represents the name of the access key to be used when signing the request.

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.

getHmac256

public Mac getHmac256()
               throws InvalidKeyException

Gets the HmacSha256 associated with the account key.

Returns:

A MAC created with the account key.

Throws:

InvalidKeyException - If the key is not a valid storage key.