Package com.amazonaws.services.s3.model
Class EncryptedPutObjectRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.s3.model.AbstractPutObjectRequest
-
- com.amazonaws.services.s3.model.PutObjectRequest
-
- com.amazonaws.services.s3.model.EncryptedPutObjectRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,MaterialsDescriptionProvider
,S3DataSource
,SSEAwsKeyManagementParamsProvider
,SSECustomerKeyProvider
,Serializable
,Cloneable
public class EncryptedPutObjectRequest extends PutObjectRequest implements MaterialsDescriptionProvider, Serializable
This class is an extension of
PutObjectRequest
to allow additional encryption material description to be specified on a per-request basis.In particular,EncryptedPutObjectRequest
is only recognized byAmazonS3EncryptionClient
.If
EncryptedPutObjectRequest
is used against the non-encryptingAmazonS3Client
, the additional attributes will be ignored.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.amazonaws.services.s3.model.S3DataSource
S3DataSource.Utils
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description EncryptedPutObjectRequest(String bucketName, String key, File file)
EncryptedPutObjectRequest(String bucketName, String key, InputStream input, ObjectMetadata metadata)
EncryptedPutObjectRequest(String bucketName, String key, String redirectLocation)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EncryptedPutObjectRequest
clone()
Returns a clone (as deep as possible) of this request object.Map<String,String>
getMaterialsDescription()
Returns an unmodifiable view of the MaterialsDescription which the caller can use to load EncryptionMaterials from anyEncryptionMaterialsAccessor
void
setMaterialsDescription(Map<String,String> materialsDescription)
sets the materials description for the encryption materials to be used with the current PutObjectRequest.EncryptedPutObjectRequest
withMaterialsDescription(Map<String,String> materialsDescription)
sets the materials description for the encryption materials to be used with the current PutObjectRequest.-
Methods inherited from class com.amazonaws.services.s3.model.PutObjectRequest
isRequesterPays, setRequesterPays, withAccessControlList, withBucketName, withCannedAcl, withFile, withInputStream, withKey, withMetadata, withProgressListener, withRedirectLocation, withRequesterPays, withSSEAwsKeyManagementParams, withSSECustomerKey, withStorageClass, withStorageClass
-
Methods inherited from class com.amazonaws.services.s3.model.AbstractPutObjectRequest
copyPutObjectBaseTo, getAccessControlList, getBucketName, getCannedAcl, getFile, getInputStream, getKey, getMetadata, getProgressListener, getRedirectLocation, getSSEAwsKeyManagementParams, getSSECustomerKey, getStorageClass, setAccessControlList, setBucketName, setCannedAcl, setFile, setInputStream, setKey, setMetadata, setProgressListener, setRedirectLocation, setSSEAwsKeyManagementParams, setSSECustomerKey, setStorageClass, setStorageClass
-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Constructor Detail
-
EncryptedPutObjectRequest
public EncryptedPutObjectRequest(String bucketName, String key, File file)
-
EncryptedPutObjectRequest
public EncryptedPutObjectRequest(String bucketName, String key, String redirectLocation)
-
EncryptedPutObjectRequest
public EncryptedPutObjectRequest(String bucketName, String key, InputStream input, ObjectMetadata metadata)
-
-
Method Detail
-
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 anyEncryptionMaterialsAccessor
- Specified by:
getMaterialsDescription
in interfaceMaterialsDescriptionProvider
- 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 PutObjectRequest.- Parameters:
materialsDescription
- the materialsDescription to set
-
withMaterialsDescription
public EncryptedPutObjectRequest withMaterialsDescription(Map<String,String> materialsDescription)
sets the materials description for the encryption materials to be used with the current PutObjectRequest.- Parameters:
materialsDescription
- the materialsDescription to set
-
clone
public EncryptedPutObjectRequest clone()
Returns a clone (as deep as possible) of this request object.- Overrides:
clone
in classPutObjectRequest
- See Also:
Object.clone()
-
-