com.bimface.sdk.service

类 BdfsService

java.lang.Object

com.bimface.sdk.service.BdfsService

public class BdfsService
extends Object

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

构造器概要

构造器

构造器和说明
BdfsService(Endpoint endpoint, AccessTokenService accessTokenService)
BdfsService(Endpoint endpoint, Config config, AccessTokenService accessTokenService)

方法概要

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

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

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

构造器详细资料

BdfsService

public BdfsService(Endpoint endpoint,
                   AccessTokenService accessTokenService)

BdfsService

public BdfsService(Endpoint endpoint,
                   Config config,
                   AccessTokenService accessTokenService)

方法详细资料

getHubList

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

获取hub列表

参数:

name - hub名称

tenantCode - 租户标识

info - 描述信息

dateTimeFrom - 开始时间

dateTimeTo - 结束时间

返回:

抛出:

com.bimface.exception.BimfaceException

getHubMeta

public com.bimface.bdfs.bean.dto.HubDTO getHubMeta(Long hubId)
                                            throws com.bimface.exception.BimfaceException

获取Hub Meta信息

参数:

hubId - hubId

返回:

单个Hub

抛出:

com.bimface.exception.BimfaceException

createProject

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

创建项目

参数:

hubId -

request - 项目目创建请求

返回:

抛出:

com.bimface.exception.BimfaceException

getProjectList

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

获取项目列表

参数:

hubId -

name - 项目名称

useFuzzySearch - 是否使用模糊查询

返回:

抛出:

com.bimface.exception.BimfaceException

getProjectMeta

public com.bimface.bdfs.bean.dto.ProjectDTO getProjectMeta(String hubId,
                                                           String projectId)
                                                    throws com.bimface.exception.BimfaceException

获取项目信息

参数:

hubId - hubId

projectId - 项目Id

返回:

抛出:

com.bimface.exception.BimfaceException

deleteProject

public com.bimface.bdfs.bean.dto.ProjectDTO deleteProject(String hubId,
                                                          String projectId)
                                                   throws com.bimface.exception.BimfaceException

删除项目

参数:

hubId - hubId

projectId - 项目Id

返回:

抛出:

com.bimface.exception.BimfaceException

updateProject

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

更新项目信息

参数:

hubId - hubId

projectId - 项目Id

updateProjectReq - 更新项目信息请求体

返回:

抛出:

com.bimface.exception.BimfaceException

getProjectRootFolderInfo

public com.bimface.bdfs.bean.dto.FileItemWithPathDTO getProjectRootFolderInfo(String hubId,
                                                                              String projectId)
                                                                       throws com.bimface.exception.BimfaceException

获取项目根文件夹信息

参数:

hubId - hubId

projectId - 项目Id

返回:

抛出:

com.bimface.exception.BimfaceException

createFolder

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

指定目录创建文件夹

参数:

projectId - 项目id

createFolderRequest - 文件夹创建请求

抛出:

com.bimface.exception.BimfaceException

getFolder

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

获取文件夹信息

抛出:

com.bimface.exception.BimfaceException

getChildrenFileItems

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

获取children列表（不包含itemSource）

参数:

projectId - 项目ID

fileItemQueryRequest -

返回:

抛出:

com.bimface.exception.BimfaceException

getFolderPathById

public String getFolderPathById(String projectId,
                                String folderId)
                         throws com.bimface.exception.BimfaceException

根据folderId 获取path

参数:

projectId - 项目ID

folderId - 文件夹ID

返回:

抛出:

com.bimface.exception.BimfaceException

getParent

public com.bimface.bdfs.bean.dto.FileItemDTO getParent(String projectId,
                                                       String folderId)
                                                throws com.bimface.exception.BimfaceException

获取父文件夹

参数:

projectId -

folderId -

返回:

抛出:

com.bimface.exception.BimfaceException

updateFolder

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

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

参数:

projectId - 项目id

updateFolderReq - 更新文件夹请求体

返回:

抛出:

com.bimface.exception.BimfaceException

deleteFolder

public String deleteFolder(String projectId,
                           String folderId,
                           String path)
                    throws com.bimface.exception.BimfaceException

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

参数:

projectId - 项目id

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

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

返回:

抛出:

com.bimface.exception.BimfaceException

uploadFileItem

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

上传文件流

参数:

fileIn - 文件流

