com.bimface.sdk.client

类 BdfsClient

java.lang.Object

com.bimface.sdk.client.AbstractClient

com.bimface.sdk.client.BdfsClient

public class BdfsClient
extends AbstractClient

Created by tangj-i on 2023/3/27.

方法概要

限定符和类型	方法和说明
String	abortMultiPartUpload(@NotNull String projectId, @NotNull com.bimface.bdfs.bean.dto.v1.multipartupload.AbortMultipartUploadRequest abortMultipartUploadRequest, @NotNull String accessToken) 终止分片上传任务
com.bimface.bdfs.bean.dto.FileItemAppendFileDTO	appendUpload(InputStream fileIn, String projectId, String appendFileId, String position, String accessToken) 追加上传文件
void	batchDeleteFileItems(String projectId, List<String> fileItemIds, String accessToken) 批量删除文件
com.bimface.bdfs.bean.dto.v1.FileItemDTOV1	completeMultiPartUpload(@NotNull String projectId, @NotNull com.bimface.bdfs.bean.dto.v1.multipartupload.CompleteMultipartUploadRequest completeMultipartUploadRequest, @NotNull String accessToken) 合并分片生成文件
List<com.bimface.bdfs.bean.dto.FileItemDTO>	copyFile(String projectId, com.bimface.bdfs.bean.CopyFileRequest copyFileRequest, String accessToken) 复制文件
com.bimface.bdfs.bean.dto.FileItemAppendFileDTO	createAppendFile(String projectId, String parentId, String parentPath, String name, Long length, String sourceId, String accessToken) 创建追加文件
com.bimface.bdfs.bean.dto.FileItemDTO	createFolder(String projectId, CreateFolderRequest createFolderRequest, String accessToken) 指定目录创建文件夹
com.bimface.bdfs.bean.dto.ProjectDTO	createProject(String hubId, ProjectCreateRequest request, String accessToken) 创建项目
com.bimface.bdfs.bean.dto.FileItemDTO	createVersion(@NotNull InputStream fileIn, @NotNull String projectId, @NotNull String fileItemId, String path, String name, Long length, String sourceId, @NotNull String accessToken) 上传版本文件
String	deleteFolder(String projectId, String folderId, String path, String accessToken) 删除文件夹 根据folderId(path)删除文件夹
com.bimface.bdfs.bean.dto.ProjectDTO	deleteProject(String hubId, String projectId, String accessToken) 删除项目
String	deleteVersion(@NotNull String projectId, @NotNull List<String> fileIds, @NotNull String accessToken) 删除指定版本文件
String	downloadFiles(String projectId, List<String> fileItemIds, String accessToken) 打包下载压缩文件
com.bimface.bdfs.bean.dto.FileItemDTO	fileRename(String projectId, com.bimface.bdfs.bean.UpdateFileRequest updateFileRequest, String accessToken) 文件重命名
com.bimface.page.PagedList<com.bimface.bdfs.bean.dto.FileItemDTO>	getAllVersions(@NotNull String projectId, @NotNull String fileItemId, @NotNull String path, Integer pageNo, Integer pageSize, @NotNull String accessToken) 获取所有版本文件信息
com.bimface.bdfs.bean.dto.FileItemAppendFileDTO	getAppendFile(String projectId, String appendFileId, String accessToken) 获取追加文件信息 获取FileItemAppendFile
static BdfsClient	getBdfsClient(String bdfsBaseUrl)
static BdfsClient	getBdfsClient(String bdfsBaseUrl, Config config)
com.bimface.page.PagedList<com.bimface.bdfs.bean.dto.FileItemDTO>	getChildrenFileItems(String projectId, FileItemQueryRequest fileItemQueryRequest, String accessToken) 获取children列表（不包含itemSource）
String	getDownloadURl(String projectId, String fileItemId, String path, Integer expireTime, String accessToken) 获取文件下载签名URL
com.bimface.bdfs.bean.dto.FileItemDTO	getFileItemMeta(String projectId, String fileItemId, String path, Boolean withItemSource, String accessToken) 获取文件信息
String	getFileItemPathById(String projectId, String fileItemId, String accessToken) 获取文件路径 根据fileItemId获取fileItemPath
com.bimface.bdfs.bean.UploadPolicyResponse	getFileItemPolicy(String projectId, String parentId, String parentPath, String name, String sourceId, Long maxLength, String accessToken) 获取文件直传的policy凭证 获取上传file的policy
FileItemUploadStatusBean	getFileItemStatus(String projectId, String fileItemId, String path, String accessToken) 获取文件状态
com.bimface.bdfs.bean.UploadPolicyResponse	getFilePolicy(@NotNull String projectId, @NotNull String fileItemId, @NotNull String path, String name, String sourceId, Long maxLength, @NotNull String accessToken) 获取新版本直传的policy凭证
com.bimface.bdfs.bean.dto.FileItemDTO	getFolder(String projectId, String folderId, String path, String accessToken) 获取文件夹信息
String	getFolderPathById(String projectId, String folderId, String accessToken) 根据folderId 获取文件夹路径
List<com.bimface.bdfs.bean.dto.HubDTO>	getHubList(String name, String tenantCode, String info, String dateTimeFrom, String dateTimeTo, String accessToken) 获取hub列表
com.bimface.bdfs.bean.dto.HubDTO	getHubMeta(Long hubId, String accessToken) 获取Hub Meta信息
String	getMultipartSignedUrl(@NotNull String projectId, @NotNull com.bimface.bdfs.bean.dto.v1.multipartupload.MultipartSignedUrlRequest multipartSignedUrlRequest, @NotNull String accessToken) 获取分片上传url
com.bimface.bdfs.bean.dto.FileItemDTO	getParent(String projectId, String folderId, String accessToken) 获取父文件夹
List<com.bimface.bdfs.bean.dto.ProjectDTO>	getProjectList(String hubId, String name, Boolean useFuzzySearch, String accessToken) 获取项目列表
com.bimface.bdfs.bean.dto.ProjectDTO	getProjectMeta(String hubId, String projectId, String accessToken) 获取项目信息
com.bimface.bdfs.bean.dto.FileItemWithPathDTO	getProjectRootFolderInfo(String hubId, String projectId, String accessToken) 获取项目根文件夹信息
com.bimface.bdfs.bean.dto.FileItemDTO	getVersion(@NotNull String projectId, @NotNull String fileId, Boolean withFileSource, @NotNull String accessToken) 获取指定版本文件信息
String	getVersionSignedUrl(@NotNull String projectId, @NotNull String fileId, Integer expireTime, @NotNull String accessToken) 下载指定版本文件
com.bimface.bdfs.bean.dto.v1.multipartupload.InitMultipartUploadDTO	initMultipartUpload(@NotNull String projectId, @NotNull com.bimface.bdfs.bean.dto.v1.multipartupload.InitMultipartUploadRequest initMultipartUploadRequest, @NotNull String accessToken) 创建分片上传任务
List<com.bimface.bdfs.bean.dto.FileItemDTO>	moveFile(String projectId, com.bimface.bdfs.bean.MoveFileRequest moveFileRequest, String accessToken) 移动文件位置
com.bimface.bdfs.bean.dto.FileItemDTO	updateFolder(String projectId, com.bimface.bdfs.bean.UpdateFolderRequest updateFolderReq, String accessToken) 文件夹重命名 根据folderId(path)更新文件夹
com.bimface.bdfs.bean.dto.ProjectDTO	updateProject(String hubId, String projectId, com.bimface.bdfs.bean.UpdateProjectRequest updateProjectReq, String accessToken) 更新项目信息
com.bimface.bdfs.bean.dto.FileItemDTO	uploadByUrl(String projectId, String parentId, String parentPath, String name, String sourceId, String url, String etag, Long maxLength, String accessToken) 指定外部文件url方式上传
com.bimface.bdfs.bean.dto.FileItemDTO	uploadFileItem(InputStream fileIn, String projectId, String parentId, String parentPath, String name, Long length, String sourceId, String accessToken) 上传文件流

