xyz.xuminghai.template

类 AbstractTemplate

java.lang.Object

xyz.xuminghai.template.AbstractTemplate

所有已实现的接口:

Executor

直接已知子类:

BlockClientTemplate, ReactiveClientTemplate

public abstract class AbstractTemplate
extends Object
implements Executor

2021/10/31 23:01 星期日
抽象的客户端模板类，定义了一些共有的属性，和方法或行为

作者:

xuMingHai

字段概要

字段

限定符和类型	字段和说明
static String	DEFAULT_TOP_DIRECTORY 阿里云盘默认的顶级目录

方法概要

限定符和类型	方法和说明
abstract Object	createFolder(CreateFolderRequest createFolderRequest) 创建文件夹
Object	createFolder(String name) 创建文件夹，使用默认的同名策略，自动重命名，使用默认的顶级目录 详细的请求参数请参考：CreateFolderRequest
Object	createFolder(String name, CheckNameEnum checkNameEnum) 创建文件夹，在默认的顶级目录 详细的请求参数请参考：CreateFolderRequest
Object	createFolder(String parentFileId, String name) 创建文件夹，使用默认的同名策略，自动重命名 详细的请求参数请参考：CreateFolderRequest
Object	createFolder(String parentFileId, String name, CheckNameEnum checkNameEnum) 创建文件夹 详细的请求参数请参考：CreateFolderRequest
abstract Object	get(String fileId) 获取单个文件或文件夹的信息
Cache	getCache() 获取缓存实例
abstract Object	getDownloadUrl(String fileId) 获取这个文件的下载参数
Object	list() 获取顶级目录的文件列表 顶级目录：DEFAULT_TOP_DIRECTORY
abstract Object	list(ListRequest listRequest) 自定义请求参数的文件列表获取
Object	list(String folderId) 根据文件夹ID查询这个文件夹下的文件信息 详细请求配置请参考：ListRequest
Object	list(String folderId, OrderByEnum orderByEnum) 根据文件夹ID，查询这个文件夹下的文件信息 详细请求配置请参考：ListRequest
Object	list(String folderId, OrderByEnum orderByEnum, OrderDirectionEnum orderDirectionEnum) 根据文件夹ID，查询这个文件夹下的文件信息 详细请求配置请参考：ListRequest
Object	list(String folderId, OrderDirectionEnum orderDirectionEnum) 根据文件夹ID，查询这个文件夹下的文件信息 详细请求配置请参考：ListRequest
abstract Object	search(SearchRequest searchRequest) 使用自定义的请求参数搜索文件
Object	search(String fileName) 根据文件名搜索文件 详细的请求配置请参考：SearchRequest
Object	search(String fileName, CategoryEnum categoryEnum) 根据文件名搜索文件 详细的请求配置请参考：SearchRequest
Object	search(String fileName, CategoryEnum categoryEnum, OrderByEnum orderByEnum, OrderDirectionEnum orderDirectionEnum) 根据文件名搜索文件 详细的请求配置请参考：SearchRequest
Object	search(String fileName, OrderByEnum orderByEnum, OrderDirectionEnum orderDirectionEnum) 根据文件名搜索文件 详细的请求配置请参考：SearchRequest
abstract Object	trash(String fileId) 将文件移入回收站
Object	update(String fileId, String newFileName) 修改文件名
abstract Object	update(UpdateRequest updateRequest) 修改文件名
Object	uploadFile(Path path) 上传文件，使用默认的顶级目录、同名策略（支持快传和分片上传）
Object	uploadFile(Path path, CheckNameEnum checkNameEnum) 上传文件，使用默认的顶级目录（支持快传和分片上传）
Object	uploadFile(String parentFileId, Path path) 上传文件，使用默认的同名策略（支持快传和分片上传）
abstract Object	uploadFile(String parentFileId, Path path, CheckNameEnum checkNameEnum) 上传文件（支持快传和分片上传）

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

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

字段详细资料

DEFAULT_TOP_DIRECTORY

public static final String DEFAULT_TOP_DIRECTORY

阿里云盘默认的顶级目录

另请参阅:

常量字段值

方法详细资料

getCache

public Cache getCache()

获取缓存实例

返回:

缓存实例，如果没有开启缓存会返回空对象缓存

list

public Object list()

获取顶级目录的文件列表
顶级目录：DEFAULT_TOP_DIRECTORY

返回:

顶级目录下的文件列表

list

public Object list(String folderId)

根据文件夹ID查询这个文件夹下的文件信息
详细请求配置请参考：ListRequest

参数:

folderId - 文件夹ID

返回:

文件列表响应

list

public Object list(String folderId,
                   OrderByEnum orderByEnum)

根据文件夹ID，查询这个文件夹下的文件信息
详细请求配置请参考：ListRequest

参数:

folderId - 文件夹ID

orderByEnum - 根据什么排序，如名称、创建时间。。。

返回:

文件列表响应

list

public Object list(String folderId,
                   OrderDirectionEnum orderDirectionEnum)

根据文件夹ID，查询这个文件夹下的文件信息
详细请求配置请参考：ListRequest

参数:

folderId - 文件夹ID

orderDirectionEnum - 排序方向，升序排列或降序

返回:

文件列表响应

list

public Object list(String folderId,
                   OrderByEnum orderByEnum,
                   OrderDirectionEnum orderDirectionEnum)

