Class EncryptedInitiateMultipartUploadRequest

All Implemented Interfaces:
ReadLimitInfo, MaterialsDescriptionProvider, SSEAwsKeyManagementParamsProvider, SSECustomerKeyProvider, Serializable, Cloneable

public class EncryptedInitiateMultipartUploadRequest extends InitiateMultipartUploadRequest implements MaterialsDescriptionProvider, Serializable
This class is an extension of InitiateMultipartUploadRequest to allow additional crypto related attributes to be specified.

In particular, this includes the options to

  • specify encryption material description on a per-request basis;
  • specify whether a new set of encryption material is to be created for the upload or not;
In particular, EncryptedInitiateMultipartUploadRequest is only recognized by AmazonS3EncryptionClient.

If EncryptedInitiateMultipartUploadRequest is used against the non-encrypting AmazonS3Client, these additional attributes will be ignored.

See Also:
  • Constructor Details

    • EncryptedInitiateMultipartUploadRequest

      public EncryptedInitiateMultipartUploadRequest(String bucketName, String key)
    • EncryptedInitiateMultipartUploadRequest

      public EncryptedInitiateMultipartUploadRequest(String bucketName, String key, ObjectMetadata objectMetadata)
  • Method Details

    • getMaterialsDescription

      public Map<String,String> getMaterialsDescription()
      Description copied from interface: MaterialsDescriptionProvider
      Returns an unmodifiable view of the MaterialsDescription which the caller can use to load EncryptionMaterials from any EncryptionMaterialsAccessor
      Specified by:
      getMaterialsDescription in interface MaterialsDescriptionProvider
      Returns:
      materials description.
    • setMaterialsDescription

      public void setMaterialsDescription(Map<String,String> materialsDescription)
      sets the materials description for the encryption materials to be used with the current Multi Part Upload Request.
      Parameters:
      materialsDescription - the materialsDescription to set
    • withMaterialsDescription

      public EncryptedInitiateMultipartUploadRequest withMaterialsDescription(Map<String,String> materialsDescription)
      sets the materials description for the encryption materials to be used with the current Multi Part Upload Request.
      Parameters:
      materialsDescription - the materialsDescription to set
    • isCreateEncryptionMaterial

      public boolean isCreateEncryptionMaterial()
      Returns true if a new set of encryption material is to be created; false otherwise. Default is true.
    • setCreateEncryptionMaterial

      public void setCreateEncryptionMaterial(boolean createEncryptionMaterial)
      Parameters:
      createEncryptionMaterial - true if a new set of encryption material is to be created; false otherwise.
    • withCreateEncryptionMaterial

      public EncryptedInitiateMultipartUploadRequest withCreateEncryptionMaterial(boolean createEncryptionMaterial)
      Parameters:
      createEncryptionMaterial - true if a new set of encryption material is to be created; false otherwise.