对象存储(KS3)Android-金山云

KS3 SDK for Android使用指南

SDK下载地址

开发前准备

依赖库

本SDK使用了loopj/android-async-http请求库，使用前请先下载对应的jar包，并导入工程

android-async-http:1.4.9
或者采用Gradle

repositories {
  mavenCentral()
}

dependencies {
  implementation 'com.loopj.android:android-async-http:1.4.9'
}

SDK使用准备

申请AccessKey、SecretKey
Android权限申明


    <uses-permission android:name="android.permission.INTERNET" />

    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

SDK配置

SDK以jar包形式呈现。将releases文件夹下ks3-android-sdk-1.0.1.jar，以及依赖库文件，放入工程libs文件下。

运行环境

支持Android 2.2及以上版本

补充说明

线程安全: 考虑到Android 4.0之后不再允许主线程内进行网络请求，以及UI操作必须在主线程中进行。ks3-android-sdk所提供的API，默认让开发者在主线程进行调用，且会以异步方式进行请求，请求回调方法仍将执行在主线程。如果开发者需要用非异步方式进行调用（即在自己开的线程内,调用同步API请求），请在初始化Ks3Client时，调用以下方法，以确保API以非异步方式进行。


    client.setIsUseAsyncMode(false);

安全性

使用场景

由于在App端明文存储AccessKey、SecretKey是极不安全的，因此推荐的使用场景如下图所示：

Android

KS3Client初始化

Ks3Client初始化包含以下两种：

直接利用AccessKey、SecretKey初始化（不安全,仅建议测试时使用）
实现授权回调（AuthListener）获取Token（推荐使用）

对应的初始化代码如下：

For AccessKey、SecretKey


        /* Directly using ak&sk */

        client = new Ks3Client(Constants.ACCESS_KEY_ID,Constants.ACCESS_KEY_SECRET, DummyActivity.this);

        configuration = Ks3ClientConfiguration.getDefaultConfiguration();

        client.setConfiguration(configuration);

For AuthListener


        /* Using authListener,Let your app server saved ak&sk and return token*/

        client = new Ks3Client(new AuthListener() {

            @Override

            public String onCalculateAuth(String httpMethod,

                    String ContentType, String Date, String ContentMD5,

                    String Resource, String Headers) {

                // 此处应由APP端向业务服务器发送post请求返回Token。

                // 需要注意该回调方法运行在非主线程

                //

                String token = requsetToAppServer(httpMethod, ContentType,

                        Date, ContentMD5, Resource, Headers);

                return token;

            }

        }, DummyActivity.this);

        configuration = Ks3ClientConfiguration.getDefaultConfiguration();

        client.setConfiguration(configuration);
        client.setEndpoint(YOUR_END_POINT);

业务服务器计算签名方式

SDK介绍及使用

核心类介绍

Ks3Client 封装接入Web Service的一系列操作，提供更加便利的接口以及回调
Ks3ClientConfiguration 配置Ks3Client参数，包括代理设置，请求超时时长以及重试次数等
AuthUtils 包含授权算法的工具类
Uploader 上传操作控制类
Downloader 下载操作控制类
TransferManager 传输操作管理类，包含传输操作核心逻辑
TransferManagerConfiguration 配置TransferManager参数，包括MultiUpload最小要求大小以及每块的Size等
TransferEvent 上传下载操作时，返回的当前传输状态事件类

为方便开发者使用，SDK在REST API接口返回值基础上进行了封装，具体更多封装类详情请见

SDK-Javadoc:

资源管理操作

List Bucket 列出客户所有的Bucket信息
Create Bucket 创建一个新的Bucket
Delete Bucket 删除指定Bucket
Get Bucket ACL 获取Bucket的ACL
Put Bucket ACL 设置Bucket的ACL
Head Bucket 查询是否已经存在指定Bucket
Get Object 下载Object数据
Head Object 查询是否已经存在指定Object
Delete Object 删除指定Object
Get Object ACL 获得Bucket的acl
Put Object ACL 上传object的acl
List Objects 列举Bucket内的Object
Put Object 上传Object数据
Copy Object 复制Object数据
Initiate Multipart Upload 调用这个接口会初始化一个分块上传
Upload Part 上传分块
List Parts 罗列出已经上传的块
Abort Multipart Upload 取消分块上传
Complete Multipart Upload 组装所有分块上传的文件
Multipart Upload Example Code 分块上传代码示例
分块上传的更高层封装接口分块上传的更高层封装接口

Service操作

List Bucket

列出客户所有的 Bucket 信息

方法名：

public void listBuckets(ListBucketsResponceHandler resultHandler) throws Ks3ClientException,Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
resultList：成功时返回的Bucket容器

代码示例：


       client.listBuckets(new ListBucketsResponceHandler() {

                @Override

                public void onSuccess(int statesCode,

                        Header[] responceHeader,

                        ArrayList<Bucket> resultList) {

                }

                @Override

                public void onFailure(int statesCode,

                        Header[] responceHeader, String responce,

                        Throwable throwable) {

                }

            }

        );

列出客户所有的 Bucket 信息

方法名：

public void listBuckets(ListBucketsRequest request,ListBucketsResponceHandler resultHandler) throws Ks3ClientException,Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：ListBucketsRequest对象

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
resultList：成功时返回的Bucket容器

代码示例：


       client.listBuckets(new ListBucketsRequest(),new ListBucketsResponceHandler() {

                @Override

                public void onSuccess(int statesCode,

                        Header[] responceHeader,

                        ArrayList<Bucket> resultList) {

                }

                @Override

                public void onFailure(int statesCode,

                        Header[] responceHeader, String responce,

                        Throwable throwable) {

                }

            }

        );

Bucket操作

Creat Bucket

创建一个新的Bucket

方法名：

public void createBucket(String bucketName,CreateBucketResponceHandler resultHandler) throw Ks3ClientException,Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示Bucke创建个数已达上限或客户端请求格式错误，403表示签名错误或本地日期时间错误，409表示Bucket已存在
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常, Bucket名字不符合需求,抛出IllegalArgumentException

代码示例：


        client.createBucket(Constants.BucketName,

                new CreateBucketResponceHandler() {

                @Override

                public void onSuccess(int statesCode,

                        Header[] responceHeaders) {

                }

                @Override

                public void onFailure(int statesCode,

                        Header[] responceHeaders, String response,

                        Throwable throwable) {

                }

            }

        );

创建一个新的Bucket，并携带AccessControlList设置权限

方法名：