根据文件夹ID，查询这个文件夹下的文件信息
详细请求配置请参考：ListRequest

参数:

folderId - 文件夹ID

orderByEnum - 根据什么排序，如名称、创建时间。。。

orderDirectionEnum - 排序方向，升序排列或降序

返回:

文件列表响应

list

public abstract Object list(ListRequest listRequest)

自定义请求参数的文件列表获取

指定者:

list 在接口中 Executor

参数:

listRequest - 文件请求参数

返回:

文件列表响应

search

public Object search(String fileName)

根据文件名搜索文件
详细的请求配置请参考：SearchRequest

参数:

fileName - 文件名

返回:

搜索响应结果。

search

public Object search(String fileName,
                     CategoryEnum categoryEnum)

根据文件名搜索文件
详细的请求配置请参考：SearchRequest

参数:

fileName - 文件名

categoryEnum - 搜索的文件类型，如，图片、视频。。。

返回:

搜索响应结果。

search

public Object search(String fileName,
                     OrderByEnum orderByEnum,
                     OrderDirectionEnum orderDirectionEnum)

根据文件名搜索文件
详细的请求配置请参考：SearchRequest

参数:

fileName - 文件名

orderByEnum - 根据什么排序，如名称、创建时间。。。

orderDirectionEnum - 排序方向，升序排列或降序

返回:

搜索响应结果。

search

public Object search(String fileName,
                     CategoryEnum categoryEnum,
                     OrderByEnum orderByEnum,
                     OrderDirectionEnum orderDirectionEnum)

根据文件名搜索文件
详细的请求配置请参考：SearchRequest

参数:

fileName - 文件名

categoryEnum - 搜索的文件类型，如，图片、视频。。。

orderByEnum - 根据什么排序，如名称、创建时间。。。

orderDirectionEnum - 排序方向，升序排列或降序

返回:

搜索响应结果

search

public abstract Object search(SearchRequest searchRequest)

使用自定义的请求参数搜索文件

指定者:

search 在接口中 Executor

参数:

searchRequest - 自定义搜索请求参数

返回:

搜索响应结果

get

public abstract Object get(String fileId)

获取单个文件或文件夹的信息

指定者:

get 在接口中 Executor

参数:

fileId - 文件ID

返回:

文件信息（可以根据类型转为对应的子类）

getDownloadUrl

public abstract Object getDownloadUrl(String fileId)

获取这个文件的下载参数

指定者:

getDownloadUrl 在接口中 Executor

参数:

fileId - 文件ID

返回:

这个文件的下载参数

createFolder

public Object createFolder(String name)

创建文件夹，使用默认的同名策略，自动重命名，使用默认的顶级目录
详细的请求参数请参考：CreateFolderRequest

参数:

name - 文件夹名

返回:

响应信息

createFolder

public Object createFolder(String parentFileId,
                           String name)

创建文件夹，使用默认的同名策略，自动重命名
详细的请求参数请参考：CreateFolderRequest

参数:

parentFileId - 父目录ID

name - 文件夹名

返回:

响应信息

createFolder

public Object createFolder(String name,
                           CheckNameEnum checkNameEnum)

创建文件夹，在默认的顶级目录
详细的请求参数请参考：CreateFolderRequest

参数:

name - 文件夹名

checkNameEnum - 同名策略

返回:

响应信息

createFolder

public Object createFolder(String parentFileId,
                           String name,
                           CheckNameEnum checkNameEnum)

创建文件夹
详细的请求参数请参考：CreateFolderRequest

参数:

parentFileId - 父目录ID

name - 文件夹名

checkNameEnum - 同名策略

返回:

响应信息

createFolder

public abstract Object createFolder(CreateFolderRequest createFolderRequest)

创建文件夹

指定者:

createFolder 在接口中 Executor

参数:

createFolderRequest - 创建文件夹请求

返回:

响应信息

uploadFile

public Object uploadFile(Path path)

上传文件，使用默认的顶级目录、同名策略（支持快传和分片上传）

参数:

path - 文件路径

返回:

响应信息

uploadFile

public Object uploadFile(String parentFileId,
                         Path path)

上传文件，使用默认的同名策略（支持快传和分片上传）

参数:

path - 文件路径

parentFileId - 父目录ID

返回:

响应信息

uploadFile

public Object uploadFile(Path path,
                         CheckNameEnum checkNameEnum)

上传文件，使用默认的顶级目录（支持快传和分片上传）

参数:

path - 文件路径

checkNameEnum - 同名策略

返回:

响应信息

uploadFile

public abstract Object uploadFile(String parentFileId,
                                  Path path,
                                  CheckNameEnum checkNameEnum)

上传文件（支持快传和分片上传）

指定者:

uploadFile 在接口中 Executor

参数:

parentFileId - 父目录ID

path - 文件路径

checkNameEnum - 同名策略

返回:

响应信息

update

public Object update(String fileId,
                     String newFileName)

修改文件名

参数:

fileId - 文件ID

newFileName - 新的文件名

返回:

响应信息

update

public abstract Object update(UpdateRequest updateRequest)

修改文件名

指定者:

update 在接口中 Executor

参数:

updateRequest - 修改文件名请求参数

返回:

响应信息

trash

public abstract Object trash(String fileId)

将文件移入回收站

指定者:

trash 在接口中 Executor

参数:

fileId - 文件ID

返回:

响应信息