com.obs.services

Class AbstractObjectClient

java.lang.Object

com.obs.services.internal.RestConnectionService

com.obs.services.internal.RestStorageService

com.obs.services.internal.service.AbstractRequestConvertor

com.obs.services.internal.service.AclHeaderConvertor

com.obs.services.internal.service.RequestConvertor

com.obs.services.internal.service.ObsBucketBaseService

com.obs.services.internal.service.ObsBucketAdvanceService

com.obs.services.internal.service.ObsObjectBaseService

com.obs.services.internal.service.ObsMultipartObjectService

com.obs.services.internal.service.ObsObjectService

com.obs.services.internal.service.ObsFileService

com.obs.services.internal.service.ObsExtensionService

com.obs.services.internal.ObsService

com.obs.services.AbstractClient

com.obs.services.AbstractDeprecatedBucketClient

com.obs.services.AbstractBucketClient

com.obs.services.AbstractBucketAdvanceClient

com.obs.services.AbstractObjectClient

All Implemented Interfaces:

IFSClient, IObsClient, Closeable, AutoCloseable

Direct Known Subclasses:

AbstractMultipartObjectClient

public abstract class AbstractObjectClient
extends AbstractBucketAdvanceClient

Nested Class Summary

Nested classes/interfaces inherited from class com.obs.services.AbstractClient

AbstractClient.ActionCallbackWithResult<T>

Nested classes/interfaces inherited from class com.obs.services.internal.service.AbstractRequestConvertor

com.obs.services.internal.service.AbstractRequestConvertor.TransResult

Field Summary

Fields inherited from class com.obs.services.internal.RestStorageService

CAN_USE_STANDARD_HTTP_HEADERS

Fields inherited from class com.obs.services.internal.RestConnectionService

apiVersionCache, credentials, httpClient, keyManagerFactory, obsProperties, segmentLock, semaphore, shuttingDown, trustManagerFactory

Constructor Summary

Constructors

Constructor and Description
AbstractObjectClient()

Method Summary

Modifier and Type	Method and Description
AppendObjectResult	appendObject(AppendObjectRequest request) Perform an appendable upload.
CopyObjectResult	copyObject(CopyObjectRequest request) Copy an object.
CopyObjectResult	copyObject(String sourceBucketName, String sourceObjectKey, String destBucketName, String destObjectKey) Copy an object.
DeleteObjectResult	deleteObject(DeleteObjectRequest request) Delete an object.
DeleteObjectResult	deleteObject(String bucketName, String objectKey) Delete an object.
DeleteObjectResult	deleteObject(String bucketName, String objectKey, String versionId) Delete an object.
DeleteObjectsResult	deleteObjects(DeleteObjectsRequest deleteObjectsRequest) Delete objects in a batch.
boolean	doesObjectExist(GetObjectMetadataRequest request) Check whether an object exists.
boolean	doesObjectExist(String buckeName, String objectKey) Check whether an object exists.
ObsObject	getObject(GetObjectRequest request) Download an object.
ObsObject	getObject(String bucketName, String objectKey) Download an object.
ObsObject	getObject(String bucketName, String objectKey, String versionId) Download an object.
AccessControlList	getObjectAcl(GetObjectAclRequest request) Obtain an object ACL.
AccessControlList	getObjectAcl(String bucketName, String objectKey) Obtain an object ACL.
AccessControlList	getObjectAcl(String bucketName, String objectKey, String versionId) Obtain an object ACL.
ObjectMetadata	getObjectMetadata(GetObjectMetadataRequest request) Obtain object properties.
ObjectMetadata	getObjectMetadata(String bucketName, String objectKey) Obtain object properties.
ObjectMetadata	getObjectMetadata(String bucketName, String objectKey, String versionId) Obtain object properties.
ObjectListing	listObjects(ListObjectsRequest request) List objects in the bucket.
ObjectListing	listObjects(String bucketName) List objects in the bucket.
ListVersionsResult	listVersions(ListVersionsRequest request) List versioning objects in a bucket.
ListVersionsResult	listVersions(String bucketName) List versioning objects in a bucket.
ListVersionsResult	listVersions(String bucketName, long maxKeys) List versioning objects in a bucket.
ListVersionsResult	listVersions(String bucketName, String prefix, String delimiter, String keyMarker, String versionIdMarker, long maxKeys) List versioning objects in a bucket.
ListVersionsResult	listVersions(String bucketName, String prefix, String delimiter, String keyMarker, String versionIdMarker, long maxKeys, String nextVersionIdMarker) Deprecated.
OptionsInfoResult	optionsObject(String bucketName, String objectKey, OptionsInfoRequest optionInfo) Deprecated.
PutObjectResult	putObject(PutObjectRequest request) Upload an object.
PutObjectResult	putObject(String bucketName, String objectKey, File file) Upload an object.
PutObjectResult	putObject(String bucketName, String objectKey, File file, ObjectMetadata metadata) Upload an object.
PutObjectResult	putObject(String bucketName, String objectKey, InputStream input) Upload an object.
PutObjectResult	putObject(String bucketName, String objectKey, InputStream input, ObjectMetadata metadata) Upload an object.
RestoreObjectRequest.RestoreObjectStatus	restoreObject(RestoreObjectRequest request) Restore an Archive object.
RestoreObjectResult	restoreObjectV2(RestoreObjectRequest request) Restore an Archive object.
HeaderResponse	setObjectAcl(SetObjectAclRequest request) Set an object ACL.
HeaderResponse	setObjectAcl(String bucketName, String objectKey, AccessControlList acl) Set an object ACL.
HeaderResponse	setObjectAcl(String bucketName, String objectKey, AccessControlList acl, String versionId) Set an object ACL.
HeaderResponse	setObjectAcl(String bucketName, String objectKey, String cannedACL, AccessControlList acl, String versionId) Deprecated.
ObjectMetadata	setObjectMetadata(SetObjectMetadataRequest request) Set object properties.