public void createBucket(String bucketName,AccessControlList list,CreateBucketResponceHandler resultHandler) throw Ks3ClientException,Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
bucketName：指定的Bucket名称
list:传入的AccessControlList

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，409表示Bucket已存在
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常, bucketName不符合需求，list不符合规范，均抛出IllegalArgumentException

代码示例：


         AccessControlList acl = new AccessControlList();

         GranteeId grantee = new GranteeId() ;

         grantee.setIdentifier("12773456");

         grantee.setDisplayName("guoliTest222");

         acl.addGrant(grantee, Permission.Read);

         GranteeId grantee1 = new GranteeId() ;

         grantee1.setIdentifier("123005789");

         grantee1.setDisplayName("guoliTest2D2");

         acl.addGrant(grantee1, Permission.Write);

         client.createBucket(Constants.BucketName,acl,

                new CreateBucketResponceHandler() {

                @Override

                public void onSuccess(int statesCode,

                        Header[] responceHeaders) {

                }

                @Override

                public void onFailure(int statesCode,

                        Header[] responceHeaders, String response,

                        Throwable throwable) {

                }

            }

        );

创建一个新的Bucket，并携带CannedAccessControlList设置权限

方法名：

public void createBucket(String bucketName,CannedAccessControlList list,CreateBucketResponceHandler resultHandler) throw Ks3ClientException,Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
bucketName：指定的Bucket名称
list:传入的CannedAccessControlList

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，409表示Bucket已存在
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常, bucketName不符合需求，list不符合规范，均抛出IllegalArgumentException

代码示例：


         CannedAccessControlList cannedAcl = CannedAccessControlList.PublicReadWrite;

         client.createBucket(Constants.BucketName,cannedAcl,

                new CreateBucketResponceHandler() {

                @Override

                public void onSuccess(int statesCode,

                        Header[] responceHeaders) {

                }

                @Override

                public void onFailure(int statesCode,

                        Header[] responceHeaders, String response,

                        Throwable throwable) {

                }

            }

        );

创建一个新的Bucket

方法名：

public void createBucket(CreateBucketRequest request,CreateBucketResponceHandler resultHandler) throw Ks3ClientException,Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：CreateBucketRequest对象

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，409表示Bucket已存在
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常, Bucket名字不符合需求,抛出IllegalArgumentException

代码示例：


        client.createBucket(new CreateBucketRequest(Constants.BucketName),

                new CreateBucketResponceHandler() {

                @Override

                public void onSuccess(int statesCode,

                        Header[] responceHeaders) {

                }

                @Override

                public void onFailure(int statesCode,

                        Header[] responceHeaders, String response,

                        Throwable throwable) {

                }

            }

        );

Delete Bucket

删除指定Bucket

方法名：

public void deleteBucket(String bucketname,DeleteBucketResponceHandler handler) throws Ks3ClientException,Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
bucketName ：指定的Bucket名称

回调参数：

statesCode：Http请求返回的状态码，204表示成功但是返回内容为空，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示删除一个不存在的Bucket，409表示删除一个不为空的Bucket
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常

代码示例：


        client.deleteBucket(Constants.BucketName,

                new DeleteBucketResponceHandler() {

                @Override

                public void onSuccess(int statesCode,

                        Header[] responceHeaders) {

                }

                @Override

                public void onFailure(int statesCode,

                        Header[] responceHeaders, String response,

                        Throwable throwable) {

                }

            }

        );

删除指定Bucket

方法名：

public void deleteBucket(DeleteBucketRequest request,DeleteBucketResponceHandler handler) throws Ks3ClientException,Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：DeleteBucketRequest对象

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示删除一个不存在的Bucket，409表示删除一个不为空的Bucket，204表示成功但是返回内容为空
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常

代码示例：


        client.deleteBucket(new DeleteBucketRequest（Constants.BucketName）,

                new DeleteBucketResponceHandler() {

                @Override

                public void onSuccess(int statesCode,

                        Header[] responceHeaders) {

                }

                @Override

                public void onFailure(int statesCode,

                        Header[] responceHeaders, String response,

                        Throwable throwable) {

                }

            }

        );

Get Bucket ACL

获取Bucket的ACL

方法名：

public void getBucketACL(String bucketName ,GetBucketACLResponceHandler resultHandler) throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
bucketName ：指定的Bucket名称

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示获取一个不存在Bucket的ACL
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
Throwable：出错时抛出的异常，Bucket名字不符合需求，抛出IllegalArgumentException
accessControlPolicy ACL政策Model类，包括Owner信息以及ACL容器等

代码示例：


        client.getBucketACL(Constants.BucketName, new GetBucketACLResponceHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders,

                    AccessControlPolicy accessControlPolicy) {

                }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable paramThrowable) {

                }

            }

        );

获取Bucket的ACL

方法名：

public void getBucketACL(GetBucketACLRequest request ,GetBucketACLResponceHandler resultHandler) throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：GetBucketACLRequest对象

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示获取一个不存在Bucket的ACL
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
Throwable：出错时抛出的异常，Bucket名字不符合需求，抛出IllegalArgumentException
accessControlPolicy ACL政策Model类，包括Owner信息以及ACL容器等

代码示例：


        client.getBucketACL(new GetBucketACLRequest(Constants.BucketName), new GetBucketACLResponceHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders,

                    AccessControlPolicy accessControlPolicy) {

                }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable paramThrowable) {

                }

            }

        );

Put Bucket ACL

设置Bucket的ACL，以AccessControlList形式

方法名：

public void putBucketACL(String bucketName, AccessControlList accessControlList, PutBucketACLResponseHandler resultHandler) throws Ks3ClientException,Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：请求封装类，需要添加要上传的ACL容器
accessControlList:传入的AccessControlList对象

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，但会清空原有ACL权限，只保留当前设置，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示给一个不存在的Bucket设置ACL
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
Throwable：出错时抛出的异常，为存在的Bucket设置空ACL时，参数检查时抛出异常，均抛出IllegalArgumentException

代码示例：


        AccessControlList acl = new AccessControlList();

        GranteeId grantee = new GranteeId();

        grantee.setIdentifier("12773456");

        grantee.setDisplayName("guoliTest222");

        acl.addGrant(grantee, Permission.Read);

        client.putBucketACL(bucketName，acl, new PutBucketACLResponseHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders) {

                }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable paramThrowable) {

                }

            }

        );

设置Bucket的ACL，以CannedAccessControlList形式

方法名：

