程序包 net.sohelp.boot.engine.web.controller

类 EngineImportController

java.lang.Object

net.sohelp.boot.admin.core.base.BaseController

net.sohelp.boot.engine.web.controller.EngineImportController

@RestController("engine-web-import")
@RequestMapping("/engine/web/import")
@ConditionalOnExpression("${sohelp-boot.engine.enabled:true} && ${sohelp-boot.engine.import.enabled:true}")
public class EngineImportController
extends BaseController

引擎批量导出

从以下版本开始:

2023/8/17 20:06

作者:

AaronFung

字段概要

从类继承的字段 net.sohelp.boot.admin.core.base.BaseController

request, response

构造器概要

构造器

构造器	说明
EngineImportController()

方法概要

修饰符和类型	方法	说明
ApiResult<Object>	confirm(Map<String,Object> dataMap)	确认导入接口 该接口用于确认导入操作，通过传入的refid进行地址和模块操作权限的验证。
ApiResult<String>	download(Map<String,Object> dataMap)
void	downloadImportTemplate(jakarta.servlet.http.HttpServletResponse response, Map<String,Object> dataMap)	下载导入模板 根据GridVO.importConfig.fields生成导入模板
ApiResult<Pager<Map<String,Object>>>	history(String refid, String keywords)	获取导入历史接口 该接口用于获取指定引用ID的导入历史记录
ApiResult<Pager<Map<String,Object>>>	preview(Map<String,Object> paramMap)	批量导入数据预览接口 该接口用于通过指定的refid和fileName参数进行数据导入操作的预览。
ApiResult<Object>	process(String refid, long fileId)	获取导入进度接口 根据提供的refid和fileId获取导入的进度信息
ApiResult<Object>	restore(Map<String,Object> dataMap)	恢复导入接口 该接口用于处理恢复导入的操作，通过接收包含refid的Map数据来验证地址和模块操作权限，并执行恢复导入。
ApiResult<Map<String,Object>>	upload(String refid, org.springframework.web.multipart.MultipartFile file)	上传文件接口 该接口用于处理文件上传功能，包括验证地址、模块操作权限以及实际上传文件操作。

从类继承的方法 net.sohelp.boot.admin.core.base.BaseController

error, error, fail, fail, fail, getLoginID, getLoginName, getLoginOrgID, getLoginOrgName, getLoginUser, getNickname, getTenantId, getUserName, getUserNo, i18n, i18n, isAdministrator, isDeveloper, limit, offset, ok, ok, response, response, responseStream, success, success, success, success, validateToken

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

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

构造器详细资料

EngineImportController

public EngineImportController()

方法详细资料

preview

@GetMapping("/preview")
@Permission("")
public ApiResult<Pager<Map<String,Object>>> preview(@RequestParam
 Map<String,Object> paramMap)
                                             throws BusiException,
TokenAuthenticationException,
AccessPermissionException,
SQLException

批量导入数据预览接口 该接口用于通过指定的refid和fileName参数进行数据导入操作的预览。

参数:

paramMap - 包含导入操作所需参数的Map，其中必须包含refid（数据引用ID）

返回:

返回预览操作的ApiResult对象

抛出:

BusiException - 如果refid为空，则抛出BusiException异常

TokenAuthenticationException - 令牌认证异常

AccessPermissionException - 访问权限异常

SQLException - 数据库异常

restore

@PostMapping("/restore")
@Permission("")
public ApiResult<Object> restore(@RequestBody
 Map<String,Object> dataMap)
                          throws BusiException,
TokenAuthenticationException,
AccessPermissionException,
SQLException

恢复导入接口 该接口用于处理恢复导入的操作，通过接收包含refid的Map数据来验证地址和模块操作权限，并执行恢复导入。

参数:

dataMap - 包含恢复导入所需数据的Map，其中必须包含refid键 - refid: 用于验证地址和模块操作权限的引用ID

返回:

返回操作结果的ApiResult对象，包含操作是否成功的信息

抛出:

BusiException - 如果refid为空，则抛出BusiException异常

TokenAuthenticationException - 如果令牌认证失败，则抛出此异常

AccessPermissionException - 如果访问权限验证失败，则抛出此异常

SQLException - 如果数据库操作出现异常，则抛出此异常

confirm

@PostMapping("/confirm")
@Transactional(rollbackFor=java.lang.Exception.class)
@Permission("")
public ApiResult<Object> confirm(@RequestBody
 Map<String,Object> dataMap)
                          throws BusiException,
TokenAuthenticationException,
AccessPermissionException,
SQLException

确认导入接口 该接口用于确认导入操作，通过传入的refid进行地址和模块操作权限的验证。

参数:

dataMap - 包含导入所需数据的Map，其中必须包含"refid"键

返回:

返回操作结果的ApiResult对象

抛出:

BusiException - 如果refid为空，则抛出BusiException异常

TokenAuthenticationException - 如果令牌认证失败，则抛出TokenAuthenticationException异常

AccessPermissionException - 如果访问权限验证失败，则抛出AccessPermissionException异常

SQLException - 如果数据库操作出现异常，则抛出SQLException异常

process

@GetMapping("/process")
@Permission("")
public ApiResult<Object> process(@RequestParam(required=false)
 String refid,
 @RequestParam("fileId")
 long fileId)
                          throws BusiException,
TokenAuthenticationException,
AccessPermissionException,
SQLException

获取导入进度接口 根据提供的refid和fileId获取导入的进度信息

参数:

refid - 配置地址，非必需，但不能为空，否则抛出BusiException异常

fileId - 文件ID，用于标识导入的文件

返回:

返回ApiResult对象，包含导入进度信息

抛出:

BusiException - 如果refid为空，则抛出该异常

TokenAuthenticationException - 如果令牌认证失败，则抛出该异常

AccessPermissionException - 如果访问权限验证失败，则抛出该异常

SQLException - 如果数据库操作出现异常，则抛出该异常

upload

@PostMapping("/upload")
@Permission("")
public ApiResult<Map<String,Object>> upload(@RequestParam(required=false)
 String refid,
 @RequestParam("file")
 org.springframework.web.multipart.MultipartFile file)
                                     throws BusiException,
TokenAuthenticationException,
AccessPermissionException,
SQLException,
IOException

上传文件接口 该接口用于处理文件上传功能，包括验证地址、模块操作权限以及实际上传文件操作。

参数:

refid - 配置地址的引用ID，可为空

file - 要上传的文件

返回:

返回操作结果的ApiResult对象

抛出:

BusiException - 如果配置地址为空，则抛出BusiException异常

TokenAuthenticationException - 令牌认证异常

AccessPermissionException - 访问权限异常

SQLException - 数据库异常

IOException

history

@GetMapping("/history")
@Permission("")
public ApiResult<Pager<Map<String,Object>>> history(@RequestParam(required=false)
 String refid,
 @RequestParam(required=false)
 String keywords)
                                             throws BusiException,
TokenAuthenticationException,
AccessPermissionException,
SQLException

获取导入历史接口 该接口用于获取指定引用ID的导入历史记录

参数:

refid - 引用ID，用于标识需要查询的导入历史记录，非必填参数

返回:

返回ApiResult对象，包含导入历史记录信息

抛出:

BusiException - 如果refid为空，则抛出BusiException异常

TokenAuthenticationException - 如果令牌认证失败，则抛出TokenAuthenticationException异常

AccessPermissionException - 如果访问权限验证失败，则抛出AccessPermissionException异常

SQLException - 如果数据库查询出现异常，则抛出SQLException异常

download

@RequestMapping("/download")
@Permission("")
public ApiResult<String> download(@RequestParam
 Map<String,Object> dataMap)
                           throws Exception

抛出:

Exception

downloadImportTemplate

@RequestMapping("/downloadTemplate")
@Permission("")
public void downloadImportTemplate(jakarta.servlet.http.HttpServletResponse response,
 @RequestParam
 Map<String,Object> dataMap)
                            throws Exception

下载导入模板 根据GridVO.importConfig.fields生成导入模板

参数:

response - HTTP响应

dataMap - 引用ID

抛出:

Exception - 处理异常