com.obs.services

类 AbstractClient

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

所有已实现的接口:

IFSClient, IObsBucketExtendClient, IObsClient, Closeable, AutoCloseable

直接已知子类:

AbstractDeprecatedBucketClient

public abstract class AbstractClient
extends com.obs.services.internal.ObsService
implements Closeable, IObsClient, IFSClient

嵌套类概要

嵌套类

限定符和类型	类和说明
protected class	AbstractClient.ActionCallbackWithResult<T>

从类继承的嵌套类/接口 com.obs.services.internal.service.AbstractRequestConvertor

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

字段概要

从类继承的字段 com.obs.services.internal.RestStorageService

CAN_USE_STANDARD_HTTP_HEADERS

从类继承的字段 com.obs.services.internal.RestConnectionService

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

构造器概要

构造器

构造器和说明
AbstractClient()

方法概要

限定符和类型	方法和说明
String	base64Md5(InputStream is)
String	base64Md5(InputStream is, long length, long offset)
void	close() Close ObsClient and release connection resources.
TemporarySignatureResponse	createGetTemporarySignature(String bucketName, String objectKey, String prefix, Date expiryDate, Map<String,String> headers, Map<String,Object> queryParams) Generate temporary authorization parameters for GET requests based on the object name prefix and validity period.
TemporarySignatureResponse	createGetTemporarySignature(String bucketName, String objectKey, String prefix, long expires, Map<String,String> headers, Map<String,Object> queryParams) Generate temporary authorization parameters for GET requests based on the object name prefix and validity period.
PostSignatureResponse	createPostSignature(long expires, String bucketName, String objectKey) Generate parameters for browser-based authorized access.
PostSignatureResponse	createPostSignature(PostSignatureRequest request) Generate parameters for browser-based authorized access.
PostSignatureResponse	createPostSignature(String acl, String contentType, long expires, String bucketName, String objectKey) Generate parameters for browser-based authorized access.
String	createSignedUrl(HttpMethodEnum method, String bucketName, String objectKey, SpecialParamEnum specialParam, Date expiryTime, Map<String,String> headers, Map<String,Object> queryParams) 已过时。
String	createSignedUrl(HttpMethodEnum method, String bucketName, String objectKey, SpecialParamEnum specialParam, long expires, Map<String,String> headers, Map<String,Object> queryParams) 已过时。
TemporarySignatureResponse	createTemporarySignature(TemporarySignatureRequest request) Generate temporarily authorized access parameters.
V4PostSignatureResponse	createV4PostSignature(long expires, String bucketName, String objectKey) 已过时。
V4PostSignatureResponse	createV4PostSignature(String acl, String contentType, long expires, String bucketName, String objectKey) 已过时。
V4PostSignatureResponse	createV4PostSignature(V4PostSignatureRequest request) 已过时。
V4TemporarySignatureResponse	createV4TemporarySignature(V4TemporarySignatureRequest request) 已过时。
protected <T> T	doActionWithResult(String action, String bucketName, AbstractClient.ActionCallbackWithResult<T> callback)
protected void	init(String accessKey, String secretKey, String securityToken, ObsConfiguration config)
void	refresh(String accessKey, String secretKey, String securityToken) Refresh the temporary access key.

从类继承的方法 com.obs.services.internal.ObsService

createPostSignatureResponse, createTemporarySignatureResponse, createV4TemporarySignature, initThreadPool, recordBulkTaskStatus

从类继承的方法 com.obs.services.internal.service.ObsExtensionService

createFetchJobImpl, deleteExtensionPolicyImpl, deleteReadAheadObjectsImpl, queryExtensionPolicyImpl, queryFetchJobImpl, queryReadAheadObjectsTaskImpl, readAheadObjectsImpl, setExtensionPolicyImpl

从类继承的方法 com.obs.services.internal.service.ObsFileService

deleteAccessLabelFsImpl, getAccessLabelFsImpl, getContentSummaryFsImpl, listContentSummaryFsImpl, listContentSummaryImpl, renameFileImpl, setAccessLabelFsImpl, truncateFileImpl, writeFileImpl

从类继承的方法 com.obs.services.internal.service.ObsObjectService

appendObjectImpl, modifyObjectImpl, renameObjectImpl, restoreObjectImpl, restoreObjectV2Impl, truncateObjectImpl

