com.microsoft.azure.storage.queue

Class QueueEncryptionPolicy

java.lang.Object

com.microsoft.azure.storage.queue.QueueEncryptionPolicy

public final class QueueEncryptionPolicy
extends Object

Represents a queue encryption policy that is used to perform envelope encryption/decryption of Azure queue messages.

Field Summary

Fields

Modifier and Type	Field and Description
com.microsoft.azure.keyvault.core.IKeyResolver	keyResolver The IKeyResolver used to select the correct key for decrypting existing queue messages.
com.microsoft.azure.keyvault.core.IKey	keyWrapper An object of type IKey that is used to wrap/unwrap the content key during encryption.

Constructor Summary

Constructors

Constructor and Description
QueueEncryptionPolicy(com.microsoft.azure.keyvault.core.IKey key, com.microsoft.azure.keyvault.core.IKeyResolver keyResolver) Initializes a new instance of the QueueEncryptionPolicy class with the specified key and resolver.

Method Summary

Modifier and Type	Method and Description
com.microsoft.azure.keyvault.core.IKey	getKey() Gets the IKey that is used to wrap/unwrap the content key during encryption.
com.microsoft.azure.keyvault.core.IKeyResolver	getKeyResolver() Gets the key resolver used to select the correct key for decrypting existing queue messages.
void	setKey(com.microsoft.azure.keyvault.core.IKey key) Sets the IKey that is used to wrap/unwrap the content key during encryption.
void	setKeyResolver(com.microsoft.azure.keyvault.core.IKeyResolver keyResolver) Sets the key resolver used to select the correct key for decrypting existing queue messages.

Methods inherited from class java.lang.Object

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

Field Detail

keyWrapper

public com.microsoft.azure.keyvault.core.IKey keyWrapper

An object of type IKey that is used to wrap/unwrap the content key during encryption.

keyResolver

public com.microsoft.azure.keyvault.core.IKeyResolver keyResolver

The IKeyResolver used to select the correct key for decrypting existing queue messages.

Constructor Detail

QueueEncryptionPolicy

public QueueEncryptionPolicy(com.microsoft.azure.keyvault.core.IKey key,
                             com.microsoft.azure.keyvault.core.IKeyResolver keyResolver)

Initializes a new instance of the QueueEncryptionPolicy class with the specified key and resolver.

If the generated policy is intended to be used for encryption, users are expected to provide a key at the minimum. The absence of key will cause an exception to be thrown during encryption. If the generated policy is intended to be used for decryption, users can provide a keyResolver. The client library will - 1. Invoke the key resolver if specified to get the key. 2. If resolver is not specified but a key is specified, match the key id on the key and use it.

Parameters:

key - An object of type IKey that is used to wrap/unwrap the content encryption key.

keyResolver - The key resolver used to select the correct key for decrypting existing queue messages.

Method Detail

getKey

public com.microsoft.azure.keyvault.core.IKey getKey()

Gets the IKey that is used to wrap/unwrap the content key during encryption.

Returns:

An IKey object.

getKeyResolver

public com.microsoft.azure.keyvault.core.IKeyResolver getKeyResolver()

Gets the key resolver used to select the correct key for decrypting existing queue messages.

Returns:

A resolver that returns an SymmetricKey given a keyId.

setKey

public void setKey(com.microsoft.azure.keyvault.core.IKey key)

Sets the IKey that is used to wrap/unwrap the content key during encryption.

Parameters:

key - An IKey object.

setKeyResolver

public void setKeyResolver(com.microsoft.azure.keyvault.core.IKeyResolver keyResolver)

Sets the key resolver used to select the correct key for decrypting existing queue messages.

Parameters:

keyResolver - A resolver that returns an IKey given a keyId.