从类继承的方法 com.bimface.sdk.client.AbstractClient

execute, executeCall, generateBasicOAuth, validToken

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

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

方法详细资料

getBdfsClient

public static BdfsClient getBdfsClient(String bdfsBaseUrl)

getBdfsClient

public static BdfsClient getBdfsClient(String bdfsBaseUrl,
                                       Config config)

getHubList

public List<com.bimface.bdfs.bean.dto.HubDTO> getHubList(String name,
                                                         String tenantCode,
                                                         String info,
                                                         String dateTimeFrom,
                                                         String dateTimeTo,
                                                         String accessToken)

获取hub列表

参数:

name - hub名称

tenantCode - 租户标识

info - 描述信息

dateTimeFrom - 开始时间

dateTimeTo - 结束时间

accessToken - accessToken

返回:

getHubMeta

public com.bimface.bdfs.bean.dto.HubDTO getHubMeta(Long hubId,
                                                   String accessToken)

获取Hub Meta信息

参数:

hubId - hubId

accessToken - accessToken

返回:

单个Hub

createProject

public com.bimface.bdfs.bean.dto.ProjectDTO createProject(String hubId,
                                                          ProjectCreateRequest request,
                                                          String accessToken)

创建项目

参数:

hubId -

request - 项目目创建请求