Methods inherited from class com.obs.services.AbstractBucketAdvanceClient

deleteBucketDirectColdAccess, deleteBucketDirectColdAccess, deleteBucketEncryption, deleteBucketEncryption, deleteBucketLifecycle, deleteBucketLifecycle, deleteBucketPolicy, deleteBucketPolicy, deleteBucketReplication, deleteBucketReplication, deleteBucketTagging, deleteBucketTagging, deleteBucketWebsite, deleteBucketWebsite, getBucketDirectColdAccess, getBucketDirectColdAccess, getBucketEncryption, getBucketEncryption, getBucketFSStatus, getBucketLifecycle, getBucketLifecycle, getBucketNotification, getBucketNotification, getBucketPolicy, getBucketPolicy, getBucketPolicyV2, getBucketPolicyV2, getBucketReplication, getBucketReplication, getBucketTagging, getBucketTagging, getBucketWebsite, getBucketWebsite, setBucketDirectColdAccess, setBucketDirectColdAccess, setBucketEncryption, setBucketEncryption, setBucketFSStatus, setBucketLifecycle, setBucketLifecycle, setBucketNotification, setBucketNotification, setBucketPolicy, setBucketPolicy, setBucketReplication, setBucketReplication, setBucketTagging, setBucketTagging, setBucketWebsite, setBucketWebsite

Methods inherited from class com.obs.services.AbstractBucketClient

createBucket, createBucket, createBucket, createBucket, deleteBucket, deleteBucket, deleteBucketCors, deleteBucketCors, getBucketAcl, getBucketAcl, getBucketCors, getBucketCors, getBucketLocation, getBucketLocation, getBucketLocationV2, getBucketLogging, getBucketLogging, getBucketMetadata, getBucketQuota, getBucketQuota, getBucketRequestPayment, getBucketRequestPayment, getBucketStorageInfo, getBucketStorageInfo, getBucketStoragePolicy, getBucketStoragePolicy, getBucketVersioning, getBucketVersioning, headBucket, headBucket, listBuckets, listBucketsV2, setBucketAcl, setBucketAcl, setBucketCors, setBucketCors, setBucketLogging, setBucketLogging, setBucketLoggingConfiguration, setBucketQuota, setBucketQuota, setBucketRequestPayment, setBucketRequestPayment, setBucketStoragePolicy, setBucketStoragePolicy, setBucketVersioning, setBucketVersioning