从类继承的方法 com.obs.services.internal.service.ObsMultipartObjectService

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

从类继承的方法 com.obs.services.internal.service.ObsObjectBaseService

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

从类继承的方法 com.obs.services.internal.service.ObsBucketAdvanceService

bindBucketAliasImpl, createBucketAliasImpl, createBucketWithClusterId, createVirtualBucketImpl, deleteBucketCorsImpl, deleteBucketCustomDomainImpl, deleteBucketDirectColdAccessImpl, deleteBucketEncryptionImpl, deleteBucketLifecycleConfigurationImpl, deleteBucketReplicationConfigurationImpl, deleteBucketTaggingImpl, deleteBucketWebsiteConfigurationImpl, getBucketAclImpl, getBucketCorsImpl, getBucketCustomDomainImpl, getBucketDirectColdAccessImpl, getBucketEncryptionImpl, getBucketLifecycleConfigurationImpl, getBucketLoggingConfigurationImpl, getBucketNotificationConfigurationImpl, getBucketQuotaImpl, getBucketReplicationConfigurationImpl, getBucketRequestPaymentImpl, getBucketTaggingImpl, getBucketWebsiteConfigurationImpl, listAliasBucketsImpl, listAvailableZoneInfo, setBucketAclImpl, setBucketCorsImpl, setBucketCustomDomainImpl, setBucketDirectColdAccessImpl, setBucketEncryptionImpl, setBucketLifecycleConfigurationImpl, setBucketLoggingConfigurationImpl, setBucketNotificationImpl, setBucketQuotaImpl, setBucketReplicationConfigurationImpl, setBucketRequestPaymentImpl, setBucketTaggingImpl, setBucketVersioningImpl, setBucketWebsiteConfigurationImpl, setVirtualReplication

从类继承的方法 com.obs.services.internal.service.ObsBucketBaseService

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

从类继承的方法 com.obs.services.internal.service.RequestConvertor

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

从类继承的方法 com.obs.services.internal.service.AclHeaderConvertor

getCredential, prepareRESTHeaderAcl, prepareRESTHeaderAclObject, putAclImpl

从类继承的方法 com.obs.services.internal.service.AbstractRequestConvertor

build, createRequestBody, getApiVersion, getHeaderByMethodName, getOptionInfoResult, getSpecialParamForStorageClass, putCleanedKeyAndValues, putHeader, setHeadersAndStatus, setHeadersAndStatus, transObjectRequest, transObjectRequestWithResult, transRequest, transRequestPaymentHeaders, transRequestPaymentHeaders, transRequestWithResult, verifyResponseContentType, verifyResponseContentTypeForJson

从类继承的方法 com.obs.services.internal.RestStorageService

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

从类继承的方法 com.obs.services.internal.RestConnectionService

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

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

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

从接口继承的方法 com.obs.services.IObsClient