accessToken - accessToken

返回:

getProjectList

public List<com.bimface.bdfs.bean.dto.ProjectDTO> getProjectList(String hubId,
                                                                 String name,
                                                                 Boolean useFuzzySearch,
                                                                 String accessToken)

获取项目列表

参数:

hubId -

name - 项目名称

useFuzzySearch - 是否使用模糊查询

accessToken - accessToken

返回:

getProjectMeta

public com.bimface.bdfs.bean.dto.ProjectDTO getProjectMeta(String hubId,
                                                           String projectId,
                                                           String accessToken)

获取项目信息

参数:

hubId - hubId

projectId - 项目Id

返回:

deleteProject

public com.bimface.bdfs.bean.dto.ProjectDTO deleteProject(String hubId,
                                                          String projectId,
                                                          String accessToken)

删除项目

参数:

hubId - hubId

projectId - 项目Id

返回:

updateProject

public com.bimface.bdfs.bean.dto.ProjectDTO updateProject(String hubId,
                                                          String projectId,
                                                          com.bimface.bdfs.bean.UpdateProjectRequest updateProjectReq,
                                                          String accessToken)

更新项目信息

参数:

hubId - hubId

projectId - 项目Id

updateProjectReq - 更新项目信息请求体

返回:

getProjectRootFolderInfo

public com.bimface.bdfs.bean.dto.FileItemWithPathDTO getProjectRootFolderInfo(String hubId,
                                                                              String projectId,
                                                                              String accessToken)

获取项目根文件夹信息

参数:

hubId - hubId

projectId - 项目Id

返回:

createFolder

public com.bimface.bdfs.bean.dto.FileItemDTO createFolder(String projectId,
                                                          CreateFolderRequest createFolderRequest,
                                                          String accessToken)

指定目录创建文件夹

getFolder

public com.bimface.bdfs.bean.dto.FileItemDTO getFolder(String projectId,
                                                       String folderId,
                                                       String path,
                                                       String accessToken)

获取文件夹信息

getChildrenFileItems

public com.bimface.page.PagedList<com.bimface.bdfs.bean.dto.FileItemDTO> getChildrenFileItems(String projectId,
                                                                                              FileItemQueryRequest fileItemQueryRequest,
                                                                                              String accessToken)

获取children列表（不包含itemSource）

参数:

projectId - 项目ID

fileItemQueryRequest -

accessToken - accessToken

返回:

getFolderPathById

public String getFolderPathById(String projectId,
                                String folderId,
                                String accessToken)

根据folderId 获取文件夹路径

参数:

projectId - 项目ID

folderId - 文件夹ID

accessToken - accessToken

返回:

getParent

public com.bimface.bdfs.bean.dto.FileItemDTO getParent(String projectId,
                                                       String folderId,
                                                       String accessToken)

