com.norconex.jef4.job

Interface IJob

All Known Subinterfaces:

IJobGroup

All Known Implementing Classes:

AbstractJob, AbstractJobGroup, AbstractResumableJob, AsyncJobGroup, SyncJobGroup, SystemCommandJob

public interface IJob

A job to be executed by the Job Execution Framework. Implementors are responsible for reporting job progress and errors in a uniform way. Great care should be taken to make every jobs recoverable.

Jobs are usually assembled together to form a JobSuite. Progress tracking, error handling, logging, etc., are all handled by job suites and implementors do not have to worry about these concerns when creating jobs.

To ensure the best integration possible with the framework, implementors are invited to adhere to the following practices:

• update job progress on JobProgress;
• ensure jobs are recoverable by considering the current progress passed to the execute method;
• use Log4J for all logging purposes;
• wrap exceptions you explicitly want to be handled by the framework into a runtime JobException instance;
• use lazy-loading where possible

Author:

Pascal Essiembre

Method Summary

Modifier and Type	Method and Description
void	execute(JobStatusUpdater statusUpdater, JobSuite suite) Executes this job.
String	getId() Gets the job unique identifier.
void	stop(IJobStatus status, JobSuite suite) Stops this job.

Method Detail

getId

String getId()

Gets the job unique identifier. All characters are valid and regular words can be used, as long as the returned string is unique.

Returns:

job unique identifier

execute

void execute(JobStatusUpdater statusUpdater,
             JobSuite suite)

Executes this job. Implementors are responsible for updating execution progress on the given JobProgress.

Parameters:

statusUpdater - status updater

suite - job suite this job is part of

stop

void stop(IJobStatus status,
          JobSuite suite)

Stops this job. Implementors are responsible for terminating the execution of this job. The progress and other contextual information can be set, but the "status" should not be overwritten, as the framework will take care of assigning it.

Parameters:

status - current job status

suite - job suite this job is part of

Since:

2.0