Class StaticEncryptionMaterialsProvider

java.lang.Object
com.amazonaws.services.s3.model.StaticEncryptionMaterialsProvider
All Implemented Interfaces:
EncryptionMaterialsAccessor, EncryptionMaterialsFactory, EncryptionMaterialsProvider, Serializable
Direct Known Subclasses:
KMSEncryptionMaterialsProvider

public class StaticEncryptionMaterialsProvider extends Object implements EncryptionMaterialsProvider, Serializable
Simple implementation of EncryptionMaterialsProvider that just wraps static EncryptionMaterials.
See Also:
  • Constructor Details

    • StaticEncryptionMaterialsProvider

      public StaticEncryptionMaterialsProvider(EncryptionMaterials materials)
  • Method Details

    • getEncryptionMaterials

      public EncryptionMaterials getEncryptionMaterials()
      Description copied from interface: EncryptionMaterialsFactory
      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 EncryptionMaterialsFactory
      Returns:
      EncryptionMaterials which the caller can use to encrypt or decrypt data.
    • refresh

      public void refresh()
      Description copied from interface: EncryptionMaterialsProvider
      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.
      Specified by:
      refresh in interface EncryptionMaterialsProvider
    • getEncryptionMaterials

      public EncryptionMaterials getEncryptionMaterials(Map<String,String> materialDescIn)
      Description copied from interface: EncryptionMaterialsAccessor
      Retrieves encryption materials matching the specified description from some source.
      Specified by:
      getEncryptionMaterials in interface EncryptionMaterialsAccessor
      Parameters:
      materialDescIn - A Map<String, String> whose key-value pairs describe an encryption materials object
      Returns:
      The encryption materials that match the description, or null if no matching encryption materials found.