com.qcloud.cos

Class COSEncryptionClient

java.lang.Object

com.qcloud.cos.COSClient

com.qcloud.cos.COSEncryptionClient

All Implemented Interfaces:

COS, COSEncryption, COSDirectSpi

public class COSEncryptionClient
extends COSClient
implements COSEncryption

Field Summary

Fields inherited from class com.qcloud.cos.COSClient

clientConfig

Constructor Summary

Constructors

Constructor and Description
COSEncryptionClient(COSCredentialsProvider credentialsProvider, EncryptionMaterialsProvider kekMaterialsProvider, ClientConfig clientConfig, CryptoConfiguration cryptoConfig)
COSEncryptionClient(QCLOUDKMS kms, COSCredentialsProvider credentialsProvider, EncryptionMaterialsProvider kekMaterialsProvider, ClientConfig clientConfig, CryptoConfiguration cryptoConfig)

Method Summary

Modifier and Type	Method and Description
void	abortMultipartUpload(AbortMultipartUploadRequest req) Aborts a multipart upload.
CompleteMultipartUploadResult	completeMultipartUpload(CompleteMultipartUploadRequest req) Completes a multipart upload by assembling previously uploaded parts.
CopyPartResult	copyPart(CopyPartRequest copyPartRequest) Copies a source object to a part of a multipart upload.
void	deleteObject(DeleteObjectRequest req) Deletes the specified object in the specified bucket.
COSObject	getObject(GetObjectRequest req) Gets the object stored in under the specified bucket and key.
ObjectMetadata	getObject(GetObjectRequest req, File dest) Gets the object metadata for the object stored in under the specified bucket and key, and saves the object contents to the specified file.
InitiateMultipartUploadResult	initiateMultipartUpload(InitiateMultipartUploadRequest req) Initiates a multipart upload and returns an InitiateMultipartUploadResult which contains an upload ID.
PutObjectResult	putInstructionFile(PutInstructionFileRequest req) Creates a new crypto instruction file by re-encrypting the CEK of an existing encrypted COS object with a new encryption material identifiable via a new set of material description.
PutObjectResult	putObject(PutObjectRequest req) Uploads a new object to the specified bucket.
void	shutdown()
UploadPartResult	uploadPart(UploadPartRequest uploadPartRequest) Uploads a part in a multipart upload.

Methods inherited from class com.qcloud.cos.COSClient