public void putBucketACL(String bucketName,CannedAccessControlList CannedAcl,PutBucketACLResponseHandler resultHandler) throws Ks3ClientException,Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request ：请求封装类，需要添加要上传的ACL容器

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，但会清空原有ACL权限，只保留当前设置，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示给一个不存在的Bucket设置ACL
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
Throwable：出错时抛出的异常，为存在的Bucket设置空ACL时，参数检查时抛出异常，均抛出IllegalArgumentException

代码示例：


        CannedAccessControlList cannedAcl = CannedAccessControlList.PublicReadWrite;

        client.putBucketACL(bucketName, cannedAcl，new PutBucketACLResponseHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders) {

                }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable paramThrowable) {

                }

            }

        );

设置Bucket的ACL

方法名：

public void putBucketACL(PutBucketACLRequest requset,PutBucketACLResponseHandler resultHandler) throws Ks3ClientException,Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request ：请求封装类，需要添加要上传的ACL容器

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，但会清空原有ACL权限，只保留当前设置，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示给一个不存在的Bucket设置ACL
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
Throwable：出错时抛出的异常，为存在的Bucket设置空ACL时，参数检查时抛出异常，均抛出IllegalArgumentException

代码示例：


        client.putBucketACL(new PutBucketACLRequest(bucketName,cannedAcl), new PutBucketACLResponseHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders) {

                }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable paramThrowable) {

                }

            }

        );

Head Bucket

查询是否已经存在指定Bucket

方法名：

public void headBucket(String bucketname,HeadBucketResponseHandler resultHandler) throws Ks3ClientException,Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
bucketname：指定的Bucket名称

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示请求一个不存在的Bucket
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
Throwable：出错时抛出的异常,Bucket名字不符合需求，抛出IllegalArgumentException

代码示例：


        client.headBucket(Constants.BucketName,

                new HeadBucketResponseHandler() {

                    @Override

                    public void onSuccess(int statesCode,

                            Header[] responceHeaders) {

                    }

                    @Override

                    public void onFailure(int statesCode,

                            Header[] responceHeaders, String response,

                            Throwable paramThrowable) {

                    }

                }

        );

查询是否已经存在指定Bucket

方法名：

public void headBucket(HeadBucketRequest request,HeadBucketResponseHandler resultHandler) throws Ks3ClientException,Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：HeadBucketRequest对象

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示请求一个不存在的Bucket
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
Throwable：出错时抛出的异常,Bucket名字不符合需求，抛出IllegalArgumentException

代码示例：


        client.headBucket(new HeadBucketRequest（Constants.BucketName,

                new HeadBucketResponseHandler() {

                    @Override

                    public void onSuccess(int statesCode,

                            Header[] responceHeaders) {

                    }

                    @Override

                    public void onFailure(int statesCode,

                            Header[] responceHeaders, String response,

                            Throwable paramThrowable) {

                    }

                }

        );

Object操作

Get Object

下载该Object数据

方法名：

public void getObject(Context context, String bucketname, String key, GetObjectResponceHandler getObjectResponceHandler（File file,String bucketname,String objectKey）)throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
context：传入的上下文
bucketname：指定的Bucket名称
objectKey：指定的Object键
file:指定生成后写入的File文件

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示指定的Bucket或者Object不存在
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
file:成功后写入的文件
object:成功后对应的Ks3Object实体类

代码示例：


        client.getObject(DummyActivity.this,Constants.BucketName,Constants.ObjectKey,

                new GetObjectResponceHandler(new File(Environment

                    .getExternalStoragePublicDirectory(Environment.DIRECTORY_PICTURES),

                    Constants.ObjectKey), Constants.BucketName,

                        Constants.ObjectKey) {

                    @Override

                    public void onTaskSuccess(int statesCode, Header[] responceHeaders) {

                    }

                    @Override

                    public void onTaskFailure(int statesCode, Header[] responceHeaders,

                            String response, Throwable throwable) {

                    }

                    @Override

                    public  void onTaskFinish(){

                    }

                    @Override

                    public  void onTaskStart(){

                    }

                    @Override

                    public void onTaskProgress(double progress){

                    //运行在非UI线程，更新UI时需要注意

                    //Progress为0-100之间的double类型数值

                    }

                }

        );

下载该Object数据

方法名：

public void getObject(GetObjectRequest request, GetObjectResponceHandler getObjectResponceHandler（File file,String bucketname,String objectKey）)throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：GetObjectRequest对象

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示指定的Bucket或者Object不存在
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
file:成功后写入的文件
object:成功后对应的Ks3Object实体类

代码示例：


        client.getObject(new GetObjectRequest(bucketname, key),

                new GetObjectResponceHandler(new File(Environment

                    .getExternalStoragePublicDirectory(Environment.DIRECTORY_PICTURES),

                    Constants.ObjectKey), Constants.BucketName,

                        Constants.ObjectKey) {

                    @Override

                    public void onTaskSuccess(int statesCode, Header[] responceHeaders) {

                    }

                    @Override

                    public void onTaskFailure(int statesCode, Header[] responceHeaders,

                            String response, Throwable throwable) {

                    }

                    @Override

                    public  void onTaskFinish(){

                    }

                    @Override

                    public  void onTaskStart(){

                    }

                    @Override

                    public void onTaskProgress(double progress){

                    //运行在非UI线程，更新UI时需要注意

                    //Progress为0-100之间的double类型数值

                    }

                }

        );

Head Object

查询是否已经存在指定Object

方法名：

public void headObject(String bucketname, String objectkey,HeadObjectResponseHandler resultHandler)throws Ks3ClientException, Ks3ServiceException;

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
bucketname：指定的Bucket名称
objectKey：指定的Object键

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示指定的Bucket或者Object不存在
headObjectResult:返回Object元数据封装类，包含元数据信息，Etag以及上次修改时间
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常，Bucket名字不符合需求，抛出IllegalArgumentException

代码示例：


        client.headObject(Constants.BucketName,Constants.ObjectKey,

                new HeadObjectResponseHandler() {

                    @Override

                    public void onSuccess(int statesCode,

                            Header[] responceHeaders,

                            HeadObjectResult headObjectResult) {

                    }

                    @Override

                    public void onFailure(int statesCode,

                            Header[] responceHeaders, String response,

                            Throwable throwable) {

                    }

                }

        );

查询是否已经存在指定Object

方法名：

public void headObject(HeadObjectRequest request,HeadObjectResponseHandler resultHandler)throws Ks3ClientException, Ks3ServiceException;

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：HeadObjectRequest对象

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示指定的Bucket或者Object不存在
headObjectResult:返回Object元数据封装类，包含元数据信息，Etag以及上次修改时间
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常，Bucket名字不符合需求，抛出IllegalArgumentException

