com.ibm.cloud.objectstorage.services.s3.model

Class EncryptedInitiateMultipartUploadRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

com.ibm.cloud.objectstorage.services.s3.model.InitiateMultipartUploadRequest

com.ibm.cloud.objectstorage.services.s3.model.EncryptedInitiateMultipartUploadRequest

All Implemented Interfaces:

HandlerContextAware, 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:

Serialized Form

Field Summary

Fields inherited from class com.ibm.cloud.objectstorage.services.s3.model.InitiateMultipartUploadRequest

objectMetadata

Fields inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
EncryptedInitiateMultipartUploadRequest(String bucketName, String key)
EncryptedInitiateMultipartUploadRequest(String bucketName, String key, ObjectMetadata objectMetadata)

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getMaterialsDescription() Returns an unmodifiable view of the MaterialsDescription which the caller can use to load EncryptionMaterials from any EncryptionMaterialsAccessor
boolean	isCreateEncryptionMaterial() Returns true if a new set of encryption material is to be created; false otherwise.
void	setCreateEncryptionMaterial(boolean createEncryptionMaterial)
void	setMaterialsDescription(Map<String,String> materialsDescription) sets the materials description for the encryption materials to be used with the current Multi Part Upload Request.
EncryptedInitiateMultipartUploadRequest	withCreateEncryptionMaterial(boolean createEncryptionMaterial)
EncryptedInitiateMultipartUploadRequest	withMaterialsDescription(Map<String,String> materialsDescription) sets the materials description for the encryption materials to be used with the current Multi Part Upload Request.

Methods inherited from class com.ibm.cloud.objectstorage.services.s3.model.InitiateMultipartUploadRequest

getAccessControlList, getBucketName, getCannedACL, getKey, getObjectLockLegalHoldStatus, getObjectLockMode, getObjectLockRetainUntilDate, getObjectMetadata, getRedirectLocation, getSSEAwsKeyManagementParams, getSSECustomerKey, getStorageClass, getTagging, isRequesterPays, setAccessControlList, setBucketName, setCannedACL, setKey, setObjectLockLegalHoldStatus, setObjectLockLegalHoldStatus, setObjectLockMode, setObjectLockMode, setObjectLockRetainUntilDate, setObjectMetadata, setRedirectLocation, setRequesterPays, setSSEAwsKeyManagementParams, setSSECustomerKey, setStorageClass, setTagging, withAccessControlList, withBucketName, withCannedACL, withKey, withObjectLockLegalHoldStatus, withObjectLockLegalHoldStatus, withObjectLockMode, withObjectLockMode, withObjectLockRetainUntilDate, withObjectMetadata, withRedirectLocation, withRequesterPays, withSSEAwsKeyManagementParams, withSSECustomerKey, withStorageClass, withStorageClass, withTagging

Methods inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

addHandlerContext, clone, copyBaseTo, 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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EncryptedInitiateMultipartUploadRequest

public EncryptedInitiateMultipartUploadRequest(String bucketName,
                                               String key)

EncryptedInitiateMultipartUploadRequest

public EncryptedInitiateMultipartUploadRequest(String bucketName,
                                               String key,
                                               ObjectMetadata objectMetadata)

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 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.