Methods inherited from class com.obs.services.AbstractDeprecatedBucketClient

createBucket, deleteBucketLifecycleConfiguration, deleteBucketReplicationConfiguration, deleteBucketWebsiteConfiguration, getBucketLifecycleConfiguration, getBucketLoggingConfiguration, getBucketReplicationConfiguration, getBucketWebsiteConfiguration, listBuckets, optionsBucket, setBucketAcl, setBucketCors, setBucketLifecycleConfiguration, setBucketLoggingConfiguration, setBucketReplicationConfiguration, setBucketVersioning, setBucketWebsiteConfiguration

Methods inherited from class com.obs.services.AbstractClient

base64Md5, base64Md5, close, createGetTemporarySignature, createGetTemporarySignature, createPostSignature, createPostSignature, createPostSignature, createSignedUrl, createSignedUrl, createTemporarySignature, createV4PostSignature, createV4PostSignature, createV4PostSignature, createV4TemporarySignature, doActionWithResult, init, refresh

Methods inherited from class com.obs.services.internal.ObsService

createPostSignatureResponse, createTemporarySignatureResponse, createV4TemporarySignature, initThreadPool, recordBulkTaskStatus

Methods inherited from class com.obs.services.internal.service.ObsExtensionService

createFetchJobImpl, deleteDisPolicyImpl, deleteExtensionPolicyImpl, deleteReadAheadObjectsImpl, getDisPolicyImpl, putDisPolicyImpl, queryExtensionPolicyImpl, queryFetchJobImpl, queryReadAheadObjectsTaskImpl, readAheadObjectsImpl, setExtensionPolicyImpl

Methods inherited from class com.obs.services.internal.service.ObsFileService

listContentSummaryImpl, renameFileImpl, truncateFileImpl, writeFileImpl

Methods inherited from class com.obs.services.internal.service.ObsObjectService

appendObjectImpl, modifyObjectImpl, renameObjectImpl, restoreObjectImpl, restoreObjectV2Impl, truncateObjectImpl

Methods inherited from class com.obs.services.internal.service.ObsMultipartObjectService

abortMultipartUploadImpl, completeMultipartUploadImpl, copyPartImpl, initiateMultipartUploadImpl, listMultipartUploadsImpl, listPartsImpl, uploadPartImpl

Methods inherited from class com.obs.services.internal.service.ObsObjectBaseService

copyObjectImpl, deleteObjectImpl, deleteObjectsImpl, doesObjectExistImpl, getObjectAclImpl, getObjectImpl, getObjectImpl, getObjectMetadataImpl, getObjectUrl, putObjectImpl, setObjectAclImpl, setObjectMetadataImpl

Methods inherited from class com.obs.services.internal.service.ObsBucketAdvanceService

deleteBucketCorsImpl, deleteBucketDirectColdAccessImpl, deleteBucketEncryptionImpl, deleteBucketLifecycleConfigurationImpl, deleteBucketReplicationConfigurationImpl, deleteBucketTaggingImpl, deleteBucketWebsiteConfigurationImpl, getBucketAclImpl, getBucketCorsImpl, getBucketDirectColdAccessImpl, getBucketEncryptionImpl, getBucketLifecycleConfigurationImpl, getBucketLoggingConfigurationImpl, getBucketNotificationConfigurationImpl, getBucketQuotaImpl, getBucketReplicationConfigurationImpl, getBucketRequestPaymentImpl, getBucketTaggingImpl, getBucketVersioningImpl, getBucketWebsiteConfigurationImpl, setBucketAclImpl, setBucketCorsImpl, setBucketDirectColdAccessImpl, setBucketEncryptionImpl, setBucketLifecycleConfigurationImpl, setBucketLoggingConfigurationImpl, setBucketNotificationImpl, setBucketQuotaImpl, setBucketReplicationConfigurationImpl, setBucketRequestPaymentImpl, setBucketTaggingImpl, setBucketVersioningImpl, setBucketWebsiteConfigurationImpl