代码示例：


        client.headObject(new HeadObjectRequest（Constants.BucketName,Constants.ObjectKey）

                new HeadObjectResponseHandler() {

                    @Override

                    public void onSuccess(int statesCode,

                            Header[] responceHeaders,

                            HeadObjectResult headObjectResult) {

                    }

                    @Override

                    public void onFailure(int statesCode,

                            Header[] responceHeaders, String response,

                            Throwable throwable) {

                    }

                }

        );

Delete Object

删除指定Object

方法名：

public void deleteObject(String bucketname, String objectKey , DeleteObjectRequestHandler handler)

throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
bucketname：指定的Bucket名称
objectKey：指定的Object键

回调参数：

statesCode：Http请求返回的状态码，204表示成功但返回内容为空,400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示删除一个不存在的Bucket或Object
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常，Bucket名字不符合需求，抛出IllegalArgumentException

代码示例：


        client.deleteObject(Constants.BucketName,Constants.ObjectKey, new DeleteObjectRequestHandler() {

                @Override

                public void onSuccess(int statesCode, Header[] responceHeaders) {

                }

                @Override

                public void onFailure(int statesCode, Header[] responceHeaders,

                        String response, Throwable throwable) {

                }

            }

        );

删除指定Object

方法名：

public void deleteObject(DeleteObjectRequest request, DeleteObjectRequestHandler handler)

throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
bucketname：指定的Bucket名称
request：DeleteObjectRequest对象

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示删除一个不存在的Bucket,204表示成功但返回内容为空
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常，Bucket名字不符合需求，抛出IllegalArgumentException

代码示例：


        client.deleteObject(new DeleteObjectRequest（Constants.BucketName,Constants.ObjectKey),new DeleteObjectRequestHandler() {

                @Override

                public void onSuccess(int statesCode, Header[] responceHeaders) {

                }

                @Override

                public void onFailure(int statesCode, Header[] responceHeaders,

                        String response, Throwable throwable) {

                }

            }

        );

Get Object ACL

获得Object的acl

方法名：

public void getObjectACL(String bucketName, String ObjectName , GetObjectACLResponseHandler resultHandler)throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
bucketname：指定的Bucket名称
objectKey：指定的Object键

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示获取一个不存在Object的ACL
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
Throwable：出错时抛出的异常,Bucket名字不符合需求，抛出IllegalArgumentException
accessControlPolicy ACL政策Model类，包括Owner信息以及ACL容器等

代码示例：


        client.getObjectACL(Constants.BucketName,Constants.ObjectKey,

                new GetObjectACLResponseHandler() {

                    @Override

                    public void onSuccess(int statesCode,

                            Header[] responceHeaders,

                            AccessControlPolicy accessControlPolicy) {

                    }

                    @Override

                    public void onFailure(int statesCode,

                            Header[] responceHeaders, String response,

                            Throwable paramThrowable) {

                    }

                }

        );

获得Object的acl

方法名：

public void getObjectACL(GetObjectACLRequest request, GetObjectACLResponseHandler resultHandler)throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request:GetObjectACLRequest对象

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示获取一个不存在Object的ACL
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
Throwable：出错时抛出的异常,Bucket名字不符合需求，抛出IllegalArgumentException
accessControlPolicy ACL政策Model类，包括Owner信息以及ACL容器等

代码示例：


        client.getObjectACL(new GetObjectACLRequest(Constants.BucketName,Constants.ObjectKey),

                new GetObjectACLResponseHandler() {

                    @Override

                    public void onSuccess(int statesCode,

                            Header[] responceHeaders,

                            AccessControlPolicy accessControlPolicy) {

                    }

                    @Override

                    public void onFailure(int statesCode,

                            Header[] responceHeaders, String response,

                            Throwable paramThrowable) {

                    }

                }

        );

Put Object ACL

上传object的acl，以CannedAccessControlList形式

方法名：

public void putObjectACL(String bucketName, String objectKey,CannedAccessControlList list, PutObjectACLResponseHandler resultHandler)

throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：请求封装类，需要添加要上传的ACL容器
list:CannedAccessControlList对象

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示给一个不存在的Obejct设置ACL，
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常，为存在的Object设置空ACL时,Bucket名字不符合需求，均抛出IllegalArgumentException

代码示例：


        CannedAccessControlList list = CannedAccessControlList.PublicRead;

        client.putObjectACL(bucketName, objectKey, list, new PutObjectACLResponseHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders) {

                }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable throwable) {

                }

            }

        );

上传object的acl，以AccessControlList形式

方法名：

public void putObjectACL(String bucketName, String objectName,AccessControlList list,PutObjectACLResponseHandler resultHandler)

throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
list：AccessControlList对象

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示给一个不存在的Obejct设置ACL，
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常，为存在的Object设置空ACL时,Bucket名字不符合需求，均抛出IllegalArgumentException

代码示例：


        AccessControlList acList = new AccessControlList();

        GranteeId grantee = new GranteeId();

        grantee.setIdentifier("123456");

        grantee.setDisplayName("TESTTEST1");

        acList.addGrant(grantee, Permission.Read);

        client.putObjectACL(bucketName, objectKey, list, new PutObjectACLResponseHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders) {

                }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable throwable) {

                }

            }

        );

上传object的acl

方法名：

public void putObjectACL(PutObjectACLRequest request, PutObjectACLResponseHandler resultHandler)

throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：PutObjectACLRequest对象

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示给一个不存在的Obejct设置ACL
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常，为存在的Object设置空ACL时,Bucket名字不符合需求，均抛出IllegalArgumentException

代码示例：


        CannedAccessControlList list = CannedAccessControlList.PublicRead;

        client.putObjectACL(new PutObjectACLRequest(bucketName, objectKey, list), new PutObjectACLResponseHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders) {

                }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable throwable) {

                }

            }

        );

List Objects

列举Bucket内的Object

方法名：

public void listObjects(String bucketname,ListObjectsResponseHandler resultHandler)

throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
bucketname：指定的Bucket名称

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示Bucket不存在，
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
objectListing:成功时返回的指定Bucket下所有的Object ummary信息实体类，包含一个Ks3ObjectSummary的容器及其他信息

代码示例：


        client.listObjects(Constants.BucketName, new ListObjectsResponseHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders,

                    ObjectListing objectListing) {

            }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable throwable) {

            }

        }

        );

列举Bucket内的Object

方法名：

public void listObjects(String bucketname,String prefix,ListObjectsResponseHandler resultHandler)

throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
bucketname：指定的Bucket名称
prefix:delimiter是用来对Object名字进行分组的一个字符。包含指定的前缀到第一次出现的delimiter字符的所有Object名字作为一组结果CommonPrefix

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示Bucket不存在，
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
objectListing:成功时返回的指定Bucket下所有的Object Summary信息实体类

代码示例：


        client.listObjects(Constants.BucketName,Constants.Prefix, new ListObjectsResponseHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders,

                    ObjectListing objectListing) {

            }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable throwable) {

            }

        }

        );

列举Bucket内的Object

方法名：

public void listObjects(String bucketName, String prefix, String marker,

String delimiter, Integer maxKeys, ListObjectsResponseHandler resultHandler)

throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
bucketname：指定的Bucket名称
prefix:限定返回的Object名字都以制定的prefix前缀开始
marker:从一个指定的名字marker开始列出Object的名字
maxKeys:设定返回的Object名字数量，返回的数量有可能比设定的少，但是绝不会比设定的多，如果还存在没有返回的Object名字，返回的结果包含true
delimiter:delimiter是用来对Object名字进行分组的一个字符。包含指定的前缀到第一次出现的delimiter字符的所有Object名字作为一组结果CommonPrefix

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示Bucket不存在
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
objectListing:成功时返回的指定Bucket下所有的Object Summary信息实体类

代码示例：


        client.listObjects(new ListObjectsRequest(bucketname,prefix,delimiter,maxKeys), new ListObjectsResponseHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders,

                    ObjectListing objectListing) {

            }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable throwable) {

            }

        }

        );

列举Bucket内的Object

方法名：

public void listObjects(ListObjectsRequest request,ListObjectsResponseHandler resultHandler)

throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：ListObjectsRequest对象

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误，404表示Bucket不存在
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
objectListing:成功时返回的指定Bucket下所有的Object Summary信息实体类

代码示例：


        client.listObjects(new ListObjectsRequest(bucketname, prefix), new ListObjectsResponseHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders,

                    ObjectListing objectListing) {

            }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable throwable) {

            }

        }

        );

Put Object

上传Object数据

方法名：

public void PutObject(String bucketname, String objectkey,

File file , PutObjectResponseHandler handler) throws Ks3ClientException, Ks3ServiceException;

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
bucketname：指定的Bucket名称
objectKey：指定的Object键
file：需要上传的file

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常

代码示例：


        client.PutObject(bucketname, objectkey, file, new PutObjectResponseHandler() {

                    @Override

                    public void onTaskSuccess(int statesCode, Header[] responceHeaders) {

                    }

                    @Override

                    public void onTaskFailure(int statesCode, Header[] responceHeaders,

                            String response, Throwable throwable) {

                    }

                    @Override

                    public  void onTaskFinish(){

                    }

                    @Override

                    public  void onTaskStart(){

                    }

                    @Override

                    public void onTaskProgress(double progress){

                    //运行在非UI线程，更新UI时需要注意

                    //Progress为0-100之间的double类型数值

                    }

                }

        );

上传Object数据

方法名：

public void PutObject(PutObjectRequest request, PutObjectResponseHandler handler) throws Ks3ClientException, Ks3ServiceException;

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request:PutObjectRequest对象

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常

代码示例：


        client.PutObject(new PutObjectRequest(bucketname, objectkey, file), new PutObjectResponseHandler() {

                    @Override

                    public void onTaskSuccess(int statesCode, Header[] responceHeaders) {

                    }

                    @Override

                    public void onTaskFailure(int statesCode, Header[] responceHeaders,

                            String response, Throwable throwable) {

                    }

                    @Override

                    public  void onTaskFinish(){

                    }

                    @Override

                    public  void onTaskStart(){

                    }

                    @Override

                    public void onTaskProgress(double progress){

                    //运行在非UI线程，更新UI时需要注意

                    //Progress为0-100之间的double类型数值

                    }

                }

        );

Copy Object

复制Object

方法名：

public void copyObject(String destinationBucket, String destinationObject,String sourceBucket, String sourceKey,

CopyObjectResponseHandler resultHandler) throws Ks3ClientException,Ks3ServiceException {}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
destinationBucket：需要复制到此Bucket之下
destinationObject：复制到指定Bucket之后的ObjectKey
sourceBucket:源BucketName
sourceKey:源ObjectKey

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
result:成功时返回的Copy结果信息实体类

代码示例：


        client.copyObject("ks3-sdk-test", "object-source", "eflake", "object-copy", new CopyObjectResponseHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders,

                    CopyResult result) {

            }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable throwable) {

            }

        });

复制Object

方法名：

public void copyObject(String destinationBucket, String destinationObject,String sourceBucket, String sourceKey,

CannedAccessControlList cannedAcl, CopyObjectResponseHandler resultHandler) throws Ks3ClientException,Ks3ServiceException {}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
destinationBucket：需要复制到此Bucket之下
destinationObject：复制到指定Bucket之后的ObjectKey
sourceBucket:源BucketName
sourceKey:源ObjectKey
cannedAcl:传入的acl参数

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
result:成功时返回的Copy结果信息实体类

代码示例：


        CannedAccessControlList cannedAcl = CannedAccessControlList.PublicRead;

        client.copyObject("ks3-sdk-test", "object-source", "eflake", "object-copy",cannedAcl, new CopyObjectResponseHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders,

                    CopyResult result) {

            }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable throwable) {

            }

        });

复制Object

方法名：

public void copyObject(String destinationBucket, String destinationObject,String sourceBucket, String sourceKey,

AccessControlList accessControlList, CopyObjectResponseHandler resultHandler) throws Ks3ClientException,Ks3ServiceException {}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
destinationBucket：需要复制到此Bucket之下
destinationObject：复制到指定Bucket之后的ObjectKey
sourceBucket:源BucketName
sourceKey:源ObjectKey
accessControlList:传入的acl参数

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
result:成功时返回的Copy结果信息实体类

代码示例：


        AccessControlList acList = new AccessControlList();

        GranteeId grantee = new GranteeId();

        grantee.setIdentifier("123456");

        grantee.setDisplayName("TESTTEST1");

        acList.addGrant(grantee, Permission.Read);

        client.copyObject("ks3-sdk-test", "object-source", "eflake", "object-copy",acList, new CopyObjectResponseHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders,

                    CopyResult result) {

            }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable throwable) {

            }

        });

复制Object

方法名：

public void copyObject(CopyObjectRequest request,CopyObjectResponseHandler resultHandler) throws Ks3ClientException,Ks3ServiceException {}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
requset:request请求对象

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
result:成功时返回的Copy结果信息实体类

