cn.ablxyw.controller

类 SysJobController

java.lang.Object

cn.ablxyw.controller.SysJobController

@RestController
 @RequestMapping(value="/sysJobConfig")
public class SysJobController
extends Object

分布式定时任务Controller

作者:

weiqiang

构造器概要

构造器

构造器和说明
SysJobController()

方法概要

限定符和类型	方法和说明
String	check(String jobName, String jobGroup) 根据定时任务名称来判断任务是否存在
ResultEntity	delete(@Valid ObjectInfo<String> objectInfo, org.springframework.validation.BindingResult bindingResult) 删除分布式定时任务配置
ResultEntity	delete(String jobName, String jobGroup) 根据定时任务名称从调度器当中删除定时任务
ResultEntity	insert(@Valid SysJobConfigEntity sysJobConfigEntity, org.springframework.validation.BindingResult bindingResult) 创建定时任务并启动
ResultEntity	list(SysJobConfigEntity sysJobConfigEntity) 获取所有定时任务
ResultEntity	list(SysJobConfigEntity sysJobConfig, Integer pageNumber, Integer pageSize, String sortName, String sortOrder) 分页查询分布式定时任务配置
ResultEntity	pauseJob(String jobName, String jobGroup) 根据任务名称暂停定时任务
ResultEntity	resume(String jobName, String jobGroup) 根据任务名称恢复定时任务
ResultEntity	runOnce(String jobName, String jobGroup) 根据任务名称立即运行一次定时任务
ResultEntity	status(String jobName, String jobGroup) 定时任务状态
ResultEntity	update(@Valid SysJobConfigEntity sysJobConfig, org.springframework.validation.BindingResult bindingResult) 修改分布式定时任务配置

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

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

构造器详细资料

SysJobController

public SysJobController()

方法详细资料

insert

@PostMapping(value="insert")
public ResultEntity insert(@Valid @RequestBody
                                                        @Valid SysJobConfigEntity sysJobConfigEntity,
                                                        org.springframework.validation.BindingResult bindingResult)

创建定时任务并启动

参数:

sysJobConfigEntity - 定时任务

返回:

ResultEntity

update

@RequestMapping(value="/update",
                method=POST)
public ResultEntity update(@Valid @RequestBody
                                                                                         @Valid SysJobConfigEntity sysJobConfig,
                                                                                         org.springframework.validation.BindingResult bindingResult)

修改分布式定时任务配置

参数:

sysJobConfig - 分布式定时任务配置

返回:

ResultEntity

pauseJob

@GetMapping(value={"/pauseJob/{jobName}","/pauseJob/{jobName}/{jobGroup}"})
public ResultEntity pauseJob(@PathVariable(value="jobName")
                                                                                                         String jobName,
                                                                                                         @PathVariable(required=false)
                                                                                                         String jobGroup)

根据任务名称暂停定时任务

返回:

ResultEntity

resume

@GetMapping(value={"/resume/{jobName}","/resume/{jobName}/{jobGroup}"})
public ResultEntity resume(@PathVariable(value="jobName")
                                                                                                   String jobName,
                                                                                                   @PathVariable(required=false)
                                                                                                   String jobGroup)

根据任务名称恢复定时任务

参数:

jobName - 任务名称

jobGroup - 任务组

返回:

String

runOnce

@GetMapping(value={"/runOnce/{jobName}","/runOnce/{jobName}/{jobGroup}"})
public ResultEntity runOnce(@PathVariable(value="jobName")
                                                                                                      String jobName,
                                                                                                      @PathVariable(required=false)
                                                                                                      String jobGroup)

根据任务名称立即运行一次定时任务

参数:

jobName - 任务名称

jobGroup - 任务组

返回:

String

delete

@DeleteMapping(value={"/delete/{jobName}","/delete/{jobName}/{jobGroup}"})
public ResultEntity delete(@PathVariable(value="jobName")
                                                                                                      String jobName,
                                                                                                      @PathVariable(required=false)
                                                                                                      String jobGroup)

根据定时任务名称从调度器当中删除定时任务

参数:

jobName - 任务名称

jobGroup - 任务组

返回:

String

check

@GetMapping(value={"/check/{jobName}","/check/{jobName}/{jobGroup}"})
public String check(@PathVariable(value="jobName")
                                                                                          String jobName,
                                                                                          @PathVariable(required=false)
                                                                                          String jobGroup)

根据定时任务名称来判断任务是否存在

参数:

jobName - 任务名称

jobGroup - 任务组

返回:

String

status

@GetMapping(value={"/status/{jobName}","/status/{jobName}/{jobGroup}"})
 @ResponseBody
public ResultEntity status(@PathVariable(value="jobName")
                                                                                                                  String jobName,
                                                                                                                  @PathVariable(required=false)
                                                                                                                  String jobGroup)

定时任务状态

参数:

jobName - 任务名称

jobGroup - 任务组

返回:

String

list

@GetMapping(value="list")
public ResultEntity list(SysJobConfigEntity sysJobConfigEntity)

获取所有定时任务

参数:

sysJobConfigEntity - 分布式定时任务配置类

返回:

ResultEntity

list

@RequestMapping(value="/listByPage",
                method=GET)
public ResultEntity list(SysJobConfigEntity sysJobConfig,
                                                                                          @RequestParam(defaultValue="1")
                                                                                          Integer pageNumber,
                                                                                          @RequestParam(defaultValue="30")
                                                                                          Integer pageSize,
                                                                                          String sortName,
                                                                                          String sortOrder)

分页查询分布式定时任务配置

参数:

sysJobConfig - 分布式定时任务配置

pageNumber - 初始页

pageSize - 每页条数

sortName - 排序信息

sortOrder - 排序顺序

返回:

ResultEntity

delete

@RequestMapping(value="deleteByIds",
                method=POST)
public ResultEntity delete(@Valid @RequestBody
                                                                                             @Valid ObjectInfo<String> objectInfo,
                                                                                             org.springframework.validation.BindingResult bindingResult)

删除分布式定时任务配置

参数:

objectInfo - 主键集合

返回:

ResultEntity