com.ksyun.ks3.service

接口 Ks3

所有已知实现类:

Ks3Client, Ks3EncryptionClient

public interface Ks3

方法概要

方法

限定符和类型	方法和说明
void	abortMultipartUpload(AbortMultipartUploadRequest request) Abort Multipart Upload
void	abortMultipartUpload(String bucketname, String objectkey, String uploadId) Abort Multipart Upload
boolean	bucketExists(String bucketname)
void	clearBucket(String bucketName) 清空bucket中的所有内容，请谨慎使用。
CompleteMultipartUploadResult	completeMultipartUpload(CompleteMultipartUploadRequest request) Complete Multipart Upload
CompleteMultipartUploadResult	completeMultipartUpload(ListPartsResult result) Complete Multipart Upload
CompleteMultipartUploadResult	completeMultipartUpload(String bucketname, String objectkey, String uploadId, List<PartETag> partETags) Complete Multipart Upload
CopyResult	copyObject(CopyObjectRequest request) Copy Object
CopyResult	copyObject(String destinationBucket, String destinationObject, String sourceBucket, String sourceKey) Copy Object
CopyResult	copyObject(String destinationBucket, String destinationObject, String sourceBucket, String sourceKey, AccessControlList accessControlList) Copy Object
CopyResult	copyObject(String destinationBucket, String destinationObject, String sourceBucket, String sourceKey, CannedAccessControlList cannedAcl) Copy Object
CopyResult	copyPart(CopyPartRequest request) Upload Part Copy
Bucket	createBucket(CreateBucketRequest request) PUT BUCKET
Bucket	createBucket(String bucketname) PUT BUCKET
void	deleteBucket(DeleteBucketRequest request) DELETE BUCKET
void	deleteBucket(String bucketname) DELETE BUCKET
void	deleteBucketCors(DeleteBucketCorsRequest request) DELETE Bucket cors
void	deleteBucketCors(String bucketname) DELETE Bucket cors
void	deleteObject(DeleteObjectRequest request) DELETE OBJECT
void	deleteObject(String bucketname, String key) DELETE OBJECT
DeleteMultipleObjectsResult	deleteObjects(DeleteMultipleObjectsRequest request) DELETE Multiple Objects
DeleteMultipleObjectsResult	deleteObjects(List<String> keys, String bucketName) DELETE Multiple Objects
DeleteMultipleObjectsResult	deleteObjects(String[] keys, String bucketName) DELETE Multiple Objects
<X extends Ks3WebServiceResponse<Y>,Y> Y	execute(Ks3WebServiceRequest request, Class<X> clazz)
String	generatePresignedUrl(String bucket, String key, int expiration) 生成object的外链地址
String	generatePresignedUrl(String bucket, String key, int expiration, ResponseHeaderOverrides overrides) 生成object的外链地址
AdpTask	getAdpTask(GetAdpRequest request)
AdpTask	getAdpTask(String taskid)
AccessControlPolicy	getBucketACL(GetBucketACLRequest request) GET Bucket acl
AccessControlPolicy	getBucketACL(String bucketName) GET BUCKET acl
CannedAccessControlList	getBucketCannedACL(GetBucketACLRequest request) GET Bucket acl
CannedAccessControlList	getBucketCannedACL(String bucketName) GET BUCKET acl
BucketCorsConfiguration	getBucketCors(GetBucketCorsRequest request) GET Bucket cors
BucketCorsConfiguration	getBucketCors(String bucketname) GET Bucket cors
CreateBucketConfiguration.REGION	getBucketLoaction(GetBucketLocationRequest request) GET Bucket Location
CreateBucketConfiguration.REGION	getBucketLoaction(String bucketName) GET Bucket Location
BucketLoggingStatus	getBucketLogging(GetBucketLoggingRequest request) GET Bucket Logging
BucketLoggingStatus	getBucketLogging(String bucketName) GET Bucket Logging
GetObjectResult	getObject(GetObjectRequest request) GET OBJECT
GetObjectResult	getObject(String bucketname, String key) GET OBJECT
AccessControlPolicy	getObjectACL(GetObjectACLRequest request) Get Object acl
AccessControlPolicy	getObjectACL(String bucketName, String ObjectName) Get Object acl
CannedAccessControlList	getObjectCannedACL(GetObjectACLRequest request) Get Object acl
CannedAccessControlList	getObjectCannedACL(String bucketName, String ObjectName) Get Object acl
HeadBucketResult	headBucket(HeadBucketRequest request) HEAD BUCKET
HeadBucketResult	headBucket(String bucketname) HEAD BUECKET
HeadObjectResult	headObject(HeadObjectRequest request) HEAD OBJECT
HeadObjectResult	headObject(String bucketname, String objectkey) HEAD OBJECT
InitiateMultipartUploadResult	initiateMultipartUpload(InitiateMultipartUploadRequest request) Initiate Multipart Upload
InitiateMultipartUploadResult	initiateMultipartUpload(String bucketname, String objectkey) Initiate Multipart Upload
List<Bucket>	listBuckets() GET SERVICE
List<Bucket>	listBuckets(ListBucketsRequest request) GET SERVICE
ListMultipartUploadsResult	listMultipartUploads(ListMultipartUploadsRequest request) List Multipart Uploads
ListMultipartUploadsResult	listMultipartUploads(String bucketName) List Multipart Uploads
ListMultipartUploadsResult	listMultipartUploads(String bucketName, String prefix) List Multipart Uploads
ListMultipartUploadsResult	listMultipartUploads(String bucketName, String prefix, String keyMarker, String uploadIdMarker) List Multipart Uploads
ObjectListing	listObjects(ListObjectsRequest request) GET BUCKET(LIST OBJECTS)
ObjectListing	listObjects(String bucketname) GET BUCKET(LIST OBJECTS)
ObjectListing	listObjects(String bucketname, String prefix) GET BUCKET(LIST OBJECTS)
ListPartsResult	listParts(ListPartsRequest request) List Parts
ListPartsResult	listParts(String bucketname, String objectkey, String uploadId) List Parts
ListPartsResult	listParts(String bucketname, String objectkey, String uploadId, int maxParts) List Parts
ListPartsResult	listParts(String bucketname, String objectkey, String uploadId, int maxParts, int partNumberMarker) List Parts
void	makeDir(String bucketName, String dir) 新建文件夹
boolean	objectExists(String bucket, String key) 判断object是否存在
PostObjectFormFields	postObject(PostPolicy policy)
PostObjectFormFields	postObject(String bucket, String filename, Map<String,String> postFormData, List<String> unknowValueFormFiled)
PutAdpResult	putAdpTask(PutAdpRequest request)
PutAdpResult	putAdpTask(String bucketName, String objectKey, List<Adp> adps)
PutAdpResult	putAdpTask(String bucketName, String objectKey, List<Adp> adps, String notifyURL)
void	putBucketACL(PutBucketACLRequest request) PUT Bucket acl
void	putBucketACL(String bucketName, AccessControlList accessControlList) PUT Bucket acl
void	putBucketACL(String bucketName, CannedAccessControlList CannedAcl) PUT Bucket acl
void	putBucketCors(PutBucketCorsRequest request) PUT Bucket cors
void	putBucketLogging(PutBucketLoggingRequest request) PUT Bucket Logging
void	putBucketLogging(String bucketName, boolean enable, String targetBucket) PUT Bucket Logging
void	putBucketLogging(String bucketName, boolean enable, String targetBucket, String targetPrefix) PUT Bucket Logging
PutObjectResult	putObject(PutObjectRequest request) PUT OBJECT
PutObjectResult	putObject(String bucketname, String objectkey, File file) PUT OBJECT
PutObjectResult	putObject(String bucketname, String objectkey, InputStream inputstream, ObjectMetadata objectmeta) PUT OBJECT
void	putObjectACL(PutObjectACLRequest request) PUT Object acl
void	putObjectACL(String bucketName, String objectName, AccessControlList accessControlList) PUT OBJECT ACL
void	putObjectACL(String bucketName, String objectName, CannedAccessControlList accessControlList) PUT OBJECT ACL
void	removeDir(String bucketName, String dir) 删除文件夹及下面的所有内容
void	setAuth(Authorization auth) 设置accesskeyid accesskeysecret
PartETag	uploadPart(UploadPartRequest request) Upload Part

