cn.ponfee.scheduler.supervisor.web.controller

类 ApiController

java.lang.Object

cn.ponfee.scheduler.supervisor.web.controller.ApiController

@RestController
 @RequestMapping(value="api")
public class ApiController
extends Object

Provides to external invoke, for manage the sched job & instance & task

作者:

Ponfee

构造器概要

构造器

构造器和说明
ApiController(SchedulerJobManager schedulerJobManager)

方法概要

限定符和类型	方法和说明
cn.ponfee.scheduler.common.base.model.Result<Void>	addJob(AddSchedJobRequest req)
cn.ponfee.scheduler.common.base.model.Result<Boolean>	cancelInstance(long instanceId)
cn.ponfee.scheduler.common.base.model.Result<Void>	deleteInstance(long instanceId)
cn.ponfee.scheduler.common.base.model.Result<Void>	deleteJob(long jobId)
cn.ponfee.scheduler.common.base.model.Result<Boolean>	disableJob(long jobId)
cn.ponfee.scheduler.common.base.model.Result<Boolean>	enableJob(long jobId)
cn.ponfee.scheduler.common.base.model.Result<Void>	forceResumeInstance(long instanceId)
cn.ponfee.scheduler.common.base.model.Result<Void>	forceUpdateInstanceState(long instanceId, int instanceTargetState, int taskTargetState)
cn.ponfee.scheduler.common.base.model.Result<GetInstanceResponse>	getInstance(long instanceId)
cn.ponfee.scheduler.common.base.model.Result<cn.ponfee.scheduler.core.model.SchedJob>	getJob(long jobId)
cn.ponfee.scheduler.common.base.model.Result<Boolean>	pauseInstance(long instanceId)
cn.ponfee.scheduler.common.base.model.Result<Boolean>	resumeInstance(long instanceId)
cn.ponfee.scheduler.common.base.model.Result<Void>	triggerJob(long jobId)
cn.ponfee.scheduler.common.base.model.Result<Void>	updateJob(UpdateSchedJobRequest req)

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

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

构造器详细资料

ApiController

public ApiController(SchedulerJobManager schedulerJobManager)

方法详细资料

addJob

@PostMapping(value="job/add")
public cn.ponfee.scheduler.common.base.model.Result<Void> addJob(@RequestBody
                                                                                               AddSchedJobRequest req)

updateJob

@PutMapping(value="job/update")
public cn.ponfee.scheduler.common.base.model.Result<Void> updateJob(@RequestBody
                                                                                                    UpdateSchedJobRequest req)

deleteJob

@DeleteMapping(value="job/delete")
public cn.ponfee.scheduler.common.base.model.Result<Void> deleteJob(@RequestParam(value="jobId")
                                                                                                       long jobId)

getJob

@GetMapping(value="job/get")
public cn.ponfee.scheduler.common.base.model.Result<cn.ponfee.scheduler.core.model.SchedJob> getJob(@RequestParam(value="jobId")
                                                                                                                                 long jobId)

disableJob

@PostMapping(value="job/disable")
public cn.ponfee.scheduler.common.base.model.Result<Boolean> disableJob(@RequestParam(value="jobId")
                                                                                                          long jobId)

enableJob

@PostMapping(value="job/enable")
public cn.ponfee.scheduler.common.base.model.Result<Boolean> enableJob(@RequestParam(value="jobId")
                                                                                                        long jobId)

triggerJob

@PostMapping(value="job/trigger")
public cn.ponfee.scheduler.common.base.model.Result<Void> triggerJob(@RequestParam(value="jobId")
                                                                                                       long jobId)
                                                                                                throws cn.ponfee.scheduler.core.exception.JobException

抛出:

cn.ponfee.scheduler.core.exception.JobException

pauseInstance

@PostMapping(value="instance/pause")
public cn.ponfee.scheduler.common.base.model.Result<Boolean> pauseInstance(@RequestParam(value="instanceId")
                                                                                                                long instanceId)

cancelInstance

@PostMapping(value="instance/cancel")
public cn.ponfee.scheduler.common.base.model.Result<Boolean> cancelInstance(@RequestParam(value="instanceId")
                                                                                                                  long instanceId)

resumeInstance

@PostMapping(value="instance/resume")
public cn.ponfee.scheduler.common.base.model.Result<Boolean> resumeInstance(@RequestParam(value="instanceId")
                                                                                                                  long instanceId)

forceResumeInstance

@PostMapping(value="instance/fresume")
public cn.ponfee.scheduler.common.base.model.Result<Void> forceResumeInstance(@RequestParam(value="instanceId")
                                                                                                                     long instanceId)

forceUpdateInstanceState

@PutMapping(value="instance/fupdate_state")
public cn.ponfee.scheduler.common.base.model.Result<Void> forceUpdateInstanceState(@RequestParam(value="instanceId")
                                                                                                                               long instanceId,
                                                                                                                               @RequestParam(value="instanceTargetState")
                                                                                                                               int instanceTargetState,
                                                                                                                               @RequestParam(value="taskTargetState")
                                                                                                                               int taskTargetState)

deleteInstance

@DeleteMapping(value="instance/delete")
public cn.ponfee.scheduler.common.base.model.Result<Void> deleteInstance(@RequestParam(value="instanceId")
                                                                                                                 long instanceId)

getInstance

@GetMapping(value="instance/get")
public cn.ponfee.scheduler.common.base.model.Result<GetInstanceResponse> getInstance(@RequestParam(value="instanceId")
                                                                                                                       long instanceId)