com.github.guang19.cosservice.template.buckettemplate.COSBucketTemplate Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cloud-storage-service Show documentation

There is a newer version: 1.0.3

Show newest version

package com.github.guang19.cosservice.template.buckettemplate;

import java.util.List;
import java.util.Map;

/**
 * @author yangguang
 * @date 2020/2/3
 * @description 
 *               COS存储桶操作模板
 *               不过个人不建议使用API操作存储桶
 *               毕竟不是特别方便和直观,还是使用控制台创建好
 *               
 *             如果是腾讯云,此模板下的所有bucketName参数,无需填写APPID,只需要前缀名字
 */
public interface COSBucketTemplate
{


    /**
     *
     * 获取当前地域下的所有存储桶
     * 如果是阿里云OSS服务,那么使用自定义域名时无法使用listBuckets方法。
     * @return          存储桶集合
     */
    public List getAllBuckets();

    /**
     * 获取存储桶的位置
     * @param bucketName 存储桶名
     * @return          存储桶位置,也就是region {@link com.qcloud.cos.region.Region}
     */
    public String getBucketLocation(String bucketName);

    /**
     *获取存储桶的访问权限控制列表
     * @param bucketName    存储桶名
     * @return              访问权限控制列表
     *                       
     *                           Map:
     *                           owner: xxx
     *                           grants:xxx
     *                       
     */
    public Map getBucketAccessControllerList(String bucketName);

    /**
     * 判断存储桶是否存在
     * @param bucketName    存储桶名
     * @return              存储桶是否存在
     */
    public boolean existBucket(String bucketName);

    /**
     * 删除存储桶
     * @param bucketName    存储桶名
     */
    public void deleteBucket(String bucketName);

    /**
     * 关闭cos客户端会话
     */
    public void close();
}