com.qiniu.storage

Class BucketManager

java.lang.Object

com.qiniu.storage.BucketManager

public final class BucketManager
extends java.lang.Object

主要涉及了空间资源管理及批量操作接口的实现，具体的接口规格可以参考 参考文档：资源管理

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BucketManager.BatchOperations 文件管理批量操作指令构建对象
class	BucketManager.FileListIterator 创建文件列表迭代器

Constructor Summary

Constructors

Constructor and Description
BucketManager(Auth auth, Configuration cfg) 构建一个新的 BucketManager 对象

Method Summary

Modifier and Type	Method and Description
Response	batch(BucketManager.BatchOperations operations) 批量文件管理请求
java.lang.String[]	buckets() 获取账号下所有空间名称列表
Response	changeMime(java.lang.String bucket, java.lang.String key, java.lang.String mime) 修改文件的MimeType
Response	changeType(java.lang.String bucket, java.lang.String key, com.qiniu.storage.BucketManager.StorageType type) 修改文件的类型（普通存储或低频存储）
void	copy(java.lang.String fromBucket, java.lang.String fromFileKey, java.lang.String toBucket, java.lang.String toFileKey) 复制文件，要求空间在同一账号下
Response	copy(java.lang.String fromBucket, java.lang.String fromFileKey, java.lang.String toBucket, java.lang.String toFileKey, boolean force) 复制文件，要求空间在同一账号下，可以设置force参数为true强行覆盖空间已有同名文件
BucketManager.FileListIterator	createFileListIterator(java.lang.String bucket, java.lang.String prefix) 根据前缀获取文件列表的迭代器
BucketManager.FileListIterator	createFileListIterator(java.lang.String bucket, java.lang.String prefix, int limit, java.lang.String delimiter) 根据前缀获取文件列表的迭代器
Response	delete(java.lang.String bucket, java.lang.String key) 删除指定空间、文件名的文件
Response	deleteAfterDays(java.lang.String bucket, java.lang.String key, int days) 设置文件的存活时间
java.lang.String[]	domainList(java.lang.String bucket) 获取该空间下所有的domain
static java.lang.String	encodedEntry(java.lang.String bucket) EncodedEntryURI格式，用在不指定key值的情况下
static java.lang.String	encodedEntry(java.lang.String bucket, java.lang.String key) EncodedEntryURI格式，其中 bucket+":"+key 称之为 entry
FetchRet	fetch(java.lang.String url, java.lang.String bucket) 抓取指定地址的文件，以指定名称保存在指定空间 要求指定url可访问，大文件不建议使用此接口抓取。可先下载再上传 如果不指定保存的文件名，那么以文件内容的 etag 作为文件名
FetchRet	fetch(java.lang.String url, java.lang.String bucket, java.lang.String key) 抓取指定地址的文件，已指定名称保存在指定空间 要求指定url可访问，大文件不建议使用此接口抓取。可先下载再上传
FileListing	listFiles(java.lang.String bucket, java.lang.String prefix, java.lang.String marker, int limit, java.lang.String delimiter) 根据前缀获取文件列表
Response	move(java.lang.String fromBucket, java.lang.String fromFileKey, java.lang.String toBucket, java.lang.String toFileKey) 移动文件。要求空间在同一账号下, 可以添加force参数为true强行移动文件。
Response	move(java.lang.String fromBucket, java.lang.String fromFileKey, java.lang.String toBucket, java.lang.String toFileKey, boolean force) 移动文件，要求空间在同一账号下
void	prefetch(java.lang.String bucket, java.lang.String key) 对于设置了镜像存储的空间，从镜像源站抓取指定名称的资源并存储到该空间中 如果该空间中已存在该名称的资源，则会将镜像源站的资源覆盖空间中相同名称的资源
Response	rename(java.lang.String bucket, java.lang.String oldFileKey, java.lang.String newFileKey) 重命名空间中的文件
Response	rename(java.lang.String bucket, java.lang.String oldFileKey, java.lang.String newFileKey, boolean force) 重命名空间中的文件，可以设置force参数为true强行覆盖空间已有同名文件
Response	setImage(java.lang.String bucket, java.lang.String srcSiteUrl) 设置空间的镜像源站
Response	setImage(java.lang.String bucket, java.lang.String srcSiteUrl, java.lang.String host) 设置空间的镜像源站
FileInfo	stat(java.lang.String bucket, java.lang.String fileKey) 获取空间中文件的属性
Response	unsetImage(java.lang.String bucket) 取消空间的镜像源站设置

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BucketManager

