com.amazonaws.services.s3.model

Interface EncryptionMaterialsProvider

All Superinterfaces:

EncryptionMaterialsAccessor

All Known Implementing Classes:

KMSEncryptionMaterialsProvider, StaticEncryptionMaterialsProvider

public interface EncryptionMaterialsProvider
extends EncryptionMaterialsAccessor

Interface for providing encryption materials. Implementations are free to use any strategy for providing encryption materials, such as simply providing static material that doesn't change, or more complicated implementations, such as integrating with existing key management systems.

Method Summary

Modifier and Type	Method and Description
EncryptionMaterials	getEncryptionMaterials() Returns EncryptionMaterials which the caller can use for encryption.
void	refresh() Forces this encryption materials provider to refresh its encryption material.

Methods inherited from interface com.amazonaws.services.s3.model.EncryptionMaterialsAccessor

getEncryptionMaterials

Method Detail

getEncryptionMaterials

EncryptionMaterials getEncryptionMaterials()

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.

Returns:

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

refresh

void refresh()

Forces this encryption materials provider to refresh its encryption material. For many implementations of encryption materials provider, this may simply be a no-op, such as any encryption materials provider implementation that vends static/non-changing encryption material. For other implementations that vend different encryption material throughout their lifetime, this method should force the encryption materials provider to refresh its encryption material.