cn.stylefeng.roses.kernel.file.api.FileOperatorApi Maven / Gradle / Ivy
/*
* Copyright [2020-2030] [https://www.stylefeng.cn]
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Guns采用APACHE LICENSE 2.0开源协议，您在使用过程中，需要注意以下几点：
*
* 1.请不要删除和修改根目录下的LICENSE文件。
* 2.请不要删除和修改Guns源码头部的版权声明。
* 3.请保留源码和相关描述文件的项目出处，作者声明等。
* 4.分发源码时候，请注明软件出处 https://gitee.com/stylefeng/guns
* 5.在修改包名，模块名称，项目代码等时，请注明软件出处 https://gitee.com/stylefeng/guns
* 6.若您的项目无法满足以上几点，可申请商业授权
*/
package cn.stylefeng.roses.kernel.file.api;
import cn.stylefeng.roses.kernel.file.api.enums.BucketAuthEnum;
import cn.stylefeng.roses.kernel.file.api.enums.FileLocationEnum;
import java.io.InputStream;
/**
* 文件操纵者（内网操作）
*
* 如果存在未包含的操作，可以调用getClient()自行获取client进行操作
*
* @author fengshuonan
* @since 2020/10/26 10:33
*/
public interface FileOperatorApi {
/**
* 初始化操作的客户端
*
* @author fengshuonan
* @since 2020/10/26 10:33
*/
void initClient();
/**
* 销毁操作的客户端
*
* @author fengshuonan
* @since 2020/10/26 10:33
*/
void destroyClient();
/**
* 获取操作的客户端
*
* 例如，获取阿里云的客户端com.aliyun.oss.OSS
*
* @author fengshuonan
* @since 2020/10/26 10:35
*/
Object getClient();
/**
* 查询存储桶是否存在
*
* 例如：传入参数exampleBucket-1250000000，返回true代表存在此桶BucketAuthEnum.java
*
* @param bucketName 存储桶名称
* @return boolean true-存在，false-不存在
* @author fengshuonan
* @since 2020/10/26 10:36
*/
boolean doesBucketExist(String bucketName);
/**
* 设置预定义策略
*
* 预定义策略如公有读、公有读写、私有读
*
* @param bucketName 存储桶名称
* @param bucketAuthEnum 存储桶的权限
* @author fengshuonan
* @since 2020/10/26 10:37
*/
void setBucketAcl(String bucketName, BucketAuthEnum bucketAuthEnum);
/**
* 判断是否存在文件
*
* @param bucketName 桶名称
* @param key 唯一标示id，例如a.txt, doc/a.txt
* @return true-存在文件，false-不存在文件
* @author fengshuonan
* @since 2020/10/26 10:38
*/
boolean isExistingFile(String bucketName, String key);
/**
* 存储文件
*
* @param bucketName 桶名称
* @param key 唯一标示id，例如a.txt, doc/a.txt
* @param bytes 文件字节数组
* @author fengshuonan
* @since 2020/10/26 10:39
*/
void storageFile(String bucketName, String key, byte[] bytes);
/**
* 存储文件（存放到指定的bucket里边）
*
* @param bucketName 桶名称
* @param key 唯一标示id，例如a.txt, doc/a.txt
* @param inputStream 文件流
* @author fengshuonan
* @since 2020/10/26 10:39
*/
void storageFile(String bucketName, String key, InputStream inputStream);
/**
* 获取某个bucket下的文件字节
*
* @param bucketName 桶名称
* @param key 唯一标示id，例如a.txt, doc/a.txt
* @return byte[] 字节数组为文件的字节数组
* @author fengshuonan
* @since 2020/10/26 10:39
*/
byte[] getFileBytes(String bucketName, String key);
/**
* 文件访问权限管理
*
* @param bucketName 桶名称
* @param key 唯一标示id，例如a.txt, doc/a.txt
* @param bucketAuthEnum 文件权限
* @author fengshuonan
* @since 2020/10/26 10:40
*/
void setFileAcl(String bucketName, String key, BucketAuthEnum bucketAuthEnum);
/**
* 拷贝文件
*
* @param originBucketName 源文件桶
* @param originFileKey 源文件名称
* @param newBucketName 新文件桶
* @param newFileKey 新文件名称
* @author fengshuonan
* @since 2020/10/26 10:40
*/
void copyFile(String originBucketName, String originFileKey, String newBucketName, String newFileKey);
/**
* 获取文件的下载地址（带鉴权的），生成外网地址
*
* @param bucketName 文件桶
* @param key 文件唯一标识
* @param timeoutMillis url失效时间，单位毫秒
* @return 外部系统可以直接访问的url
* @author fengshuonan
* @since 2020/10/26 10:40
*/
String getFileAuthUrl(String bucketName, String key, Long timeoutMillis);
/**
* 获取文件的下载地址（不带鉴权的），生成外网地址
*
* @param bucketName 文件桶
* @param key 文件唯一标识
* @return 外部系统可以直接访问的url
* @author fengshuonan
* @since 2021/6/10 12:03
*/
String getFileUnAuthUrl(String bucketName, String key);
/**
* 删除文件
*
* @param bucketName 文件桶
* @param key 文件唯一标识
* @author fengshuonan
* @since 2020/10/26 10:42
*/
void deleteFile(String bucketName, String key);
/**
* 获取当前api的文件存储类型
*
* @author fengshuonan
* @since 2022/1/2 20:50
*/
FileLocationEnum getFileLocationEnum();
}