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

com.aliyun.openservices.oss
类 OSSClient

java.lang.Object
  继承者 com.aliyun.openservices.oss.OSSClient
所有已实现的接口：
OSS
public class OSSClient
extends Object
implements OSS

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

构造方法摘要
OSSClient(String accessKeyId, String accessKeySecret)
          使用默认的OSS Endpoint构造一个新的OSSClient对象。
OSSClient(String endpoint, String accessKeyId, String accessKeySecret)
          使用指定的OSS Endpoint构造一个新的OSSClient对象。
OSSClient(String endpoint, String accessKeyId, String accessKeySecret, ClientConfiguration config)
          使用指定的OSS Endpoint和配置构造一个新的OSSClient对象。
 
方法摘要
 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(CreateBucketRequest createBucketRequest)
          创建Bucket。
 Bucket createBucket(String bucketName)
          创建Bucket。
 void deleteBucket(String bucketName)
          删除Bucket。
 void deleteBucketCORSRules(String bucketName)
          删除指定bucket下面的所有跨域访问规则
 void deleteBucketLogging(String bucketName)
          关闭Bucket的访问日志记录功能。
 void deleteBucketWebsite(String bucketName)
          关闭Bucket的静态网站托管模式。
 void deleteObject(String bucketName, String key)
          删除指定的OSSObject。
 boolean doesBucketExist(String bucketName)
          已过时。 
 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。
 String getAccessKeyId()
          返回使用的Access Key ID。
 String getAccessKeySecret()
          返回使用的Access Key Secret。
 AccessControlList getBucketAcl(String bucketName)
          返回给定Bucket的Access Control List(ACL)。
 List<SetBucketCORSRequest.CORSRule> getBucketCORSRules(String bucketName)
          列出指定bucket
 String getBucketLocation(String bucketName)
          返回给定Bucket所在的数据中心。
 BucketLoggingResult getBucketLogging(String bucketName)
          查看Bucket的访问日志配置。
 BucketWebsiteResult getBucketWebsite(String bucketName)
          获取Bucket的静态网站托管状态。
 URI getEndpoint()
          返回访问的OSS Endpoint。
 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上传事件。
 boolean isBucketExist(String bucketName)
          已过时。 
 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信息
 com.aliyun.common.comm.ResponseMessage optionsObject(OptionsRequest request)
          option object
 PutObjectResult putObject(String bucketName, String key, InputStream input, ObjectMetadata metadata)
          上传指定的OSSObject到OSS中指定的Bucket。
 void setBucketAcl(String bucketName, CannedAccessControlList acl)
          设置指定Bucket的Access Control List(ACL)。
 void setBucketCORS(SetBucketCORSRequest request)
          操作将在指定的bucket上设定一个跨域资源共享(CORS)的规则，如果原规则存在则覆盖原规则
 void setBucketLogging(SetBucketLoggingRequest request)
           
 void setBucketWebsite(SetBucketWebsiteRequest setBucketWebSiteRequest)
          将一个Bucket设置成静态网站托管模式。
 UploadPartResult uploadPart(UploadPartRequest request)
          上传一个分块（Part）到指定的的Multipart上传事件中。
 
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

构造方法详细信息

OSSClient

public OSSClient(String accessKeyId,
                 String accessKeySecret)
使用默认的OSS Endpoint构造一个新的OSSClient对象。

参数：
accessKeyId - 访问OSS的Access Key ID。
accessKeySecret - 访问OSS的Access Key Secret。

OSSClient

public OSSClient(String endpoint,
                 String accessKeyId,
                 String accessKeySecret)
使用指定的OSS Endpoint构造一个新的OSSClient对象。

参数：
endpoint - OSS服务的Endpoint。必须以"http://"开头。
accessKeyId - 访问OSS的Access Key ID。
accessKeySecret - 访问OSS的Access Key Secret。

OSSClient

public OSSClient(String endpoint,
                 String accessKeyId,
                 String accessKeySecret,
                 ClientConfiguration config)
使用指定的OSS Endpoint和配置构造一个新的OSSClient对象。

参数：
endpoint - OSS服务的Endpoint。必须以"http://"开头。
accessKeyId - 访问OSS的Access Key ID。
accessKeySecret - 访问OSS的Access Key Secret。
config - 客户端配置 ClientConfiguration。 如果为null则会使用默认配置。
方法详细信息

getEndpoint

public URI getEndpoint()
返回访问的OSS Endpoint。

返回：
OSS Endpoint。

getAccessKeyId

public String getAccessKeyId()
返回使用的Access Key ID。

返回：
使用的Access Key ID。

getAccessKeySecret

public String getAccessKeySecret()
返回使用的Access Key Secret。