代码示例：


        CopyObjectRequest request = new CopyObjectRequest(destinationBucket,

                destinationObject, sourceBucket, sourceKey);

        client.copyObject(request, new CopyObjectResponseHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders,

                    CopyResult result) {

            }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable throwable) {

            }

        });

Initiate Multipart Upload

调用这个接口会初始化一个分块上传，KS3 Server会返回一个upload id, upload id 用来标识属于当前object的具体的块，并且用来标识完成分块上传或者取消分块上传

方法名：

public void initiateMultipartUpload(String bucketname, String objectkey, InitiateMultipartUploadResponceHandler resultHandler) throws Ks3ClientException,

Ks3ServiceException;

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
bucketname：指定的Bucket名称
objectKey：指定的Object键

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
result：成功时返回的初始化分块上传结果实体类，包含uploadId信息等

代码示例：


    client.initiateMultipartUpload(bucketName, objectKey,

                new InitiateMultipartUploadResponceHandler() {

                    @Override

                    public void onFailure(int statesCode,

                            Header[] responceHeaders, String response,

                            Throwable paramThrowable) {

                    }

                    @Override

                    public void onSuccess(int statesCode,

                            Header[] responceHeaders,

                            InitiateMultipartUploadResult result) {

                        String uploadId = result.getUploadId();

                });

方法名：

public void initiateMultipartUpload(InitiateMultipartUploadRequest request, InitiateMultipartUploadResponceHandler resultHandler) throws Ks3ClientException,

Ks3ServiceException;

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request:InitiateMultipartUploadRequest对象

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
result：成功时返回的初始化分块上传结果实体类，包含uploadId信息等

代码示例：


    client.initiateMultipartUpload(new InitiateMultipartUploadRequest(

                bucketName, objectKey),

                new InitiateMultipartUploadResponceHandler() {

                    @Override

                    public void onFailure(int statesCode,

                            Header[] responceHeaders, String response,

                            Throwable paramThrowable) {

                    }

                    @Override

                    public void onSuccess(int statesCode,

                            Header[] responceHeaders,

                            InitiateMultipartUploadResult result) {

                        String uploadId = result.getUploadId();

                });

Upload Part

初始化分块上传后，上传分块接口。Part number 是标识每个分块的数字，介于0-10000之间。除了最后一块，每个块必须大于等于5MB，最后一块没有这个限制。

方法名：

public void uploadPart(String bucketName, String key, String uploadId,File file, long offset, int partNumber, long partSize,UploadPartResponceHandler resultHandler)throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：请求封装类，应包含uploadId，上传的文件及其指定offset和size信息
bucketname：指定的Bucket名称
objectKey：指定的Object键
uploadId：初始化时得到的uploadId
file：需要上传的file
offset：此分块在文件中内容的起始位置
partNumber：此分块是第几块
partSize：此分块的大小，单位为Byte

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
result:成功时返回PartETag结果实体类，包含partNumber以及Etag信息

代码示例：


        client.uploadPart(bucketName, key,

                uploadId, file, offset, partNumbe，partsize,new UploadPartResponceHandler() {

                    @Override

                    public void onSuccess(int statesCode,

                    Header[] responceHeaders,

                    PartETag result) {

                        Log.d("eflake","upload part success , partnumber = "+ result.getPartNumber()+ ",etag = "+ result.getETag());

                    }

                    @Override

                    public void onFailure(int statesCode,Header[] responceHeaders,

                        String response, Throwable throwable) {

                        Log.d("eflake","upload part failed ,responce = "

                        + response);

                    }

                }

            );

初始化分块上传后，上传分块接口。Part number 是标识每个分块的数字，介于0-10000之间。除了最后一块，每个块必须大于等于5MB,最后一块没有大小限制。

方法名：

public void uploadPart(UploadPartRequest request,UploadPartResponceHandler resultHandler)throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：请求封装类，应包含uploadId，上传的文件及其指定offset和size信息

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
result:成功时返回UploadPart结果实体类，包含partNumber以及Etag信息

代码示例：


        client.uploadPart(new UploadPartRequest(bucketName, key,

                uploadId, file, offset, partNumber++, partsize),new UploadPartResponceHandler() {

                    @Override

                    public void onSuccess(int statesCode,

                    Header[] responceHeaders,

                    UploadPartResult result) {

                        Log.d("eflake","upload part success , partnumber = "+ result.getPartNumber()+ ",etag = "+ result.getETag());

                    }

                    @Override

                    public void onFailure(int statesCode,Header[] responceHeaders,

                        String response, Throwable throwable) {

                        Log.d("eflake","upload part failed ,responce = "

                        + response);

                    }

                }

            );

List Parts

罗列出已经上传的块

方法名：

public void ListParts(String bucketname, String objectkey,

String uploadId,ListPartsResponseHandler handler) throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：请求封装类，应包含uploadId，上传的文件及其指定offset和size信息
bucketname：指定的Bucket名称
objectKey：指定的bject键
uploadId：初始化时得到的uploadId

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
result:成功时返回ListPartsResult结果实体类,包含Owner及一个Parts容器类

代码示例：


        client.ListParts(bucketName, objectKey, uploadId,

                        new ListPartsResponseHandler() {

                            @Override

                            public void onSuccess(int statesCode,

                                    Header[] responceHeaders,

                                    ListPartsResult listPartsResult) {

                                Log.d("eflake", "listPart success :"

                                        + listPartsResult.toString());

                                mLastListPartResul = listPartsResult;

                                int mLastSize = listPartsResult.getParts()

                                        .size();

                            }

                            @Override

                            public void onFailure(int statesCode,

                                    Header[] responceHeaders, String response,

                                    Throwable paramThrowable) {

                                Log.d("eflake",

                                        "listPart fail ,reason :"

                                                + response);

                            }

                        });

罗列出已经上传的块

方法名：

public void ListParts(String bucketname, String objectkey,

String uploadId, int maxParts, ListPartsResponseHandler handler) throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：请求封装类，应包含uploadId，上传的文件及其指定offset和size信息
bucketname：指定的Bucket名称
objectKey：指定的Object键
uploadId：初始化时得到的uploadId
maxParts:返回块大小限制

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
result:成功时返回ListPartsResult结果实体类,包含Owner及一个Parts容器类

代码示例：


        client.ListParts(bucketName, objectKey,uploadId,maxParts,

                        new ListPartsResponseHandler() {

                            @Override

                            public void onSuccess(int statesCode,

                                    Header[] responceHeaders,

                                    ListPartsResult listPartsResult) {

                                Log.d("eflake", "listPart success :"

                                        + listPartsResult.toString());

                                mLastListPartResul = listPartsResult;

                                int mLastSize = listPartsResult.getParts()

                                        .size();

                            }

                            @Override

                            public void onFailure(int statesCode,

                                    Header[] responceHeaders, String response,

                                    Throwable paramThrowable) {

                                Log.d("eflake",

                                        "listPart fail ,reason :"

                                                + response);

                            }

                        });

罗列出已经上传的块

方法名：

public void ListParts(String bucketname, String objectkey,

String uploadId,int maxParts, int partNumberMarker, ListPartsResponseHandler handler) throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：请求封装类，应包含uploadId，上传的文件及其指定offset和size信息
bucketname：指定的Bucket名称
objectKey：指定的Object键
uploadId：初始化时得到的uploadId
maxParts:返回块大小限制
partNumberMarker:块号标记，将返回大于此块号的分块

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
result:成功时返回ListPartsResult结果实体类,包含Owner及一个Parts容器类

代码示例：


        client.ListParts(bucketName, objectKey,uploadId,maxParts,partNumberMarker,

                        new ListPartsResponseHandler() {

                            @Override

                            public void onSuccess(int statesCode,

                                    Header[] responceHeaders,

                                    ListPartsResult listPartsResult) {

                                Log.d("eflake", "listPart success :"

                                        + listPartsResult.toString());

                                mLastListPartResul = listPartsResult;

                                int mLastSize = listPartsResult.getParts()

                                        .size();

                            }

                            @Override

                            public void onFailure(int statesCode,

                                    Header[] responceHeaders, String response,

                                    Throwable paramThrowable) {

                                Log.d("eflake",

                                        "listPart fail ,reason :"

                                                + response);

                            }

                        });

Abort Multipart Upload

取消分块上传。

方法名：

public void abortMultipartUpload(String bucketname, String objectkey,

String uploadId,AbortMultipartUploadResponseHandler handler) throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：请求封装类，应包含uploadId，上传的文件及其指定offset和size信息
bucketname：指定的Bucket名称
objectKey：指定的Object键
uploadId：初始化时得到的uploadId

回调参数：

statesCode：Http请求返回的状态码，204表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常

代码示例：


        client.abortMultipartUpload(bucketname, objectkey, uploadId, new AbortMultipartUploadResponseHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders) {

            }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable paramThrowable) {

            }

        });

