com.aliyun.oss

Class OSSEncryptionClient

java.lang.Object

com.aliyun.oss.OSSClient

com.aliyun.oss.OSSEncryptionClient

All Implemented Interfaces:

OSS

public class OSSEncryptionClient
extends OSSClient

OSSEncryptionClient is used to do client-side encryption.

Field Summary

Fields

Modifier and Type	Field and Description
static String	USER_AGENT_SUFFIX

Constructor Summary

Constructors

Constructor and Description
OSSEncryptionClient(String endpoint, CredentialsProvider credsProvider, ClientConfiguration clientConfig, EncryptionMaterials encryptionMaterials, CryptoConfiguration cryptoConfig)

Method Summary

Modifier and Type	Method and Description
AppendObjectResult	appendObject(AppendObjectRequest appendObjectRequest) Deprecated. please use normal oss client method OSSClient.appendObject(AppendObjectRequest appendObjectRequest).
CompleteMultipartUploadResult	completeMultipartUpload(CompleteMultipartUploadRequest request, MultipartUploadCryptoContext context)
DownloadFileResult	downloadFile(DownloadFileRequest downloadFileRequest) File download Very similar with file upload, this method will split the OSS object into parts and download them in parallel by a thread pool, though by default the thread pool only has one thread.
OSSObject	getObject(GetObjectRequest req) Gets the OSSObject from the bucket specified in GetObjectRequest parameter.
ObjectMetadata	getObject(GetObjectRequest req, File file) Downloads the file from a file specified by the GetObjectRequest parameter.
InitiateMultipartUploadResult	initiateMultipartUpload(InitiateMultipartUploadRequest request) Deprecated. please use encryption client method initiateMultipartUpload(InitiateMultipartUploadRequest request, MultipartUploadCryptoContext context).
InitiateMultipartUploadResult	initiateMultipartUpload(InitiateMultipartUploadRequest request, MultipartUploadCryptoContext context)
PutObjectResult	putObject(PutObjectRequest req) Uploads the file to Bucket.
PutObjectResult	putObject(URL signedUrl, InputStream requestContent, long contentLength, Map<String,String> requestHeaders, boolean useChunkEncoding) Deprecated.
UploadFileResult	uploadFile(UploadFileRequest uploadFileRequest) File upload This method will automatically split files into parts and upload them in parallel by a thread pool, though by default the thread pool only has one thread.
UploadPartResult	uploadPart(UploadPartRequest request) Deprecated. please use encryption client method uploadPart(UploadPartRequest request, MultipartUploadCryptoContext context).
UploadPartResult	uploadPart(UploadPartRequest request, MultipartUploadCryptoContext context)
UploadPartCopyResult	uploadPartCopy(UploadPartCopyRequest request) Deprecated. please use normal oss client method OSSClient.uploadPartCopy(UploadPartCopyRequest request).

Methods inherited from class com.aliyun.oss.OSSClient

