com.dangdang.ddframe.job.executor

接口 JobFacade

public interface JobFacade

作业内部服务门面服务.

作者:

zhangliang

方法概要

方法

限定符和类型	方法和说明
void	afterJobExecuted(ShardingContexts shardingContexts) 作业执行后的执行的方法.
void	beforeJobExecuted(ShardingContexts shardingContexts) 作业执行前的执行的方法.
void	checkJobExecutionEnvironment() 检查作业执行环境.
void	clearMisfire(Collection<Integer> shardingItems) 清除任务被错过执行的标记.
void	failoverIfNecessary() 如果需要失效转移, 则执行作业失效转移.
ShardingContexts	getShardingContexts() 获取当前作业服务器的分片上下文.
boolean	isEligibleForJobRunning() 判断作业是否符合继续运行的条件.
boolean	isExecuteMisfired(Collection<Integer> shardingItems) 判断作业是否需要执行错过的任务.
boolean	isNeedSharding() 判断是否需要重分片.
JobRootConfiguration	loadJobRootConfiguration(boolean fromCache) 读取作业配置.
boolean	misfireIfRunning(Collection<Integer> shardingItems) 设置任务被错过执行的标记.
void	postJobExecutionEvent(JobExecutionEvent jobExecutionEvent) 发布执行事件.
void	postJobStatusTraceEvent(String taskId, JobStatusTraceEvent.State state, String message) 发布作业状态追踪事件.
void	registerJobBegin(ShardingContexts shardingContexts) 注册作业启动信息.
void	registerJobCompleted(ShardingContexts shardingContexts) 注册作业完成信息.

方法详细资料

loadJobRootConfiguration

JobRootConfiguration loadJobRootConfiguration(boolean fromCache)

读取作业配置.

参数:

fromCache - 是否从缓存中读取

返回:

作业配置

checkJobExecutionEnvironment

void checkJobExecutionEnvironment()
                                  throws JobExecutionEnvironmentException

检查作业执行环境.

抛出:

JobExecutionEnvironmentException - 作业执行环境异常

failoverIfNecessary

void failoverIfNecessary()

如果需要失效转移, 则执行作业失效转移.

registerJobBegin

void registerJobBegin(ShardingContexts shardingContexts)

注册作业启动信息.

参数:

shardingContexts - 分片上下文

registerJobCompleted

void registerJobCompleted(ShardingContexts shardingContexts)

注册作业完成信息.

参数:

shardingContexts - 分片上下文

getShardingContexts

ShardingContexts getShardingContexts()

获取当前作业服务器的分片上下文.

返回:

分片上下文

misfireIfRunning

boolean misfireIfRunning(Collection<Integer> shardingItems)

设置任务被错过执行的标记.

参数:

shardingItems - 需要设置错过执行的任务分片项

返回:

是否满足misfire条件

clearMisfire

void clearMisfire(Collection<Integer> shardingItems)

清除任务被错过执行的标记.

参数:

shardingItems - 需要清除错过执行的任务分片项

isExecuteMisfired

boolean isExecuteMisfired(Collection<Integer> shardingItems)

判断作业是否需要执行错过的任务.

参数:

shardingItems - 任务分片项集合

返回:

作业是否需要执行错过的任务

isEligibleForJobRunning

boolean isEligibleForJobRunning()

判断作业是否符合继续运行的条件.

如果作业停止或需要重分片或非流式处理则作业将不会继续运行.

返回:

作业是否符合继续运行的条件

isNeedSharding

boolean isNeedSharding()

判断是否需要重分片.

返回:

是否需要重分片

beforeJobExecuted

void beforeJobExecuted(ShardingContexts shardingContexts)

作业执行前的执行的方法.

参数:

shardingContexts - 分片上下文

afterJobExecuted

void afterJobExecuted(ShardingContexts shardingContexts)

作业执行后的执行的方法.

参数:

shardingContexts - 分片上下文

postJobExecutionEvent

void postJobExecutionEvent(JobExecutionEvent jobExecutionEvent)

发布执行事件.

参数:

jobExecutionEvent - 作业执行事件

postJobStatusTraceEvent

void postJobStatusTraceEvent(String taskId,
                           JobStatusTraceEvent.State state,
                           String message)

发布作业状态追踪事件.

参数:

taskId - 作业Id

state - 作业执行状态

message - 作业执行消息