wang.bigbird.domain.framework.web.core.controller

类 CommonController

java.lang.Object

wang.bigbird.domain.framework.web.core.controller.CommonController

@RestController
 @RequestMapping(value="/common")
public class CommonController
extends Object

web公共业务接口

作者:

Bigbird

构造器概要

构造器

构造器和说明
CommonController()

方法概要

限定符和类型	方法和说明
RespResult<Void>	cancelProcess(String processID, javax.servlet.http.HttpSession session) 取消处理过程
protected void	clearCache(javax.servlet.http.HttpSession session, String... keys) 清除session中指定键值
RespResult<Boolean>	deleteFile(String filePath) 删除文件
void	downloadFile(String filePath, String fileName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 下载文件
RespResult<String>	getFromSession(String key, javax.servlet.http.HttpSession session) 从Session中获取对应键值
RespResult<String>	getProcess(String processID, javax.servlet.http.HttpSession session) 获取处理过程状态
protected void	initCancelStatus(String processID, javax.servlet.http.HttpSession session) 初始化取消状态
protected boolean	isCancel(String processID, javax.servlet.http.HttpSession session) 是否取消任务
RespResult<Long>	loadServerTimeStamp() 网站对外提供的服务器时间戳
RespResult<Void>	removeFromSession(String keyInfo, javax.servlet.http.HttpSession session) 从Session中移除指定键值
RespResult<Void>	saveInSession(Map<String,String> map, javax.servlet.http.HttpSession session) 将指定键值信息存入Session
protected void	setProgressStatus(String processID, String info, javax.servlet.http.HttpSession session) 设置当前处理状态
protected void	startProgress(String processID, javax.servlet.http.HttpSession session) 开始处理
RespResult<Map<String,Object>>	uploadFile(String currentAttachName, String supportSuffix, org.springframework.web.multipart.MultipartFile file, javax.servlet.http.HttpSession session) 上传文件，仅支持上传一个附件

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

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

构造器详细资料

CommonController

public CommonController()

方法详细资料

loadServerTimeStamp

@GetMapping(value="/loadServerTimeStamp")
public RespResult<Long> loadServerTimeStamp()

网站对外提供的服务器时间戳

返回:

服务器时间戳

getFromSession

@GetMapping(value="/getFromSession/{key}")
public RespResult<String> getFromSession(@PathVariable(value="key")
                                                                                     String key,
                                                                                     javax.servlet.http.HttpSession session)

从Session中获取对应键值

参数:

key - 键

session - session

返回:

指定键值

saveInSession

@PutMapping(value="/saveInSession")
public RespResult<Void> saveInSession(@RequestBody
                                                                           Map<String,String> map,
                                                                           javax.servlet.http.HttpSession session)

将指定键值信息存入Session

参数:

map - 键值对

session - session

返回:

保存结果

removeFromSession

@DeleteMapping(value="/removeFromSession/{keyInfo}")
public RespResult<Void> removeFromSession(@PathVariable(value="keyInfo")
                                                                                                String keyInfo,
                                                                                                javax.servlet.http.HttpSession session)

从Session中移除指定键值

参数:

keyInfo - 键

session - session

返回:

删除结果

cancelProcess

@PutMapping(value="/cancelProcess/{processID}")
public RespResult<Void> cancelProcess(@PathVariable(value="processID")
                                                                                       String processID,
                                                                                       javax.servlet.http.HttpSession session)

取消处理过程

参数:

processID - 处理过程ID

session - session

返回:

取消结果

getProcess

@GetMapping(value="/getProcess/{processID}")
public RespResult<String> getProcess(@PathVariable(value="processID")
                                                                                   String processID,
                                                                                   javax.servlet.http.HttpSession session)

获取处理过程状态

参数:

processID - 处理过程ID

session - session

返回:

当前处理过程状态

uploadFile

@PostMapping(value="/uploadFile")
public RespResult<Map<String,Object>> uploadFile(@RequestParam(value="currentAttachName",required=false)
                                                                                    String currentAttachName,
                                                                                    @RequestParam(value="supportSuffix",required=false)
                                                                                    String supportSuffix,
                                                                                    @RequestParam(value="file")
                                                                                    org.springframework.web.multipart.MultipartFile file,
                                                                                    javax.servlet.http.HttpSession session)
                                                                             throws IOException

上传文件，仅支持上传一个附件

参数:

currentAttachName - 当前附件名称

supportSuffix - 支持的文件格式，必须是支持的白名单中的格式子集

file - 上传文件对象

session - session

返回:

上传文件信息

抛出:

IOException

deleteFile

@DeleteMapping(value="/deleteFile")
public RespResult<Boolean> deleteFile(@RequestParam(value="filePath")
                                                                           String filePath)
                                                                    throws FileNotFoundException,
                                                                           UnsupportedEncodingException

删除文件

参数:

filePath - 待解密的文件路径

返回:

删除结果

抛出:

FileNotFoundException

UnsupportedEncodingException

downloadFile

@GetMapping(value="/downloadFile")
public void downloadFile(@RequestParam(value="filePath")
                                                             String filePath,
                                                             @RequestParam(value="fileName",required=false)
                                                             String fileName,
                                                             javax.servlet.http.HttpServletRequest request,
                                                             javax.servlet.http.HttpServletResponse response)
                                                      throws IOException

下载文件

参数:

filePath - 待解密的文件路径

fileName - 下载文件保存名称

request - 请求对象

response - 响应对象

抛出:

IOException - 可能抛出该异常

initCancelStatus

protected void initCancelStatus(String processID,
                                javax.servlet.http.HttpSession session)

初始化取消状态

参数:

processID - 处理过程ID

session - session

startProgress

protected void startProgress(String processID,
                             javax.servlet.http.HttpSession session)

开始处理

参数:

processID - 处理过程ID

session - session

setProgressStatus

protected void setProgressStatus(String processID,
                                 String info,
                                 javax.servlet.http.HttpSession session)

设置当前处理状态

参数:

processID - 处理过程ID

info - 状态信息

session - session

isCancel

protected boolean isCancel(String processID,
                           javax.servlet.http.HttpSession session)

是否取消任务

参数:

processID - 处理过程ID

session - session

返回:

是否取消

clearCache

protected void clearCache(javax.servlet.http.HttpSession session,
                          String... keys)

清除session中指定键值

参数:

session - session

keys - 键信息