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:

HandlerContextAware, ReadLimitInfo, ExpectedBucketOwnerRequest, 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 by AmazonS3EncryptionClient.

If EncryptedPutObjectRequest is used against the non-encrypting AmazonS3Client, 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 and 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

Modifier and Type	Method and 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 any EncryptionMaterialsAccessor
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

getExpectedBucketOwner, isRequesterPays, setExpectedBucketOwner, setRequesterPays, withAccessControlList, withBucketName, withCannedAcl, withExpectedBucketOwner, withFile, withInputStream, withKey, withMetadata, withProgressListener, withRedirectLocation, withRequesterPays, withSSEAwsKeyManagementParams, withSSECustomerKey, withStorageClass, withStorageClass, withTagging

Methods inherited from class com.amazonaws.services.s3.model.AbstractPutObjectRequest

getAccessControlList, getBucketKeyEnabled, getBucketName, getCannedAcl, getFile, getIfNoneMatch, getInputStream, getKey, getMetadata, getObjectLockLegalHoldStatus, getObjectLockMode, getObjectLockRetainUntilDate, getProgressListener, getRedirectLocation, getSSEAwsKeyManagementParams, getSSECustomerKey, getStorageClass, getTagging, ifNoneMatch, setAccessControlList, setBucketKeyEnabled, setBucketName, setCannedAcl, setFile, setIfNoneMatch, setInputStream, setKey, setMetadata, setObjectLockLegalHoldStatus, setObjectLockLegalHoldStatus, setObjectLockMode, setObjectLockMode, setObjectLockRetainUntilDate, setProgressListener, setRedirectLocation, setSSEAwsKeyManagementParams, setSSECustomerKey, setStorageClass, setStorageClass, setTagging, withBucketKeyEnabled, withObjectLockLegalHoldStatus, withObjectLockLegalHoldStatus, withObjectLockMode, withObjectLockMode, withObjectLockRetainUntilDate

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

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 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 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 class PutObjectRequest

See Also:

Object.clone()