返回：
使用的Access Key Secret。

createBucket

public Bucket createBucket(String bucketName)
                    throws OSSException,
                           ClientException
从接口 OSS 复制的描述
创建Bucket。

指定者：
接口 OSS 中的 createBucket
参数：
bucketName - Bucket名称。
抛出：
OSSException
ClientException

createBucket

public Bucket createBucket(CreateBucketRequest createBucketRequest)
从接口 OSS 复制的描述
创建Bucket。

指定者：
接口 OSS 中的 createBucket
参数：
createBucketRequest - 请求参数CreateBucketRequest。

deleteBucket

public void deleteBucket(String bucketName)
                  throws OSSException,
                         ClientException
从接口 OSS 复制的描述
删除Bucket。

指定者：
接口 OSS 中的 deleteBucket
参数：
bucketName - Bucket名称。
抛出：
OSSException
ClientException

listBuckets

public List<Bucket> listBuckets()
                         throws OSSException,
                                ClientException
从接口 OSS 复制的描述
返回请求者拥有的所有Bucket的列表。

指定者：
接口 OSS 中的 listBuckets
返回：
请求者拥有的所有Bucket的列表。
抛出：
OSSException
ClientException

setBucketAcl

public void setBucketAcl(String bucketName,
                         CannedAccessControlList acl)
                  throws OSSException,
                         ClientException
从接口 OSS 复制的描述
设置指定Bucket的Access Control List(ACL)。

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

getBucketAcl

public AccessControlList getBucketAcl(String bucketName)
                               throws OSSException,
                                      ClientException
从接口 OSS 复制的描述
返回给定Bucket的Access Control List(ACL)。

指定者：
接口 OSS 中的 getBucketAcl
参数：
bucketName - Bucket名称。
返回：
Access Control List(ACL) AccessControlList。
抛出：
OSSException
ClientException

getBucketLocation

public String getBucketLocation(String bucketName)
                         throws OSSException,
                                ClientException
从接口 OSS 复制的描述
返回给定Bucket所在的数据中心。

指定者：
接口 OSS 中的 getBucketLocation
参数：
bucketName - Bucket名称。
返回：
Bucket所在的数据中心。
抛出：
OSSException
ClientException

doesBucketExist

@Deprecated
public boolean doesBucketExist(String bucketName)
                        throws OSSException,
                               ClientException
已过时。 

从接口 OSS 复制的描述
判断给定Bucket是否存在。

指定者：
接口 OSS 中的 doesBucketExist
参数：
bucketName - Bucket名称。
抛出：
OSSException
ClientException

isBucketExist

@Deprecated
public boolean isBucketExist(String bucketName)
                      throws OSSException,
                             ClientException
已过时。 

已过时。请使用doesBucketExist(String)。

参数：
bucketName -
返回：
抛出：
OSSException
ClientException

listObjects

public ObjectListing listObjects(String bucketName)
                          throws OSSException,
                                 ClientException
从接口 OSS 复制的描述
列出指定Bucket下的OSSObject。

指定者：
接口 OSS 中的 listObjects
参数：
bucketName - Bucket名称。
返回：
Object列表ObjectListing
抛出：
OSSException
ClientException

listObjects

public ObjectListing listObjects(String bucketName,
                                 String prefix)
                          throws OSSException,
                                 ClientException
从接口 OSS 复制的描述
列出指定Bucket下key以给定prefix开头的OSSObject。

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

listObjects

public ObjectListing listObjects(ListObjectsRequest listObjectsRequest)
                          throws OSSException,
                                 ClientException
从接口 OSS 复制的描述
列出指定Bucket下的OSSObject。

指定者：
接口 OSS 中的 listObjects
参数：
listObjectsRequest - 请求信息。
返回：
object列表ObjectListing
抛出：
OSSException
ClientException

putObject

public PutObjectResult putObject(String bucketName,
                                 String key,
                                 InputStream input,
                                 ObjectMetadata metadata)
                          throws OSSException,
                                 ClientException
从接口 OSS 复制的描述
上传指定的OSSObject到OSS中指定的Bucket。

指定者：
接口 OSS 中的 putObject
参数：
bucketName - Bucket名称。
key - object的key。
input - 输入流。
metadata - object的元信息ObjectMetadata。
抛出：
OSSException
ClientException

copyObject

public CopyObjectResult copyObject(String sourceBucketName,
                                   String sourceKey,
                                   String destinationBucketName,
                                   String destinationKey)
                            throws OSSException,
                                   ClientException
从接口 OSS 复制的描述
拷贝一个在OSS上已经存在的Object成另外一个Object。

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

copyObject

