com.qiniu.storage

类 BucketManager

java.lang.Object

com.qiniu.storage.BucketManager

public final class BucketManager
extends java.lang.Object

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

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	BucketManager.BatchOperations 文件管理批量操作指令构建对象
class	BucketManager.FileListIterator 创建文件列表迭代器

构造器概要

构造器

构造器和说明
BucketManager(Auth auth, Client client)
BucketManager(Auth auth, Configuration cfg) 构建一个新的 BucketManager 对象

方法概要

限定符和类型	方法和说明
Response	asynFetch(java.lang.String url, java.lang.String bucket, java.lang.String key) 异步第三方资源抓取 从指定 URL 抓取资源，并将该资源存储到指定空间中。
Response	asynFetch(java.lang.String url, java.lang.String bucket, java.lang.String key, java.lang.String md5, java.lang.String etag, java.lang.String callbackurl, java.lang.String callbackbody, java.lang.String callbackbodytype, java.lang.String callbackhost, java.lang.String fileType) 异步第三方资源抓取 从指定 URL 抓取资源，并将该资源存储到指定空间中。
Response	batch(BucketManager.BatchOperations operations) 批量文件管理请求
java.lang.String[]	buckets() 获取账号下所有空间名称列表
Response	changeHeaders(java.lang.String bucket, java.lang.String key, java.util.Map<java.lang.String,java.lang.String> headers) 修改文件的元数据
Response	changeMime(java.lang.String bucket, java.lang.String key, java.lang.String mime) 修改文件的MimeType
Response	changeStatus(java.lang.String bucket, java.lang.String key, int status) 修改文件的状态（禁用或者正常）
Response	changeType(java.lang.String bucket, java.lang.String key, StorageType type) 修改文件的类型（普通存储或低频存储）
Response	checkAsynFetchid(java.lang.String region, java.lang.String fetchWorkId) 查询异步抓取任务
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强行覆盖空间已有同名文件
void	createBucket(java.lang.String bucketName, java.lang.String region)
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) 设置文件的存活时间
void	deleteBucket(java.lang.String bucketname)
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可访问，大文件不建议使用此接口抓取。
FetchRet	fetch(java.lang.String url, java.lang.String bucket, java.lang.String key) 抓取指定地址的文件，以指定名称保存在指定空间 要求指定url可访问，大文件不建议使用此接口抓取。
BucketInfo	getBucketInfo(java.lang.String bucket)
FileListing	listFiles(java.lang.String bucket, java.lang.String prefix, java.lang.String marker, int limit, java.lang.String delimiter)
FileListing	listFilesV2(java.lang.String bucket, java.lang.String prefix, java.lang.String marker, int limit, java.lang.String delimiter)
Response	listV1(java.lang.String bucket, java.lang.String prefix, java.lang.String marker, int limit, java.lang.String delimiter) 列举空间文件 v1 接口，返回一个 response 对象。
Response	listV2(java.lang.String bucket, java.lang.String prefix, java.lang.String marker, int limit, java.lang.String delimiter) 列举空间文件 v2 接口，返回一个 response 对象。
Response	move(java.lang.String fromBucket, java.lang.String fromFileKey, java.lang.String toBucket, java.lang.String toFileKey) 移动文件。
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强行覆盖空间已有同名文件
void	setBucketAcl(java.lang.String bucket, AclType acl)
Response	setImage(java.lang.String bucket, java.lang.String srcSiteUrl) 设置空间的镜像源站
Response	setImage(java.lang.String bucket, java.lang.String srcSiteUrl, java.lang.String host) 设置空间的镜像源站
void	setIndexPage(java.lang.String bucket, IndexPageType type)
FileInfo	stat(java.lang.String bucket, java.lang.String fileKey) 获取空间中文件的属性
Response	unsetImage(java.lang.String bucket) 取消空间的镜像源站设置

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

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

构造器详细资料

BucketManager

public BucketManager(Auth auth,
                     Configuration cfg)

