com.obs.services

Class 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

All Implemented Interfaces:

IFSClient, IObsClient, Closeable, AutoCloseable

Direct Known Subclasses:

AbstractDeprecatedBucketClient

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	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
AbstractClient()

Method Summary

Modifier and Type	Method and Description
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) Deprecated.
String	createSignedUrl(HttpMethodEnum method, String bucketName, String objectKey, SpecialParamEnum specialParam, long expires, Map<String,String> headers, Map<String,Object> queryParams) Deprecated.
TemporarySignatureResponse	createTemporarySignature(TemporarySignatureRequest request) Generate temporarily authorized access parameters.
V4PostSignatureResponse	createV4PostSignature(long expires, String bucketName, String objectKey) Deprecated.
V4PostSignatureResponse	createV4PostSignature(String acl, String contentType, long expires, String bucketName, String objectKey) Deprecated.
V4PostSignatureResponse	createV4PostSignature(V4PostSignatureRequest request) Deprecated.
V4TemporarySignatureResponse	createV4TemporarySignature(V4TemporarySignatureRequest request) Deprecated.
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.

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, appendObject, completeMultipartUpload, copyObject, copyObject, copyPart, createBucket, createBucket, createBucket, createBucket, 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, 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, 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

Methods inherited from interface com.obs.services.IFSClient

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

Constructor Detail

AbstractClient

public AbstractClient()

Method Detail

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

Deprecated.

Create a temporarily authorized URL.

Parameters:

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

Returns:

Temporarily authorized URL

Throws:

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)

Deprecated.

Create a temporarily authorized URL.

Parameters:

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

Returns:

Temporarily authorized URL

Throws:

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)

Deprecated.

createV4PostSignature

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

Deprecated.

Throws:

ObsException

createV4PostSignature

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

Deprecated.

Throws:

ObsException

createV4PostSignature

@Deprecated
public V4PostSignatureResponse createV4PostSignature(V4PostSignatureRequest request)
                                                          throws ObsException

Deprecated.

Throws:

ObsException

createTemporarySignature

public TemporarySignatureResponse createTemporarySignature(TemporarySignatureRequest request)

Description copied from interface: IObsClient

Generate temporarily authorized access parameters.

Specified by:

createTemporarySignature in interface IObsClient

Parameters:

request - Parameters in a request for temporarily authorized access

Returns:

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.

Parameters:

bucketName - Bucket name

objectKey - Object name

prefix - Object name prefix

expiryDate - Expiration date (ISO 8601 UTC)

headers - Header information

queryParams - Query parameter information

Returns:

Response to the request for temporary access authorization

Throws:

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.

Parameters:

bucketName - Bucket name

objectKey - Object name

prefix - Object name prefix

expires - Validity period (seconds)

headers - Header information

queryParams - Query parameter information

Returns:

Response to the request for temporary access authorization

Throws:

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.

Parameters:

acl - Object ACL

contentType - MIME type of the object

expires - Validity period (in seconds)

bucketName - Bucket name

objectKey - Object name

Returns:

Response to the V4 browser-based authorized access

Throws:

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.

Parameters:

expires - Validity period (in seconds)

bucketName - Bucket name

objectKey - Object name

Returns:

Response to the V4 browser-based authorized access

Throws:

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

Description copied from interface: IObsClient

Generate parameters for browser-based authorized access.

Specified by:

createPostSignature in interface IObsClient

Parameters:

request - Request parameters for V4 browser-based authorized access

Returns:

Response to the V4 browser-based authorized access

Throws:

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

Throws:

ObsException

refresh

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

Description copied from interface: IObsClient

Refresh the temporary access key.

Specified by:

refresh in interface IObsClient

Parameters:

accessKey - AK in the temporary access key

secretKey - SK in the temporary access key

securityToken - Security token

close

public void close()
           throws IOException

Description copied from interface: IObsClient

Close ObsClient and release connection resources.

Specified by:

close in interface IFSClient

Specified by:

close in interface IObsClient

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - ObsClient close exception

base64Md5

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

Throws:

NoSuchAlgorithmException

IOException

base64Md5

public String base64Md5(InputStream is)
                 throws NoSuchAlgorithmException,
                        IOException

Throws:

NoSuchAlgorithmException

IOException