取消分块上传。

方法名：

public void abortMultipartUpload(AbortMultipartUploadRequest request, AbortMultipartUploadResponseHandler handler) throws Ks3ClientException, Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：请求封装类，应包含uploadId，上传的文件及其指定offset和size信息
bucketname：指定的Bucket名称
objectKey：指定的Object键
uploadId：初始化时得到的uploadId

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常

代码示例：


        client.abortMultipartUpload(new AbortMultipartUploadRequest(bucketname, objectkey, uploadId), new AbortMultipartUploadResponseHandler() {

            @Override

            public void onSuccess(int statesCode, Header[] responceHeaders) {

            }

            @Override

            public void onFailure(int statesCode, Header[] responceHeaders,

                    String response, Throwable paramThrowable) {

            }

        });

Complete Multipart Upload

组装之前上传的块，然后完成分块上传。通过你提供的xml文件，进行分块组装。在xml文件中，块号必须使用升序排列。必须提供每个块的ETag值。

方法名：

public void completeMultipartUpload(String bucketname, String objectkey, String uploadId,

List partETags,CompleteMultipartUploadResponseHandler handler) throws Ks3ClientException,Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：请求封装类，应包含uploadId，上传的文件及其指定offset和size信息
bucketname：指定的Bucket名称
objectKey：指定的Object键
uploadId：初始化时得到的uploadId
partETags：PartEtag容器，PartEtag是服务器UploadPart成功时，服务器返回的Etag以及PartNumber信息实体类

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
result:成功时返回结果实体类

代码示例：


        client.completeMultipartUpload(

                            new CompleteMultipartUploadRequest(

                                    mLastListPartResul),

                            new CompleteMultipartUploadResponseHandler() {

                                @Override

                                public void onSuccess(int statesCode,

                                        Header[] responceHeaders,

                                        CompleteMultipartUploadResult result) {

                                    Log.d("eflake",

                                            "completeMultipartUpload success, result = "

                                                    + result.getBucket());

                                }

                                @Override

                                public void onFailure(int statesCode,

                                        Header[] responceHeaders,

                                        String response,

                                        Throwable paramThrowable) {

                                    Log.d("eflake",

                                            "completeMultipartUpload failed, reason =  "

                                                    + response);

                                }

                            });

组装之前上传的块，然后完成分块上传。通过你提供的xml文件，进行分块组装。在xml文件中，块号必须使用升序排列。必须提供每个块的ETag值。

方法名：

public void completeMultipartUpload(ListPartsResult result, CompleteMultipartUploadResponseHandler handler) throws Ks3ClientException,Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
result:ListParts()接口返回结果实体类

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
result:成功时返回结果实体类

代码示例：


        client.completeMultipartUpload(mLastListPartResul,

                            new CompleteMultipartUploadResponseHandler() {

                                @Override

                                public void onSuccess(int statesCode,

                                        Header[] responceHeaders,

                                        CompleteMultipartUploadResult result) {

                                    Log.d("eflake",

                                            "completeMultipartUpload success, result = "

                                                    + result.getBucket());

                                }

                                @Override

                                public void onFailure(int statesCode,

                                        Header[] responceHeaders,

                                        String response,

                                        Throwable paramThrowable) {

                                    Log.d("eflake",

                                            "completeMultipartUpload failed, reason =  "

                                                    + response);

                                }

                            });

组装之前上传的块，然后完成分块上传。通过你提供的xml文件，进行分块组装。在xml文件中，块号必须使用升序排列。必须提供每个块的ETag值。

方法名：

public void completeMultipartUpload(CompleteMultipartUploadRequest request, CompleteMultipartUploadResponseHandler handler) throws Ks3ClientException,Ks3ServiceException{}

参数说明：

resultHandler：回调接口，包含onSuccess以及onFailure两个回调方法，运行在主线程
request：请求封装类，应包含uploadId，上传的文件及其指定offset和size信息

回调参数：

statesCode：Http请求返回的状态码，200表示请求成功，400表示客户端请求错误，403表示签名错误或本地日期时间错误
responceHeader:Http请求响应报头
responce：失败时返回的响应正文
throwable：出错时抛出的异常
result:成功时返回结果实体类

