cn.ponfee.disjob.supervisor.component

类 JobManager

java.lang.Object

cn.ponfee.disjob.supervisor.component.JobManager

@Component
public class JobManager
extends Object

Job manager

作者:

Ponfee

构造器概要

构造器

构造器和说明
JobManager(SupervisorProperties conf, cn.ponfee.disjob.common.base.IdGenerator idGenerator, SchedJobMapper jobMapper, SchedDependMapper dependMapper, SchedInstanceMapper instanceMapper, SchedWorkflowMapper workflowMapper, SchedTaskMapper taskMapper, WorkerClient workerClient, org.springframework.transaction.support.TransactionTemplate txTemplate)

方法概要

限定符和类型	方法和说明
Long	addJob(SchedJob job)
boolean	cancelInstance(long instanceId, cn.ponfee.disjob.core.enums.Operation ops) Cancel instance
void	changeInstanceState(long instanceId, cn.ponfee.disjob.core.enums.ExecuteState toExecuteState) Force change instance state, for example: CANCELED -> WAITING
void	changeJobState(String user, long jobId, cn.ponfee.disjob.core.enums.JobState toState)
void	deleteInstance(long instanceId)
void	deleteJob(String user, long jobId)
void	disableJob(SchedJob job)
boolean	dispatch(SchedJob job, SchedInstance instance, List<SchedTask> tasks)
long	generateId()
void	manualTriggerJob(long jobId)
boolean	pauseInstance(long instanceId) Pause instance
void	processTaskDispatchFailedEvent(TaskDispatchFailedEvent event) Listen task dispatch failed event `@Async`需要标注`@EnableAsync`来启用，默认使用的是`SimpleAsyncTaskExecutor`线程池，会为每个任务创建一个新线程(慎用默认的线程池)
boolean	purgeInstance(SchedInstance inst) Purge the zombie instance which maybe dead
boolean	redispatch(SchedJob job, SchedInstance instance, List<SchedTask> tasks)
boolean	resumeInstance(long instanceId) Resume the instance from paused to waiting state
void	saveInstanceAndTasks(SchedInstance instance, List<SchedTask> tasks)
void	saveLeadInstanceAndWorkflows(SchedInstance instance, List<SchedWorkflow> workflows)
boolean	savepoint(long taskId, String worker, String executeSnapshot)
void	scheduleTriggerJob(SchedJob job, long triggerTime)
List<SchedTask>	splitJob(String group, long instanceId, cn.ponfee.disjob.core.dto.worker.SplitJobParam param)
cn.ponfee.disjob.core.dto.supervisor.StartTaskResult	startTask(cn.ponfee.disjob.core.dto.supervisor.StartTaskParam param) Starts the task
boolean	stopTask(cn.ponfee.disjob.core.dto.supervisor.StopTaskParam param) Stops the task
boolean	updateInstanceNextScanTime(SchedInstance inst, Date nextScanTime)
void	updateJob(SchedJob job)
void	updateJobNextScanTime(SchedJob job)
boolean	updateJobNextTriggerTime(SchedJob job)
void	updateTaskWorker(String worker, List<Long> taskIds) Set or clear task worker

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

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

构造器详细资料

JobManager

public JobManager(SupervisorProperties conf,
                  cn.ponfee.disjob.common.base.IdGenerator idGenerator,
                  SchedJobMapper jobMapper,
                  SchedDependMapper dependMapper,
                  SchedInstanceMapper instanceMapper,
                  SchedWorkflowMapper workflowMapper,
                  SchedTaskMapper taskMapper,
                  WorkerClient workerClient,
                  @Qualifier(value="disjobTransactionTemplate")
                  org.springframework.transaction.support.TransactionTemplate txTemplate)

方法详细资料

generateId

public long generateId()

splitJob

public List<SchedTask> splitJob(String group,
                                long instanceId,
                                cn.ponfee.disjob.core.dto.worker.SplitJobParam param)
                         throws cn.ponfee.disjob.core.exception.JobException

抛出:

cn.ponfee.disjob.core.exception.JobException

dispatch

public boolean dispatch(SchedJob job,
                        SchedInstance instance,
                        List<SchedTask> tasks)

redispatch

public boolean redispatch(SchedJob job,
                          SchedInstance instance,
                          List<SchedTask> tasks)

disableJob

public void disableJob(SchedJob job)

updateJobNextTriggerTime

public boolean updateJobNextTriggerTime(SchedJob job)

updateJobNextScanTime

public void updateJobNextScanTime(SchedJob job)

updateInstanceNextScanTime