方法详细资料

setAuth

void setAuth(Authorization auth)

设置accesskeyid accesskeysecret

参数:

auth -

listBuckets

List<Bucket> listBuckets()
                         throws Ks3ClientException,
                                Ks3ServiceException

GET SERVICE

返回:

Bucket

抛出:

Ks3ClientException

Ks3ServiceException -

列出当前用户下的所有bucket

listBuckets

List<Bucket> listBuckets(ListBucketsRequest request)
                         throws Ks3ClientException,
                                Ks3ServiceException

GET SERVICE

参数:

request - ListBucketsRequest

返回:

Bucket

抛出:

Ks3ClientException

Ks3ServiceException -

列出当前用户下的所有bucket

getBucketLoaction

CreateBucketConfiguration.REGION getBucketLoaction(String bucketName)
                                                   throws Ks3ClientException,
                                                          Ks3ServiceException

GET Bucket Location

参数:

bucketName -

返回:

抛出:

Ks3ClientException

Ks3ServiceException -

获取bucket的存储地点

getBucketLoaction

CreateBucketConfiguration.REGION getBucketLoaction(GetBucketLocationRequest request)
                                                   throws Ks3ClientException,
                                                          Ks3ServiceException

GET Bucket Location

参数:

request - GetBucketLocationRequest

返回:

抛出:

Ks3ClientException

Ks3ServiceException -

获取bucket的存储地点

getBucketLogging

BucketLoggingStatus getBucketLogging(String bucketName)
                                     throws Ks3ClientException,
                                            Ks3ServiceException

GET Bucket Logging

参数:

bucketName -

返回:

BucketLoggingStatus

抛出:

Ks3ClientException

Ks3ServiceException -

获取bucket的日志配置

getBucketLogging

BucketLoggingStatus getBucketLogging(GetBucketLoggingRequest request)
                                     throws Ks3ClientException,
                                            Ks3ServiceException

GET Bucket Logging

参数:

request - GetBucketLoggingRequest

