cn.ponfee.disjob.supervisor.provider

类 SupervisorOpenApiProvider

java.lang.Object

cn.ponfee.disjob.common.spring.BaseController

cn.ponfee.disjob.supervisor.provider.SupervisorOpenApiProvider

所有已实现的接口:

cn.ponfee.disjob.common.collect.TypedKeyValue<String,String>

@RestController
 @RequestMapping(value="supervisor/open/api")
public class SupervisorOpenApiProvider
extends cn.ponfee.disjob.common.spring.BaseController

Supervisor open api

作者:

Ponfee

构造器概要

构造器

构造器和说明
SupervisorOpenApiProvider(cn.ponfee.disjob.core.api.supervisor.SupervisorOpenRpcService supervisorOpenRpcService)

方法概要

限定符和类型	方法和说明
cn.ponfee.disjob.common.model.Result<Void>	addJob(cn.ponfee.disjob.core.api.supervisor.request.AddSchedJobRequest req)
cn.ponfee.disjob.common.model.Result<Void>	cancelInstance(long instanceId)
cn.ponfee.disjob.common.model.Result<Void>	changeInstanceState(long instanceId, int targetExecuteState)
cn.ponfee.disjob.common.model.Result<Boolean>	changeJobState(long jobId, int jobState)
cn.ponfee.disjob.common.model.Result<Void>	deleteInstance(long instanceId)
cn.ponfee.disjob.common.model.Result<Void>	deleteJob(long jobId)
cn.ponfee.disjob.common.model.Result<cn.ponfee.disjob.core.api.supervisor.response.SchedInstanceResponse>	getInstance(long instanceId, boolean withTasks)
cn.ponfee.disjob.common.model.Result<List<cn.ponfee.disjob.core.api.supervisor.response.SchedTaskResponse>>	getInstanceTasks(long instanceId)
cn.ponfee.disjob.common.model.Result<cn.ponfee.disjob.core.api.supervisor.response.SchedJobResponse>	getJob(long jobId)
cn.ponfee.disjob.common.model.Result<List<cn.ponfee.disjob.core.api.supervisor.response.SchedInstanceResponse>>	listInstanceChildren(long pnstanceId)
cn.ponfee.disjob.common.model.Result<Void>	pauseInstance(long instanceId)
cn.ponfee.disjob.common.model.Result<cn.ponfee.disjob.common.model.PageResponse<cn.ponfee.disjob.core.api.supervisor.response.SchedInstanceResponse>>	queryInstanceForPage(cn.ponfee.disjob.core.api.supervisor.request.SchedInstancePageRequest pageRequest) Http request Content-Type: Http form-data or application/x-www-form-urlencoded
cn.ponfee.disjob.common.model.Result<cn.ponfee.disjob.common.model.PageResponse<cn.ponfee.disjob.core.api.supervisor.response.SchedJobResponse>>	queryJobForPage(cn.ponfee.disjob.core.api.supervisor.request.SchedJobPageRequest pageRequest) Http request Content-Type: Http form-data or application/x-www-form-urlencoded
cn.ponfee.disjob.common.model.Result<Void>	resumeInstance(long instanceId)
cn.ponfee.disjob.common.model.Result<Void>	triggerJob(long jobId)
cn.ponfee.disjob.common.model.Result<Void>	updateJob(cn.ponfee.disjob.core.api.supervisor.request.UpdateSchedJobRequest req)

从类继承的方法 cn.ponfee.disjob.common.spring.BaseController

getRequest, getRequestAttributes, getResponse, getSession, getValue, initBinder

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

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

从接口继承的方法 cn.ponfee.disjob.common.collect.TypedKeyValue

get, getBoolean, getBoolean, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getRequired, getRequired, getRequiredBoolean, getRequiredDouble, getRequiredFloat, getRequiredInt, getRequiredLong, getRequiredString, getString, getString, hasKey

构造器详细资料

SupervisorOpenApiProvider

public SupervisorOpenApiProvider(cn.ponfee.disjob.core.api.supervisor.SupervisorOpenRpcService supervisorOpenRpcService)

方法详细资料

addJob

@PostMapping(value="job/add")
public cn.ponfee.disjob.common.model.Result<Void> addJob(@RequestBody
                                                                                       cn.ponfee.disjob.core.api.supervisor.request.AddSchedJobRequest req)
                                                                                throws cn.ponfee.disjob.core.exception.JobCheckedException

抛出:

cn.ponfee.disjob.core.exception.JobCheckedException

updateJob

@PutMapping(value="job/update")
public cn.ponfee.disjob.common.model.Result<Void> updateJob(@RequestBody
                                                                                            cn.ponfee.disjob.core.api.supervisor.request.UpdateSchedJobRequest req)
                                                                                     throws cn.ponfee.disjob.core.exception.JobCheckedException

抛出:

cn.ponfee.disjob.core.exception.JobCheckedException

deleteJob

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

changeJobState

@PostMapping(value="job/state/change")
public cn.ponfee.disjob.common.model.Result<Boolean> changeJobState(@RequestParam(value="jobId")
                                                                                                           long jobId,
                                                                                                           @RequestParam(value="jobState")
                                                                                                           int jobState)

triggerJob

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

抛出:

cn.ponfee.disjob.core.exception.JobCheckedException

getJob

@GetMapping(value="job/get")
public cn.ponfee.disjob.common.model.Result<cn.ponfee.disjob.core.api.supervisor.response.SchedJobResponse> getJob(@RequestParam(value="jobId")
                                                                                                                                                long jobId)

queryJobForPage

@GetMapping(value="job/page")
public cn.ponfee.disjob.common.model.Result<cn.ponfee.disjob.common.model.PageResponse<cn.ponfee.disjob.core.api.supervisor.response.SchedJobResponse>> queryJobForPage(cn.ponfee.disjob.core.api.supervisor.request.SchedJobPageRequest pageRequest)

Http request Content-Type: Http form-data or application/x-www-form-urlencoded

参数:

pageRequest - the page request

返回:

page result

另请参阅:

org.springframework.http.MediaType#APPLICATION_FORM_URLENCODED, org.springframework.http.MediaType#MULTIPART_FORM_DATA

pauseInstance

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

cancelInstance

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

resumeInstance

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

deleteInstance

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

changeInstanceState

@PostMapping(value="instance/state/change")
public cn.ponfee.disjob.common.model.Result<Void> changeInstanceState(@RequestParam(value="instanceId")
                                                                                                                  long instanceId,
                                                                                                                  @RequestParam(value="targetExecuteState")
                                                                                                                  int targetExecuteState)

getInstance

@GetMapping(value="instance/get")
public cn.ponfee.disjob.common.model.Result<cn.ponfee.disjob.core.api.supervisor.response.SchedInstanceResponse> getInstance(@RequestParam(value="instanceId")
                                                                                                                                                               long instanceId,
                                                                                                                                                               @RequestParam(value="withTasks",defaultValue="false")
                                                                                                                                                               boolean withTasks)

getInstanceTasks

@GetMapping(value="instance/tasks")
public cn.ponfee.disjob.common.model.Result<List<cn.ponfee.disjob.core.api.supervisor.response.SchedTaskResponse>> getInstanceTasks(@RequestParam(value="instanceId")
                                                                                                                                                                        long instanceId)

queryInstanceForPage

@GetMapping(value="instance/page")
public cn.ponfee.disjob.common.model.Result<cn.ponfee.disjob.common.model.PageResponse<cn.ponfee.disjob.core.api.supervisor.response.SchedInstanceResponse>> queryInstanceForPage(cn.ponfee.disjob.core.api.supervisor.request.SchedInstancePageRequest pageRequest)

Http request Content-Type: Http form-data or application/x-www-form-urlencoded

参数:

pageRequest - the page request

返回:

page result

另请参阅:

org.springframework.http.MediaType#APPLICATION_FORM_URLENCODED, org.springframework.http.MediaType#MULTIPART_FORM_DATA

listInstanceChildren

@GetMapping(value="instance/children")
public cn.ponfee.disjob.common.model.Result<List<cn.ponfee.disjob.core.api.supervisor.response.SchedInstanceResponse>> listInstanceChildren(@RequestParam(value="pnstanceId")
                                                                                                                                                                                   long pnstanceId)