获取父文件夹

参数:

projectId -

folderId -

accessToken - accessToken

返回:

updateFolder

public com.bimface.bdfs.bean.dto.FileItemDTO updateFolder(String projectId,
                                                          com.bimface.bdfs.bean.UpdateFolderRequest updateFolderReq,
                                                          String accessToken)

文件夹重命名 根据folderId(path)更新文件夹

参数:

projectId - 项目id

updateFolderReq - 更新文件夹请求体

返回:

deleteFolder

public String deleteFolder(String projectId,
                           String folderId,
                           String path,
                           String accessToken)

删除文件夹 根据folderId(path)删除文件夹

参数:

projectId - 项目id

folderId - 文件夹id(folderId和path,必须二选一填入)

path - 文件夹路径,使用URL编码（UTF-8）,最多256个字符(folderId和path,必须二选一填入)

返回:

uploadFileItem

public com.bimface.bdfs.bean.dto.FileItemDTO uploadFileItem(InputStream fileIn,
                                                            String projectId,
                                                            String parentId,
                                                            String parentPath,
                                                            String name,
                                                            Long length,
                                                            String sourceId,
                                                            String accessToken)

上传文件流

参数:

fileIn - 文件流

projectId - 项目id

parentId - 父文件夹id

parentPath - 父文件夹路径

name - 文件名称

length - 文件大小

sourceId - 源文件id

accessToken - accessToken

返回:

uploadByUrl

public com.bimface.bdfs.bean.dto.FileItemDTO uploadByUrl(String projectId,
                                                         String parentId,
                                                         String parentPath,
                                                         String name,
                                                         String sourceId,
                                                         String url,
                                                         String etag,
                                                         Long maxLength,
                                                         String accessToken)

指定外部文件url方式上传

参数:

projectId - 项目ID

parentId - 父文件夹Id

parentPath - 父文件夹路径

name - 文件名称

sourceId - 调用方的文件源ID，不能重复

url - sourceUrl

etag - 文件etag

maxLength - maxLength

accessToken - accessToken

返回:

createAppendFile

public com.bimface.bdfs.bean.dto.FileItemAppendFileDTO createAppendFile(String projectId,
                                                                        String parentId,
                                                                        String parentPath,
                                                                        String name,
                                                                        Long length,
                                                                        String sourceId,
                                                                        String accessToken)

创建追加文件

参数:

projectId - 项目ID

parentId - 父文件夹Id

parentPath - 父文件夹路径

name - 文件名称

length - 文件流的长度

sourceId - 调用方的文件源ID，不能重复

返回:

getAppendFile

public com.bimface.bdfs.bean.dto.FileItemAppendFileDTO getAppendFile(String projectId,
                                                                     String appendFileId,
                                                                     String accessToken)

获取追加文件信息 获取FileItemAppendFile

参数:

projectId - 项目ID

appendFileId - 追加上传ID

返回:

appendUpload

public com.bimface.bdfs.bean.dto.FileItemAppendFileDTO appendUpload(InputStream fileIn,
                                                                    String projectId,
                                                                    String appendFileId,
                                                                    String position,
                                                                    String accessToken)

追加上传文件

参数:

projectId - 项目ID

appendFileId - 父文件夹Id

position - 父文件夹路径

返回:

copyFile

public List<com.bimface.bdfs.bean.dto.FileItemDTO> copyFile(String projectId,
                                                            com.bimface.bdfs.bean.CopyFileRequest copyFileRequest,
                                                            String accessToken)

复制文件

参数:

projectId - 项目ID

copyFileRequest - 复制文件请求体

返回:

getFileItemPolicy

public com.bimface.bdfs.bean.UploadPolicyResponse getFileItemPolicy(String projectId,
                                                                    String parentId,
                                                                    String parentPath,
                                                                    String name,
                                                                    String sourceId,
                                                                    Long maxLength,
                                                                    String accessToken)

获取文件直传的policy凭证 获取上传file的policy

参数:

projectId - 项目ID

parentId - 父文件ID

