com.microsoft.azure.storage

Class StorageKey

java.lang.Object

com.microsoft.azure.storage.StorageKey

Deprecated.

as of 3.0.0. Please use the methods on StorageCredentialsAccountAndKey.

@Deprecated
public final class StorageKey
extends Object

Represents a container for a storage key.

Constructor Summary

Constructors

Constructor and Description
StorageKey(byte[] key) Deprecated. Creates an instance of the StorageKey class.

Method Summary

Methods

Modifier and Type	Method and Description
static String	computeMacSha256(StorageKey storageKey, String stringToSign) Deprecated. Computes a signature for the specified string using the HMAC-SHA256 algorithm.
static String	computeMacSha512(StorageKey storageKey, String stringToSign) Deprecated. Computes a signature for the specified string using the HMAC-SHA512 algorithm.
String	getBase64EncodedKey() Deprecated. Returns the Base64-encoded key.
byte[]	getKey() Deprecated. Returns the key.
void	setKey(byte[] key) Deprecated. Sets the key to be used, using the specified byte array as the key.
void	setKey(String key) Deprecated. Sets the key to be used, using the specified String as the key.

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageKey

public StorageKey(byte[] key)

Deprecated.

Creates an instance of the StorageKey class.

Parameters:

key - An array of bytes that represent the storage key.

Method Detail

computeMacSha256

public static String computeMacSha256(StorageKey storageKey,
                      String stringToSign)
                               throws InvalidKeyException

Deprecated.

Computes a signature for the specified string using the HMAC-SHA256 algorithm.

Parameters:

storageKey - A StorageKey object that represents the storage key to use.

stringToSign - The UTF-8-encoded string to sign.

Returns:

A String that contains the HMAC-SHA256-encoded signature.

Throws:

IllegalArgumentException - If the string to sign is not a valid Base64-encoded string.

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

computeMacSha512

public static String computeMacSha512(StorageKey storageKey,
                      String stringToSign)
                               throws InvalidKeyException

Deprecated.

Computes a signature for the specified string using the HMAC-SHA512 algorithm.

Parameters:

storageKey - A StorageKey object that represents the storage key to use.

stringToSign - The UTF-8-encoded string to sign.

Returns:

A String that contains the HMAC-SHA512-encoded signature.

Throws:

IllegalArgumentException - If the string to sign is not a valid Base64-encoded string.

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

getBase64EncodedKey

public String getBase64EncodedKey()

Deprecated.

Returns the Base64-encoded key.

Returns:

A String that represents the Base64-encoded key.

getKey

public byte[] getKey()

Deprecated.

Returns the key.

Returns:

A byte array that represents the key.

setKey

public void setKey(byte[] key)

Deprecated.

Sets the key to be used, using the specified byte array as the key.

This method is provided to support key rotation. This method is not thread-safe.

Parameters:

key - A byte array that represents the key being assigned.

setKey

public void setKey(String key)

Deprecated.

Sets the key to be used, using the specified String as the key.

This method is provided to support key rotation. This method is not thread-safe.

Parameters:

key - A String that represents the key being assigned.