StorageCredentialsHelper (Microsoft Azure Storage Client SDK 2.2.0 API)

java.lang.Object
- com.microsoft.azure.storage.core.StorageCredentialsHelper

```
public class StorageCredentialsHelper
extends Object
```
RESERVED FOR INTERNAL USE. A helper method for StorageCredentials.

Constructor Summary

Constructors
Constructor and Description

StorageCredentialsHelper()

Constructors
Constructor and Description
`StorageCredentialsHelper()`

Method Summary

Methods
Modifier and Type	Method and Description
`static boolean`	`canCredentialsSignRequest(StorageCredentials creds)` Reserved.
`static boolean`	`canCredentialsSignRequestLite(StorageCredentials creds)` Deprecated. as of 2.0.0. Use `canCredentialsSignRequest(com.microsoft.azure.storage.StorageCredentials)` instead.
`static String`	`computeHmac256(StorageCredentials creds, String value)` Computes a signature for the specified string using the HMAC-SHA256 algorithm.
`static String`	`computeHmac256(StorageCredentials creds, String value, OperationContext opContext)` Computes a signature for the specified string using the HMAC-SHA256 algorithm with the specified operation context.
`static void`	`signBlobAndQueueRequest(StorageCredentials creds, HttpURLConnection request, long contentLength)` Signs a request under the Shared Key authentication scheme.
`static void`	`signBlobAndQueueRequest(StorageCredentials creds, HttpURLConnection request, long contentLength, OperationContext opContext)` Signs a request using the specified operation context under the Shared Key authentication scheme.
`static void`	`signBlobAndQueueRequestLite(StorageCredentials creds, HttpURLConnection request, long contentLength)` Deprecated. as of 2.0.0. Use `signBlobAndQueueRequest(com.microsoft.azure.storage.StorageCredentials, java.net.HttpURLConnection, long)` instead.
`static void`	`signBlobAndQueueRequestLite(StorageCredentials creds, HttpURLConnection request, long contentLength, OperationContext opContext)` Deprecated. as of 2.0.0. Use `signBlobAndQueueRequest(com.microsoft.azure.storage.StorageCredentials, java.net.HttpURLConnection, long)` instead.
`static void`	`signTableRequest(StorageCredentials creds, HttpURLConnection request, long contentLength)` Signs a request 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.
`static void`	`signTableRequestLite(StorageCredentials creds, HttpURLConnection request, long contentLength)` Deprecated. as of 2.0.0. Use `signTableRequest(com.microsoft.azure.storage.StorageCredentials, java.net.HttpURLConnection, long)` instead.
`static void`	`signTableRequestLite(StorageCredentials creds, HttpURLConnection request, long contentLength, OperationContext opContext)` Deprecated. as of 2.0.0. Use `signTableRequest(com.microsoft.azure.storage.StorageCredentials, java.net.HttpURLConnection, long)` instead.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StorageCredentialsHelper
```
public StorageCredentialsHelper()
```
- Method Detail
  - canCredentialsSignRequest
```
public static boolean canCredentialsSignRequest(StorageCredentials creds)
```
    Reserved.
  - canCredentialsSignRequestLite
```
@Deprecated
public static boolean canCredentialsSignRequestLite(StorageCredentials creds)
```
    Deprecated. as of 2.0.0. Use canCredentialsSignRequest(com.microsoft.azure.storage.StorageCredentials) instead.
    
    Reserved.
  - 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.
  - computeHmac256
```
public static String computeHmac256(StorageCredentials creds,
                    String value,
                    OperationContext opContext)
                             throws InvalidKeyException
```
    Computes a signature for the specified string using the HMAC-SHA256 algorithm with the specified operation context.
    
    Parameters:
    value - The UTF-8-encoded string to sign.
    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 String that contains the HMAC-SHA256-encoded signature.
    
    Throws:
    
    InvalidKeyException - If the key is not a valid Base64-encoded string.
  - signBlobAndQueueRequest
```
public static void signBlobAndQueueRequest(StorageCredentials creds,
                           HttpURLConnection request,
                           long contentLength)
                                    throws InvalidKeyException,
                                           StorageException
```
    Signs a request 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.
    
    Throws:
    
    InvalidKeyException - If the given key is invalid.
    
    StorageException - If a storage service error occurred.
  - signBlobAndQueueRequest
```
public static void signBlobAndQueueRequest(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.
  - signBlobAndQueueRequestLite
```
@Deprecated
public static void signBlobAndQueueRequestLite(StorageCredentials creds,
                                          HttpURLConnection request,
                                          long contentLength)
                                        throws InvalidKeyException,
                                               StorageException
```
    Deprecated. as of 2.0.0. Use signBlobAndQueueRequest(com.microsoft.azure.storage.StorageCredentials, java.net.HttpURLConnection, long) instead.
    
    Signs a request using the Shared Key Lite 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.
    
    Throws:
    
    InvalidKeyException - If the given key is invalid.
    
    StorageException - If an unspecified storage exception occurs.
  - signBlobAndQueueRequestLite
```
@Deprecated
public static void signBlobAndQueueRequestLite(StorageCredentials creds,
                                          HttpURLConnection request,
                                          long contentLength,
                                          OperationContext opContext)
                                        throws StorageException,
                                               InvalidKeyException
```
    Deprecated. as of 2.0.0. Use signBlobAndQueueRequest(com.microsoft.azure.storage.StorageCredentials, java.net.HttpURLConnection, long) instead.
    
    Signs a request using the specified operation context under the Shared Key Lite 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)
                             throws InvalidKeyException,
                                    StorageException
```
    Signs a request 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.
    
    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.
  - signTableRequestLite
```
@Deprecated
public static void signTableRequestLite(StorageCredentials creds,
                                   HttpURLConnection request,
                                   long contentLength)
                                 throws InvalidKeyException,
                                        StorageException
```
    Deprecated. as of 2.0.0. Use signTableRequest(com.microsoft.azure.storage.StorageCredentials, java.net.HttpURLConnection, long) instead.
    
    Signs a request using the Shared Key Lite 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.
    
    Throws:
    
    InvalidKeyException - If the given key is invalid.
    
    StorageException - If an unspecified storage exception occurs.
  - signTableRequestLite
```
@Deprecated
public static void signTableRequestLite(StorageCredentials creds,
                                   HttpURLConnection request,
                                   long contentLength,
                                   OperationContext opContext)
                                 throws StorageException,
                                        InvalidKeyException
```
    Deprecated. as of 2.0.0. Use signTableRequest(com.microsoft.azure.storage.StorageCredentials, java.net.HttpURLConnection, long) instead.
    
    Signs a request using the specified operation context under the Shared Key Lite 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.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class StorageCredentialsHelper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StorageCredentialsHelper

Method Detail

canCredentialsSignRequest

canCredentialsSignRequestLite

computeHmac256

computeHmac256

signBlobAndQueueRequest

signBlobAndQueueRequest

signBlobAndQueueRequestLite

signBlobAndQueueRequestLite

signTableRequest

signTableRequest

signTableRequestLite

signTableRequestLite