com.actionsoft.sdk.local.api

接口 JobAPI

public interface JobAPI

Job定时器接口

方法概要

限定符和类型	方法和说明
AWSScheduleModel	getJobModel(JobExecutionContext jobExecutionContext) 根据Job调度器的上下文环境，取得Job的模型定义对象
java.lang.String	getJobParameter(JobExecutionContext jobExecutionContext) 根据Job调度器的上下文环境，取得Job的扩展参数定义
java.util.Map<java.lang.String,java.util.Map<java.lang.String,AWSScheduleModel>>	getList() 按appid和模型ID获得定时器模型列表
TriggerState	getState(java.lang.String id) 获得定时器模型的调度状态
void	pause(java.lang.String id) 暂停定时任务的调度执行
void	reschedule(java.lang.String id) 更新调度中的定时器的触发信息
void	resume(java.lang.String id) 恢复暂停的定时任务
java.lang.String	schedule(java.lang.String createUser, java.lang.String appId, java.lang.String clazz, java.lang.String name, java.lang.String desc, int repeatCount, long repeatInterval) 创建一个固定频率的定时器模型并加入执行调度
java.lang.String	schedule(java.lang.String createUser, java.lang.String appId, java.lang.String clazz, java.lang.String name, java.lang.String desc, int repeatCount, long repeatInterval, int misfireInstruction) 创建一个固定频率的定时器模型并加入执行调度
java.lang.String	schedule(java.lang.String createUser, java.lang.String appId, java.lang.String clazz, java.lang.String name, java.lang.String desc, java.lang.String cronExpression) 创建一个cron类型的定时器模型并加入执行调度
java.lang.String	schedule(java.lang.String createUser, java.lang.String appId, java.lang.String clazz, java.lang.String name, java.lang.String desc, java.lang.String cronExpression, int misfireInstruction) 创建一个cron类型的定时器模型并加入执行调度
void	unschedule(java.lang.String id) 删除定时器模型并从调度中移除

方法详细资料

getJobModel

AWSScheduleModel getJobModel(JobExecutionContext jobExecutionContext)

根据Job调度器的上下文环境，取得Job的模型定义对象

参数:

jobExecutionContext - 运行时刻的上下文对象

返回:

如果该模型不存在返回null

getJobParameter

java.lang.String getJobParameter(JobExecutionContext jobExecutionContext)

根据Job调度器的上下文环境，取得Job的扩展参数定义

参数:

jobExecutionContext - 运行时刻的上下文对象

返回:

如果未定义或不存在返回空串

schedule

java.lang.String schedule(java.lang.String createUser,
                          java.lang.String appId,
                          java.lang.String clazz,
                          java.lang.String name,
                          java.lang.String desc,
                          int repeatCount,
                          long repeatInterval)

创建一个固定频率的定时器模型并加入执行调度

参数:

createUser - 创建者

appId - 所在应用

clazz - 定时器执行类

name - 名称

desc - 描述信息

repeatCount - 执行次数

repeatInterval - 执行间隔

返回:

定时器模型ID

schedule

java.lang.String schedule(java.lang.String createUser,
                          java.lang.String appId,
                          java.lang.String clazz,
                          java.lang.String name,
                          java.lang.String desc,
                          int repeatCount,
                          long repeatInterval,
                          int misfireInstruction)

创建一个固定频率的定时器模型并加入执行调度

参数:

createUser - 创建者

appId - 所在应用

clazz - 定时器执行类

name - 名称

desc - 描述信息

repeatCount - 执行次数

repeatInterval - 执行间隔

misfireInstruction - 错失触发后的策略，参考org.quartz.SimpleTrigger的MISFIRE_INSTRUCTION

返回:

定时器模型ID

schedule

java.lang.String schedule(java.lang.String createUser,
                          java.lang.String appId,
                          java.lang.String clazz,
                          java.lang.String name,
                          java.lang.String desc,
                          java.lang.String cronExpression)

创建一个cron类型的定时器模型并加入执行调度

参数:

createUser - 创建者

appId - 所在应用

clazz - 定时器执行类

name - 名称

desc - 描述信息

cronExpression - cron表达式

返回:

定时器模型ID

schedule

java.lang.String schedule(java.lang.String createUser,
                          java.lang.String appId,
                          java.lang.String clazz,
                          java.lang.String name,
                          java.lang.String desc,
                          java.lang.String cronExpression,
                          int misfireInstruction)

创建一个cron类型的定时器模型并加入执行调度

参数:

createUser - 创建者

appId - 所在应用

clazz - 定时器执行类

name - 名称

desc - 描述信息

cronExpression - cron表达式

misfireInstruction - 错失触发后的策略，参考org.quartz.CronTrigger的MISFIRE_INSTRUCTION

返回:

定时器模型ID

unschedule

void unschedule(java.lang.String id)

删除定时器模型并从调度中移除

参数:

id - 定时器模型ID

reschedule

void reschedule(java.lang.String id)

更新调度中的定时器的触发信息

参数:

id - 定时器模型ID

getList

java.util.Map<java.lang.String,java.util.Map<java.lang.String,AWSScheduleModel>> getList()

按appid和模型ID获得定时器模型列表

getState

TriggerState getState(java.lang.String id)

获得定时器模型的调度状态

参数:

id - 定时器模型ID

pause

void pause(java.lang.String id)

暂停定时任务的调度执行

参数:

id - 定时器模型ID

resume

void resume(java.lang.String id)

恢复暂停的定时任务

参数:

id - 定时器模型ID