projectId - 项目id

parentId - 父文件夹id

parentPath - 父文件夹路径

name - 文件名称

length - 文件大小

sourceId - 源文件id

返回:

抛出:

com.bimface.exception.BimfaceException

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)
                                                  throws com.bimface.exception.BimfaceException

指定外部文件url方式上传

参数:

projectId - 项目ID

parentId - 父文件夹Id

parentPath - 父文件夹路径

name - 文件名称

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

url - sourceUrl

etag - 文件etag

maxLength - maxLength

返回:

抛出:

com.bimface.exception.BimfaceException

createAppendFile

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

创建追加文件

参数:

projectId - 项目ID

parentId - 父文件夹Id

parentPath - 父文件夹路径

name - 文件名称

length - 文件流的长度

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

返回:

抛出:

com.bimface.exception.BimfaceException

getAppendFile

public com.bimface.bdfs.bean.dto.FileItemAppendFileDTO getAppendFile(String projectId,
                                                                     String appendFileId)
                                                              throws com.bimface.exception.BimfaceException

获取追加文件信息 获取FileItemAppendFile

参数:

projectId - 项目ID

appendFileId - 追加上传ID

返回:

抛出:

com.bimface.exception.BimfaceException

appendUpload

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

追加上传文件

参数:

projectId - 项目ID

appendFileId - 父文件夹Id

position - 父文件夹路径

返回:

抛出:

com.bimface.exception.BimfaceException

copyFile

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

复制文件

参数:

projectId - 项目ID

copyFileRequest - 复制文件请求体

返回:

抛出:

com.bimface.exception.BimfaceException

getFileItemPolicy

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

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

参数:

projectId - 项目ID

parentId - 父文件ID

parentPath - 父文件路径

name - 文件名称

sourceId - 调用方的文件源ID

maxLength - 文件流的长度

返回:

抛出:

com.bimface.exception.BimfaceException

getFileItemMeta

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

获取文件信息(不包含itemSource信息)

参数:

projectId - 项目id

fileItemId - 文件id

path - 文件路径

withItemSource - 是否携带fileItemSource信息

返回:

抛出:

com.bimface.exception.BimfaceException

getFileItemStatus

public FileItemUploadStatusBean getFileItemStatus(String projectId,
                                                  String fileItemId,
                                                  String path)
                                           throws com.bimface.exception.BimfaceException

获取文件状态

参数:

projectId - 项目id

fileItemId - 文件id

path - 文件路径

返回:

抛出:

com.bimface.exception.BimfaceException

getDownloadURl

public String getDownloadURl(String projectId,
                             String fileItemId,
                             String path,
                             Integer expireTime)
                      throws com.bimface.exception.BimfaceException

获取文件下载签名URL

参数:

projectId - 项目id

fileItemId - 文件id

path - 文件路径

expireTime - 过期时间

返回:

抛出:

com.bimface.exception.BimfaceException

getFileItemPathById

public String getFileItemPathById(String projectId,
                                  String fileItemId)
                           throws com.bimface.exception.BimfaceException

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

参数:

projectId - 项目ID

fileItemId - 文件ID

返回:

抛出:

com.bimface.exception.BimfaceException

downloadFiles

public String downloadFiles(String projectId,
                            List<String> fileItemIds)
                     throws com.bimface.exception.BimfaceException

打包下载压缩文件

参数:

projectId - 项目ID

fileItemIds - 文件ID

返回:

抛出:

com.bimface.exception.BimfaceException

moveFile

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

移动文件位置

参数:

projectId - 项目ID

moveFileRequest - 移动文件请求体

返回:

抛出:

com.bimface.exception.BimfaceException

fileRename

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

文件重命名

参数:

projectId - 项目ID

updateFileRequest - 更新文件请求体

返回:

抛出:

com.bimface.exception.BimfaceException

batchDeleteFileItems

public void batchDeleteFileItems(String projectId,
                                 List<String> fileItemIds)
                          throws com.bimface.exception.BimfaceException

批量删除文件

参数:

projectId - 项目id

fileItemIds - 文件id集合

抛出:

com.bimface.exception.BimfaceException

initMultipartUpload

public com.bimface.bdfs.bean.dto.v1.multipartupload.InitMultipartUploadDTO initMultipartUpload(String projectId,
                                                                                               com.bimface.bdfs.bean.dto.v1.multipartupload.InitMultipartUploadRequest initMultipartUploadRequest)
                                                                                        throws com.bimface.exception.BimfaceException