abortMultipartUpload, appendObject, completeMultipartUpload, copyObject, copyObject, copyPart, createBucket, createBucket, createBucket, createBucket, createVirtualBucket, deleteBucket, deleteBucket, deleteBucketCors, deleteBucketCors, deleteBucketDirectColdAccess, deleteBucketDirectColdAccess, deleteBucketEncryption, deleteBucketEncryption, deleteBucketLifecycle, deleteBucketLifecycle, deleteBucketPolicy, deleteBucketPolicy, deleteBucketReplication, deleteBucketReplication, deleteBucketTagging, deleteBucketTagging, deleteBucketWebsite, deleteBucketWebsite, deleteObject, deleteObject, deleteObject, deleteObjects, deleteReadAheadObjects, doesObjectExist, doesObjectExist, downloadFile, getBucketAcl, getBucketAcl, getBucketCors, getBucketCors, getBucketDirectColdAccess, getBucketDirectColdAccess, getBucketEncryption, getBucketEncryption, getBucketLifecycle, getBucketLifecycle, getBucketLocation, getBucketLocation, getBucketLocationV2, getBucketLogging, getBucketLogging, getBucketMetadata, getBucketNotification, getBucketNotification, getBucketPolicy, getBucketPolicy, getBucketPolicyV2, getBucketPolicyV2, getBucketQuota, getBucketQuota, getBucketReplication, getBucketReplication, getBucketRequestPayment, getBucketRequestPayment, getBucketStorageInfo, getBucketStorageInfo, getBucketStoragePolicy, getBucketStoragePolicy, getBucketTagging, getBucketTagging, getBucketVersioning, getBucketVersioning, getBucketWebsite, getBucketWebsite, getObject, getObject, getObject, getObjectAcl, getObjectAcl, getObjectAcl, getObjectMetadata, getObjectMetadata, getObjectMetadata, headBucket, headBucket, initiateMultipartUpload, listAliasBuckets, listBuckets, listBucketsV2, listMultipartUploads, listObjects, listObjects, listParts, listVersions, listVersions, listVersions, listVersions, modifyObject, modifyObject, modifyObject, putObject, putObject, putObject, putObject, putObject, putObjects, queryReadAheadObjectsTask, readAheadObjects, renameObject, renameObject, restoreObject, restoreObjects, restoreObjectV2, selectObjectContent, setBucketAcl, setBucketAcl, setBucketCors, setBucketCors, setBucketDirectColdAccess, setBucketDirectColdAccess, setBucketEncryption, setBucketEncryption, setBucketLifecycle, setBucketLifecycle, setBucketLogging, setBucketLogging, setBucketLoggingConfiguration, setBucketNotification, setBucketNotification, setBucketPolicy, setBucketPolicy, setBucketQuota, setBucketQuota, setBucketReplication, setBucketReplication, setBucketRequestPayment, setBucketRequestPayment, setBucketStoragePolicy, setBucketStoragePolicy, setBucketTagging, setBucketTagging, setBucketVersioning, setBucketVersioning, setBucketWebsite, setBucketWebsite, setObjectAcl, setObjectAcl, setObjectAcl, setObjectMetadata, truncateObject, truncateObject, uploadFile, uploadPart, uploadPart, uploadPart

从接口继承的方法 com.obs.services.IObsBucketExtendClient

deleteBucketCustomDomain, deleteBucketCustomDomain, getBucketCustomDomain, getBucketCustomDomain, setBucketCustomDomain, setBucketCustomDomain

从接口继承的方法 com.obs.services.IFSClient

appendFile, deleteAccessLabelFs, dropFile, dropFolder, getAccessLabelFs, getAttribute, getBucketFSStatus, getContentSummaryFs, listContentSummary, listContentSummaryFs, newBucket, newFile, newFolder, readFile, renameFile, renameFolder, setAccessLabelFs, setBucketFSStatus, truncateFile, writeFile

构造器详细资料

AbstractClient

public AbstractClient()

方法详细资料

init

protected void init(String accessKey,
                    String secretKey,
                    String securityToken,
                    ObsConfiguration config)

createSignedUrl

@Deprecated
public String createSignedUrl(HttpMethodEnum method,
                                           String bucketName,
                                           String objectKey,
                                           SpecialParamEnum specialParam,
                                           Date expiryTime,
                                           Map<String,String> headers,
                                           Map<String,Object> queryParams)
                                    throws ObsException

已过时。

Create a temporarily authorized URL.

参数:

method - HTTP request method

bucketName - Bucket name

objectKey - Object name

specialParam - Special operator

expiryTime - Time when the temporary authentication expires

headers - Header information

queryParams - Query parameter information

返回:

Temporarily authorized URL

抛出:

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

createSignedUrl

@Deprecated
public String createSignedUrl(HttpMethodEnum method,
                                           String bucketName,
                                           String objectKey,
                                           SpecialParamEnum specialParam,
                                           long expires,
                                           Map<String,String> headers,
                                           Map<String,Object> queryParams)

已过时。

Create a temporarily authorized URL.

参数:

method - HTTP request method

bucketName - Bucket name

objectKey - Object name

specialParam - Special operator

expires - Time when the temporary authentication expires. The unit is second and the default value is 300.

headers - Header information

queryParams - Query parameter information

返回:

Temporarily authorized URL

抛出:

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

createV4TemporarySignature

@Deprecated
public V4TemporarySignatureResponse createV4TemporarySignature(V4TemporarySignatureRequest request)

已过时。

createV4PostSignature

@Deprecated
public V4PostSignatureResponse createV4PostSignature(String acl,
                                                                  String contentType,
                                                                  long expires,
                                                                  String bucketName,
                                                                  String objectKey)
                                                           throws ObsException

已过时。

抛出:

ObsException