public CopyObjectResult copyObject(CopyObjectRequest copyObjectRequest)
                            throws OSSException,
                                   ClientException
从接口 OSS 复制的描述
拷贝一个在OSS上已经存在的Object成另外一个Object。

指定者：
接口 OSS 中的 copyObject
参数：
copyObjectRequest - 请求参数CopyObjectRequest实例。
返回：
抛出：
OSSException
ClientException

getObject

public OSSObject getObject(String bucketName,
                           String key)
                    throws OSSException,
                           ClientException
从接口 OSS 复制的描述
从OSS指定的Bucket中导出OSSObject。

指定者：
接口 OSS 中的 getObject
参数：
bucketName - Bucket名称。
key - Object Key。
返回：
请求结果OSSObject实例。使用完之后需要手动关闭其中的ObjectContent释放请求连接。
抛出：
OSSException
ClientException

getObject

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

指定者：
接口 OSS 中的 getObject
参数：
getObjectRequest - 请求参数GetObjectRequest。
file - 目标文件。
抛出：
OSSException
ClientException

getObject

public OSSObject getObject(GetObjectRequest getObjectRequest)
                    throws OSSException,
                           ClientException
从接口 OSS 复制的描述
从OSS指定的Bucket中导出OSSObject。

指定者：
接口 OSS 中的 getObject
参数：
getObjectRequest - 请求参数GetObjectRequest。
返回：
请求结果OSSObject实例。使用完之后需要手动关闭其中的ObjectContent释放请求连接。
抛出：
OSSException
ClientException

getObjectMetadata

public ObjectMetadata getObjectMetadata(String bucketName,
                                        String key)
                                 throws OSSException,
                                        ClientException
从接口 OSS 复制的描述
返回OSSObject的元数据。

指定者：
接口 OSS 中的 getObjectMetadata
参数：
bucketName - Bucket名称。
key - Object key。
抛出：
OSSException
ClientException

deleteObject

public void deleteObject(String bucketName,
                         String key)
                  throws OSSException,
                         ClientException
从接口 OSS 复制的描述
删除指定的OSSObject。

指定者：
接口 OSS 中的 deleteObject
参数：
bucketName - Bucket名称。
key - Object key。
抛出：
OSSException
ClientException

generatePresignedUrl

public URL generatePresignedUrl(String bucketName,
                                String key,
                                Date expiration)
                         throws ClientException
从接口 OSS 复制的描述
生成一个用HTTP GET方法访问OSSObject的URL。

指定者：
接口 OSS 中的 generatePresignedUrl
参数：
bucketName - Bucket名称。
key - Object key。
expiration - URL的超时时间。
返回：
访问OSSObject的URL。
抛出：
ClientException

generatePresignedUrl

public URL generatePresignedUrl(String bucketName,
                                String key,
                                Date expiration,
                                HttpMethod method)
                         throws ClientException
从接口 OSS 复制的描述
生成一个用指定HTTP方法访问OSSObject的URL。

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

generatePresignedUrl

public URL generatePresignedUrl(GeneratePresignedUrlRequest request)
                         throws ClientException
从接口 OSS 复制的描述
生成一个包含签名信息并可以访问OSSObject的URL。

指定者：
接口 OSS 中的 generatePresignedUrl
参数：
request - GeneratePresignedUrlRequest对象。
返回：
包含签名信息并可以访问OSSObject的URL。
抛出：
ClientException

abortMultipartUpload

public void abortMultipartUpload(AbortMultipartUploadRequest request)
                          throws OSSException,
                                 ClientException
从接口 OSS 复制的描述
终止一个Multipart上传事件。

指定者：
接口 OSS 中的 abortMultipartUpload
参数：
request - AbortMultipartUploadRequest对象。
抛出：
ClientException
OSSException

completeMultipartUpload

public CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest request)
                                                      throws OSSException,
                                                             ClientException
从接口 OSS 复制的描述
完成一个Multipart上传事件。

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

此方法对应的操作为非幂等操作，SDK不会对其进行重试（即使设置最大重试次数大于0也不会重试）

指定者：
接口 OSS 中的 completeMultipartUpload
参数：
request - CompleteMultipartUploadRequest对象。
返回：
CompleteMultipartUploadResult
抛出：
ClientException
OSSException

initiateMultipartUpload

public InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest request)
                                                      throws OSSException,
                                                             ClientException
从接口 OSS 复制的描述
初始化一个Multipart上传事件。

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

此方法对应的操作为非幂等操作，SDK不会对其进行重试（即使设置最大重试次数大于0也不会重试）

指定者：
接口 OSS 中的 initiateMultipartUpload
参数：
request - InitiateMultipartUploadRequest对象。
返回：
InitiateMultipartUploadResult
抛出：
ClientException
OSSException

