StorageClient (java-sdk 1.2.2-SNAPSHOT API)

java.lang.Object
- com.sinacloud.storage.StorageBase
- - com.sinacloud.storage.StorageClient

所有已实现的接口:

Storage
```
public class StorageClient
extends StorageBase
implements Storage
```
新浪云容器应用 Storage 服务接口。
Storage是新浪云为开发者提供的分布式对象存储服务，旨在利用新浪云在分布式以及网络技术方面的优势为开发者提供安全、简单、高效的存储服务。
Storage支持文本、多媒体、二进制等任何类型的数据的存储。仅限容器环境中

使用样例：
StroageClient sc = new StroageClient(); // 这里是默认构造，如果不使用当前应用下的storage可以调用传参数构造器new StroageClient(appname,ak,sk)
//创建bucket
sc.createBucket("example_bucket"');
//删除buckete
sc.deleteBucket("example_bucket");
//获取相应bucket信息
Bucket bucket = sc.getBucketInfo();
//列出所有的bucket信息
BucketList bucketList = sc.listBuckets();
//获取bucket下所有的文件列表
ObjectFileList objectFileList = sc.getBucket("example_bucket");
//获取bucket下所有以example_prefix为前缀的文件列表
ObjectFileList objectFileList = sc.getBucket("example_bucket","example_prefix");
//在storage上写一个文件，最后的参数不需要可以传null
sc.putObjectFile("example_bucket","filename","content".getBytes(),metaMap);
//上传一个文件，最后的参数不需要可以传null
sc.putObjectFile("example_bucket","filename",File,metaMap);
//获取一个文件
ObjectFile objcetFile = sc.getObject("example_bucket","filename");
//删除一个文件
sc.deleteObject("example_bucket","filename");

作者:

nero

字段概要
- 从类继承的字段 com.sinacloud.storage.StorageBase
  accessKey, appName, baseurl, DELETE, errMsg, errNo, GET, HEAD, HEADER_DATE_FORMAT, internal_timeout, NORMAL_DATE_FORMAT, POST, PUT, secretKey

构造器概要

构造器
构造器和说明

StorageClient()

StorageClient(String appName, String accessKey, String secertKey)

构造器
构造器和说明
`StorageClient()`
`StorageClient(String appName, String accessKey, String secertKey)`

方法概要

方法
限定符和类型	方法和说明
`boolean`	`createBucket(String bucketName)` 创建一个新的bucket
`boolean`	`deleteBucket(String bucketName)` 删除指定的bucket
`boolean`	`deleteObject(String bucketName, String objectFileName)` 删除指定的object
`ObjectFileList`	`getBucket(String bucketName)` 列出提供的bucket下所有的object列表
`ObjectFileList`	`getBucket(String bucketName, String prefix)` 列出提供的bucket下所有以 prefix 为前缀的object列表
`Bucket`	`getBucketInfo(String bucketName)` 获取bucket相关的信息
`ObjectFile`	`getObject(String bucketName, String objectFileName)` 获取提供的bucket下对应文件名的内容，如果需要获取bucket下某个文件夹的文件请使用"aa/bb"的形式传入文件名
`String`	`getTempUrl(String bucketName, String method, String objectName, int seconds)` 获取一个object临时访问的URL
`BucketList`	`listBuckets()` 列出当前用户下所有的bucket
`boolean`	`putObjectFile(String bucketName, String fileName, byte[] content, Map<String,String> map)` 上传文件到指定的bucket下，content为你需要写入的内容，并且以byte[] 形式，map参数设置acl，如果没有可以直接传null 如果需要put到bucket下某个文件夹下请使用"aa/bb"的形式传入文件名
`boolean`	`putObjectFile(String bucketName, String fileName, File file, Map<String,String> map)` 上传文件到指定的bucket下，file需要已经上传到容器的某个位置，map参数设置acl，如果没有可以直接传null 如果需要put到bucket下某个文件夹下请使用"aa/bb"的形式传入文件名

从类继承的方法 com.sinacloud.storage.StorageBase
getErrmsg, getErrno

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - StorageClient
```
public StorageClient()
```
  - StorageClient
```
public StorageClient(String appName,
             String accessKey,
             String secertKey)
```
- 方法详细资料
  - createBucket
```
public boolean createBucket(String bucketName)
```
    创建一个新的bucket
    
    指定者:
    
    createBucket 在接口中 Storage
    
    参数:
    bucketName -
    
    返回:
    是否创建成功
    
    抛出:
    
    RuntimeException - {"the value of parameter can not be empty!","the bucket has created","reach the upper limit of creating buckets"}
    
    IOException
  - getBucketInfo
```
public Bucket getBucketInfo(String bucketName)
```
    获取bucket相关的信息
    
    指定者:
    
    getBucketInfo 在接口中 Storage
    
    参数:
    bucketName -
    
    返回:
    Bucket
    
    抛出:
    
    IOException
    
    RuntimeException - "the value of parameter can not be empty!"
  - listBuckets
```
public BucketList listBuckets()
```
    列出当前用户下所有的bucket
    
    指定者:
    
    listBuckets 在接口中 Storage
    
    返回:
    BucketList
    
    抛出:
    
    IOException
  - getBucket
```
public ObjectFileList getBucket(String bucketName)
```
    列出提供的bucket下所有的object列表
    
    指定者:
    
    getBucket 在接口中 Storage
    
    参数:
    bucketName -
    
    返回:
    BucketList
    
    抛出:
    
    RuntimeException - "the value of parameter can not be empty!"
    
    IOException
  - getBucket
```
public ObjectFileList getBucket(String bucketName,
                       String prefix)
```
    列出提供的bucket下所有以 prefix 为前缀的object列表
    
    指定者:
    
    getBucket 在接口中 Storage
    
    参数:
    bucketName -
    prefix -
    
    返回:
    ObjectFileList
    
    抛出:
    
    RuntimeException - "the value of parameter can not be empty!"
    
    IOException
  - deleteBucket
```
public boolean deleteBucket(String bucketName)
```
    删除指定的bucket
    
    指定者:
    
    deleteBucket 在接口中 Storage
    
    参数:
    bucketName -
    
    返回:
    是否删除成功
    
    抛出:
    
    RuntimeException - {"the value of parameter can not be empty!","the bucket is not null","the bucket not found or has remove"}
  - putObjectFile
```
public boolean putObjectFile(String bucketName,
                    String fileName,
                    byte[] content,
                    Map<String,String> map)
```
    上传文件到指定的bucket下，content为你需要写入的内容，并且以byte[] 形式，map参数设置acl，如果没有可以直接传null
    如果需要put到bucket下某个文件夹下请使用"aa/bb"的形式传入文件名
    
    指定者:
    
    putObjectFile 在接口中 Storage
    
    参数:
    bucketName -
    fileName -
    content -
    map -
    
    返回:
    是否上传成功
    
    抛出:
    
    RuntimeException - {"the value of parameter can not be empty!","the bucket not found or has remove"}
  - putObjectFile
```
public boolean putObjectFile(String bucketName,
                    String fileName,
                    File file,
                    Map<String,String> map)
```
    上传文件到指定的bucket下，file需要已经上传到容器的某个位置，map参数设置acl，如果没有可以直接传null
    如果需要put到bucket下某个文件夹下请使用"aa/bb"的形式传入文件名
    
    指定者:
    
    putObjectFile 在接口中 Storage
    
    参数:
    bucketName -
    file -
    map -
    
    返回:
    是否上传成功
    
    抛出:
    
    RuntimeException - {"the value of parameter can not be empty!","file does not exist","the bucket not found or has remove"}
  - getObject
```
public ObjectFile getObject(String bucketName,
                   String objectFileName)
```
    获取提供的bucket下对应文件名的内容，如果需要获取bucket下某个文件夹的文件请使用"aa/bb"的形式传入文件名
    
    指定者:
    
    getObject 在接口中 Storage
    
    参数:
    bucketName -
    objectFileName -
    
    返回:
    ObjectFile
    
    抛出:
    
    RuntimeException - {"the value of parameter can not be empty!","object file does not exist in the bucket or has removed"}
  - deleteObject
```
public boolean deleteObject(String bucketName,
                   String objectFileName)
```
    删除指定的object
    
    指定者:
    
    deleteObject 在接口中 Storage
    
    参数:
    bucketName -
    objectFileName -
    
    返回:
    ObjectFile
    
    抛出:
    
    RuntimeException - {"the value of parameter can not be empty!","object file does not exist in the bucket or has removed"}
  - getTempUrl
```
public String getTempUrl(String bucketName,
                String method,
                String objectName,
                int seconds)
```
    获取一个object临时访问的URL
    
    参数:
    bucketName - bucket的名称
    method - http请求方法默认GET
    objectName - object的名称
    seconds - 存活时间，秒数
    
    返回:
    url

类 StorageClient

字段概要

从类继承的字段 com.sinacloud.storage.StorageBase

构造器概要

方法概要

从类继承的方法 com.sinacloud.storage.StorageBase

从类继承的方法 java.lang.Object

构造器详细资料

StorageClient

StorageClient

方法详细资料

createBucket

getBucketInfo

listBuckets

getBucket

getBucket

deleteBucket

putObjectFile

putObjectFile

getObject

deleteObject

getTempUrl