Methods inherited from class com.obs.services.internal.service.ObsBucketBaseService

createBucketImpl, deleteBucketImpl, deleteBucketPolicyImpl, getBucketLocationImpl, getBucketMetadataImpl, getBucketPolicyImpl, getBucketStorageInfoImpl, getBucketStoragePolicyImpl, headBucketImpl, listAllBucketsImpl, listObjectsImpl, listVersionsImpl, optionsImpl, setBucketFSStatusImpl, setBucketPolicyImpl, setBucketStorageImpl

Methods inherited from class com.obs.services.internal.service.RequestConvertor

transAppendObjectRequest, transConditionCopyHeaders, transConditionGetObjectHeaders, transCopyObjectRequest, transCopyPartRequest, transCreateBucketRequest, transExtensionPermissions, transGetObjectParams, transGetObjectRequest, transInitiateMultipartUploadRequest, transListContentSummaryRequest, transListObjectsRequest, transListVersionsRequest, transModifyObjectRequest, transPutObjectRequest, transRangeHeader, transRestoreObjectResultToRestoreObjectStatus, transSetObjectMetadataRequest, transSseCHeaders, transSseCSourceHeaders, transSseHeaders, transSseKmsHeaders, transUploadPartRequest, transWriteFileRequest

Methods inherited from class com.obs.services.internal.service.AclHeaderConvertor

getCredential, prepareRESTHeaderAcl, prepareRESTHeaderAclObject, putAclImpl

Methods inherited from class com.obs.services.internal.service.AbstractRequestConvertor

build, build, cleanResponseHeaders, createRequestBody, getApiVersion, getHeaderByMethodName, getOptionInfoResult, getSpecialParamForStorageClass, putHeader, setResponseHeaders, setStatusCode, transRequestPaymentHeaders, transRequestPaymentHeaders, verifyResponseContentType, verifyResponseContentTypeForJson

Methods inherited from class com.obs.services.internal.RestStorageService

addRequestHeadersToConnection, authorizeHttpRequest, convertHeadersToMap, getApiVersionCache, getFileSystemDelimiter, getIConvertor, getIHeaders, getProviderCredentials, getRestHeaderPrefix, getRestMetadataPrefix, getXmlResponseSaxParser, isAuthTypeNegotiation, performRequest, performRequest, performRequest, performRequestWithoutSignature, performRestDelete, performRestDelete, performRestDelete, performRestDelete, performRestForApiVersion, performRestGet, performRestGet, performRestGetForListBuckets, performRestHead, performRestOptions, performRestPost, performRestPost, performRestPut, performRestPut, renameMetadataKeys, retryRequest, setCanUseStandardHTTPHeaders, setProviderCredentials, setUserHeaders

Methods inherited from class com.obs.services.internal.RestConnectionService

addRequestParametersToUrlPath, addRequestParametersToUrlPath, getEndpoint, getHttpPort, getHttpsOnly, getHttpsPort, initHttpClient, isCname, isKeepAlive, isPathStyle, setupConnection, setupConnection, setupConnection, shutdown, shutdownImpl

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.obs.services.IObsClient

abortMultipartUpload, completeMultipartUpload, copyPart, deleteReadAheadObjects, downloadFile, initiateMultipartUpload, listMultipartUploads, listParts, modifyObject, modifyObject, modifyObject, putObjects, queryReadAheadObjectsTask, readAheadObjects, renameObject, renameObject, restoreObjects, truncateObject, truncateObject, uploadFile, uploadPart, uploadPart, uploadPart

Methods inherited from interface com.obs.services.IFSClient

appendFile, dropFile, dropFolder, getAttribute, listContentSummary, newBucket, newFile, newFolder, readFile, renameFile, renameFolder, truncateFile, writeFile

Constructor Detail

AbstractObjectClient

public AbstractObjectClient()

Method Detail

doesObjectExist

public boolean doesObjectExist(String buckeName,
                               String objectKey)
                        throws ObsException