abortBucketWorm, abortBucketWorm, abortMultipartUpload, addBucketCname, addBucketReplication, calculatePostSignature, closeMetaQuery, completeBucketWorm, completeBucketWorm, completeMultipartUpload, copyObject, copyObject, createBucket, createBucket, createBucketCnameToken, createBucketVpcip, createDirectory, createDirectory, createLiveChannel, createSelectObjectMetadata, createSymlink, createSymlink, createUdf, createUdfApplication, createVpcip, deleteBucket, deleteBucket, deleteBucketCname, deleteBucketCname, deleteBucketCORSRules, deleteBucketCORSRules, deleteBucketEncryption, deleteBucketEncryption, deleteBucketImage, deleteBucketImage, deleteBucketInventoryConfiguration, deleteBucketInventoryConfiguration, deleteBucketLifecycle, deleteBucketLifecycle, deleteBucketLogging, deleteBucketLogging, deleteBucketPolicy, deleteBucketPolicy, deleteBucketQosInfo, deleteBucketQosInfo, deleteBucketReplication, deleteBucketReplication, deleteBucketTagging, deleteBucketTagging, deleteBucketTransferAcceleration, deleteBucketVpcip, deleteBucketWebsite, deleteBucketWebsite, deleteDirectory, deleteDirectory, deleteDirectory, deleteImageStyle, deleteImageStyle, deleteLiveChannel, deleteLiveChannel, deleteObject, deleteObject, deleteObjects, deleteObjectTagging, deleteObjectTagging, deleteUdf, deleteUdfApplication, deleteUdfImage, deleteVersion, deleteVersion, deleteVersions, deleteVpcip, doesBucketExist, doesBucketExist, doesObjectExist, doesObjectExist, doesObjectExist, doesObjectExist, doesObjectExist, doMetaQuery, extendBucketWorm, extendBucketWorm, generatePostPolicy, generatePresignedUrl, generatePresignedUrl, generatePresignedUrl, generateRtmpUri, generateRtmpUri, generateVodPlaylist, generateVodPlaylist, getAsyncFetchTask, getAsyncFetchTask, getBucketAccessMonitor, getBucketAcl, getBucketAcl, getBucketCname, getBucketCname, getBucketCnameToken, getBucketCORS, getBucketCORSRules, getBucketCORSRules, getBucketEncryption, getBucketEncryption, getBucketImage, getBucketImage, getBucketInfo, getBucketInfo, getBucketInventoryConfiguration, getBucketInventoryConfiguration, getBucketLifecycle, getBucketLifecycle, getBucketLocation, getBucketLocation, getBucketLogging, getBucketLogging, getBucketMetadata, getBucketMetadata, getBucketPolicy, getBucketPolicy, getBucketProcess, getBucketProcess, getBucketQosInfo, getBucketQosInfo, getBucketReferer, getBucketReferer, getBucketReplication, getBucketReplication, getBucketReplicationLocation, getBucketReplicationLocation, getBucketReplicationProgress, getBucketReplicationProgress, getBucketRequestPayment, getBucketRequestPayment, getBucketResourceGroup, getBucketStat, getBucketStat, getBucketStorageCapacity, getBucketStorageCapacity, getBucketTagging, getBucketTagging, getBucketTransferAcceleration, getBucketVersioning, getBucketVersioning, getBucketVpcip, getBucketWebsite, getBucketWebsite, getBucketWorm, getBucketWorm, getClientConfiguration, getConnectionPoolStats, getCredentialsProvider, getEndpoint, getImageStyle, getImageStyle, getLiveChannelHistory, getLiveChannelHistory, getLiveChannelInfo, getLiveChannelInfo, getLiveChannelStat, getLiveChannelStat, getMetaQueryStatus, getMultipartOperation, getObject, getObject, getObjectAcl, getObjectAcl, getObjectMetadata, getObjectMetadata, getObjectOperation, getObjectTagging, getObjectTagging, getSimplifiedObjectMeta, getSimplifiedObjectMeta, getSymlink, getSymlink, getUdfApplicationInfo, getUdfApplicationLog, getUdfImageInfo, getUdfInfo, getUserQosInfo, getVodPlaylist, getVodPlaylist, headObject, headObject, initiateBucketWorm, initiateBucketWorm, isBucketExist, listBucketInventoryConfigurations, listBucketInventoryConfigurations, listBucketInventoryConfigurations, listBuckets, listBuckets, listBuckets, listImageStyle, listImageStyle, listLiveChannels, listLiveChannels, listMultipartUploads, listObjects, listObjects, listObjects, listObjectsV2, listObjectsV2, listObjectsV2, listObjectsV2, listParts, listUdfApplications, listUdfs, listVersions, listVersions, listVersions, listVpcip, openMetaQuery, optionsObject, processObject, putBucketAccessMonitor, putBucketImage, putImageStyle, putObject, putObject, putObject, putObject, putObject, putObject, putObject, renameObject, renameObject, resizeUdfApplication, restoreObject, restoreObject, restoreObject, restoreObject, selectObject, setAsyncFetchTask, setAsyncFetchTask, setBucketAcl, setBucketAcl, setBucketCORS, setBucketEncryption, setBucketInventoryConfiguration, setBucketInventoryConfiguration, setBucketLifecycle, setBucketLogging, setBucketPolicy, setBucketPolicy, setBucketProcess, setBucketQosInfo, setBucketQosInfo, setBucketReferer, setBucketReferer, setBucketRequestPayment, setBucketRequestPayment, setBucketResourceGroup, setBucketStorageCapacity, setBucketStorageCapacity, setBucketTagging, setBucketTagging, setBucketTagging, setBucketTransferAcceleration, setBucketVersioning, setBucketWebsite, setCloudBoxId, setDownloadOperation, setEndpoint, setLiveChannelStatus, setLiveChannelStatus, setObjectAcl, setObjectAcl, setObjectTagging, setObjectTagging, setObjectTagging, setProduct, setRegion, setUploadOperation, shutdown, switchCredentials, switchSignatureVersion, upgradeUdfApplication, uploadUdfImage

