com.microsoft.azure.storage.blob

Class BlobCustomerProvidedKey

java.lang.Object

com.microsoft.azure.storage.blob.BlobCustomerProvidedKey

public final class BlobCustomerProvidedKey
extends Object

Immutable wrapper for an encryption key to be used with client provided key encryption.

Constructor Summary

Constructors

Constructor and Description
BlobCustomerProvidedKey(byte[] key) Creates a new wrapper for a client provided key.
BlobCustomerProvidedKey(String key) Creates a new wrapper for a client provided key.

Method Summary

Methods

Modifier and Type	Method and Description
String	getEncryptionAlgorithm() Gets the algorithm to use this key with.
String	getKey() Gets the encryption key.
String	getKeySHA256() Gets the encryption key's hash.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlobCustomerProvidedKey

public BlobCustomerProvidedKey(String key)
                        throws NoSuchAlgorithmException

Creates a new wrapper for a client provided key.

Parameters:

key - The encryption key encoded as a base64 string.

Throws:

NoSuchAlgorithmException - Throws if MessageDigest "SHA-256" cannot be found.

BlobCustomerProvidedKey

public BlobCustomerProvidedKey(byte[] key)
                        throws NoSuchAlgorithmException

Creates a new wrapper for a client provided key.

Parameters:

key - The encryption key bytes.

Throws:

NoSuchAlgorithmException - Throws if MessageDigest "SHA-256" cannot be found.

Method Detail

getKey

public String getKey()

Gets the encryption key.

Returns:

A base64 encoded string of the encryption key.

getKeySHA256

public String getKeySHA256()

Gets the encryption key's hash.

Returns:

A base64 encoded string of the encryption key hash.

getEncryptionAlgorithm

public String getEncryptionAlgorithm()

Gets the algorithm to use this key with.

Returns:

A label for the encryption algorithm, as understood by Azure Storage.