appendObject, batchImageAuditing, cancelMediaJob, copyObject, copyObject, createAudioAuditingJobs, createAuditingDocumentJobs, createAuditingTextJobs, createBucket, createBucket, createDocProcessBucket, createDocProcessJobs, createMediaJobs, createMediaTemplate, createRequest, createVideoAuditingJob, createWebpageAuditingJob, deleteBucket, deleteBucket, deleteBucketCrossOriginConfiguration, deleteBucketCrossOriginConfiguration, deleteBucketDomainConfiguration, deleteBucketDomainConfiguration, deleteBucketInventoryConfiguration, deleteBucketInventoryConfiguration, deleteBucketLifecycleConfiguration, deleteBucketLifecycleConfiguration, deleteBucketPolicy, deleteBucketPolicy, deleteBucketReplicationConfiguration, deleteBucketReplicationConfiguration, deleteBucketTaggingConfiguration, deleteBucketTaggingConfiguration, deleteBucketWebsiteConfiguration, deleteBucketWebsiteConfiguration, deleteMediaTemplate, deleteObject, deleteObjects, deleteObjectTagging, deleteVersion, deleteVersion, deleteWorkflow, describeAudioAuditingJob, describeAuditingDocumentJob, describeAuditingImageJob, describeAuditingJob, describeAuditingTextJob, describeDocProcessBuckets, describeDocProcessJob, describeDocProcessJobs, describeDocProcessQueues, describeMediaBuckets, describeMediaJob, describeMediaJobs, describeMediaQueues, describeMediaTemplates, describeWebpageAuditingJob, describeWorkflow, describeWorkflowExecution, describeWorkflowExecutions, doesBucketExist, doesObjectExist, GenerateDocPreviewUrl, generateMediainfo, generatePresignedUrl, generatePresignedUrl, generatePresignedUrl, generatePresignedUrl, generatePresignedUrl, generatePresignedUrl, generateSnapshot, getAsyncFetchTask, getBucketAcl, getBucketAcl, getBucketCrossOriginConfiguration, getBucketCrossOriginConfiguration, getBucketDomainConfiguration, getBucketDomainConfiguration, getBucketIntelligentTierConfiguration, getBucketIntelligentTierConfiguration, getBucketInventoryConfiguration, getBucketInventoryConfiguration, getBucketLifecycleConfiguration, getBucketLifecycleConfiguration, getBucketLocation, getBucketLocation, getBucketLoggingConfiguration, getBucketLoggingConfiguration, getBucketPolicy, getBucketPolicy, getBucketRefererConfiguration, getBucketRefererConfiguration, getBucketReplicationConfiguration, getBucketReplicationConfiguration, getBucketTaggingConfiguration, getBucketTaggingConfiguration, getBucketVersioningConfiguration, getBucketVersioningConfiguration, getBucketWebsiteConfiguration, getBucketWebsiteConfiguration, getClientConfig, getImageLabel, getImageLabelV2, getObject, getObjectAcl, getObjectAcl, getObjectMetadata, getObjectMetadata, getObjectTagging, getObjectUrl, getObjectUrl, getObjectUrl, getPrivateM3U8, headBucket, imageAuditing, listBucketInventoryConfigurations, listBuckets, listBuckets, listMultipartUploads, listNextBatchOfObjects, listNextBatchOfObjects, listNextBatchOfVersions, listNextBatchOfVersions, listObjects, listObjects, listObjects, listParts, listVersions, listVersions, listVersions, populateRequestMetadata, processImage, putAsyncFetchTask, putObject, putObject, putObject, rename, restoreObject, restoreObject, selectObjectContent, setBucketAcl, setBucketAcl, setBucketAcl, setBucketCrossOriginConfiguration, setBucketCrossOriginConfiguration, setBucketDomainConfiguration, setBucketDomainConfiguration, setBucketIntelligentTieringConfiguration, setBucketInventoryConfiguration, setBucketInventoryConfiguration, setBucketLifecycleConfiguration, setBucketLifecycleConfiguration, setBucketLoggingConfiguration, setBucketPolicy, setBucketPolicy, setBucketRefererConfiguration, setBucketRefererConfiguration, setBucketReplicationConfiguration, setBucketReplicationConfiguration, setBucketTaggingConfiguration, setBucketTaggingConfiguration, setBucketVersioningConfiguration, setBucketWebsiteConfiguration, setBucketWebsiteConfiguration, setCOSCredentials, setCOSCredentialsProvider, setObjectAcl, setObjectAcl, setObjectAcl, setObjectTagging, updateDocProcessQueue, updateMediaQueue, updateMediaTemplate, updateObjectMetaData, uploadObjectInternal

Methods inherited from class java.lang.Object

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

Constructor Detail

COSEncryptionClient

public COSEncryptionClient(COSCredentialsProvider credentialsProvider,
                           EncryptionMaterialsProvider kekMaterialsProvider,
                           ClientConfig clientConfig,
                           CryptoConfiguration cryptoConfig)

COSEncryptionClient

public COSEncryptionClient(QCLOUDKMS kms,
                           COSCredentialsProvider credentialsProvider,
                           EncryptionMaterialsProvider kekMaterialsProvider,
                           ClientConfig clientConfig,
                           CryptoConfiguration cryptoConfig)

Method Detail

putObject

public PutObjectResult putObject(PutObjectRequest req)

Description copied from interface: COS

Uploads a new object to the specified bucket. The PutObjectRequest contains all the details of the request, including the bucket to upload to, the key the object will be uploaded under, and the file or input stream containing the data to upload.

never stores partial objects; if during this call an exception wasn't thrown, the entire object was stored.

Depending on whether a file or input stream is being uploaded, this method has slightly different behavior.

When uploading a file:

• The client automatically computes a checksum of the file. uses checksums to validate the data in each file.
• Using the file extension, attempts to determine the correct content type and content disposition to use for the object.

When uploading directly from an input stream:

• Be careful to set the correct content type in the metadata object before directly sending a stream. Unlike file uploads, content types from input streams cannot be automatically determined. If the caller doesn't explicitly set the content type, it will not be set in .
• Content length must be specified before data can be uploaded to . Qcloud COS explicitly requires that the content length be sent in the request headers before it will accept any of the data. If the caller doesn't provide the length, the library must buffer the contents of the input stream in order to calculate it.