Description copied from interface: IObsClient

Check whether an object exists.

Parameters:

buckeName - Bucket name

objectKey - Object name

Returns:

Whether an object exists

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

doesObjectExist

public boolean doesObjectExist(GetObjectMetadataRequest request)
                        throws ObsException

Description copied from interface: IObsClient

Check whether an object exists.

Parameters:

request - Request parameters for obtaining the properties of an object

Returns:

Whether an object exists

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

optionsObject

@Deprecated
public OptionsInfoResult optionsObject(String bucketName,
                                                   String objectKey,
                                                   OptionsInfoRequest optionInfo)
                                            throws ObsException

Deprecated.

Perform a preflight on a bucket.

Parameters:

bucketName - Bucket name

objectKey - Object name

optionInfo - Parameters in an object preflight request

Returns:

Response to the object preflight request

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

listObjects

public ObjectListing listObjects(ListObjectsRequest request)
                          throws ObsException

Description copied from interface: IObsClient

List objects in the bucket.

Parameters:

request - Request parameters for listing objects in a bucket

Returns:

Response to the request for listing objects in the bucket

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

listObjects

public ObjectListing listObjects(String bucketName)
                          throws ObsException

Description copied from interface: IObsClient

List objects in the bucket.

Parameters:

bucketName - Bucket name

Returns:

Response to the request for listing objects in the bucket

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

listVersions

@Deprecated
public ListVersionsResult listVersions(String bucketName,
                                                   String prefix,
                                                   String delimiter,
                                                   String keyMarker,
                                                   String versionIdMarker,
                                                   long maxKeys,
                                                   String nextVersionIdMarker)
                                            throws ObsException

Deprecated.

List versioning objects in a bucket.

Parameters:

bucketName - Bucket name

prefix - Object name prefix used for listing versioning objects

delimiter - Character for grouping object names

keyMarker - Start position for listing versioning objects (sorted by object name)

versionIdMarker - Start position for listing versioning objects (sorted by version ID)

maxKeys - Maximum number of versioning objects to be listed

nextVersionIdMarker - Deprecated field

Returns:

Response to the request for listing versioning objects in the bucket

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

listVersions

public ListVersionsResult listVersions(ListVersionsRequest request)
                                throws ObsException

Description copied from interface: IObsClient

List versioning objects in a bucket.

Parameters:

request - Request parameters for listing versioning objects in the bucket

Returns:

Response to the request for listing versioning objects in the bucket

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

listVersions

public ListVersionsResult listVersions(String bucketName)
                                throws ObsException

Description copied from interface: IObsClient

List versioning objects in a bucket.

Parameters:

bucketName - Bucket name

Returns:

Response to the request for listing versioning objects in the bucket

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

listVersions

public ListVersionsResult listVersions(String bucketName,
                                       long maxKeys)
                                throws ObsException

Description copied from interface: IObsClient

List versioning objects in a bucket.

Parameters:

bucketName - Bucket name

maxKeys - Maximum number of versioning objects to be listed

Returns:

Response to the request for listing versioning objects in the bucket

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

listVersions

public ListVersionsResult listVersions(String bucketName,
                                       String prefix,
                                       String delimiter,
                                       String keyMarker,
                                       String versionIdMarker,
                                       long maxKeys)
                                throws ObsException

Description copied from interface: IObsClient

List versioning objects in a bucket.

Parameters:

bucketName - Bucket name

prefix - Object name prefix used for listing versioning objects

delimiter - Character for grouping object names

keyMarker - Start position for listing versioning objects (sorted by object name)

versionIdMarker - Start position for listing versioning objects (sorted by version ID)

maxKeys - Maximum number of versioning objects to be listed

Returns:

Response to the request for listing versioning objects in the bucket

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

putObject

public PutObjectResult putObject(String bucketName,
                                 String objectKey,
                                 InputStream input,
                                 ObjectMetadata metadata)
                          throws ObsException

Description copied from interface: IObsClient

Upload an object.

Parameters:

bucketName - Bucket name

objectKey - Object name

