org.xwiki.wiki.provisioning

Interface WikiProvisioningJobExecutor

@Role
public interface WikiProvisioningJobExecutor

Executor that manage jobs that provision wikis.

Since:

5.3M3

Version:

$Id: cbbb61d99191df124ba1bcff35ce144e6b7bbd41 $

Method Summary

Methods

Modifier and Type	Method and Description
WikiProvisioningJob	createAndExecuteJob(String wikiId, String provisioningJobName, Object parameter) Create a job and execute it.
WikiProvisioningJob	getJob(List<String> jobId) Get a wiki provisioning job.

Method Detail

createAndExecuteJob

WikiProvisioningJob createAndExecuteJob(String wikiId,
                                      String provisioningJobName,
                                      Object parameter)
                                        throws WikiProvisioningJobException

Create a job and execute it.

Parameters:

wikiId - id of the wiki to provision

provisioningJobName - name of the WikiProvisioningJob component to use

parameter - parameter used by the wiki provisioning job, depending of its implementation.

Returns:

the created job.

Throws:

WikiProvisioningJobException - if problems occur

getJob

WikiProvisioningJob getJob(List<String> jobId)
                           throws WikiProvisioningJobException

Get a wiki provisioning job.

Parameters:

jobId - Id of the job

Returns:

the job status

Throws:

WikiProvisioningJobException - if problems occur