listMultipartUploads

public MultipartUploadListing listMultipartUploads(ListMultipartUploadsRequest request)
                                            throws OSSException,
                                                   ClientException
从接口 OSS 复制的描述
列出所有执行中的 Multipart上传事件。

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

指定者：
接口 OSS 中的 listMultipartUploads
参数：
request - ListMultipartUploadsRequest对象。
返回：
MultipartUploadListing Multipart上传事件的列表MultipartUploadListing。
抛出：
ClientException
OSSException

listParts

public PartListing listParts(ListPartsRequest request)
                      throws OSSException,
                             ClientException
从接口 OSS 复制的描述
列出multipart中上传的所有part信息

指定者：
接口 OSS 中的 listParts
参数：
request - ListPartsRequest对象。
返回：
PartListing
抛出：
ClientException
OSSException

uploadPart

public UploadPartResult uploadPart(UploadPartRequest request)
                            throws OSSException,
                                   ClientException
从接口 OSS 复制的描述
上传一个分块（Part）到指定的的Multipart上传事件中。

指定者：
接口 OSS 中的 uploadPart
参数：
request - UploadPartRequest对象。
返回：
UploadPartResult 上传Part的返回结果UploadPartResult。
抛出：
ClientException
OSSException

setBucketCORS

public void setBucketCORS(SetBucketCORSRequest request)
                   throws OSSException,
                          ClientException
从接口 OSS 复制的描述
操作将在指定的bucket上设定一个跨域资源共享(CORS)的规则，如果原规则存在则覆盖原规则

指定者：
接口 OSS 中的 setBucketCORS
参数：
request - SetBucketCORSRequest}
抛出：
OSSException
ClientException

getBucketCORSRules

public List<SetBucketCORSRequest.CORSRule> getBucketCORSRules(String bucketName)
                                                       throws OSSException,
                                                              ClientException
从接口 OSS 复制的描述
列出指定bucket

指定者：
接口 OSS 中的 getBucketCORSRules
返回：
抛出：
OSSException
ClientException

deleteBucketCORSRules

public void deleteBucketCORSRules(String bucketName)
                           throws OSSException,
                                  ClientException
从接口 OSS 复制的描述
删除指定bucket下面的所有跨域访问规则

指定者：
接口 OSS 中的 deleteBucketCORSRules
抛出：
OSSException
ClientException

optionsObject

public com.aliyun.common.comm.ResponseMessage optionsObject(OptionsRequest request)
                                                     throws OSSException,
                                                            ClientException
从接口 OSS 复制的描述
option object

指定者：
接口 OSS 中的 optionsObject
返回：
抛出：
OSSException
ClientException

setBucketLogging

public void setBucketLogging(SetBucketLoggingRequest request)
                      throws OSSException,
                             ClientException
指定者：
接口 OSS 中的 setBucketLogging
抛出：
OSSException
ClientException

getBucketLogging

public BucketLoggingResult getBucketLogging(String bucketName)
从接口 OSS 复制的描述
查看Bucket的访问日志配置。

指定者：
接口 OSS 中的 getBucketLogging
返回：

deleteBucketLogging

public void deleteBucketLogging(String bucketName)
                         throws OSSException,
                                ClientException
从接口 OSS 复制的描述
关闭Bucket的访问日志记录功能。

指定者：
接口 OSS 中的 deleteBucketLogging
抛出：
OSSException
ClientException

setBucketWebsite

public void setBucketWebsite(SetBucketWebsiteRequest setBucketWebSiteRequest)
                      throws OSSException,
                             ClientException
从接口 OSS 复制的描述
将一个Bucket设置成静态网站托管模式。

指定者：
接口 OSS 中的 setBucketWebsite
抛出：
OSSException
ClientException

getBucketWebsite

public BucketWebsiteResult getBucketWebsite(String bucketName)
                                     throws OSSException,
                                            ClientException
从接口 OSS 复制的描述
获取Bucket的静态网站托管状态。

指定者：
接口 OSS 中的 getBucketWebsite
返回：
抛出：
OSSException
ClientException

deleteBucketWebsite

public void deleteBucketWebsite(String bucketName)
                         throws OSSException,
                                ClientException
从接口 OSS 复制的描述
关闭Bucket的静态网站托管模式。

指定者：
接口 OSS 中的 deleteBucketWebsite
抛出：
OSSException
ClientException
概述  软件包   类  使用  树  已过时  索引  帮助 
 上一个类   下一个类 框架    无框架    
摘要： 嵌套 | 字段 | 构造方法 | 方法 详细信息： 字段 | 构造方法 | 方法
Copyright © 2014. All Rights Reserved.