返回:

BucketLoggingStatus

抛出:

Ks3ClientException

Ks3ServiceException -

获取bucket的日志配置

putBucketLogging

void putBucketLogging(String bucketName,
                    boolean enable,
                    String targetBucket)
                      throws Ks3ClientException,
                             Ks3ServiceException

PUT Bucket Logging

参数:

bucketName -

enable - 是否开启

targetBucket - 存储日志的bucket

抛出:

Ks3ClientException

Ks3ServiceException -

配置bucket的日志

putBucketLogging

void putBucketLogging(String bucketName,
                    boolean enable,
                    String targetBucket,
                    String targetPrefix)
                      throws Ks3ClientException,
                             Ks3ServiceException

PUT Bucket Logging

参数:

bucketName -

enable - 是否开启

targetBucket - 存储日志的bucket

targetPrefix - 日志文件前缀

抛出:

Ks3ClientException

Ks3ServiceException -

配置 bucket的日志

putBucketLogging

void putBucketLogging(PutBucketLoggingRequest request)
                      throws Ks3ClientException,
                             Ks3ServiceException

PUT Bucket Logging

参数:

request - PutBucketLoggingRequest

抛出:

Ks3ClientException

Ks3ServiceException -

配置bucket的日志

getBucketACL

AccessControlPolicy getBucketACL(String bucketName)
                                 throws Ks3ClientException,
                                        Ks3ServiceException

GET BUCKET acl

参数:

bucketName - bucket名称

返回:

AccessControlPolicy

抛出:

Ks3ClientException

Ks3ServiceException -

获取bucket的acl

getBucketACL

AccessControlPolicy getBucketACL(GetBucketACLRequest request)
                                 throws Ks3ClientException,
                                        Ks3ServiceException

GET Bucket acl

参数:

request - GetBucketACLRequest

返回:

AccessControlPolicy

抛出:

Ks3ClientException

Ks3ServiceException -

获取bucket的acl

getBucketCannedACL

CannedAccessControlList getBucketCannedACL(String bucketName)
                                           throws Ks3ClientException,
                                                  Ks3ServiceException

GET BUCKET acl

参数:

bucketName - bucket名称

返回:

CannedAccessControlList

抛出:

Ks3ClientException

Ks3ServiceException -

获取bucket的acl

getBucketCannedACL

CannedAccessControlList getBucketCannedACL(GetBucketACLRequest request)
                                           throws Ks3ClientException,
                                                  Ks3ServiceException

GET Bucket acl

参数:

request - GetBucketACLRequest

返回:

CannedAccessControlList

抛出:

Ks3ClientException

Ks3ServiceException -

获取bucket的acl

putBucketACL

void putBucketACL(String bucketName,
                AccessControlList accessControlList)
                  throws Ks3ClientException,
                         Ks3ServiceException

PUT Bucket acl

参数:

bucketName - bucket名称

accessControlList - AccessControlList

抛出:

Ks3ClientException

Ks3ServiceException -

编辑bucket的acl

putBucketACL

void putBucketACL(String bucketName,
                CannedAccessControlList CannedAcl)
                  throws Ks3ClientException,
                         Ks3ServiceException

PUT Bucket acl

参数:

bucketName - bucket名称

CannedAcl - CannedAccessControlList

抛出:

Ks3ClientException

Ks3ServiceException -

编辑bucket的acl

putBucketACL

void putBucketACL(PutBucketACLRequest request)
                  throws Ks3ClientException,
                         Ks3ServiceException

PUT Bucket acl

参数:

request - PutBucketACLRequest

抛出:

Ks3ClientException

Ks3ServiceException -

编辑bucket的acl

putObjectACL

void putObjectACL(String bucketName,
                String objectName,
                CannedAccessControlList accessControlList)
                  throws Ks3ClientException,
                         Ks3ServiceException

PUT OBJECT ACL

参数:

bucketName - bucket名称

objectName - object名称

accessControlList - CannedAccessControlList

抛出:

Ks3ClientException

Ks3ServiceException -

编辑object的acl

putObjectACL

void putObjectACL(String bucketName,
                String objectName,
                AccessControlList accessControlList)
                  throws Ks3ClientException,
                         Ks3ServiceException

PUT OBJECT ACL

参数:

bucketName - bucket名称

objectName - object名称

accessControlList - AccessControlList

抛出:

Ks3ClientException

Ks3ServiceException -

编辑object的acl

putObjectACL

void putObjectACL(PutObjectACLRequest request)
                  throws Ks3ClientException,
                         Ks3ServiceException

PUT Object acl

参数:

request - PutObjectACLRequest

抛出:

Ks3ClientException

Ks3ServiceException -

编辑object的acl

getObjectACL

AccessControlPolicy getObjectACL(String bucketName,
                               String ObjectName)
                                 throws Ks3ClientException,
                                        Ks3ServiceException

Get Object acl

参数:

bucketName - bucket名称

ObjectName - object名称

返回:

AccessControlPolicy

抛出:

Ks3ClientException

Ks3ServiceException -

获取object的acl

getObjectACL

AccessControlPolicy getObjectACL(GetObjectACLRequest request)
                                 throws Ks3ClientException,
                                        Ks3ServiceException