input - Data stream to be uploaded

metadata - Object properties

Returns:

Response to an object upload request

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

putObject

public PutObjectResult putObject(String bucketName,
                                 String objectKey,
                                 InputStream input)
                          throws ObsException

Description copied from interface: IObsClient

Upload an object.

Parameters:

bucketName - Bucket name

objectKey - Object name

input - Data stream to be uploaded

Returns:

Response to an object upload request

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

putObject

public PutObjectResult putObject(PutObjectRequest request)
                          throws ObsException

Description copied from interface: IObsClient

Upload an object.

Parameters:

request - Parameters in an object upload request

Returns:

Response to an object upload request

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

putObject

public PutObjectResult putObject(String bucketName,
                                 String objectKey,
                                 File file)
                          throws ObsException

Description copied from interface: IObsClient

Upload an object.

Parameters:

bucketName - Bucket name

objectKey - Object name

file - File to be uploaded

Returns:

Response to an object upload request

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

putObject

public PutObjectResult putObject(String bucketName,
                                 String objectKey,
                                 File file,
                                 ObjectMetadata metadata)
                          throws ObsException

Description copied from interface: IObsClient

Upload an object.

Parameters:

bucketName - Bucket name

objectKey - Object name

file - File to be uploaded

metadata - Object properties

Returns:

Response to an object upload request

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getObject

public ObsObject getObject(GetObjectRequest request)
                    throws ObsException

Description copied from interface: IObsClient

Download an object.

Parameters:

request - Parameters in an object download request

Returns:

Object information, including the object data stream

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getObject

public ObsObject getObject(String bucketName,
                           String objectKey,
                           String versionId)
                    throws ObsException

Description copied from interface: IObsClient

Download an object.

Parameters:

bucketName - Bucket name

objectKey - Object name

versionId - Object version ID

Returns:

Object information, including the object data stream

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getObject

public ObsObject getObject(String bucketName,
                           String objectKey)
                    throws ObsException

Description copied from interface: IObsClient

Download an object.

Parameters:

bucketName - Bucket name

objectKey - Object name

Returns:

Object information, including the object data stream

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteObject

public DeleteObjectResult deleteObject(String bucketName,
                                       String objectKey,
                                       String versionId)
                                throws ObsException

Description copied from interface: IObsClient

Delete an object.

Parameters:

bucketName - Bucket name

objectKey - Object name

versionId - Object version ID

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteObject

public DeleteObjectResult deleteObject(String bucketName,
                                       String objectKey)
                                throws ObsException

Description copied from interface: IObsClient

Delete an object.

Parameters:

bucketName - Bucket name

objectKey - Object name

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteObject

public DeleteObjectResult deleteObject(DeleteObjectRequest request)
                                throws ObsException

Description copied from interface: IObsClient

Delete an object.

Parameters:

request - Request parameters for deleting an object

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteObjects

public DeleteObjectsResult deleteObjects(DeleteObjectsRequest deleteObjectsRequest)
                                  throws ObsException

Description copied from interface: IObsClient

Delete objects in a batch.

Parameters:

deleteObjectsRequest - Parameters in an object batch deletion request

Returns:

Result of the object batch deletion request

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

copyObject

public CopyObjectResult copyObject(CopyObjectRequest request)
                            throws ObsException

Description copied from interface: IObsClient

Copy an object.

Parameters:

request - Parameters in a request for copying an object

Returns:

Result of the object copy

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

copyObject

public CopyObjectResult copyObject(String sourceBucketName,
                                   String sourceObjectKey,
                                   String destBucketName,
                                   String destObjectKey)
                            throws ObsException

Description copied from interface: IObsClient

Copy an object.

Parameters:

sourceBucketName - Source bucket name

sourceObjectKey - Source object name

destBucketName - Destination bucket name

destObjectKey - Destination object name

Returns:

Result of the object copy

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getObjectAcl

public AccessControlList getObjectAcl(String bucketName,
                                      String objectKey,
                                      String versionId)
                               throws ObsException

Description copied from interface: IObsClient

Obtain an object ACL.

Parameters:

bucketName - Bucket name

objectKey - Object name

versionId - Object version ID

Returns:

Object ACL

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getObjectAcl

public AccessControlList getObjectAcl(String bucketName,
                                      String objectKey)
                               throws ObsException

Description copied from interface: IObsClient

Obtain an object ACL.

Parameters:

bucketName - Bucket name

objectKey - Object name

Returns:

Object ACL

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getObjectAcl

public AccessControlList getObjectAcl(GetObjectAclRequest request)
                               throws ObsException

Description copied from interface: IObsClient

Obtain an object ACL.

Parameters:

request - Request parameters for obtaining an object ACL

Returns:

Object ACL

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setObjectAcl

@Deprecated
public HeaderResponse setObjectAcl(String bucketName,
                                               String objectKey,
                                               String cannedACL,
                                               AccessControlList acl,
                                               String versionId)
                                        throws ObsException

Deprecated.

Set an object ACL.

Parameters:

bucketName - Bucket name

objectKey - Object name

cannedACL - Pre-defined access control policy

acl - ACL ("acl" and "cannedACL" cannot be used together.)

versionId - Object version ID

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setObjectAcl

public HeaderResponse setObjectAcl(SetObjectAclRequest request)
                            throws ObsException

Description copied from interface: IObsClient

Set an object ACL.

Parameters:

request - Request parameters

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setObjectAcl

public HeaderResponse setObjectAcl(String bucketName,
                                   String objectKey,
                                   AccessControlList acl,
                                   String versionId)
                            throws ObsException

Description copied from interface: IObsClient

Set an object ACL.

Parameters:

bucketName - Bucket name

objectKey - Object name

acl - ACL

versionId - Object version ID

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setObjectAcl

public HeaderResponse setObjectAcl(String bucketName,
                                   String objectKey,
                                   AccessControlList acl)
                            throws ObsException

Description copied from interface: IObsClient

Set an object ACL.

Parameters:

bucketName - Bucket name

objectKey - Object name

acl - ACL

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getObjectMetadata

public ObjectMetadata getObjectMetadata(GetObjectMetadataRequest request)
                                 throws ObsException

Description copied from interface: IObsClient

Obtain object properties.

Parameters:

request - Parameters in a request for obtaining the properties of an object

Returns:

Object properties

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setObjectMetadata

public ObjectMetadata setObjectMetadata(SetObjectMetadataRequest request)
                                 throws ObsException

Description copied from interface: IObsClient

Set object properties.

Parameters:

request - Parameters in the request for obtaining object properties

Returns:

Object properties

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getObjectMetadata

public ObjectMetadata getObjectMetadata(String bucketName,
                                        String objectKey,
                                        String versionId)
                                 throws ObsException

Description copied from interface: IObsClient

Obtain object properties.

Parameters:

bucketName - Bucket name

objectKey - Object name

versionId - Object version ID

Returns:

Object properties

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getObjectMetadata

public ObjectMetadata getObjectMetadata(String bucketName,
                                        String objectKey)
                                 throws ObsException

Description copied from interface: IObsClient

Obtain object properties.

Parameters:

bucketName - Bucket name

objectKey - Object name

Returns:

Object properties

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

appendObject

public AppendObjectResult appendObject(AppendObjectRequest request)
                                throws ObsException

Description copied from interface: IObsClient

Perform an appendable upload.

Parameters:

request - Parameters in an appendable upload request

Returns:

Response to the appendable upload request

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

restoreObject

public RestoreObjectRequest.RestoreObjectStatus restoreObject(RestoreObjectRequest request)
                                                       throws ObsException

Description copied from interface: IObsClient

Restore an Archive object.

Parameters:

request - Parameters in a request for restoring an Archive object

Returns:

Status of the to-be-restored Archive object

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

restoreObjectV2

public RestoreObjectResult restoreObjectV2(RestoreObjectRequest request)
                                    throws ObsException

Description copied from interface: IObsClient

Restore an Archive object.

Parameters:

request - Request parameters for restoring an Archive object

Returns:

Result of restoring the Archive object

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails