CustomerProvidedKey Class

Package:

com.azure.storage.file.datalake.models

Maven Artifact:

com.azure:azure-storage-file-datalake:12.21.0

• java.lang.Object
• • com.azure.storage.file.datalake.models.CustomerProvidedKey

public class CustomerProvidedKey

Contains the customer provided key information used to encrypt a file's content on the server.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
EncryptionAlgorithmType	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 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CustomerProvidedKey

public CustomerProvidedKey(byte[] key)

Creates a new wrapper for a client provided key.

Parameters:

key - The encryption key bytes.

CustomerProvidedKey

public CustomerProvidedKey(String key)

Creates a new wrapper for a client provided key.

Parameters:

key - The encryption key encoded as a base64 string.

Method Details

getEncryptionAlgorithm

public EncryptionAlgorithmType getEncryptionAlgorithm()

Gets the algorithm to use this key with.

Returns:

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

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.