Get Object acl

参数:

request - GetObjectACLRequest

返回:

AccessControlPolicy

抛出:

Ks3ClientException

Ks3ServiceException -

获取object的acl

getObjectCannedACL

CannedAccessControlList getObjectCannedACL(String bucketName,
                                         String ObjectName)
                                           throws Ks3ClientException,
                                                  Ks3ServiceException

Get Object acl

参数:

bucketName - bucket名称

ObjectName - object名称

返回:

CannedAccessControlList

抛出:

Ks3ClientException

Ks3ServiceException -

获取object的acl

getObjectCannedACL

CannedAccessControlList getObjectCannedACL(GetObjectACLRequest request)
                                           throws Ks3ClientException,
                                                  Ks3ServiceException

Get Object acl

参数:

request - GetObjectACLRequest

返回:

CannedAccessControlList

抛出:

Ks3ClientException

Ks3ServiceException -

获取object的acl

headBucket

HeadBucketResult headBucket(String bucketname)
                            throws Ks3ClientException,
                                   Ks3ServiceException

HEAD BUECKET

参数:

bucketname - bucket名称

返回:

statue code and headersHeadBucketResult

抛出:

Ks3ClientException

Ks3ServiceException -

返回headers

headBucket

HeadBucketResult headBucket(HeadBucketRequest request)
                            throws Ks3ClientException,
                                   Ks3ServiceException

HEAD BUCKET

参数:

request - HeadBucketRequest

返回:

statue code and headersHeadBucketResult

抛出:

Ks3ClientException

Ks3ServiceException -

返回headers

bucketExists

boolean bucketExists(String bucketname)
                     throws Ks3ClientException,
                            Ks3ServiceException

参数:

bucketname - bucket名称

返回:

如果bucket存在则为true

抛出:

Ks3ClientException -

判断bucket是否存在,bucket存在但不属于当前用户也会返回true

Ks3ServiceException

createBucket

Bucket createBucket(String bucketname)
                    throws Ks3ClientException,
                           Ks3ServiceException

PUT BUCKET

参数:

bucketname - bucket名称

Bucket是存放Object的容器，所有的Object都必须存放在特定的Bucket中。 ，每个Bucket中可以存放无限多个Object。Bucket不能嵌套，每个Bucket中只能存放Object， 不能再存放Bucket ，Bucket下的Object是一个平级的结构。

Bucket的名称全局唯一且命名规则与DNS命名规则相同：

• 长度3-63，
• 不包含大写字母，不包含[‘ ’,\t,\r,\n]，不包含连续的’.’
• ，’.’和’-’在bucket名称中不能相连，
• 仅可包含. - 数字 小写字母，
• 不以’.’或’-’结尾

返回:

Bucket

抛出:

Ks3ClientException

Ks3ServiceException -

创建bucket，权限默认是私有的，存储地点为杭州

createBucket

Bucket createBucket(CreateBucketRequest request)
                    throws Ks3ClientException,
                           Ks3ServiceException

PUT BUCKET

参数:

request - CreateBucketRequest

返回:

Bucket

抛出:

Ks3ClientException

Ks3ServiceException -

创建bucket，权限默认是私有的，存储地点为杭州

clearBucket

void clearBucket(String bucketName)
                 throws Ks3ClientException,
                        Ks3ServiceException

清空bucket中的所有内容，请谨慎使用。

参数:

bucketName -

抛出:

Ks3ClientException

Ks3ServiceException

makeDir

void makeDir(String bucketName,
           String dir)
             throws Ks3ClientException,
                    Ks3ServiceException

新建文件夹

参数:

bucketName -

dir -

抛出:

Ks3ClientException

Ks3ServiceException

removeDir

void removeDir(String bucketName,
             String dir)
               throws Ks3ClientException,
                      Ks3ServiceException

删除文件夹及下面的所有内容

参数:

bucketName -

dir -

抛出:

Ks3ClientException

Ks3ServiceException

deleteBucket

void deleteBucket(String bucketname)
                  throws Ks3ClientException,
                         Ks3ServiceException

DELETE BUCKET

参数:

bucketname - bucket名称

抛出:

Ks3ClientException

Ks3ServiceException -

删除bucket，bucket中内容为空时可以删除成功

注意这个操作是不能回退的

deleteBucket

void deleteBucket(DeleteBucketRequest request)
                  throws Ks3ClientException,
                         Ks3ServiceException

DELETE BUCKET

参数:

request - DeleteBucketRequest

抛出:

Ks3ClientException

Ks3ServiceException -

删除bucket，bucket中内容为空时可以删除成功

注意这个操作是不能回退的

listObjects

ObjectListing listObjects(String bucketname)
                          throws Ks3ClientException,
                                 Ks3ServiceException

GET BUCKET(LIST OBJECTS)

参数:

bucketname - bucket名称

返回:

ObjectListing

抛出:

Ks3ClientException

Ks3ServiceException -

列出bucket下满足条件的object

delimiter使用默认的/

返回的最大数(max-keys)使用默认的1000

listObjects

ObjectListing listObjects(String bucketname,
                        String prefix)
                          throws Ks3ClientException,
                                 Ks3ServiceException