Methods inherited from class java.lang.Object

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

Field Detail

USER_AGENT_SUFFIX

public static final String USER_AGENT_SUFFIX

See Also:

Constant Field Values

Constructor Detail

OSSEncryptionClient

public OSSEncryptionClient(String endpoint,
                           CredentialsProvider credsProvider,
                           ClientConfiguration clientConfig,
                           EncryptionMaterials encryptionMaterials,
                           CryptoConfiguration cryptoConfig)

Method Detail

putObject

public PutObjectResult putObject(PutObjectRequest req)
                          throws OSSException,
                                 ClientException

Description copied from interface: OSS

Uploads the file to Bucket.

Specified by:

putObject in interface OSS

Overrides:

putObject in class OSSClient

Parameters:

req - The PutObjectRequest instance that has bucket name, object key, metadata information.

Returns:

A PutObjectResult instance.

Throws:

OSSException - If any errors occurred in OSS while processing the request.

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

getObject

public OSSObject getObject(GetObjectRequest req)
                    throws OSSException,
                           ClientException

Description copied from interface: OSS

Gets the OSSObject from the bucket specified in GetObjectRequest parameter.

Specified by:

getObject in interface OSS

Overrides:

getObject in class OSSClient

Parameters:

req - A GetObjectRequest instance which specifies the bucket name and the object key.

Returns:

A OSSObject instance of the bucket file. The caller is responsible to close the connection after usage.

Throws:

OSSException - If any errors occurred in OSS while processing the request.

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

getObject

public ObjectMetadata getObject(GetObjectRequest req,
                                File file)
                         throws OSSException,
                                ClientException

Description copied from interface: OSS

Downloads the file from a file specified by the GetObjectRequest parameter.

Specified by:

getObject in interface OSS

Overrides:

getObject in class OSSClient

Parameters:

req - A GetObjectRequest instance which specifies bucket name and object key.

file - Target file instance to download as.

Returns:

A ObjectMetadata instance of the bucket file meta.

Throws:

OSSException - If any errors occurred in OSS while processing the request.

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

uploadFile

public UploadFileResult uploadFile(UploadFileRequest uploadFileRequest)
                            throws Throwable

Description copied from interface: OSS

File upload This method will automatically split files into parts and upload them in parallel by a thread pool, though by default the thread pool only has one thread. After all parts are uploaded, then it will merge them into one file. But if any one part fails to be uploaded, the whole upload fails. Optionally a checkpoint file could be used to track the progress of the upload and resume the upload later upon failure. Once the upload completes, the checkpoint file would be deleted. By default checkpoint file is disabled.

Specified by:

uploadFile in interface OSS

Overrides:

uploadFile in class OSSClient

Parameters:

uploadFileRequest - A UploadFileRequest instance that specifies the bucket name, object key, file path ,part size (> 100K) and thread count (from 1 to 1000) and checkpoint file.

Returns:

A UploadFileRequest instance which has the new uploaded file's key, ETag, location.

Throws:

Throwable - Base class for any exceptions.

downloadFile

public DownloadFileResult downloadFile(DownloadFileRequest downloadFileRequest)
                                throws Throwable

Description copied from interface: OSS

File download Very similar with file upload, this method will split the OSS object into parts and download them in parallel by a thread pool, though by default the thread pool only has one thread. After all parts are downloaded, then the method will merge them into one file. But if any one part fails to be downloaded, the whole download fails. Optionally a checkpoint file could be used to track the progress of the download and resume the download later upon failure. Once the download completes, the checkpoint file would be deleted. By default checkpoint file is disabled.

Specified by:

downloadFile in interface OSS

Overrides:

downloadFile in class OSSClient

Parameters:

downloadFileRequest - A DownloadFileRequest instance that specifies the bucket name, object key, file path, part size (> 100K) and thread count (from 1 to 1000) and checkpoint file. Also it could have the ETag and ModifiedSince constraints.

Returns:

A DownloadFileResult instance that has the ObjectMetadata information.

Throws:

Throwable - Base class for any exceptions.

initiateMultipartUpload

public InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest request,
                                                             MultipartUploadCryptoContext context)
                                                      throws OSSException,
                                                             ClientException

Throws:

OSSException

ClientException

uploadPart

public UploadPartResult uploadPart(UploadPartRequest request,
                                   MultipartUploadCryptoContext context)

completeMultipartUpload

public CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest request,
                                                             MultipartUploadCryptoContext context)
                                                      throws OSSException,
                                                             ClientException

Throws:

OSSException

ClientException

initiateMultipartUpload

@Deprecated
public InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest request)
                                                                  throws ClientException

Deprecated. please use encryption client method initiateMultipartUpload(InitiateMultipartUploadRequest request, MultipartUploadCryptoContext context).

Note: This method is disabled in encryption client.

Specified by:

initiateMultipartUpload in interface OSS

Overrides:

initiateMultipartUpload in class OSSClient

Parameters:

request - A InitiateMultipartUploadRequest instance which specifies the bucket name, object key and metadata.

Returns:

a InitiateMultipartUploadResult instance which has the global unique id if succeeds.

Throws:

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

uploadPart

@Deprecated
public UploadPartResult uploadPart(UploadPartRequest request)
                                        throws ClientException

Deprecated. please use encryption client method uploadPart(UploadPartRequest request, MultipartUploadCryptoContext context).

Note: This method is disabled in encryption client.

Specified by:

uploadPart in interface OSS

Overrides:

uploadPart in class OSSClient

Parameters:

request - A UploadPartRequest instance which specifies bucket, object key, upload id, part number, content and length, MD5 digest and chunked transfer encoding flag.

Returns:

UploadPartResult A UploadPartResult instance to indicate the upload result.

Throws:

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

appendObject

@Deprecated
public AppendObjectResult appendObject(AppendObjectRequest appendObjectRequest)
                                            throws ClientException

Deprecated. please use normal oss client method OSSClient.appendObject(AppendObjectRequest appendObjectRequest).

Note: This method is disabled in encryption client.

Specified by:

appendObject in interface OSS

Overrides:

appendObject in class OSSClient

Parameters:

appendObjectRequest - A AppendObjectRequest instance which specifies the bucket name, appendable object key, the file or the InputStream object to append.

Returns:

A AppendObjectResult instance.

Throws:

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

uploadPartCopy

@Deprecated
public UploadPartCopyResult uploadPartCopy(UploadPartCopyRequest request)
                                                throws ClientException

Deprecated. please use normal oss client method OSSClient.uploadPartCopy(UploadPartCopyRequest request).

Note: This method is disabled in encryption client.

Specified by:

uploadPartCopy in interface OSS

Overrides:

uploadPartCopy in class OSSClient

Parameters:

request - A UploadPartCopyRequest instance which specifies: 1) source file 2) source file's copy range 3) target file 4) target file's upload Id and its part number 5) constraints such as ETag match or non-match, last modified match or non-match, etc.

Returns:

A UploadPartCopyResult instance which has the part number and ETag upon a successful upload.

Throws:

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

putObject

@Deprecated
public PutObjectResult putObject(URL signedUrl,
                                             InputStream requestContent,
                                             long contentLength,
                                             Map<String,String> requestHeaders,
                                             boolean useChunkEncoding)
                                      throws ClientException

Deprecated.

Note: This method is disabled in encryption client.

Specified by:

putObject in interface OSS

Overrides:

putObject in class OSSClient

Parameters:

signedUrl - Signed Url, which has the bucket name, object key, account information and accessed Ids and its signature. The url is recommended to be generated by generatePresignedUrl().

requestContent - InputStream instance to read from.

contentLength - Hint content length to write. if useChunkEncoding is true, then -1 is used.

requestHeaders - Rquest headers,including standard or customized http headers documented by PutObject REST API.

useChunkEncoding - The flag of using chunked transfer encoding.

Returns:

A PutObjectResult instance.

Throws:

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