概述  软件包   类  使用  树  已过时  索引  帮助 
 上一个类   下一个类 框架    无框架    
摘要： 嵌套 | 字段 | 构造方法 | 方法 详细信息： 字段 | 构造方法 | 方法

com.aliyun.openservices.oss
接口 OSS

所有已知实现类：
OSSClient
public interface OSS

阿里云开放存储服务（Open Storage Service， OSS）的访问接口。

阿里云存储服务（Open Storage Service，简称OSS），是阿里云对外提供的海量，安全，低成本， 高可靠的云存储服务。用户可以通过简单的REST接口，在任何时间、任何地点上传和下载数据， 也可以使用WEB页面对数据进行管理。
基于OSS，用户可以搭建出各种多媒体分享网站、网盘、个人企业数据备份等基于大规模数据的服务。

方法摘要
 void abortMultipartUpload(AbortMultipartUploadRequest request)
          终止一个Multipart上传事件。
 CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest request)
          完成一个Multipart上传事件。
 CopyObjectResult copyObject(CopyObjectRequest copyObjectRequest)
          拷贝一个在OSS上已经存在的Object成另外一个Object。
 CopyObjectResult copyObject(String sourceBucketName, String sourceKey, String destinationBucketName, String destinationKey)
          拷贝一个在OSS上已经存在的Object成另外一个Object。
 Bucket createBucket(String bucketName)
          创建Bucket。
 void deleteBucket(String bucketName)
          删除Bucket。
 void deleteObject(String bucketName, String key)
          删除指定的OSSObject。
 boolean doesBucketExist(String bucketName)
          判断给定Bucket是否存在。
 URL generatePresignedUrl(GeneratePresignedUrlRequest request)
          生成一个包含签名信息并可以访问OSSObject的URL。
 URL generatePresignedUrl(String bucketName, String key, Date expiration)
          生成一个用HTTP GET方法访问OSSObject的URL。
 URL generatePresignedUrl(String bucketName, String key, Date expiration, HttpMethod method)
          生成一个用指定HTTP方法访问OSSObject的URL。
 AccessControlList getBucketAcl(String bucketName)
          返回给定Bucket的Access Control List(ACL)。
 OSSObject getObject(GetObjectRequest getObjectRequest)
          从OSS指定的Bucket中导出OSSObject。
 ObjectMetadata getObject(GetObjectRequest getObjectRequest, File file)
          从OSS指定的Bucket中导出指定的OSSObject到目标文件。
 OSSObject getObject(String bucketName, String key)
          从OSS指定的Bucket中导出OSSObject。
 ObjectMetadata getObjectMetadata(String bucketName, String key)
          返回OSSObject的元数据。
 InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest request)
          初始化一个Multipart上传事件。
 List<Bucket> listBuckets()
          返回请求者拥有的所有Bucket的列表。
 MultipartUploadListing listMultipartUploads(ListMultipartUploadsRequest request)
          列出所有执行中的 Multipart上传事件。
 ObjectListing listObjects(ListObjectsRequest listObjectsRequest)
          列出指定Bucket下的OSSObject。
 ObjectListing listObjects(String bucketName)
          列出指定Bucket下的OSSObject。
 ObjectListing listObjects(String bucketName, String prefix)
          列出指定Bucket下key以给定prefix开头的OSSObject。
 PartListing listParts(ListPartsRequest request)
          列出multipart中上传的所有part信息
 PutObjectResult putObject(String bucketName, String key, InputStream input, ObjectMetadata metadata)
          上传指定的OSSObject到OSS中指定的Bucket。
 void setBucketAcl(String bucketName, CannedAccessControlList acl)
          设置指定Bucket的Access Control List(ACL)。
 UploadPartResult uploadPart(UploadPartRequest request)
          上传一个分块（Part）到指定的的Multipart上传事件中。
 

方法详细信息

createBucket

Bucket createBucket(String bucketName)
                    throws OSSException,
                           ClientException
创建Bucket。

参数：
bucketName - Bucket名称。
抛出：
OSSException
ClientException

deleteBucket

void deleteBucket(String bucketName)
                  throws OSSException,
                         ClientException
删除Bucket。

参数：
bucketName - Bucket名称。
抛出：
OSSException
ClientException

listBuckets

List<Bucket> listBuckets()
                         throws OSSException,
                                ClientException
返回请求者拥有的所有Bucket的列表。

