com.qcloud.cos.model

类 EncryptedGetObjectRequest

java.lang.Object

com.qcloud.cos.internal.CosServiceRequest

com.qcloud.cos.model.GetObjectRequest

com.qcloud.cos.model.EncryptedGetObjectRequest

所有已实现的接口:

ReadLimitInfo, SSECustomerKeyProvider, Serializable, Cloneable

public class EncryptedGetObjectRequest
extends GetObjectRequest
implements Serializable

An extension of GetObjectRequest to allow additional encryption material description to be specified on a per-request basis. In particular, EncryptedGetObjectRequest is only recognized by COSEncryptionClient.

If EncryptedGetObjectRequest is used against the non-encrypting COSEncryptionClient, the additional attributes will be ignored.

The additional material description must not conflict with the existing one saved in COS or else will cause the get request to fail fast later on.

另请参阅:

序列化表格

构造器概要

构造器

构造器和说明
EncryptedGetObjectRequest(COSObjectId cosObjectId)
EncryptedGetObjectRequest(String bucketName, String key)
EncryptedGetObjectRequest(String bucketName, String key, String versionId)

方法概要

限定符和类型	方法和说明
String	getInstructionFileSuffix()
boolean	isKeyWrapExpected() Returns true if key wrapping is expected; false otherwise.
void	setInstructionFileSuffix(String instructionFileSuffix) Explicitly sets the suffix of an instruction file to be used to retrieve the COS encrypted object.
void	setKeyWrapExpected(boolean keyWrapExpected)
EncryptedGetObjectRequest	withInstructionFileSuffix(String instructionFileSuffix) Fluent API to explicitly sets the suffix of an instruction file to be used to retrieve the COS encrypted object.
EncryptedGetObjectRequest	withKeyWrapExpected(boolean keyWrapExpected) Fluent API for setKeyWrapExpected(boolean).

从类继承的方法 com.qcloud.cos.model.GetObjectRequest

getBucketName, getCOSObjectId, getKey, getMatchingETagConstraints, getModifiedSinceConstraint, getNonmatchingETagConstraints, getRange, getResponseHeaders, getSSECustomerKey, getTrafficLimit, getUnmodifiedSinceConstraint, getVersionId, setBucketName, setKey, setMatchingETagConstraints, setModifiedSinceConstraint, setNonmatchingETagConstraints, setRange, setResponseHeaders, setSSECustomerKey, setTrafficLimit, setUnmodifiedSinceConstraint, setVersionId, withBucketName, withKey, withMatchingETagConstraint, withModifiedSinceConstraint, withNonmatchingETagConstraint, withRange, withResponseHeaders, withSSECustomerKey, withUnmodifiedSinceConstraint, withVersionId

从类继承的方法 com.qcloud.cos.internal.CosServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getCosCredentials, getCustomQueryParameters, getCustomRequestHeaders, getFixedEndpointAddr, getGeneralProgressListener, getReadLimit, getRequestClientOptions, putCustomQueryParameter, putCustomRequestHeader, setCosCredentials, setFixedEndpointAddr, setGeneralProgressListener, withGeneralProgressListener

从类继承的方法 java.lang.Object

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

构造器详细资料

EncryptedGetObjectRequest

public EncryptedGetObjectRequest(String bucketName,
                                 String key)

EncryptedGetObjectRequest

public EncryptedGetObjectRequest(String bucketName,
                                 String key,
                                 String versionId)

EncryptedGetObjectRequest

public EncryptedGetObjectRequest(COSObjectId cosObjectId)

方法详细资料

getInstructionFileSuffix

public String getInstructionFileSuffix()

setInstructionFileSuffix

public void setInstructionFileSuffix(String instructionFileSuffix)

Explicitly sets the suffix of an instruction file to be used to retrieve the COS encrypted object. Typically this is for more advanced use cases where multiple crypto instruction files have been created for the same COS object. Each instruction file contains the same CEK encrypted under a different KEK, the IV, and other meta information (aka material description).

参数:

instructionFileSuffix - suffix of the instruction file to be used.

另请参阅:

COSEncryptionClient#putInstructionFile(PutInstructionFileRequest)

withInstructionFileSuffix

public EncryptedGetObjectRequest withInstructionFileSuffix(String instructionFileSuffix)

Fluent API to explicitly sets the suffix of an instruction file to be used to retrieve the COS encrypted object. Typically this is for more advanced use cases where multiple crypto instruction files have been created for the same COS object. Each instruction file contains the same CEK encrypted under a different KEK, the IV, and other meta information (aka material description).

参数:

instructionFileSuffix - suffix of the instruction file to be used.

另请参阅:

COSEncryptionClient#putInstructionFile(PutInstructionFileRequest)

isKeyWrapExpected

public boolean isKeyWrapExpected()

Returns true if key wrapping is expected; false otherwise. Note, however, that if CryptoMode#StrictAuthenticatedEncryption or KMS is in use, key wrapping is always expected for the CEK regardless.

setKeyWrapExpected

public void setKeyWrapExpected(boolean keyWrapExpected)

参数:

keyWrapExpected - true if key wrapping is expected for the CEK; false otherwse. Note, however, that if CryptoMode#StrictAuthenticatedEncryption or KMS is in use, key wrapping is always expected for the CEK regardless.

If keyWrapExpected is set to true but the CEK is found to be not key-wrapped, it would cause a KeyWrapException to be thrown.

withKeyWrapExpected

public EncryptedGetObjectRequest withKeyWrapExpected(boolean keyWrapExpected)

Fluent API for setKeyWrapExpected(boolean).