The specified bucket must already exist and the caller must have Permission.Write permission to the bucket to upload an object.

Specified by:

putObject in interface COS

Specified by:

putObject in interface COSDirectSpi

Overrides:

putObject in class COSClient

Parameters:

req - The request object containing all the parameters to upload a new object to .

Returns:

A PutObjectResult object containing the information returned by for the newly created object.

See Also:

COS.putObject(String, String, File), COS.putObject(String, String, InputStream, ObjectMetadata)

getObject

public COSObject getObject(GetObjectRequest req)

Description copied from interface: COS

Gets the object stored in under the specified bucket and key. Returns null if the specified constraints weren't met.

Be extremely careful when using this method; the returned COS object contains a direct stream of data from the HTTP connection. The underlying HTTP connection cannot be closed until the user finishes reading the data and closes the stream. Therefore:

• Use the data from the input stream in object as soon as possible,
• Close the input stream in object as soon as possible.

If callers do not follow those rules, then the client can run out of resources if allocating too many open, but unused, HTTP connections.

To get an object from , the caller must have Permission.Read access to the object.

If the object fetched is publicly readable, it can also read it by pasting its URL into a browser.

When specifying constraints in the request object, the client needs to be prepared to handle this method returning null if the provided constraints aren't met when Qcloud COS receives the request.

If the advanced options provided in GetObjectRequest aren't needed, use the simpler COS.getObject(String bucketName, String key) method.

Specified by:

getObject in interface COS

Specified by:

getObject in interface COSDirectSpi

Overrides:

getObject in class COSClient

Parameters:

req - The request object containing all the options on how to download the object.

Returns:

The object stored in in the specified bucket and key. Returns null if constraints were specified but not met.

See Also:

COS.getObject(String, String), COS.getObject(GetObjectRequest, File)

getObject

public ObjectMetadata getObject(GetObjectRequest req,
                                File dest)

Description copied from interface: COS

Gets the object metadata for the object stored in under the specified bucket and key, and saves the object contents to the specified file. Returns null if the specified constraints weren't met.

Instead of using COS.getObject(GetObjectRequest), use this method to ensure that the underlying HTTP stream resources are automatically closed as soon as possible. The clients handles immediate storage of the object contents to the specified file.

To get an object from , the caller must have Permission.Read access to the object.

If the object fetched is publicly readable, it can also read it by pasting its URL into a browser.

When specifying constraints in the request object, the client needs to be prepared to handle this method returning null if the provided constraints aren't met when Qcloud COS receives the request.

Specified by:

getObject in interface COS

Specified by:

getObject in interface COSDirectSpi

Overrides:

getObject in class COSClient

Parameters:

req - The request object containing all the options on how to download the object content.

dest - Indicates the file (which might already exist) where to save the object content being downloading from .

Returns:

All COS object metadata for the specified object. Returns null if constraints were specified but not met.

See Also:

COS.getObject(String, String), COS.getObject(GetObjectRequest)

deleteObject

public void deleteObject(DeleteObjectRequest req)

Description copied from interface: COS

Deletes the specified object in the specified bucket. Once deleted, the object can only be restored if versioning was enabled when the object was deleted.

If attempting to delete an object that does not exist, will return a success message instead of an error message.

Specified by:

deleteObject in interface COS

Overrides:

deleteObject in class COSClient

Parameters:

req - The request object containing all options for deleting an Qcloud COS object.

See Also:

COSClient.deleteObject(String, String)

completeMultipartUpload

public CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest req)

Description copied from interface: COS

Completes a multipart upload by assembling previously uploaded parts.

You first upload all parts using the COS.uploadPart(UploadPartRequest) method. After successfully uploading all individual parts of an upload, you call this operation to complete the upload. Upon receiving this request, concatenates all the parts in ascending order by part number to create a new object. In the CompleteMultipartUpload request, you must provide the parts list. For each part in the list, you provide the part number and the ETag header value, returned after that part was uploaded.

Processing of a CompleteMultipartUpload request may take several minutes to complete.

Specified by:

completeMultipartUpload in interface COS

Specified by:

completeMultipartUpload in interface COSDirectSpi

Overrides:

completeMultipartUpload in class COSClient

Parameters:

req - The CompleteMultipartUploadRequest object that specifies all the parameters of this operation.

Returns:

A CompleteMultipartUploadResult from COS containing the ETag for the new object composed of the individual parts.

initiateMultipartUpload

public InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest req)

Description copied from interface: COS

Initiates a multipart upload and returns an InitiateMultipartUploadResult which contains an upload ID. This upload ID associates all the parts in the specific upload and is used in each of your subsequent COS.uploadPart(UploadPartRequest) requests. You also include this upload ID in the final request to either complete, or abort the multipart upload request.

Note: After you initiate a multipart upload and upload one or more parts, you must either complete or abort the multipart upload in order to stop getting charged for storage of the uploaded parts. Once you complete or abort the multipart upload will release the stored parts and stop charging you for their storage.

Specified by:

initiateMultipartUpload in interface COS

Specified by:

initiateMultipartUpload in interface COSDirectSpi

Overrides:

initiateMultipartUpload in class COSClient

Parameters:

req - The InitiateMultipartUploadRequest object that specifies all the parameters of this operation.

Returns:

An InitiateMultipartUploadResult from .

uploadPart

public UploadPartResult uploadPart(UploadPartRequest uploadPartRequest)
                            throws CosClientException,
                                   CosServiceException

Uploads a part in a multipart upload. You must initiate a multipart upload before you can upload any part.

Your UploadPart request must include an upload ID and a part number. The upload ID is the ID returned by in response to your Initiate Multipart Upload request. Part number can be any number between 1 and 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being uploaded. If you upload a new part using the same part number that was specified in uploading a previous part, the previously uploaded part is overwritten.

To ensure data is not corrupted traversing the network, specify the Content-MD5 header in the Upload Part request. checks the part data against the provided MD5 value. If they do not match, returns an error.

When you upload a part, the returned UploadPartResult contains an ETag property. You should record this ETag property value and the part number. After uploading all parts, you must send a CompleteMultipartUpload request. At that time constructs a complete object by concatenating all the parts you uploaded, in ascending order based on the part numbers. The CompleteMultipartUpload request requires you to send all the part numbers and the corresponding ETag values.

Note: After you initiate a multipart upload and upload one or more parts, you must either complete or abort the multipart upload in order to stop getting charged for storage of the uploaded parts. Once you complete or abort the multipart upload will release the stored parts and stop charging you for their storage.

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

Specified by:

uploadPart in interface COS

Specified by:

uploadPart in interface COSDirectSpi

Overrides:

uploadPart in class COSClient

Returns:

An UploadPartResult from containing the part number and ETag of the new part.

Throws:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

copyPart

public CopyPartResult copyPart(CopyPartRequest copyPartRequest)

Description copied from interface: COS

Copies a source object to a part of a multipart upload.

To copy an object, the caller's account must have read access to the source object and write access to the destination bucket.

Specified by:

copyPart in interface COS

Specified by:

copyPart in interface COSDirectSpi

Overrides:

copyPart in class COSClient

Parameters:

copyPartRequest - The request object containing all the options for copying an object.

Returns:

CopyPartResult containing the information returned by COS about the newly created object, or null if constraints were specified that weren't met when COS attempted to copy the object.

abortMultipartUpload

public void abortMultipartUpload(AbortMultipartUploadRequest req)

Description copied from interface: COS

Aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed.

Specified by:

abortMultipartUpload in interface COS

Specified by:

abortMultipartUpload in interface COSDirectSpi

Overrides:

abortMultipartUpload in class COSClient

Parameters:

req - The AbortMultipartUploadRequest object that specifies all the parameters of this operation.

putInstructionFile

public PutObjectResult putInstructionFile(PutInstructionFileRequest req)

Creates a new crypto instruction file by re-encrypting the CEK of an existing encrypted COS object with a new encryption material identifiable via a new set of material description.

User of this method is responsible for explicitly deleting/updating the instruction file so created should the corresponding COS object is deleted/created.

Returns:

the result of the put (instruction file) operation.

shutdown

public void shutdown()

If the a default internal KMS client has been constructed, it will also be shut down by calling this method. Otherwise, users who provided the KMS client would be responsible to shut down the KMS client extrinsic to this method.

Overrides:

shutdown in class COSClient