com.microsoft.azure.storage.core

Class StorageCredentialsHelper

java.lang.Object

com.microsoft.azure.storage.core.StorageCredentialsHelper

public final class StorageCredentialsHelper
extends Object

RESERVED FOR INTERNAL USE. A helper method for StorageCredentials.

Method Summary

Modifier and Type	Method and Description
static boolean	canCredentialsGenerateClient(StorageCredentials creds) RESERVED, for internal use only.
static boolean	canCredentialsSignRequest(StorageCredentials creds) RESERVED, for internal use only.
static String	computeHmac256(StorageCredentials creds, String value) Computes a signature for the specified string using the HMAC-SHA256 algorithm.
static void	signBlobQueueAndFileRequest(StorageCredentials creds, HttpURLConnection request, long contentLength, OperationContext opContext) Signs a request using the specified operation context under the Shared Key authentication scheme.
static void	signTableRequest(StorageCredentials creds, HttpURLConnection request, long contentLength, OperationContext opContext) Signs a request using the specified operation context under the Shared Key authentication scheme.

Methods inherited from class java.lang.Object

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

Method Detail

canCredentialsSignRequest

public static boolean canCredentialsSignRequest(StorageCredentials creds)

RESERVED, for internal use only. Gets a value indicating whether a request can be signed under the Shared Key authentication scheme using the specified credentials.

Returns:

true if a request can be signed with these credentials; otherwise, false

canCredentialsGenerateClient

public static boolean canCredentialsGenerateClient(StorageCredentials creds)

RESERVED, for internal use only. Gets a value indicating whether a client can be generated under the Shared Key or Shared Access Signature authentication schemes using the specified credentials.

Returns:

true if a client can be generated with these credentials; otherwise, false

computeHmac256

public static String computeHmac256(StorageCredentials creds,
                                    String value)
                             throws InvalidKeyException

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

Parameters:

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

Returns:

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

Throws:

InvalidKeyException - If the key is not a valid Base64-encoded string.

signBlobQueueAndFileRequest

public static void signBlobQueueAndFileRequest(StorageCredentials creds,
                                               HttpURLConnection request,
                                               long contentLength,
                                               OperationContext opContext)
                                        throws InvalidKeyException,
                                               StorageException

Signs a request using the specified operation context under the Shared Key authentication scheme.

Parameters:

request - An HttpURLConnection object that represents the request to sign.

contentLength - The length of the content written to the output stream. If unknown, specify -1.

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.

Throws:

InvalidKeyException - If the given key is invalid.

StorageException - If a storage service error occurred.

signTableRequest

public static void signTableRequest(StorageCredentials creds,
                                    HttpURLConnection request,
                                    long contentLength,
                                    OperationContext opContext)
                             throws InvalidKeyException,
                                    StorageException

Signs a request using the specified operation context under the Shared Key authentication scheme.

Parameters:

request - An HttpURLConnection object that represents the request to sign.

contentLength - The length of the content written to the output stream. If unknown, specify -1.

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.

Throws:

InvalidKeyException - If the given key is invalid.

StorageException - If a storage service error occurred.