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.Batch 文件管理操作指令
class	BucketManager.FileListIterator 获取文件列表迭代器

Constructor Summary

Constructors

Constructor and Description
BucketManager(Auth auth)

Method Summary

Modifier and Type	Method and Description
Response	batch(BucketManager.Batch operations) 批量执行文件管理相关操作
java.lang.String[]	buckets() 获取账号下所有空间名列表
void	changeMime(java.lang.String bucket, java.lang.String key, java.lang.String mime) 修改完文件mimeTYpe
void	copy(java.lang.String from_bucket, java.lang.String from_key, java.lang.String to_bucket, java.lang.String to_key) 复制文件。要求空间在同一账号下。
void	copy(java.lang.String from_bucket, java.lang.String from_key, java.lang.String to_bucket, java.lang.String to_key, 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) 根据前缀获取文件列表的迭代器
void	delete(java.lang.String bucket, java.lang.String key) 删除指定空间、文件名的文件
static java.lang.String	entry(java.lang.String bucket, java.lang.String key) EncodedEntryURI格式
static java.lang.String	entry(java.lang.String bucket, java.lang.String key, boolean mustHaveKey) EncodedEntryURI格式 当 mustHaveKey 为 false， 且 key 为 null 时，返回 urlsafe_base64_encode(Bucket); 其它条件下返回 urlsafe_base64_encode(Bucket:Key)
DefaultPutRet	fetch(java.lang.String url, java.lang.String bucket) 抓取指定地址的文件，已指定名称保存在指定空间。 要求指定url可访问。 大文件不建议使用此接口抓取。可先下载再上传。
DefaultPutRet	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) 根据前缀获取文件列表
void	move(java.lang.String from_bucket, java.lang.String from_key, java.lang.String to_bucket, java.lang.String to_key) 移动文件。要求空间在同一账号下。
void	move(java.lang.String from_bucket, java.lang.String from_key, java.lang.String to_bucket, java.lang.String to_key, boolean force) 移动文件。要求空间在同一账号下, 可以添加force参数为true强行移动文件。
void	prefetch(java.lang.String bucket, java.lang.String key) 对于设置了镜像存储的空间，从镜像源站抓取指定名称的资源并存储到该空间中。 如果该空间中已存在该名称的资源，则会将镜像源站的资源覆盖空间中相同名称的资源
void	rename(java.lang.String bucket, java.lang.String oldname, java.lang.String newname) 修改指定空间、文件的文件名
FileInfo	stat(java.lang.String bucket, java.lang.String key) 获取指定空间、文件名的状态

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)

Method Detail

entry

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

EncodedEntryURI格式

Parameters:

bucket -

key -

Returns:

urlsafe_base64_encode(Bucket:Key)

entry

public static java.lang.String entry(java.lang.String bucket,
                                     java.lang.String key,
                                     boolean mustHaveKey)

EncodedEntryURI格式 当 mustHaveKey 为 false， 且 key 为 null 时，返回 urlsafe_base64_encode(Bucket); 其它条件下返回 urlsafe_base64_encode(Bucket:Key)

Parameters:

bucket -

key -

mustHaveKey -

Returns:

urlsafe_base64_encode(entry)

buckets

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

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

Returns:

bucket 列表

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 key)
              throws QiniuException

获取指定空间、文件名的状态

Parameters:

bucket -

key -

Returns:

Throws:

QiniuException

delete

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

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

Parameters:

bucket -

key -

Throws:

QiniuException

rename

public void rename(java.lang.String bucket,
                   java.lang.String oldname,
                   java.lang.String newname)
            throws QiniuException

修改指定空间、文件的文件名

Parameters:

bucket -

oldname -

newname -

Throws:

QiniuException

copy

public void copy(java.lang.String from_bucket,
                 java.lang.String from_key,
                 java.lang.String to_bucket,
                 java.lang.String to_key)
          throws QiniuException

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

Parameters:

from_bucket -

from_key -

to_bucket -

to_key -

Throws:

QiniuException

copy

public void copy(java.lang.String from_bucket,
                 java.lang.String from_key,
                 java.lang.String to_bucket,
                 java.lang.String to_key,
                 boolean force)
          throws QiniuException

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

Parameters:

from_bucket -

from_key -

to_bucket -

to_key -

force -

Throws:

QiniuException

move

public void move(java.lang.String from_bucket,
                 java.lang.String from_key,
                 java.lang.String to_bucket,
                 java.lang.String to_key)
          throws QiniuException

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

Parameters:

from_bucket -

from_key -

to_bucket -

to_key -

Throws:

QiniuException

move

public void move(java.lang.String from_bucket,
                 java.lang.String from_key,
                 java.lang.String to_bucket,
                 java.lang.String to_key,
                 boolean force)
          throws QiniuException

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

Parameters:

from_bucket -

from_key -

to_bucket -

to_key -

force -

Throws:

QiniuException

changeMime

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

修改完文件mimeTYpe

Parameters:

bucket -

key -

mime -

Throws:

QiniuException

fetch

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

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

Parameters:

url -

bucket -

Throws:

QiniuException

fetch

public DefaultPutRet 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

batch

public Response batch(BucketManager.Batch operations)
               throws QiniuException

批量执行文件管理相关操作

Parameters:

operations -

Returns:

Throws:

QiniuException

See Also:

BucketManager.Batch