public BucketManager(Auth auth,
                     Configuration cfg)

构建一个新的 BucketManager 对象

Parameters:

auth - Auth对象

cfg - Configuration对象

Method Detail

encodedEntry

public static java.lang.String encodedEntry(java.lang.String bucket,
                                            java.lang.String key)

EncodedEntryURI格式，其中 bucket+":"+key 称之为 entry

Parameters:

bucket -

key -

Returns:

UrlSafeBase64.encodeToString(entry)

encodedEntry

public static java.lang.String encodedEntry(java.lang.String bucket)

EncodedEntryURI格式，用在不指定key值的情况下

Parameters:

bucket - 空间名称

Returns:

UrlSafeBase64.encodeToString(bucket)

buckets

public java.lang.String[] buckets()
                           throws QiniuException

获取账号下所有空间名称列表

Returns:

空间名称列表

Throws:

QiniuException

domainList

public java.lang.String[] domainList(java.lang.String bucket)
                              throws QiniuException

获取该空间下所有的domain

Parameters:

bucket -

Returns:

该空间名下的domain

Throws:

QiniuException

createFileListIterator

public BucketManager.FileListIterator createFileListIterator(java.lang.String bucket,
                                                             java.lang.String prefix)

根据前缀获取文件列表的迭代器

Parameters:

bucket - 空间名

prefix - 文件名前缀

Returns:

FileInfo迭代器

createFileListIterator

public BucketManager.FileListIterator createFileListIterator(java.lang.String bucket,
                                                             java.lang.String prefix,
                                                             int limit,
                                                             java.lang.String delimiter)

根据前缀获取文件列表的迭代器

Parameters:

bucket - 空间名

prefix - 文件名前缀

limit - 每次迭代的长度限制，最大1000，推荐值 100

delimiter - 指定目录分隔符，列出所有公共前缀（模拟列出目录效果）。缺省值为空字符串

Returns:

FileInfo迭代器

listFiles

public FileListing listFiles(java.lang.String bucket,
                             java.lang.String prefix,
                             java.lang.String marker,
                             int limit,
                             java.lang.String delimiter)
                      throws QiniuException

根据前缀获取文件列表

Parameters:

bucket - 空间名

prefix - 文件名前缀

marker - 上一次获取文件列表时返回的 marker

limit - 每次迭代的长度限制，最大1000，推荐值 100

delimiter - 指定目录分隔符，列出所有公共前缀（模拟列出目录效果）。缺省值为空字符串

Returns:

Throws:

QiniuException

stat

public FileInfo stat(java.lang.String bucket,
                     java.lang.String fileKey)
              throws QiniuException

获取空间中文件的属性

Parameters:

bucket - 空间名称

fileKey - 文件名称

Returns:

文件属性

Throws:

QiniuException

delete

public Response delete(java.lang.String bucket,
                       java.lang.String key)
                throws QiniuException

删除指定空间、文件名的文件

Parameters:

bucket - 空间名称

key - 文件名称

Throws:

QiniuException

changeMime

public Response changeMime(java.lang.String bucket,
                           java.lang.String key,
                           java.lang.String mime)
                    throws QiniuException

修改文件的MimeType

Parameters:

bucket - 空间名称

key - 文件名称

mime - 文件的新MimeType

Throws:

QiniuException

changeType

public Response changeType(java.lang.String bucket,
                           java.lang.String key,
                           com.qiniu.storage.BucketManager.StorageType type)
                    throws QiniuException

修改文件的类型（普通存储或低频存储）

Parameters:

bucket - 空间名称

key - 文件名称

type - type=0 表示普通存储，type=1 表示低频存存储

Throws:

QiniuException

rename

public Response rename(java.lang.String bucket,
                       java.lang.String oldFileKey,
                       java.lang.String newFileKey,
                       boolean force)
                throws QiniuException

重命名空间中的文件，可以设置force参数为true强行覆盖空间已有同名文件

Parameters:

bucket - 空间名称

oldFileKey - 文件名称

newFileKey - 新文件名

force - 强制覆盖空间中已有同名（和 newFileKey 相同）的文件

Throws:

QiniuException

rename

public Response rename(java.lang.String bucket,
                       java.lang.String oldFileKey,
                       java.lang.String newFileKey)
                throws QiniuException

重命名空间中的文件

Parameters:

bucket - 空间名称

oldFileKey - 文件名称

newFileKey - 新文件名