GET BUCKET(LIST OBJECTS)

参数:

bucketname - bucket名称

prefix - 前缀

返回:

ObjectListing

抛出:

Ks3ClientException

Ks3ServiceException -

列出bucket下满足条件的object

delimiter使用默认的/

返回的最大数(max-keys)使用默认的1000

listObjects

ObjectListing listObjects(ListObjectsRequest request)
                          throws Ks3ClientException,
                                 Ks3ServiceException

GET BUCKET(LIST OBJECTS)

参数:

request - ListObjectsRequest

返回:

ObjectListing

抛出:

Ks3ClientException

Ks3ServiceException -

列出bucket下满足条件的object

deleteObject

void deleteObject(String bucketname,
                String key)
                  throws Ks3ClientException,
                         Ks3ServiceException

DELETE OBJECT

参数:

bucketname - bucket名称

key - object的key(即名称)

抛出:

Ks3ClientException

Ks3ServiceException -

删除指定的object

deleteObject

void deleteObject(DeleteObjectRequest request)
                  throws Ks3ClientException,
                         Ks3ServiceException

DELETE OBJECT

参数:

request - DeleteObjectRequest

抛出:

Ks3ClientException

Ks3ServiceException -

删除指定的object

deleteObjects

DeleteMultipleObjectsResult deleteObjects(DeleteMultipleObjectsRequest request)
                                          throws Ks3ClientException,
                                                 Ks3ServiceException

DELETE Multiple Objects

参数:

request - DeleteMultipleObjectsRequest

返回:

DeleteMultipleObjectsResult

抛出:

Ks3ClientException

Ks3ServiceException -

删除若干的objects

deleteObjects

DeleteMultipleObjectsResult deleteObjects(List<String> keys,
                                        String bucketName)
                                          throws Ks3ClientException,
                                                 Ks3ServiceException

DELETE Multiple Objects

参数:

keys - 要删除的keys

返回:

DeleteMultipleObjectsResult

抛出:

Ks3ClientException

Ks3ServiceException -

删除若干的objects

deleteObjects

DeleteMultipleObjectsResult deleteObjects(String[] keys,
                                        String bucketName)
                                          throws Ks3ClientException,
                                                 Ks3ServiceException

DELETE Multiple Objects

参数:

keys - 要删除的keys

返回:

DeleteMultipleObjectsResult

抛出:

Ks3ClientException

Ks3ServiceException -

删除若干的objects

getObject

GetObjectResult getObject(String bucketname,
                        String key)
                          throws Ks3ClientException,
                                 Ks3ServiceException

GET OBJECT

参数:

bucketname - bucket名称

key - object的key(即名称)

返回:

GetObjectResult

抛出:

Ks3ClientException

Ks3ServiceException -

获取指定的object

getObject

GetObjectResult getObject(GetObjectRequest request)
                          throws Ks3ClientException,
                                 Ks3ServiceException

GET OBJECT

参数:

request - GetObjectRequest

返回:

GetObjectResult

抛出:

Ks3ClientException

Ks3ServiceException -

获取指定的object

generatePresignedUrl

String generatePresignedUrl(String bucket,
                          String key,
                          int expiration)
                            throws Ks3ClientException

生成object的外链地址

参数:

bucket -

key -

expiration - 外链地址过期时间，单位秒

返回:

抛出:

Ks3ClientException

generatePresignedUrl

String generatePresignedUrl(String bucket,
                          String key,
                          int expiration,
                          ResponseHeaderOverrides overrides)
                            throws Ks3ClientException

生成object的外链地址

参数:

bucket -

key -

expiration - 外链地址过期时间，单位秒

overrides - 修改返回的headers

返回:

抛出:

Ks3ClientException

putObject

PutObjectResult putObject(String bucketname,
                        String objectkey,
                        File file)
                          throws Ks3ClientException,
                                 Ks3ServiceException

PUT OBJECT

参数:

bucketname - bucket名称

objectkey - object的key(即名称,编码后的长度不得超过1024个字节。)

file - 要上传的文件

返回:

PutObjectResult

抛出:

Ks3ClientException

Ks3ServiceException -

上传object

putObject

PutObjectResult putObject(String bucketname,
                        String objectkey,
                        InputStream inputstream,
                        ObjectMetadata objectmeta)
                          throws Ks3ClientException,
                                 Ks3ServiceException

PUT OBJECT

参数:

bucketname - bucket名称

objectkey - object的key(即名称,编码后的长度不得超过1024个字节。)

inputstream - 数据流

objectmeta - object元数据ObjectMetadata

返回:

PutObjectResult

抛出:

Ks3ClientException

Ks3ServiceException -

使用时请尽量在metadata中提供content -length,否则有可能导致jvm内存溢出。可以在metadata中指定contentMD5

上传object

putObject

PutObjectResult putObject(PutObjectRequest request)
                          throws Ks3ClientException,
                                 Ks3ServiceException

PUT OBJECT

参数:

request - PutObjectRequest

返回:

PutObjectResult

抛出:

Ks3ClientException

Ks3ServiceException -

上传object

copyObject