创建分片上传任务

参数:

projectId - 项目id

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

抛出:

com.bimface.exception.BimfaceException - BimfaceException

getMultipartSignedUrl

public String getMultipartSignedUrl(String projectId,
                                    com.bimface.bdfs.bean.dto.v1.multipartupload.MultipartSignedUrlRequest multipartSignedUrlRequest)
                             throws com.bimface.exception.BimfaceException

获取分片上传url

参数:

projectId - 项目 id

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

返回:

生成的 signed url

抛出:

com.bimface.exception.BimfaceException

completeMultiPartUpload

public com.bimface.bdfs.bean.dto.v1.FileItemDTOV1 completeMultiPartUpload(String projectId,
                                                                          com.bimface.bdfs.bean.dto.v1.multipartupload.CompleteMultipartUploadRequest completeMultipartUploadRequest)
                                                                   throws com.bimface.exception.BimfaceException

合并分片生成文件

参数:

projectId - 项目 id

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

返回:

返回生成的 FileItem

抛出:

com.bimface.exception.BimfaceException

abortMultiPartUpload

public String abortMultiPartUpload(String projectId,
                                   com.bimface.bdfs.bean.dto.v1.multipartupload.AbortMultipartUploadRequest abortMultipartUploadRequest)
                            throws com.bimface.exception.BimfaceException

终止分片上传任务

参数:

projectId - 项目 id

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

返回:

提示信息

抛出:

com.bimface.exception.BimfaceException

getAllVersions

public com.bimface.page.PagedList<com.bimface.bdfs.bean.dto.FileItemDTO> getAllVersions(String projectId,
                                                                                        String fileItemId,
                                                                                        String path,
                                                                                        Integer pageNo,
                                                                                        Integer pageSize)
                                                                                 throws com.bimface.exception.BimfaceException

获取所有版本文件信息

参数:

projectId - 项目ID

fileItemId - 文件Id

path - 文件路径

pageNo - 开始页码

pageSize - 每页大小

返回:

PagedList

抛出:

com.bimface.exception.BimfaceException

createVersion

public com.bimface.bdfs.bean.dto.FileItemDTO createVersion(InputStream fileIn,
                                                           String projectId,
                                                           String fileItemId,
                                                           String path,
                                                           String name,
                                                           Long length,
                                                           String sourceId)
                                                    throws com.bimface.exception.BimfaceException

上传版本文件

参数:

fileIn - 文件流

projectId - 项目ID

fileItemId - 文件Id

path - 文件路径

name - 文件名称

length - 文件长度

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

返回:

FileItemDTO

抛出:

com.bimface.exception.BimfaceException

getFilePolicy

public com.bimface.bdfs.bean.UploadPolicyResponse getFilePolicy(String projectId,
                                                                String fileItemId,
                                                                String path,
                                                                String name,
                                                                String sourceId,
                                                                Long maxLength)
                                                         throws com.bimface.exception.BimfaceException

获取新版本直传的policy凭证

参数:

projectId - 项目ID

fileItemId - 文件Id

path - 文件路径

name - 文件名称

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

maxLength - 文件流的长度

返回:

UploadPolicyResponse

抛出:

com.bimface.exception.BimfaceException

getVersion

public com.bimface.bdfs.bean.dto.FileItemDTO getVersion(String projectId,
                                                        String fileId,
                                                        Boolean withFileSource)
                                                 throws com.bimface.exception.BimfaceException

获取指定版本文件信息

参数:

projectId - 项目ID

fileId - 文件版本Id

withFileSource - 是否携带itemSource

返回:

FileItemDTO

抛出:

com.bimface.exception.BimfaceException

getVersionSignedUrl

public String getVersionSignedUrl(String projectId,
                                  String fileId,
                                  Integer expireTime)
                           throws com.bimface.exception.BimfaceException

下载指定版本文件

参数:

projectId - 项目ID

fileId - 文件版本Id

expireTime - 有限期，默认3600s

返回:

String

抛出:

com.bimface.exception.BimfaceException

deleteVersion

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

删除指定版本文件

参数:

projectId - 项目ID

fileIds - 文件版本Id

返回:

String

抛出:

com.bimface.exception.BimfaceException