返回：
请求者拥有的所有Bucket的列表。
抛出：
OSSException
ClientException

setBucketAcl

void setBucketAcl(String bucketName,
                  CannedAccessControlList acl)
                  throws OSSException,
                         ClientException
设置指定Bucket的Access Control List(ACL)。

参数：
bucketName - Bucket名称。
acl - CannedAccessControlList中列出的ACL。 如果传入null，则表示使用默认值CannedAccessControlList.Private。
抛出：
OSSException
ClientException

getBucketAcl

AccessControlList getBucketAcl(String bucketName)
                               throws OSSException,
                                      ClientException
返回给定Bucket的Access Control List(ACL)。

参数：
bucketName - Bucket名称。
返回：
Access Control List(ACL) AccessControlList。
抛出：
OSSException
ClientException

doesBucketExist

boolean doesBucketExist(String bucketName)
                        throws OSSException,
                               ClientException
判断给定Bucket是否存在。

参数：
bucketName - Bucket名称。
抛出：
OSSException
ClientException

listObjects

ObjectListing listObjects(String bucketName)
                          throws OSSException,
                                 ClientException
列出指定Bucket下的OSSObject。

参数：
bucketName - Bucket名称。
返回：
Object列表ObjectListing
抛出：
OSSException
ClientException

listObjects

ObjectListing listObjects(String bucketName,
                          String prefix)
                          throws OSSException,
                                 ClientException
列出指定Bucket下key以给定prefix开头的OSSObject。

参数：
bucketName - Bucket名称。
prefix - 限定返回的Object key必须以prefix作为前缀。
返回：
Object列表ObjectListing
抛出：
OSSException
ClientException

listObjects

ObjectListing listObjects(ListObjectsRequest listObjectsRequest)
                          throws OSSException,
                                 ClientException
列出指定Bucket下的OSSObject。

参数：
listObjectsRequest - 请求信息。
返回：
object列表ObjectListing
抛出：
OSSException
ClientException

putObject

PutObjectResult putObject(String bucketName,
                          String key,
                          InputStream input,
                          ObjectMetadata metadata)
                          throws OSSException,
                                 ClientException
上传指定的OSSObject到OSS中指定的Bucket。

参数：
bucketName - Bucket名称。
key - object的key。
input - 输入流。
metadata - object的元信息ObjectMetadata。
抛出：
OSSException
ClientException

copyObject

CopyObjectResult copyObject(String sourceBucketName,
                            String sourceKey,
                            String destinationBucketName,
                            String destinationKey)
                            throws OSSException,
                                   ClientException
拷贝一个在OSS上已经存在的Object成另外一个Object。

参数：
sourceBucketName - 源Object所在的Bucket的名称。
sourceKey - 源Object的Key。
destinationBucketName - 目标Object所在的Bucket的名称。
destinationKey - 目标Object的Key。
返回：
请求结果CopyObjectResult实例。
抛出：
OSSException
ClientException

copyObject

CopyObjectResult copyObject(CopyObjectRequest copyObjectRequest)
                            throws OSSException,
                                   ClientException
拷贝一个在OSS上已经存在的Object成另外一个Object。

参数：
copyObjectRequest - 请求参数CopyObjectRequest实例。
返回：
抛出：
OSSException
ClientException

getObject

OSSObject getObject(String bucketName,
                    String key)
                    throws OSSException,
                           ClientException
从OSS指定的Bucket中导出OSSObject。

参数：
bucketName - Bucket名称。
key - Object Key。
抛出：
OSSException
ClientException

getObject

ObjectMetadata getObject(GetObjectRequest getObjectRequest,
                         File file)
                         throws OSSException,
                                ClientException
从OSS指定的Bucket中导出指定的OSSObject到目标文件。

参数：
getObjectRequest - 请求参数GetObjectRequest。
file - 目标文件。
抛出：
OSSException
ClientException

getObject

OSSObject getObject(GetObjectRequest getObjectRequest)
                    throws OSSException,
                           ClientException
从OSS指定的Bucket中导出OSSObject。

参数：
getObjectRequest - 请求参数GetObjectRequest。
抛出：
OSSException
ClientException

getObjectMetadata

ObjectMetadata getObjectMetadata(String bucketName,
                                 String key)
                                 throws OSSException,
                                        ClientException
返回OSSObject的元数据。

参数：
bucketName - Bucket名称。
key - Object key。
抛出：
OSSException
ClientException

