org.apache.shardingsphere.elasticjob.executor

Interface JobFacade

public interface JobFacade

Job facade.

Method Summary

Modifier and Type	Method and Description
void	afterJobExecuted(ShardingContexts shardingContexts) Call after job executed.
void	beforeJobExecuted(ShardingContexts shardingContexts) Call before job executed.
void	checkJobExecutionEnvironment() Check job execution environment.
void	clearMisfire(Collection<Integer> shardingItems) Clear misfire flag.
void	failoverIfNecessary() Failover If necessary.
ShardingContexts	getShardingContexts() Get sharding contexts.
boolean	isExecuteMisfired(Collection<Integer> shardingItems) Judge job whether need to execute misfire tasks.
boolean	isNeedSharding() Judge job whether need resharding.
JobConfiguration	loadJobConfiguration(boolean fromCache) Load job configuration.
boolean	misfireIfRunning(Collection<Integer> shardingItems) Set task misfire flag.
void	postJobExecutionEvent(JobExecutionEvent jobExecutionEvent) Post job execution event.
void	postJobStatusTraceEvent(String taskId, JobStatusTraceEvent.State state, String message) Post job status trace event.
void	registerJobBegin(ShardingContexts shardingContexts) Register job begin.
void	registerJobCompleted(ShardingContexts shardingContexts) Register job completed.

Method Detail

loadJobConfiguration

JobConfiguration loadJobConfiguration(boolean fromCache)

Load job configuration.

Parameters:

fromCache - load from cache or not

Returns:

job configuration

checkJobExecutionEnvironment

void checkJobExecutionEnvironment()
                           throws JobExecutionEnvironmentException

Check job execution environment.

Throws:

JobExecutionEnvironmentException - job execution environment exception

failoverIfNecessary

void failoverIfNecessary()

Failover If necessary.

registerJobBegin

void registerJobBegin(ShardingContexts shardingContexts)

Register job begin.

Parameters:

shardingContexts - sharding contexts

registerJobCompleted

void registerJobCompleted(ShardingContexts shardingContexts)

Register job completed.

Parameters:

shardingContexts - sharding contexts

getShardingContexts

ShardingContexts getShardingContexts()

Get sharding contexts.

Returns:

sharding contexts

misfireIfRunning

boolean misfireIfRunning(Collection<Integer> shardingItems)

Set task misfire flag.

Parameters:

shardingItems - sharding items to be set misfire flag

Returns:

whether satisfy misfire condition

clearMisfire

void clearMisfire(Collection<Integer> shardingItems)

Clear misfire flag.

Parameters:

shardingItems - sharding items to be cleared misfire flag

isExecuteMisfired

boolean isExecuteMisfired(Collection<Integer> shardingItems)

Judge job whether need to execute misfire tasks.

Parameters:

shardingItems - sharding items

Returns:

whether need to execute misfire tasks

isNeedSharding

boolean isNeedSharding()

Judge job whether need resharding.

Returns:

whether need resharding

beforeJobExecuted

void beforeJobExecuted(ShardingContexts shardingContexts)

Call before job executed.

Parameters:

shardingContexts - sharding contexts

afterJobExecuted

void afterJobExecuted(ShardingContexts shardingContexts)

Call after job executed.

Parameters:

shardingContexts - sharding contexts

postJobExecutionEvent

void postJobExecutionEvent(JobExecutionEvent jobExecutionEvent)

Post job execution event.

Parameters:

jobExecutionEvent - job execution event

postJobStatusTraceEvent

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

Post job status trace event.

Parameters:

taskId - task Id

state - job state

message - job message