parentPath - 父文件路径

name - 文件名称

sourceId - 调用方的文件源ID

maxLength - 文件流的长度

返回:

getFileItemMeta

public com.bimface.bdfs.bean.dto.FileItemDTO getFileItemMeta(String projectId,
                                                             String fileItemId,
                                                             String path,
                                                             Boolean withItemSource,
                                                             String accessToken)

获取文件信息

参数:

projectId - 项目id

fileItemId - 文件id

path - 文件路径

withItemSource - 是否携带fileItemSource信息

accessToken -

返回:

getFileItemStatus

public FileItemUploadStatusBean getFileItemStatus(String projectId,
                                                  String fileItemId,
                                                  String path,
                                                  String accessToken)

获取文件状态

参数:

projectId - 项目id

fileItemId - 文件id

path - 文件路径

accessToken - accessToken

返回:

getDownloadURl

public String getDownloadURl(String projectId,
                             String fileItemId,
                             String path,
                             Integer expireTime,
                             String accessToken)

获取文件下载签名URL

参数:

projectId - 项目id

fileItemId - 文件id

path - 文件路径

expireTime - 过期时间

accessToken - accessToken

返回:

getFileItemPathById

public String getFileItemPathById(String projectId,
                                  String fileItemId,
                                  String accessToken)

获取文件路径 根据fileItemId获取fileItemPath

参数:

projectId - 项目ID

fileItemId - 文件ID

返回:

downloadFiles

public String downloadFiles(String projectId,
                            List<String> fileItemIds,
                            String accessToken)

打包下载压缩文件

参数:

projectId - 项目ID

fileItemIds - 文件ID

返回:

moveFile

public List<com.bimface.bdfs.bean.dto.FileItemDTO> moveFile(String projectId,
                                                            com.bimface.bdfs.bean.MoveFileRequest moveFileRequest,
                                                            String accessToken)

移动文件位置

参数:

projectId - 项目ID

moveFileRequest - 移动文件请求体

返回:

fileRename

public com.bimface.bdfs.bean.dto.FileItemDTO fileRename(String projectId,
                                                        com.bimface.bdfs.bean.UpdateFileRequest updateFileRequest,
                                                        String accessToken)

文件重命名

参数:

projectId - 项目ID

updateFileRequest - 更新文件请求体

返回:

batchDeleteFileItems

public void batchDeleteFileItems(String projectId,
                                 List<String> fileItemIds,
                                 String accessToken)

批量删除文件

参数:

projectId - 项目id

fileItemIds - 文件id集合

accessToken - accessToken

initMultipartUpload

public com.bimface.bdfs.bean.dto.v1.multipartupload.InitMultipartUploadDTO initMultipartUpload(@NotNull
                                                                                               @NotNull String projectId,
                                                                                               @NotNull
                                                                                               @NotNull com.bimface.bdfs.bean.dto.v1.multipartupload.InitMultipartUploadRequest initMultipartUploadRequest,
                                                                                               @NotNull
                                                                                               @NotNull String accessToken)

创建分片上传任务

参数:

projectId - 项目id

initMultipartUploadRequest - 初始化分片上传的请求体

accessToken - accessToken

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getMultipartSignedUrl

public String getMultipartSignedUrl(@NotNull
                                    @NotNull String projectId,
                                    @NotNull
                                    @NotNull com.bimface.bdfs.bean.dto.v1.multipartupload.MultipartSignedUrlRequest multipartSignedUrlRequest,
                                    @NotNull
                                    @NotNull String accessToken)

获取分片上传url

参数:

projectId - 项目 id

multipartSignedUrlRequest - 获取分片的 signedUrl的请求体

返回:

生成的 signed url

completeMultiPartUpload

public com.bimface.bdfs.bean.dto.v1.FileItemDTOV1 completeMultiPartUpload(@NotNull
                                                                          @NotNull String projectId,
                                                                          @NotNull
                                                                          @NotNull com.bimface.bdfs.bean.dto.v1.multipartupload.CompleteMultipartUploadRequest completeMultipartUploadRequest,
                                                                          @NotNull
                                                                          @NotNull String accessToken)