deleteObject

void deleteObject(String bucketName,
                  String key)
                  throws OSSException,
                         ClientException
删除指定的OSSObject。

参数：
bucketName - Bucket名称。
key - Object key。
抛出：
OSSException
ClientException

generatePresignedUrl

URL generatePresignedUrl(String bucketName,
                         String key,
                         Date expiration)
                         throws ClientException
生成一个用HTTP GET方法访问OSSObject的URL。

参数：
bucketName - Bucket名称。
key - Object key。
expiration - URL的超时时间。
返回：
访问OSSObject的URL。
抛出：
ClientException

generatePresignedUrl

URL generatePresignedUrl(String bucketName,
                         String key,
                         Date expiration,
                         HttpMethod method)
                         throws ClientException
生成一个用指定HTTP方法访问OSSObject的URL。

参数：
bucketName - Bucket名称。
key - Object Key。
expiration - URL的超时时间。
method - HTTP方法，只支持HttpMethod.GET和HttpMethod.PUT。
返回：
访问OSSObject的URL。
抛出：
ClientException

generatePresignedUrl

URL generatePresignedUrl(GeneratePresignedUrlRequest request)
                         throws ClientException
生成一个包含签名信息并可以访问OSSObject的URL。

参数：
request - GeneratePresignedUrlRequest对象。
返回：
包含签名信息并可以访问OSSObject的URL。
抛出：
ClientException

abortMultipartUpload

void abortMultipartUpload(AbortMultipartUploadRequest request)
                          throws OSSException,
                                 ClientException
终止一个Multipart上传事件。

参数：
request - AbortMultipartUploadRequest对象。
抛出：
ClientException
OSSException

completeMultipartUpload

CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest request)
                                                      throws OSSException,
                                                             ClientException
完成一个Multipart上传事件。

在将所有数据Part 都上传完成后，可以调用 Complete Multipart Upload API 来完成整个文件的 Multipart Upload。在执行该操作时，用户必须提供所有有效 的数据Part的列表（包括part号码和ETAG）； OSS收到用户提交的Part列表后， 会逐一验证每个数据 Part 的有效性。当所有的数据 Part 验证通过后，OSS 将把 这些数据part组合成一个完整的 Object。

参数：
request - CompleteMultipartUploadRequest对象。
返回：
CompleteMultipartUploadResult
抛出：
ClientException
OSSException

initiateMultipartUpload

InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest request)
                                                      throws OSSException,
                                                             ClientException
初始化一个Multipart上传事件。

使用Multipart模式上传数据前，必须先调用该接口来通过OSS初始化一个Multipart上传事件。 该接口会返回一个OSS服务器创建的全局唯一的Upload ID，用于标识本次Multipart上传事件。 用户可以根据这个ID来发起相关的操作，如中止、查询Multipart上传等。

参数：
request - InitiateMultipartUploadRequest对象。
返回：
InitiateMultipartUploadResult
抛出：
ClientException
OSSException

listMultipartUploads

MultipartUploadListing listMultipartUploads(ListMultipartUploadsRequest request)
                                            throws OSSException,
                                                   ClientException
列出所有执行中的 Multipart上传事件。

即已经被初始化的 Multipart Upload 但是未被完成或被终止的 Multipart上传事件。 OSS返回的罗列结果中最多会包含1000个Multipart上传事件。

参数：
request - ListMultipartUploadsRequest对象。
返回：
MultipartUploadListing Multipart上传事件的列表MultipartUploadListing。
抛出：
ClientException
OSSException

listParts

PartListing listParts(ListPartsRequest request)
                      throws OSSException,
                             ClientException
列出multipart中上传的所有part信息

参数：
request - ListPartsRequest对象。
返回：
PartListing
抛出：
ClientException
OSSException

uploadPart

UploadPartResult uploadPart(UploadPartRequest request)
                            throws OSSException,
                                   ClientException
上传一个分块（Part）到指定的的Multipart上传事件中。

参数：
request - UploadPartRequest对象。
返回：
UploadPartResult 上传Part的返回结果UploadPartResult。
抛出：
ClientException
OSSException
概述  软件包   类  使用  树  已过时  索引  帮助 
 上一个类   下一个类 框架    无框架    
摘要： 嵌套 | 字段 | 构造方法 | 方法 详细信息： 字段 | 构造方法 | 方法
Copyright © 2013. All Rights Reserved.