CopyResult copyObject(String destinationBucket,
                    String destinationObject,
                    String sourceBucket,
                    String sourceKey)
                      throws Ks3ClientException,
                             Ks3ServiceException

Copy Object

参数:

destinationBucket - 目标bucket

destinationObject - 目标object key

sourceBucket - 数据源bucket

sourceKey - 数据源object key

返回:

CopyResult

抛出:

Ks3ClientException

Ks3ServiceException -

将指定的object复制到目标地点

copyObject

CopyResult copyObject(String destinationBucket,
                    String destinationObject,
                    String sourceBucket,
                    String sourceKey,
                    CannedAccessControlList cannedAcl)
                      throws Ks3ClientException,
                             Ks3ServiceException

Copy Object

参数:

destinationBucket - 目标bucket

destinationObject - 目标object key

sourceBucket - 数据源bucket

sourceKey - 数据源object key

cannedAcl - CannedAccessControlList

返回:

CopyResult

抛出:

Ks3ClientException

Ks3ServiceException -

将指定的object复制到目标地点

copyObject

CopyResult copyObject(String destinationBucket,
                    String destinationObject,
                    String sourceBucket,
                    String sourceKey,
                    AccessControlList accessControlList)
                      throws Ks3ClientException,
                             Ks3ServiceException

Copy Object

参数:

destinationBucket - 目标bucket

destinationObject - 目标object key

sourceBucket - 数据源bucket

sourceKey - 数据源object key

accessControlList - AccessControlList

返回:

CopyResult

抛出:

Ks3ClientException

Ks3ServiceException -

将指定的object复制到目标地点

copyObject

CopyResult copyObject(CopyObjectRequest request)
                      throws Ks3ClientException,
                             Ks3ServiceException

Copy Object

参数:

request - CopyObjectRequest

返回:

CopyResult

抛出:

Ks3ClientException

Ks3ServiceException -

将指定的object复制到目标地点，将复制源object的元数据、acl等信息

headObject

HeadObjectResult headObject(String bucketname,
                          String objectkey)
                            throws Ks3ClientException,
                                   Ks3ServiceException

HEAD OBJECT

参数:

bucketname - bucket名称

objectkey - object的key(即object名称)

返回:

HeadObjectResult

抛出:

Ks3ClientException

Ks3ServiceException -

获取object的元数据、etag、上次修改时间

headObject

HeadObjectResult headObject(HeadObjectRequest request)
                            throws Ks3ClientException,
                                   Ks3ServiceException

HEAD OBJECT

参数:

request - HeadObjectRequest

返回:

HeadObjectResult

抛出:

Ks3ClientException

Ks3ServiceException -

获取object的元数据、etag、上次修改时间

objectExists

boolean objectExists(String bucket,
                   String key)

判断object是否存在

参数:

bucket -

key -

返回:

boolean

initiateMultipartUpload

InitiateMultipartUploadResult initiateMultipartUpload(String bucketname,
                                                    String objectkey)
                                                      throws Ks3ClientException,
                                                             Ks3ServiceException

Initiate Multipart Upload

参数:

bucketname - bucket名称

objectkey - object的key(即object名称)

返回:

InitiateMultipartUploadResult

抛出:

Ks3ClientException

Ks3ServiceException -

初始化分块上传

initiateMultipartUpload

InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest request)
                                                      throws Ks3ClientException,
                                                             Ks3ServiceException

Initiate Multipart Upload

参数:

request - InitiateMultipartUploadRequest

返回:

InitiateMultipartUploadResult

抛出:

Ks3ClientException

Ks3ServiceException -

初始化分块上传

uploadPart

PartETag uploadPart(UploadPartRequest request)
                    throws Ks3ClientException,
                           Ks3ServiceException

Upload Part

参数:

request - UploadPartRequest

返回:

PartETag

抛出:

Ks3ClientException

Ks3ServiceException -

分块上传文件

copyPart

CopyResult copyPart(CopyPartRequest request)
                    throws Ks3ClientException,
                           Ks3ServiceException

Upload Part Copy

参数:

request - CopyPartRequest

返回:

CopyResult

抛出:

Ks3ClientException

Ks3ServiceException -

分块上传时使用copy

completeMultipartUpload

CompleteMultipartUploadResult completeMultipartUpload(String bucketname,
                                                    String objectkey,
                                                    String uploadId,
                                                    List<PartETag> partETags)
                                                      throws Ks3ClientException,
                                                             Ks3ServiceException

Complete Multipart Upload

参数:

bucketname - bucket名称

objectkey - object的key(即名称)

uploadId - 通过初始化分块上传获取到的uploadId

partETags -

public PartETag uploadPart(UploadPartRequest request)throws Ks3ClientException, Ks3ServiceException;

获取到的结果PartETag

返回:

CompleteMultipartUploadResult

抛出:

Ks3ClientException

Ks3ServiceException -

完成分块上传，使ks3服务器将之前上传的小块合并成一个object

completeMultipartUpload

CompleteMultipartUploadResult completeMultipartUpload(ListPartsResult result)
                                                      throws Ks3ClientException,
                                                             Ks3ServiceException

Complete Multipart Upload

参数:

result - ListPartsResultListParts操作的返回值

抛出:

Ks3ClientException

Ks3ServiceException -

完成分块上传，使ks3服务器将之前上传的小块合并成一个object

completeMultipartUpload

CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest request)
                                                      throws Ks3ClientException,
                                                             Ks3ServiceException

Complete Multipart Upload

参数:

request - CompleteMultipartUploadRequest

返回:

CompleteMultipartUploadResult

抛出:

Ks3ClientException

Ks3ServiceException -

完成分块上传，使ks3服务器将之前上传的小块合并成一个object

abortMultipartUpload

void abortMultipartUpload(String bucketname,
                        String objectkey,
                        String uploadId)
                          throws Ks3ClientException,
                                 Ks3ServiceException

Abort Multipart Upload

参数:

bucketname - bucket名称

objectkey - object的key(即object的名称)

uploadId - 通过初始化分块上传获取到的uploadId

抛出:

Ks3ClientException

Ks3ServiceException -

中止分块上传

abortMultipartUpload

void abortMultipartUpload(AbortMultipartUploadRequest request)
                          throws Ks3ClientException,
                                 Ks3ServiceException

Abort Multipart Upload

参数:

request - AbortMultipartUploadRequest

抛出:

Ks3ClientException

Ks3ServiceException -

中止分块上传

listParts

ListPartsResult listParts(String bucketname,
                        String objectkey,
                        String uploadId)
                          throws Ks3ClientException,
                                 Ks3ServiceException

List Parts

参数:

bucketname - bucket名称

objectkey - object的key(即object的名称)

uploadId - 通过初始化分块上传获取到的uploadId

返回:

ListPartsResult

抛出:

Ks3ClientException

Ks3ServiceException -

列出该uploadid下已经上传成功的块

listParts

ListPartsResult listParts(String bucketname,
                        String objectkey,
                        String uploadId,
                        int maxParts)
                          throws Ks3ClientException,
                                 Ks3ServiceException

List Parts

参数:

bucketname - bucket名称

objectkey - object的key(即object的名称)

uploadId - 通过初始化分块上传获取到的uploadId

maxParts - 列出的最大结果数

返回:

ListPartsResult

抛出:

Ks3ClientException

Ks3ServiceException -

列出该uploadid下已经上传成功的块

listParts

ListPartsResult listParts(String bucketname,
                        String objectkey,
                        String uploadId,
                        int maxParts,
                        int partNumberMarker)
                          throws Ks3ClientException,
                                 Ks3ServiceException

List Parts

参数:

bucketname - bucket名称

objectkey - object的key(即object的名称)

uploadId - 通过初始化分块上传获取到的uploadId

maxParts - 列出的最大结果数

partNumberMarker - partnumber游标，即从第partNumberMarker开始罗列

返回:

ListPartsResult

抛出:

Ks3ClientException

Ks3ServiceException -

列出该uploadid下已经上传成功的块

listParts

ListPartsResult listParts(ListPartsRequest request)
                          throws Ks3ClientException,
                                 Ks3ServiceException

List Parts

参数:

request - ListPartsRequest

返回:

ListPartsResult

抛出:

Ks3ClientException

Ks3ServiceException -

列出该uploadid下已经上传成功的块

listMultipartUploads

ListMultipartUploadsResult listMultipartUploads(String bucketName)
                                                throws Ks3ClientException,
                                                       Ks3ServiceException

List Multipart Uploads

参数:

bucketName -

返回:

ListMultipartUploadsResult

抛出:

Ks3ClientException

Ks3ClientException -

列出bucket下分块上传未abort或complete的块

Ks3ServiceException

listMultipartUploads

ListMultipartUploadsResult listMultipartUploads(String bucketName,
                                              String prefix)
                                                throws Ks3ClientException,
                                                       Ks3ServiceException

List Multipart Uploads

参数:

bucketName -

prefix - object key前缀

返回:

ListMultipartUploadsResult

抛出:

Ks3ClientException

Ks3ClientException -

列出bucket下分块上传未abort或complete的块

Ks3ServiceException

listMultipartUploads

ListMultipartUploadsResult listMultipartUploads(String bucketName,
                                              String prefix,
                                              String keyMarker,
                                              String uploadIdMarker)
                                                throws Ks3ClientException,
                                                       Ks3ServiceException

List Multipart Uploads

参数:

bucketName -

prefix - object key前缀

keyMarker -

uploadIdMarker -

keyMarker为空，uploadIdMarker不为空

无意义

keyMarker不为空，uploadIdMarker不为空

列出分块上传object key为keyMarker，且upload id 大于uploadIdMarker的块

keyMarker不为空，uploadIdMarker为空

列出分块上传object key大于keyMarker的块

返回:

ListMultipartUploadsResult

抛出:

Ks3ClientException

Ks3ClientException -

列出bucket下分块上传未abort或complete的块

Ks3ServiceException

listMultipartUploads

ListMultipartUploadsResult listMultipartUploads(ListMultipartUploadsRequest request)
                                                throws Ks3ClientException,
                                                       Ks3ServiceException

List Multipart Uploads

参数:

request - ListMultipartUploadsRequest

返回:

ListMultipartUploadsResult

抛出:

Ks3ClientException

Ks3ClientException -

