程序包 cn.herodotus.oss.specification.core.repository

接口 OssObjectRepository

public interface OssObjectRepository

Description: Dante Java OSS API 对象操作抽象定义

作者:

: gengwei.zheng

Date:

: 2023/7/24 16:39

方法概要

修饰符和类型	方法	说明
void	deleteObject(DeleteObjectArguments arguments)	删除一个对象
default void	deleteObject(String bucketName, String objectName)	删除一个对象
List<DeleteObjectDomain>	deleteObjects(DeleteObjectsArguments arguments)	批量删除对象
ObjectMetadataDomain	download(DownloadObjectArguments arguments)	下载对象
String	generatePresignedUrl(GeneratePresignedUrlArguments arguments)	创建预签名 URL
default String	generatePresignedUrl(String bucketName, String objectName, Duration expiration)	创建预签名 URL
default String	generatePresignedUrl(String bucketName, String objectName, Duration expiration, HttpMethod method)	创建预签名 URL
GetObjectDomain	getObject(GetObjectArguments arguments)	获取（下载）对象
default GetObjectDomain	getObject(String bucketName, String objectName)	获取（下载）对象
ObjectMetadataDomain	getObjectMetadata(GetObjectMetadataArguments arguments)	获取对象元信息
default ObjectMetadataDomain	getObjectMetadata(String bucketName, String objectName)	获取对象元信息
ListObjectsDomain	listObjects(ListObjectsArguments arguments)	获取对象列表
default ListObjectsDomain	listObjects(String bucketName)	根据存储桶名称获取对象列表
default ListObjectsDomain	listObjects(String bucketName, String prefix)	根据存储桶名称和前缀获取对象列表
ListObjectsV2Domain	listObjectsV2(ListObjectsV2Arguments arguments)	获取对象列表V2
default ListObjectsV2Domain	listObjectsV2(String bucketName)	根据存储桶名称和前缀获取对象列表V2
default ListObjectsV2Domain	listObjectsV2(String bucketName, String prefix)	根据存储桶名称和前缀获取对象列表V2
PutObjectDomain	putObject(PutObjectArguments arguments)	放置（上传）对象
ObjectWriteDomain	upload(UploadObjectArguments arguments)	上传对象

方法详细资料

listObjects

default ListObjectsDomain listObjects(String bucketName)

根据存储桶名称获取对象列表

参数:

bucketName - 存储桶名称

返回:

对象列表结果 ListObjectsDomain

listObjects

default ListObjectsDomain listObjects(String bucketName,
 String prefix)

根据存储桶名称和前缀获取对象列表

参数:

bucketName - 存储桶名

prefix - 前缀

返回:

对象列表结果 ListObjectsDomain

listObjects

ListObjectsDomain listObjects(ListObjectsArguments arguments)

获取对象列表

参数:

arguments - 对象列表请求参数 ListObjectsArguments

返回:

对象列表结果 ListObjectsDomain

listObjectsV2

default ListObjectsV2Domain listObjectsV2(String bucketName)

根据存储桶名称和前缀获取对象列表V2

参数:

bucketName - 存储桶名

返回:

对象列表结果 ListObjectsDomain

listObjectsV2

default ListObjectsV2Domain listObjectsV2(String bucketName,
 String prefix)

根据存储桶名称和前缀获取对象列表V2

参数:

bucketName - 存储桶名

prefix - 前缀

返回:

对象列表结果 ListObjectsV2Domain

listObjectsV2

ListObjectsV2Domain listObjectsV2(ListObjectsV2Arguments arguments)

获取对象列表V2

参数:

arguments - 对象列表请求参数 ListObjectsV2Arguments

返回:

对象列表结果 ListObjectsV2Domain

deleteObject

default void deleteObject(String bucketName,
 String objectName)

删除一个对象

参数:

bucketName - 存储桶名称

objectName - 对象名称

deleteObject

void deleteObject(DeleteObjectArguments arguments)

删除一个对象

参数:

arguments - 删除对象请求参数 DeleteObjectArguments

deleteObjects

List<DeleteObjectDomain> deleteObjects(DeleteObjectsArguments arguments)

批量删除对象

参数:

arguments - 批量删除对象请求参数 DeleteObjectsArguments

返回:

批量删除对象结果对象

getObjectMetadata

default ObjectMetadataDomain getObjectMetadata(String bucketName,
 String objectName)

获取对象元信息

参数:

bucketName - 存储桶名称

objectName - 对象名称

返回:

对象元信息结果对象 ObjectMetadataDomain

getObjectMetadata

ObjectMetadataDomain getObjectMetadata(GetObjectMetadataArguments arguments)

获取对象元信息

参数:

arguments - 获取对象元信息 DeleteObjectsArguments

返回:

对象元信息结果对象 ObjectMetadataDomain

getObject

default GetObjectDomain getObject(String bucketName,
 String objectName)

获取（下载）对象

参数:

bucketName - 存储桶名称

objectName - 对象名称

返回:

获取（下载）对象结果域对象 GetObjectDomain

getObject

GetObjectDomain getObject(GetObjectArguments arguments)

获取（下载）对象

参数:

arguments - 获取（下载）对象请求参数实体 GetObjectArguments

返回:

获取（下载）对象结果域对象 GetObjectDomain

putObject

PutObjectDomain putObject(PutObjectArguments arguments)

放置（上传）对象

参数:

arguments - 放置（上传）对象请求参数实体 PutObjectArguments

返回:

放置（上传）对象结果域对象 PutObjectDomain

generatePresignedUrl

default String generatePresignedUrl(String bucketName,
 String objectName,
 Duration expiration)

创建预签名 URL

参数:

bucketName - 存储桶名称

objectName - 对象名称

expiration - 中止时间

返回:

预签名地址

generatePresignedUrl

default String generatePresignedUrl(String bucketName,
 String objectName,
 Duration expiration,
 HttpMethod method)

创建预签名 URL

参数:

bucketName - 存储桶名称

objectName - 对象名称

expiration - 中止时间

method - http 请求类型

返回:

预签名地址

generatePresignedUrl

String generatePresignedUrl(GeneratePresignedUrlArguments arguments)

创建预签名 URL

参数:

arguments - 创建预签名 URL 请求参数 GeneratePresignedUrlArguments

返回:

预签名地址

download

ObjectMetadataDomain download(DownloadObjectArguments arguments)

下载对象

该方法与getObject不同，该方法要指明具体的文件File 或者文件名。这就意味着可以把该方法理解为服务端下载操作。

参数:

arguments - 下载对象请求参数实体 DownloadObjectArguments

返回:

下载对象结果域对象 ObjectMetadataDomain

upload

ObjectWriteDomain upload(UploadObjectArguments arguments)

上传对象

该方法与putObject不同，该方法要指明具体的文件File 或者文件名。这就意味着可以把该方法理解为服务端下载操作

参数:

arguments - 下载对象请求参数实体 UploadObjectArguments

返回:

下载对象结果域对象 ObjectWriteDomain