org.xwiki.job

Interface JobExecutor

@Role
public interface JobExecutor

By default Jobs are either executed asynchronously whenever there is a free thread in the pool. Jobs can implement GroupedJob to make sure they con't be executed at the same time than the jobs from the same groups.

Since:

6.1M2

Version:

$Id: 247476a59f39d923de950d7e07d5c7b0ca8f2312 $

See Also:

GroupedJob, Job

Method Summary

Modifier and Type	Method and Description
void	execute(Job job) Add a new job in the queue of jobs to execute.
Job	execute(String jobType, Request request) Create and add a new job in the queue of jobs to execute.
Job	getCurrentJob(JobGroupPath groupPath) The current job running in the passed jobs group.
Job	getJob(List<String> jobId) Return job corresponding to the provided id from the current executed or waiting jobs.

Method Detail

getCurrentJob

Job getCurrentJob(JobGroupPath groupPath)

The current job running in the passed jobs group.

Parameters:

groupPath - the group path

Returns:

the currently running job in the passed group

getJob

Job getJob(List<String> jobId)

Return job corresponding to the provided id from the current executed or waiting jobs.

Parameters:

jobId - the id of the job

Returns:

the job status corresponding to the provided job id, null if none can be found

execute

Job execute(String jobType,
            Request request)
     throws JobException

Create and add a new job in the queue of jobs to execute.

Parameters:

jobType - the role hint of the job component

request - the request

Returns:

the created job

Throws:

JobException - error when creating the job

RejectedExecutionException - if this task cannot be accepted for execution (for example when the JobExecutor is disposed).

execute

void execute(Job job)

Add a new job in the queue of jobs to execute.

Parameters:

job - the job to execute

Throws:

RejectedExecutionException - if this task cannot be accepted for execution (for example when the JobExecutor is disposed).