合并分片生成文件

参数:

projectId - 项目 id

completeMultipartUploadRequest - 完成分片上传的请求体

返回:

返回生成的 FileItem

abortMultiPartUpload

public String abortMultiPartUpload(@NotNull
                                   @NotNull String projectId,
                                   @NotNull
                                   @NotNull com.bimface.bdfs.bean.dto.v1.multipartupload.AbortMultipartUploadRequest abortMultipartUploadRequest,
                                   @NotNull
                                   @NotNull String accessToken)

终止分片上传任务

参数:

projectId - 项目 id

abortMultipartUploadRequest - 终止分片上传的请求体

返回:

提示信息

getAllVersions

public com.bimface.page.PagedList<com.bimface.bdfs.bean.dto.FileItemDTO> getAllVersions(@NotNull
                                                                                        @NotNull String projectId,
                                                                                        @NotNull
                                                                                        @NotNull String fileItemId,
                                                                                        @NotNull
                                                                                        @NotNull String path,
                                                                                        Integer pageNo,
                                                                                        Integer pageSize,
                                                                                        @NotNull
                                                                                        @NotNull String accessToken)

获取所有版本文件信息

参数:

projectId - 项目ID

fileItemId - 文件Id

path - 文件路径

pageNo - 开始页码

pageSize - 每页大小

返回:

PagedList

createVersion

public com.bimface.bdfs.bean.dto.FileItemDTO createVersion(@NotNull
                                                           @NotNull InputStream fileIn,
                                                           @NotNull
                                                           @NotNull String projectId,
                                                           @NotNull
                                                           @NotNull String fileItemId,
                                                           String path,
                                                           String name,
                                                           Long length,
                                                           String sourceId,
                                                           @NotNull
                                                           @NotNull String accessToken)

上传版本文件

参数:

fileIn - 文件流

projectId - 项目ID

fileItemId - 文件Id

path - 文件路径

name - 文件名称

length - 文件长度

sourceId - 调用方的文件源ID，不能重复

返回:

FileItemDTO

getFilePolicy

public com.bimface.bdfs.bean.UploadPolicyResponse getFilePolicy(@NotNull
                                                                @NotNull String projectId,
                                                                @NotNull
                                                                @NotNull String fileItemId,
                                                                @NotNull
                                                                @NotNull String path,
                                                                String name,
                                                                String sourceId,
                                                                Long maxLength,
                                                                @NotNull
                                                                @NotNull String accessToken)

获取新版本直传的policy凭证

参数:

projectId - 项目ID

fileItemId - 文件Id

path - 文件路径

name - 文件名称

sourceId - 调用方的文件源ID，不能重复

maxLength - 文件流的长度

返回:

UploadPolicyResponse

getVersion

public com.bimface.bdfs.bean.dto.FileItemDTO getVersion(@NotNull
                                                        @NotNull String projectId,
                                                        @NotNull
                                                        @NotNull String fileId,
                                                        Boolean withFileSource,
                                                        @NotNull
                                                        @NotNull String accessToken)

获取指定版本文件信息

参数:

projectId - 项目ID

fileId - 文件版本Id

withFileSource - 是否携带itemSource

返回:

FileItemDTO

getVersionSignedUrl

public String getVersionSignedUrl(@NotNull
                                  @NotNull String projectId,
                                  @NotNull
                                  @NotNull String fileId,
                                  Integer expireTime,
                                  @NotNull
                                  @NotNull String accessToken)

下载指定版本文件

参数:

projectId - 项目ID

fileId - 文件版本Id

expireTime - 有限期，默认3600s

返回:

String

deleteVersion

public String deleteVersion(@NotNull
                            @NotNull String projectId,
                            @NotNull
                            @NotNull List<String> fileIds,
                            @NotNull
                            @NotNull String accessToken)
                     throws com.bimface.exception.BimfaceException

删除指定版本文件

参数:

projectId - 项目ID

fileIds - 文件版本Id

返回:

String

抛出:

com.bimface.exception.BimfaceException