com.ibm.cloud.objectstorage.services.s3.internal.crypto.v1

Class CryptoModuleDispatcher

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.internal.crypto.v1.S3CryptoModule<MultipartUploadContext>

com.ibm.cloud.objectstorage.services.s3.internal.crypto.v1.CryptoModuleDispatcher

public class CryptoModuleDispatcher
extends S3CryptoModule<MultipartUploadContext>

A proxy cryptographic module used to dispatch method calls to the appropriate underlying cryptographic module depending on the current configuration.

Constructor Summary

Constructors

Constructor and Description
CryptoModuleDispatcher(com.ibm.cloud.objectstorage.services.kms.AWSKMS kms, S3Direct s3, AWSCredentialsProvider credentialsProvider, EncryptionMaterialsProvider encryptionMaterialsProvider, CryptoConfiguration cryptoConfig)

Method Summary

Modifier and Type	Method and Description
void	abortMultipartUploadSecurely(AbortMultipartUploadRequest req)
CompleteMultipartUploadResult	completeMultipartUploadSecurely(CompleteMultipartUploadRequest req)
CopyPartResult	copyPartSecurely(CopyPartRequest req)
S3Object	getObjectSecurely(GetObjectRequest req)
ObjectMetadata	getObjectSecurely(GetObjectRequest req, File destinationFile)
InitiateMultipartUploadResult	initiateMultipartUploadSecurely(InitiateMultipartUploadRequest req)
PutObjectResult	putInstructionFileSecurely(PutInstructionFileRequest req)
void	putLocalObjectSecurely(UploadObjectRequest req, String uploadId, OutputStream os)
PutObjectResult	putObjectSecurely(PutObjectRequest putObjectRequest)
UploadPartResult	uploadPartSecurely(UploadPartRequest req)

Methods inherited from class java.lang.Object

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

Constructor Detail

CryptoModuleDispatcher

public CryptoModuleDispatcher(com.ibm.cloud.objectstorage.services.kms.AWSKMS kms,
                              S3Direct s3,
                              AWSCredentialsProvider credentialsProvider,
                              EncryptionMaterialsProvider encryptionMaterialsProvider,
                              CryptoConfiguration cryptoConfig)

Method Detail

putObjectSecurely

public PutObjectResult putObjectSecurely(PutObjectRequest putObjectRequest)

Specified by:

putObjectSecurely in class S3CryptoModule<MultipartUploadContext>

Returns:

the result of the putting the S3 object.

getObjectSecurely

public S3Object getObjectSecurely(GetObjectRequest req)

Specified by:

getObjectSecurely in class S3CryptoModule<MultipartUploadContext>

getObjectSecurely

public ObjectMetadata getObjectSecurely(GetObjectRequest req,
                                        File destinationFile)

Specified by:

getObjectSecurely in class S3CryptoModule<MultipartUploadContext>

completeMultipartUploadSecurely

public CompleteMultipartUploadResult completeMultipartUploadSecurely(CompleteMultipartUploadRequest req)
                                                              throws SdkClientException,
                                                                     AmazonServiceException

Specified by:

completeMultipartUploadSecurely in class S3CryptoModule<MultipartUploadContext>

Throws:

SdkClientException

AmazonServiceException

abortMultipartUploadSecurely

public void abortMultipartUploadSecurely(AbortMultipartUploadRequest req)

Specified by:

abortMultipartUploadSecurely in class S3CryptoModule<MultipartUploadContext>

initiateMultipartUploadSecurely

public InitiateMultipartUploadResult initiateMultipartUploadSecurely(InitiateMultipartUploadRequest req)
                                                              throws SdkClientException,
                                                                     AmazonServiceException

Specified by:

initiateMultipartUploadSecurely in class S3CryptoModule<MultipartUploadContext>

Throws:

SdkClientException

AmazonServiceException

uploadPartSecurely

public UploadPartResult uploadPartSecurely(UploadPartRequest req)
                                    throws SdkClientException,
                                           AmazonServiceException

NOTE: Because the encryption process requires context from block N-1 in order to encrypt block N, parts uploaded with the AmazonS3EncryptionClient (as opposed to the normal AmazonS3Client) must be uploaded serially, and in order. Otherwise, the previous encryption context isn't available to use when encrypting the current part.

Specified by:

uploadPartSecurely in class S3CryptoModule<MultipartUploadContext>

Throws:

SdkClientException

AmazonServiceException

copyPartSecurely

public CopyPartResult copyPartSecurely(CopyPartRequest req)

Specified by:

copyPartSecurely in class S3CryptoModule<MultipartUploadContext>

putInstructionFileSecurely

public PutObjectResult putInstructionFileSecurely(PutInstructionFileRequest req)

Specified by:

putInstructionFileSecurely in class S3CryptoModule<MultipartUploadContext>

Returns:

the result of putting the instruction file in S3; or null if the specified S3 object doesn't exist. The S3 object can be subsequently retrieved using the new instruction file via the usual get operation by specifying a EncryptedGetObjectRequest.

putLocalObjectSecurely

public void putLocalObjectSecurely(UploadObjectRequest req,
                                   String uploadId,
                                   OutputStream os)
                            throws IOException

Specified by:

putLocalObjectSecurely in class S3CryptoModule<MultipartUploadContext>

uploadId - multipart upload id

os - output stream which will be closed upon method completion.

Throws:

IOException