createV4PostSignature

@Deprecated
public V4PostSignatureResponse createV4PostSignature(long expires,
                                                                  String bucketName,
                                                                  String objectKey)
                                                           throws ObsException

已过时。

抛出:

ObsException

createV4PostSignature

@Deprecated
public V4PostSignatureResponse createV4PostSignature(V4PostSignatureRequest request)
                                                           throws ObsException

已过时。

抛出:

ObsException

createTemporarySignature

public TemporarySignatureResponse createTemporarySignature(TemporarySignatureRequest request)

从接口复制的说明: IObsClient

Generate temporarily authorized access parameters.

指定者:

createTemporarySignature 在接口中 IObsClient

参数:

request - Parameters in a request for temporarily authorized access

返回:

Response to the request for temporarily authorized access

createGetTemporarySignature

public TemporarySignatureResponse createGetTemporarySignature(String bucketName,
                                                              String objectKey,
                                                              String prefix,
                                                              Date expiryDate,
                                                              Map<String,String> headers,
                                                              Map<String,Object> queryParams)

Generate temporary authorization parameters for GET requests based on the object name prefix and validity period.

参数:

bucketName - Bucket name

objectKey - Object name

prefix - Object name prefix

expiryDate - Expiration date (ISO 8601 UTC)

headers - Header information

queryParams - Query parameter information

返回:

Response to the request for temporary access authorization

抛出:

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

createGetTemporarySignature

public TemporarySignatureResponse createGetTemporarySignature(String bucketName,
                                                              String objectKey,
                                                              String prefix,
                                                              long expires,
                                                              Map<String,String> headers,
                                                              Map<String,Object> queryParams)

Generate temporary authorization parameters for GET requests based on the object name prefix and validity period.

参数:

bucketName - Bucket name

objectKey - Object name

prefix - Object name prefix

expires - Validity period (seconds)

headers - Header information

queryParams - Query parameter information

返回:

Response to the request for temporary access authorization

抛出:

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

createPostSignature

public PostSignatureResponse createPostSignature(String acl,
                                                 String contentType,
                                                 long expires,
                                                 String bucketName,
                                                 String objectKey)
                                          throws ObsException

Generate parameters for browser-based authorized access.

参数:

acl - Object ACL

contentType - MIME type of the object

expires - Validity period (in seconds)

bucketName - Bucket name

objectKey - Object name

返回:

Response to the V4 browser-based authorized access

抛出:

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

createPostSignature

public PostSignatureResponse createPostSignature(long expires,
                                                 String bucketName,
                                                 String objectKey)
                                          throws ObsException

Generate parameters for browser-based authorized access.

参数:

expires - Validity period (in seconds)

bucketName - Bucket name

objectKey - Object name

返回:

Response to the V4 browser-based authorized access

抛出:

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

createPostSignature

public PostSignatureResponse createPostSignature(PostSignatureRequest request)
                                          throws ObsException

从接口复制的说明: IObsClient

Generate parameters for browser-based authorized access.

指定者:

createPostSignature 在接口中 IObsClient

参数:

request - Request parameters for V4 browser-based authorized access

返回:

Response to the V4 browser-based authorized access

抛出:

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

doActionWithResult

protected <T> T doActionWithResult(String action,
                                   String bucketName,
                                   AbstractClient.ActionCallbackWithResult<T> callback)
                            throws ObsException

抛出:

ObsException

refresh

public void refresh(String accessKey,
                    String secretKey,
                    String securityToken)

从接口复制的说明: IObsClient

Refresh the temporary access key.

指定者:

refresh 在接口中 IObsClient

参数:

accessKey - AK in the temporary access key

secretKey - SK in the temporary access key

securityToken - Security token

close

public void close()
           throws IOException

从接口复制的说明: IObsClient

Close ObsClient and release connection resources.

指定者:

close 在接口中 IFSClient

指定者:

close 在接口中 IObsClient

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

抛出:

IOException - ObsClient close exception

base64Md5

public String base64Md5(InputStream is,
                        long length,
                        long offset)
                 throws NoSuchAlgorithmException,
                        IOException

抛出:

NoSuchAlgorithmException

IOException

base64Md5

public String base64Md5(InputStream is)
                 throws NoSuchAlgorithmException,
                        IOException

抛出:

NoSuchAlgorithmException

IOException