public boolean updateInstanceNextScanTime(SchedInstance inst,
                                          Date nextScanTime)

savepoint

public boolean savepoint(long taskId,
                         String worker,
                         String executeSnapshot)

saveLeadInstanceAndWorkflows

public void saveLeadInstanceAndWorkflows(SchedInstance instance,
                                         List<SchedWorkflow> workflows)

saveInstanceAndTasks

public void saveInstanceAndTasks(SchedInstance instance,
                                 List<SchedTask> tasks)

addJob

@Transactional(transactionManager="disjobTransactionManager",
               rollbackFor=java.lang.Exception.class)
public Long addJob(SchedJob job)
                                                                                                                                throws cn.ponfee.disjob.core.exception.JobException

抛出:

cn.ponfee.disjob.core.exception.JobException

updateJob

@Transactional(transactionManager="disjobTransactionManager",
               rollbackFor=java.lang.Exception.class)
public void updateJob(SchedJob job)
                                                                                                                                   throws cn.ponfee.disjob.core.exception.JobException

抛出:

cn.ponfee.disjob.core.exception.JobException

deleteJob

@Transactional(transactionManager="disjobTransactionManager",
               rollbackFor=java.lang.Exception.class)
public void deleteJob(String user,
                                                                                                                                          long jobId)

changeJobState

@Transactional(transactionManager="disjobTransactionManager",
               rollbackFor=java.lang.Exception.class)
public void changeJobState(String user,
                                                                                                                                               long jobId,
                                                                                                                                               cn.ponfee.disjob.core.enums.JobState toState)

manualTriggerJob

@Transactional(transactionManager="disjobTransactionManager",
               rollbackFor=java.lang.Exception.class)
public void manualTriggerJob(long jobId)
                                                                                                                                          throws cn.ponfee.disjob.core.exception.JobException

抛出:

cn.ponfee.disjob.core.exception.JobException

scheduleTriggerJob

@Transactional(transactionManager="disjobTransactionManager",
               rollbackFor=java.lang.Exception.class)
public void scheduleTriggerJob(SchedJob job,
                                                                                                                                                   long triggerTime)
                                                                                                                                            throws cn.ponfee.disjob.core.exception.JobException

抛出:

cn.ponfee.disjob.core.exception.JobException

updateTaskWorker

@Transactional(transactionManager="disjobTransactionManager",
               rollbackFor=java.lang.Exception.class)
public void updateTaskWorker(String worker,
                                                                                                                                                 List<Long> taskIds)

Set or clear task worker

参数:

worker - the worker

taskIds - the task id list

processTaskDispatchFailedEvent

@EventListener
public void processTaskDispatchFailedEvent(TaskDispatchFailedEvent event)

Listen task dispatch failed event

`@Async`需要标注`@EnableAsync`来启用，默认使用的是`SimpleAsyncTaskExecutor`线程池，会为每个任务创建一个新线程(慎用默认的线程池)

参数:

event - the TaskDispatchFailedEvent

startTask

public cn.ponfee.disjob.core.dto.supervisor.StartTaskResult startTask(cn.ponfee.disjob.core.dto.supervisor.StartTaskParam param)

Starts the task

参数:

param - the start task param

返回:

start result

stopTask

public boolean stopTask(cn.ponfee.disjob.core.dto.supervisor.StopTaskParam param)

Stops the task

参数:

param - the stop task param

返回:

true if stopped task successful

changeInstanceState

public void changeInstanceState(long instanceId,
                                cn.ponfee.disjob.core.enums.ExecuteState toExecuteState)

Force change instance state, for example: CANCELED -> WAITING

参数:

instanceId - the instance id, unsupported workflow

toExecuteState - the target execute state

deleteInstance

public void deleteInstance(long instanceId)

purgeInstance

public boolean purgeInstance(SchedInstance inst)

Purge the zombie instance which maybe dead

参数:

inst - the sched instance

返回:

true if purged successfully

pauseInstance

public boolean pauseInstance(long instanceId)

Pause instance

参数:

instanceId - the instance id, if workflow must be lead instance id

返回:

true if paused successfully

cancelInstance

public boolean cancelInstance(long instanceId,
                              cn.ponfee.disjob.core.enums.Operation ops)

Cancel instance

参数:

instanceId - the instance id, if workflow must be lead instance id

ops - the operation

返回:

true if canceled successfully

resumeInstance

public boolean resumeInstance(long instanceId)

Resume the instance from paused to waiting state

参数:

instanceId - the instance id, if workflow must be lead instance id

返回:

true if resumed successfully