构建一个新的 BucketManager 对象

参数:

auth - Auth对象

cfg - Configuration对象

BucketManager

public BucketManager(Auth auth,
                     Client client)

方法详细资料

encodedEntry

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

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

参数:

bucket -

key -

返回:

UrlSafeBase64.encodeToString(entry)

encodedEntry

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

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

参数:

bucket - 空间名称

返回:

UrlSafeBase64.encodeToString(bucket)

buckets

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

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

返回:

空间名称列表

抛出:

QiniuException

createBucket

public void createBucket(java.lang.String bucketName,
                         java.lang.String region)
                  throws QiniuException

抛出:

QiniuException

deleteBucket

public void deleteBucket(java.lang.String bucketname)
                  throws QiniuException

抛出:

QiniuException

domainList

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

获取该空间下所有的domain

参数:

bucket -

返回:

该空间名下的domain

抛出:

QiniuException

createFileListIterator

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

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

参数:

bucket - 空间名

prefix - 文件名前缀

返回:

FileInfo迭代器

createFileListIterator

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

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

参数:

bucket - 空间名

prefix - 文件名前缀

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

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

返回:

FileInfo迭代器

listV1

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

列举空间文件 v1 接口，返回一个 response 对象。

参数:

bucket - 空间名

prefix - 文件名前缀

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

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

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

返回:

抛出:

QiniuException

listFiles

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

抛出:

QiniuException

listV2

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

列举空间文件 v2 接口，返回一个 response 对象。v2 接口可以避免由于大量删除导致的列举超时问题，返回的 response 对象中的 body 可以转换为 string stream 来处理。

参数:

bucket - 空间名

prefix - 文件名前缀

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

limit - 每次迭代的长度限制，推荐值 10000

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

返回:

Response 返回一个 okhttp response 对象

抛出:

QiniuException

listFilesV2

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

抛出:

QiniuException

stat

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

获取空间中文件的属性

参数:

bucket - 空间名称

fileKey - 文件名称

返回:

文件属性

抛出:

QiniuException

delete

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

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

参数:

bucket - 空间名称

key - 文件名称

抛出:

QiniuException

changeMime

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

修改文件的MimeType

参数:

bucket - 空间名称

key - 文件名称

mime - 文件的新MimeType

抛出:

QiniuException

changeHeaders

public Response changeHeaders(java.lang.String bucket,
                              java.lang.String key,
                              java.util.Map<java.lang.String,java.lang.String> headers)
                       throws QiniuException

修改文件的元数据

参数:

bucket - 空间名称

key - 文件名称

headers - 需要修改的文件元数据

抛出:

QiniuException

changeType

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

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

参数:

bucket - 空间名称

key - 文件名称

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

抛出:

QiniuException

changeStatus

public Response changeStatus(java.lang.String bucket,
                             java.lang.String key,
                             int status)
                      throws QiniuException

修改文件的状态（禁用或者正常）

参数:

bucket - 空间名称

key - 文件名称

status - 0表示启用；1表示禁用。

抛出:

QiniuException

rename

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

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

参数:

bucket - 空间名称

oldFileKey - 文件名称

newFileKey - 新文件名

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

抛出:

QiniuException

rename

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

重命名空间中的文件

参数:

bucket - 空间名称

oldFileKey - 文件名称

newFileKey - 新文件名

抛出:

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强行覆盖空间已有同名文件

参数:

fromBucket - 源空间名称

fromFileKey - 源文件名称

toBucket - 目的空间名称

toFileKey - 目的文件名称

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

抛出:

QiniuException

copy

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

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

参数:

fromBucket - 源空间名称

fromFileKey - 源文件名称

toBucket - 目的空间名称

toFileKey - 目的文件名称

抛出:

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

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

参数:

fromBucket - 源空间名称

fromFileKey - 源文件名称

toBucket - 目的空间名称

toFileKey - 目的文件名称

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

抛出:

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强行移动文件。

参数:

fromBucket - 源空间名称

fromFileKey - 源文件名称

toBucket - 目的空间名称

toFileKey - 目的文件名称

抛出:

QiniuException

fetch

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

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

参数:

url - 待抓取的文件链接

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

抛出:

QiniuException

fetch

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

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

参数:

url - 待抓取的文件链接

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

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

抛出:

QiniuException

asynFetch

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

异步第三方资源抓取 从指定 URL 抓取资源，并将该资源存储到指定空间中。每次只抓取一个文件，抓取时可以指定保存空间名和最终资源名。 主要对于大文件进行抓取 https://developer.qiniu.com/kodo/api/4097/asynch-fetch

参数:

url - 待抓取的文件链接，支持设置多个,以';'分隔

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

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

返回:

Response

抛出:

QiniuException

asynFetch

public Response asynFetch(java.lang.String url,
                          java.lang.String bucket,
                          java.lang.String key,
                          java.lang.String md5,
                          java.lang.String etag,
                          java.lang.String callbackurl,
                          java.lang.String callbackbody,
                          java.lang.String callbackbodytype,
                          java.lang.String callbackhost,
                          java.lang.String fileType)
                   throws QiniuException

异步第三方资源抓取 从指定 URL 抓取资源，并将该资源存储到指定空间中。每次只抓取一个文件，抓取时可以指定保存空间名和最终资源名。 https://developer.qiniu.com/kodo/api/4097/asynch-fetch 提供更多参数的抓取 可以对抓取文件进行校验 和自定义抓取回调地址等

参数:

url - 待抓取的文件链接，支持设置多个,以';'分隔

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

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

md5 - 文件md5,传入以后会在存入存储时对文件做校验，校验失败则不存入指定空间

etag - 文件etag,传入以后会在存入存储时对文件做校验，校验失败则不存入指定空间

callbackurl - 回调URL，详细解释请参考上传策略中的callbackUrl

callbackbody - 回调Body，如果callbackurl不为空则必须指定。与普通上传一致支持魔法变量，

callbackbodytype - 回调Body内容类型,默认为"application/x-www-form-urlencoded"，

callbackhost - 回调时使用的Host

fileType - 存储文件类型 0:正常存储(默认),1:低频存储

返回:

Response

抛出:

QiniuException

checkAsynFetchid

public Response checkAsynFetchid(java.lang.String region,
                                 java.lang.String fetchWorkId)
                          throws QiniuException

查询异步抓取任务

参数:

region - 抓取任务所在bucket区域 华东 z0 华北 z1 华南 z2 北美 na0 东南亚 as0

fetchWorkId - 抓取任务id

返回:

Response

抛出:

QiniuException

prefetch

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

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

参数:

bucket - 空间名称

key - 文件名称

抛出:

QiniuException

setImage

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

设置空间的镜像源站

参数:

bucket - 空间名称

srcSiteUrl - 镜像回源地址

抛出:

QiniuException

setImage

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

设置空间的镜像源站

参数:

bucket - 空间名称

srcSiteUrl - 镜像回源地址

host - 镜像回源Host

抛出:

QiniuException

unsetImage

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

取消空间的镜像源站设置

参数:

bucket - 空间名称

抛出:

QiniuException

deleteAfterDays

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

设置文件的存活时间

参数:

bucket - 空间名称

key - 文件名称

days - 存活时间，单位：天

抛出:

QiniuException

setBucketAcl

public void setBucketAcl(java.lang.String bucket,
                         AclType acl)
                  throws QiniuException

抛出:

QiniuException

getBucketInfo

public BucketInfo getBucketInfo(java.lang.String bucket)
                         throws QiniuException

抛出:

QiniuException

setIndexPage

public void setIndexPage(java.lang.String bucket,
                         IndexPageType type)
                  throws QiniuException

抛出:

QiniuException

batch

public Response batch(BucketManager.BatchOperations operations)
               throws QiniuException

批量文件管理请求

抛出:

QiniuException