Throws:

QiniuException

copy

public Response copy(java.lang.String fromBucket,
                     java.lang.String fromFileKey,
                     java.lang.String toBucket,
                     java.lang.String toFileKey,
                     boolean force)
              throws QiniuException

复制文件，要求空间在同一账号下，可以设置force参数为true强行覆盖空间已有同名文件

Parameters:

fromBucket - 源空间名称

fromFileKey - 源文件名称

toBucket - 目的空间名称

toFileKey - 目的文件名称

force - 强制覆盖空间中已有同名（和 toFileKey 相同）的文件

Throws:

QiniuException

copy

public void copy(java.lang.String fromBucket,
                 java.lang.String fromFileKey,
                 java.lang.String toBucket,
                 java.lang.String toFileKey)
          throws QiniuException

复制文件，要求空间在同一账号下

Parameters:

fromBucket - 源空间名称

fromFileKey - 源文件名称

toBucket - 目的空间名称

toFileKey - 目的文件名称

Throws:

QiniuException

move

public Response move(java.lang.String fromBucket,
                     java.lang.String fromFileKey,
                     java.lang.String toBucket,
                     java.lang.String toFileKey,
                     boolean force)
              throws QiniuException

移动文件，要求空间在同一账号下

Parameters:

fromBucket - 源空间名称

fromFileKey - 源文件名称

toBucket - 目的空间名称

toFileKey - 目的文件名称

force - 强制覆盖空间中已有同名（和 toFileKey 相同）的文件

Throws:

QiniuException

move

public Response move(java.lang.String fromBucket,
                     java.lang.String fromFileKey,
                     java.lang.String toBucket,
                     java.lang.String toFileKey)
              throws QiniuException

移动文件。要求空间在同一账号下, 可以添加force参数为true强行移动文件。

Parameters:

fromBucket - 源空间名称

fromFileKey - 源文件名称

toBucket - 目的空间名称

toFileKey - 目的文件名称

Throws:

QiniuException

fetch

public FetchRet fetch(java.lang.String url,
                      java.lang.String bucket)
               throws QiniuException

抓取指定地址的文件，以指定名称保存在指定空间 要求指定url可访问，大文件不建议使用此接口抓取。可先下载再上传 如果不指定保存的文件名，那么以文件内容的 etag 作为文件名

Parameters:

url - 待抓取的文件链接

bucket - 文件抓取后保存的空间

Throws:

QiniuException

fetch

public FetchRet fetch(java.lang.String url,
                      java.lang.String bucket,
                      java.lang.String key)
               throws QiniuException

抓取指定地址的文件，已指定名称保存在指定空间 要求指定url可访问，大文件不建议使用此接口抓取。可先下载再上传

Parameters:

url - 待抓取的文件链接

bucket - 文件抓取后保存的空间

key - 文件抓取后保存的文件名

Throws:

QiniuException

prefetch

public void prefetch(java.lang.String bucket,
                     java.lang.String key)
              throws QiniuException

对于设置了镜像存储的空间，从镜像源站抓取指定名称的资源并存储到该空间中 如果该空间中已存在该名称的资源，则会将镜像源站的资源覆盖空间中相同名称的资源

Parameters:

bucket - 空间名称

key - 文件名称

Throws:

QiniuException

setImage

public Response setImage(java.lang.String bucket,
                         java.lang.String srcSiteUrl)
                  throws QiniuException

设置空间的镜像源站

Parameters:

bucket - 空间名称

srcSiteUrl - 镜像回源地址

Throws:

QiniuException

setImage

public Response setImage(java.lang.String bucket,
                         java.lang.String srcSiteUrl,
                         java.lang.String host)
                  throws QiniuException

设置空间的镜像源站

Parameters:

bucket - 空间名称

srcSiteUrl - 镜像回源地址

host - 镜像回源Host

Throws:

QiniuException

unsetImage

public Response unsetImage(java.lang.String bucket)
                    throws QiniuException

取消空间的镜像源站设置

Parameters:

bucket - 空间名称

Throws:

QiniuException

deleteAfterDays

public Response deleteAfterDays(java.lang.String bucket,
                                java.lang.String key,
                                int days)
                         throws QiniuException

设置文件的存活时间

Parameters:

bucket - 空间名称

key - 文件名称

days - 存活时间，单位：天

Throws:

QiniuException

batch

public Response batch(BucketManager.BatchOperations operations)
               throws QiniuException

批量文件管理请求

Throws:

QiniuException