列出bucket下分块上传未abort或complete的块

Ks3ServiceException

putBucketCors

void putBucketCors(PutBucketCorsRequest request)
                   throws Ks3ClientException,
                          Ks3ServiceException

PUT Bucket cors

参数:

request - PutBucketCorsRequest

抛出:

Ks3ClientException

Ks3ClientException -

配置bucket的跨域资源共享

Ks3ServiceException

getBucketCors

BucketCorsConfiguration getBucketCors(String bucketname)
                                      throws Ks3ClientException,
                                             Ks3ServiceException

GET Bucket cors

参数:

bucketname -

返回:

抛出:

Ks3ClientException

Ks3ServiceException -

获取bucket的跨域资源共享配置

getBucketCors

BucketCorsConfiguration getBucketCors(GetBucketCorsRequest request)
                                      throws Ks3ClientException,
                                             Ks3ServiceException

GET Bucket cors

参数:

request - GetBucketCorsRequest

返回:

抛出:

Ks3ClientException

Ks3ServiceException -

获取bucket的跨域资源共享配置

deleteBucketCors

void deleteBucketCors(String bucketname)
                      throws Ks3ClientException,
                             Ks3ServiceException

DELETE Bucket cors

参数:

bucketname -

抛出:

Ks3ClientException

Ks3ServiceException -

删除bucket的跨域资源共享配置

deleteBucketCors

void deleteBucketCors(DeleteBucketCorsRequest request)
                      throws Ks3ClientException,
                             Ks3ServiceException

DELETE Bucket cors

参数:

request - DeleteBucketCorsRequest

抛出:

Ks3ClientException

Ks3ServiceException -

删除bucket的跨域资源共享配置

execute

<X extends Ks3WebServiceResponse<Y>,Y> Y execute(Ks3WebServiceRequest request,
                                               Class<X> clazz)
          throws Ks3ClientException,
                 Ks3ServiceException

参数:

request - Class<? extends Ks3WebServiceRequest>

clazz - Class<? extends Ks3WebServiceResponse>

返回:

抛出:

Ks3ClientException

Ks3ClientException -

对于自定义的request和response可以通过这个方法执行

Ks3ServiceException

postObject

PostObjectFormFields postObject(PostPolicy policy)
                                throws Ks3ClientException

参数:

policy -

返回:

PostObjectFormFields

抛出:

Ks3ClientException -

通过自定义policy规则获取post object时表单中的Signature、KSSAccessKeyId、policy三项的值

postObject

PostObjectFormFields postObject(String bucket,
                              String filename,
                              Map<String,String> postFormData,
                              List<String> unknowValueFormFiled)
                                throws Ks3ClientException

参数:

bucket - 目标bucket

filename - 要上传的文件名称,当postFormData中没有使用${filename}时可以不提供

postFormData - 可以确定值得表单项

unknowValueFormFiled - 无法确定值得表单项

返回:

PostObjectFormFields

抛出:

Ks3ClientException -

通过bucket和表单中的除 Signature、KSSAccessKeyId、policy外的所有表单项 获取post object时表单中的Signature、KSSAccessKeyId、policy三项的值

由此方法生成的签名只能适用于本次请求，matchingType全部使用eq或通配

putAdpTask

PutAdpResult putAdpTask(String bucketName,
                      String objectKey,
                      List<Adp> adps)
                        throws Ks3ClientException,
                               Ks3ServiceException

参数:

bucketName - 要处理的数据所在的bucket

objectKey - 要处理的数据的key

adps - 一系列的操作指令Adp

返回:

PutAdpResult PutAdpResult

抛出:

Ks3ClientException

Ks3ServiceException -

添加数据处理任务

putAdpTask

PutAdpResult putAdpTask(String bucketName,
                      String objectKey,
                      List<Adp> adps,
                      String notifyURL)
                        throws Ks3ClientException,
                               Ks3ServiceException

参数:

bucketName - 要处理的数据所在的bucket

objectKey - 要处理的数据的key

adps - 一系列的操作指令Adp

notifyURL - 处理完成后KS3将调用该url,以通知用户

返回:

PutAdpResult PutAdpResult

抛出:

Ks3ClientException

Ks3ServiceException -

添加数据处理任务

putAdpTask

PutAdpResult putAdpTask(PutAdpRequest request)
                        throws Ks3ClientException,
                               Ks3ServiceException

参数:

request - PutAdpRequest

返回:

PutAdpResult PutAdpResult

抛出:

Ks3ClientException

Ks3ServiceException -

添加数据处理任务

getAdpTask

AdpTask getAdpTask(String taskid)
                   throws Ks3ClientException,
                          Ks3ServiceException

参数:

taskid - 由putpfop，postobject，putobject，complete_mutipart_upload返回的taskid

返回:

AdpTask

抛出:

Ks3ClientException

Ks3ServiceException -

查询数据处理任务的状态

getAdpTask

AdpTask getAdpTask(GetAdpRequest request)
                   throws Ks3ClientException,
                          Ks3ServiceException

参数:

request - GetAdpRequest

返回:

AdpTask

抛出:

Ks3ClientException

Ks3ServiceException -

查询数据处理任务的状态