代码示例：


        client.completeMultipartUpload(

                            new CompleteMultipartUploadRequest(

                                    mLastListPartResul),

                            new CompleteMultipartUploadResponseHandler() {

                                @Override

                                public void onSuccess(int statesCode,

                                        Header[] responceHeaders,

                                        CompleteMultipartUploadResult result) {

                                    Log.d("eflake",

                                            "completeMultipartUpload success, result = "

                                                    + result.getBucket());

                                }

                                @Override

                                public void onFailure(int statesCode,

                                        Header[] responceHeaders,

                                        String response,

                                        Throwable paramThrowable) {

                                    Log.d("eflake",

                                            "completeMultipartUpload failed, reason =  "

                                                    + response);

                                }

                            });

Multipart Upload Example Code

分块上传代码示例


        handler = new UploadPartHandler();

        client.initiateMultipartUpload(new InitiateMultipartUploadRequest(

                bucketName, objectKey),

                new InitiateMultipartUploadResponceHandler() {

                    @Override

                    public void onSuccess(int statesCode,

                            Header[] responceHeaders,

                            InitiateMultipartUploadResult result) {

                        String uploadId = result.getUploadId();

                        handler.sendEmptyMessage(TransferManager.STATE_UPLOAD_NEXT);

                    @Override

                    public void onFailure(int statesCode,

                            Header[] responceHeaders, String response,

                            Throwable paramThrowable) {

                    }

                }

            );

        public class UploadPartHandler extends Handler {

                    @Override

                    public void handleMessage(Message msg) {

                        super.handleMessage(msg);

                        switch (msg.what) {

                    case TransferManager.STATE_UPLOAD_NEXT:

                    if (localUploadPartRequestFactory.hasMoreRequests()) {

                    UploadPartRequest uploadPartRequest = localUploadPartRequestFactory

                            .getNextUploadPartRequest();

                    client.uploadPart(uploadPartRequest,

                            new UploadPartResponceHandler() {

                                @Override

                                public void onSuccess(int statesCode,

                                        Header[] responceHeaders,

                                        UploadPartResult result) {

                                    Log.d("eflake",

                                            "upload part success , partnumber = "

                                                    + result.getPartNumber()

                                                    + ",etag = "

                                                    + result.getETag());

                                    handler.sendEmptyMessage(TransferManager.STATE_UPLOAD_NEXT);

                                }

                                @Override

                                public void onFailure(int statesCode,

                                        Header[] responceHeaders,

                                        String response, Throwable throwable) {

                                    Log.d("eflake",

                                            "upload part failed ,responce = "

                                                    + response);

                                    handler.sendEmptyMessage(TransferManager.STATE_UPLOAD_FAILED);

                                }

                            });

                } else {

                    handler.sendEmptyMessage(TransferManager.STATE_UPLOAD_FINISH);

                }

                break;

            case TransferManager.STATE_UPLOAD_FINISH:

                client.ListParts(bucketName, objectKey,

                        transferResponceHandler.getMultipartUoloadId(),

                        new ListPartsResponseHandler() {

                            @Override

                            public void onSuccess(int statesCode,

                                    Header[] responceHeaders,

                                    ListPartsResult listPartsResult) {

                                mLastListPartResul = listPartsResult;

                                handler.sendEmptyMessage(TransferManager.STATE_UPLOAD_COMPLETE);

                            }

                            @Override

                            public void onFailure(int statesCode,

                                    Header[] responceHeaders, String response,

                                    Throwable paramThrowable) {

                                Log.d("eflake",

                                        "listPart failed, reason :"

                                                + response);

                            }

                        });

                break;

            case TransferManager.STATE_UPLOAD_FAILED:

                break;

            case TransferManager.STATE_UPLOAD_COMPLETE:

                if (mLastListPartResul != null) {

                    client.completeMultipartUpload(

                            new CompleteMultipartUploadRequest(

                                    mLastListPartResul),

                            new CompleteMultipartUploadResponseHandler() {

                                @Override

                                public void onSuccess(int statesCode,

                                        Header[] responceHeaders,

                                        CompleteMultipartUploadResult result) {

                                    Log.d("eflake",

                                            "completeMultipartUpload success, result = "

                                                    + result.getBucket());

                                }

                                @Override

                                public void onFailure(int statesCode,

                                        Header[] responceHeaders,

                                        String response,

                                        Throwable paramThrowable) {

                                    Log.d("eflake",

                                            "completeMultipartUpload failed, reason =  "

                                                    + response);

                                }

                            });

                }

                break;

            default:

                break;

            }

        }

    }

分块上传的更高层封装接口

以上接口是比较底层的，需要自行创建uploadid，上传每一块。com.ksyun.ks3.services.MultiUploader这个类是更高层封装。一般大于10M的文件才使用分块。本接口是按5M一块分块的。

MultiUploader 代码示例


    最简用法：

    MultiUploader uploader = new MultiUploader(client, bucketName, key, new File("/sdcard/11"));

    uploader.setHandler(multiHandler); // handler的定义方法见下面几行。也可以不设置，不设也正常传，只是不回掉到你的代码里。

    uploader.setConcurrentNo(2); // 并发传的块数，默认就是2。一般不用改。根据你自测的性能状况来调整。

    uploader.upload();

    // 

    CompleteMultipartUploadResponseHandler multiHandler = new CompleteMultipartUploadResponseHandler(){

      @Override

        public void onFailure(int statesCode, Ks3Error error, Header[] responceHeaders, String response, Throwable paramThrowable) {

          //整个分块上传中，任意步骤失败都会调到这里

        }

      @Override

        public void onSuccess(int statesCode, Header[] responceHeaders, CompleteMultipartUploadResult result) {

          //最终成功，才会调到这里

        }

    }

    推荐用法：

    从SDK源码里把com.ksyun.ks3.services.MultiUploader.java拷贝到你的目录下，可以修改partSize等变量，log输出格式等。也可以在initiateMultipartUpload这一步之后加入保存uploadid的逻辑(最好存在你自己后台)。

    当然也可参考MultiUploader.java自行实现你的接口。

其他

完整示例，请见 KS3-Android-SDK-Demo

文档中心

产品描述

快速入门

开发指南

访问域名（Endpoint）

存储类型

存储空间（Bucket）

购买与计费

控制台使用手册

空间管理

内容管理

报表中心

访问权限管理

图片处理

图片处理API

图片样式管理

云监控

最佳实践

访问权限管理实践

测试与工具

工具

环境安装与配置

服务协议

常见问题

API文档

Bucket相关