cn.ponfee.disjob.core.base

接口 SupervisorService

所有超级接口:

Checkpoint

@RequestMapping(value="supervisor/service/")
public interface SupervisorService
extends Checkpoint

Supervisor service api, for the worker communication.

作者:

Ponfee

字段概要

从接口继承的字段 cn.ponfee.disjob.core.handle.Checkpoint

DISCARD

方法概要

限定符和类型	方法和说明
boolean	cancelInstance(long instanceId, Long wnstanceId, Operations ops)
boolean	checkpoint(long taskId, String executeSnapshot) Save the task execution snapshot
SchedTask	getTask(long taskId)
List<WorkflowPredecessorNode>	getWorkflowPredecessorNodes(long wnstanceId, long instanceId) Gets workflow predecessor nodes
boolean	pauseInstance(long instanceId, Long wnstanceId)
boolean	startTask(StartTaskParam param)
boolean	terminateTask(TerminateTaskParam param)
void	updateTaskWorker(List<TaskWorkerParam> params)

方法详细资料

getTask

@GetMapping(value="task/get")
SchedTask getTask(long taskId)
                                         throws Exception

抛出:

Exception

startTask

@PostMapping(value="task/start")
boolean startTask(StartTaskParam param)
                                            throws Exception

抛出:

Exception

updateTaskWorker

@PostMapping(value="task/worker/update")
void updateTaskWorker(List<TaskWorkerParam> params)
                                                        throws Exception

抛出:

Exception

getWorkflowPredecessorNodes

@GetMapping(value="workflow/predecessor/nodes/get")
List<WorkflowPredecessorNode> getWorkflowPredecessorNodes(long wnstanceId,
                                                                                                              long instanceId)
                                                                                                       throws Exception

Gets workflow predecessor nodes

参数:

wnstanceId - the workflow lead instance id

instanceId - the current node instance id

返回:

list of predecessor nodes

抛出:

Exception - if occur error

terminateTask

@PostMapping(value="task/terminate")
boolean terminateTask(TerminateTaskParam param)
                                                    throws Exception

抛出:

Exception

pauseInstance

@PostMapping(value="instance/pause")
boolean pauseInstance(long instanceId,
                                                           Long wnstanceId)
                                                    throws Exception

抛出:

Exception

cancelInstance

@PostMapping(value="instance/cancel")
boolean cancelInstance(long instanceId,
                                                             Long wnstanceId,
                                                             Operations ops)
                                                      throws Exception

抛出:

Exception

checkpoint

@PostMapping(value="task/checkpoint")
boolean checkpoint(long taskId,
                                                         String executeSnapshot)
                                                  throws Exception

从接口复制的说明: Checkpoint

Save the task execution snapshot

指定者:

checkpoint 在接口中 Checkpoint

参数:

taskId - the task id

executeSnapshot - the execution snapshot data

返回:

true if saved successfully

抛出:

Exception - if saved occur exception