com.amazonaws.services.dynamodbv2.datamodeling.encryption.providers

Class KeyStoreMaterialsProvider

java.lang.Object

com.amazonaws.services.dynamodbv2.datamodeling.encryption.providers.KeyStoreMaterialsProvider

All Implemented Interfaces:

EncryptionMaterialsProvider

public class KeyStoreMaterialsProvider
extends java.lang.Object
implements EncryptionMaterialsProvider

Constructor Summary

Constructors

Constructor and Description
KeyStoreMaterialsProvider(java.security.KeyStore keyStore, java.lang.String encryptionAlias, java.lang.String signingAlias, java.security.KeyStore.ProtectionParameter encryptionProtection, java.security.KeyStore.ProtectionParameter signingProtection, java.util.Map<java.lang.String,java.lang.String> description)
KeyStoreMaterialsProvider(java.security.KeyStore keyStore, java.lang.String encryptionAlias, java.lang.String signingAlias, java.util.Map<java.lang.String,java.lang.String> description)

Method Summary

Modifier and Type	Method and Description
DecryptionMaterials	getDecryptionMaterials(EncryptionContext context) Retrieves encryption materials matching the specified description from some source.
EncryptionMaterials	getEncryptionMaterials(EncryptionContext context) Returns EncryptionMaterials which the caller can use for encryption.
void	refresh() Reloads the keys from the underlying keystore by calling KeyStore.getEntry(String, ProtectionParameter) again for each of them.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyStoreMaterialsProvider

public KeyStoreMaterialsProvider(java.security.KeyStore keyStore,
                                 java.lang.String encryptionAlias,
                                 java.lang.String signingAlias,
                                 java.util.Map<java.lang.String,java.lang.String> description)
                          throws java.security.KeyStoreException,
                                 java.security.NoSuchAlgorithmException,
                                 java.security.UnrecoverableEntryException

Throws:

java.security.KeyStoreException

java.security.NoSuchAlgorithmException

java.security.UnrecoverableEntryException

KeyStoreMaterialsProvider

public KeyStoreMaterialsProvider(java.security.KeyStore keyStore,
                                 java.lang.String encryptionAlias,
                                 java.lang.String signingAlias,
                                 java.security.KeyStore.ProtectionParameter encryptionProtection,
                                 java.security.KeyStore.ProtectionParameter signingProtection,
                                 java.util.Map<java.lang.String,java.lang.String> description)
                          throws java.security.KeyStoreException,
                                 java.security.NoSuchAlgorithmException,
                                 java.security.UnrecoverableEntryException

Throws:

java.security.KeyStoreException

java.security.NoSuchAlgorithmException

java.security.UnrecoverableEntryException

Method Detail

getDecryptionMaterials

public DecryptionMaterials getDecryptionMaterials(EncryptionContext context)

Description copied from interface: EncryptionMaterialsProvider

Retrieves encryption materials matching the specified description from some source.

Specified by:

getDecryptionMaterials in interface EncryptionMaterialsProvider

Parameters:

context - Information to assist in selecting a the proper return value. The implementation is free to determine the minimum necessary for successful processing.

Returns:

The encryption materials that match the description, or null if no matching encryption materials found.

getEncryptionMaterials

public EncryptionMaterials getEncryptionMaterials(EncryptionContext context)

Description copied from interface: EncryptionMaterialsProvider

Returns EncryptionMaterials which the caller can use for encryption. Each implementation of EncryptionMaterialsProvider can choose its own strategy for loading encryption material. For example, an implementation might load encryption material from an existing key management system, or load new encryption material when keys are rotated.

Specified by:

getEncryptionMaterials in interface EncryptionMaterialsProvider

Parameters:

context - Information to assist in selecting a the proper return value. The implementation is free to determine the minimum necessary for successful processing.

Returns:

EncryptionMaterials which the caller can use to encrypt or decrypt data.

refresh

public void refresh()

Reloads the keys from the underlying keystore by calling KeyStore.getEntry(String, ProtectionParameter) again for each of them.

Specified by:

refresh in interface EncryptionMaterialsProvider