Package org.bonitasoft.engine.scheduler

Interface SchedulerService

All Superinterfaces:

LifecycleService, PlatformLifecycleService

All Known Implementing Classes:

SchedulerServiceImpl

public interface SchedulerService
extends PlatformLifecycleService

Since:

6.0

Author:

Matthieu Chaffotte

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JOB_FAILED
static final String	SCHEDULER_STARTED	This service will fire the following events : SCHEDULER_STARTED = "SCHEDULER_STARTED" SCHEDULER_STOPPED = "SCHEDULER_STOPPED" JOB_FAILED = "JOB_FAILED"
static final String	SCHEDULER_STOPPED

Method Summary

Modifier and Type	Method	Description
boolean	delete(String jobName)	Deletes a job according to its name.
void	deleteJobs()	Deletes all jobs.
void	executeAgain(long jobDescriptorId, int delayInMillis)	Execute a job again
List<String>	getAllJobs()	Get all jobs on all tenants \/!\Must be replaced by a platform scheduler/!\
List<String>	getJobs()	Get all jobs on the current tenant
boolean	isExistingJob(String jobName)	Check if a job exists.
boolean	isStarted()	Checks whether the service is started.
boolean	isStopped()	Checks whether the service is shutdown.
boolean	mayFireAgain(String groupName, String jobName)
void	pauseJobs(long tenantId)	Pause all jobs running on the tenant
void	rescheduleErroneousTriggers()
Date	rescheduleJob(String triggerName, String groupName, Date triggerStartTime)	Remove (delete) the Trigger with the given key, and store the new given one - which must be associated with the same job (the new trigger must have the job name & group specified) - however, the new trigger need not have the same name as the old trigger.
void	resumeJobs(long tenantId)	Resume all jobs paused on the tenant
void	retryJobThatFailed(long jobDescriptorId)	Retry a job once In addition to executing the job again, this will also delete failed job logs
void	retryJobThatFailed(long jobDescriptorId, List<SJobParameter> parameters)	Change parameters of a job and retry it once In addition to executing the job again, this will also delete failed job logs
void	schedule(SJobDescriptor jobDescriptor, List<SJobParameter> parameters, Trigger trigger)	Schedules a job.
void	schedule(SJobDescriptor jobDescriptor, Trigger trigger)	Schedules a job.
void	start()	Note that once a scheduler is shutdown, it cannot be restarted without being re-instantiated.
void	stop()	Note that once a scheduler is shutdown, it cannot be restarted without being re-instantiated.

Methods inherited from interface org.bonitasoft.engine.commons.LifecycleService

pause, resume

Field Details

SCHEDULER_STARTED

static final String SCHEDULER_STARTED

This service will fire the following events :

• SCHEDULER_STARTED = "SCHEDULER_STARTED"
• SCHEDULER_STOPPED = "SCHEDULER_STOPPED"
• JOB_FAILED = "JOB_FAILED"

See Also:

• Constant Field Values

SCHEDULER_STOPPED

static final String SCHEDULER_STOPPED

See Also:

• Constant Field Values

JOB_FAILED

static final String JOB_FAILED

See Also:

• Constant Field Values

Method Details

isStarted

boolean isStarted()
           throws SSchedulerException

Checks whether the service is started.

Returns:

true if the service is started; false otherwise.

Throws:

SSchedulerException - if an exception occurs.

isStopped

boolean isStopped()
           throws SSchedulerException

Checks whether the service is shutdown.

Returns:

true if the service is shutdown; false otherwise.

Throws:

SSchedulerException

schedule

void schedule(SJobDescriptor jobDescriptor,
 Trigger trigger)
       throws SSchedulerException

Schedules a job.

Parameters:

jobDescriptor -

trigger -

Throws:

SSchedulerException - if an exception occurs.

schedule

void schedule(SJobDescriptor jobDescriptor,
 List<SJobParameter> parameters,
 Trigger trigger)
       throws SSchedulerException

Schedules a job.

Parameters:

jobDescriptor -

jobParameters -

trigger -

Throws:

SSchedulerException - if an exception occurs.

executeAgain

void executeAgain(long jobDescriptorId,
 int delayInMillis)
           throws SSchedulerException

Execute a job again

Parameters:

jobDescriptorId - the job to re execute

delayInMillis -

Throws:

SSchedulerException

retryJobThatFailed

void retryJobThatFailed(long jobDescriptorId)
                 throws SSchedulerException

Retry a job once In addition to executing the job again, this will also delete failed job logs

Parameters:

jobDescriptorId - the job to retry

Throws:

SSchedulerException

retryJobThatFailed

void retryJobThatFailed(long jobDescriptorId,
 List<SJobParameter> parameters)
                 throws SSchedulerException

Change parameters of a job and retry it once In addition to executing the job again, this will also delete failed job logs

Parameters:

jobDescriptorId - the job to retry

parameters - the new parameters for the job

Throws:

SSchedulerException

delete

boolean delete(String jobName)
        throws SSchedulerException

Deletes a job according to its name.

Parameters:

jobName - the job name

Returns:

true if delete a job, otherwise return false.

Throws:

SSchedulerException - if an exception occurs.

deleteJobs

void deleteJobs()
         throws SSchedulerException

Deletes all jobs.

Throws:

SSchedulerException - if an exception occurs.

getJobs

List<String> getJobs()
              throws SSchedulerException

Get all jobs on the current tenant

Returns:

all jobs on the current tenant

Throws:

SSchedulerException - if an exception occurs.

getAllJobs

List<String> getAllJobs()
                 throws SSchedulerException

Get all jobs on all tenants \/!\Must be replaced by a platform scheduler/!\

Returns:

all jobs on the current tenant

Throws:

SSchedulerException - if an exception occurs.

rescheduleErroneousTriggers

void rescheduleErroneousTriggers()
                          throws SSchedulerException

Throws:

SSchedulerException

pauseJobs

void pauseJobs(long tenantId)
        throws SSchedulerException

Pause all jobs running on the tenant

Parameters:

tenantId -

Throws:

SSchedulerException

resumeJobs

void resumeJobs(long tenantId)
         throws SSchedulerException

Resume all jobs paused on the tenant

Parameters:

tenantId -

Throws:

SSchedulerException

rescheduleJob

Date rescheduleJob(String triggerName,
 String groupName,
 Date triggerStartTime)
            throws SSchedulerException

Remove (delete) the Trigger with the given key, and store the new given one - which must be associated with the same job (the new trigger must have the job name & group specified) - however, the new trigger need not have the same name as the old trigger.

Parameters:

triggerName - The name of the trigger to replace

groupName - The group name of the trigger to replace

triggerStartTime - The start date of the new trigger

Returns:

null if a Trigger with the given name & group was not found and removed from the store (and the new trigger is therefore not stored), otherwise the first fire time of the newly scheduled trigger is returned.

Throws:

SSchedulerException

Since:

6.4.0

start

void start()
    throws SBonitaException

Note that once a scheduler is shutdown, it cannot be restarted without being re-instantiated.

Specified by:

start in interface LifecycleService

Throws:

SSchedulerException

SBonitaException

Since:

6.4.0

stop

void stop()
   throws SBonitaException

Note that once a scheduler is shutdown, it cannot be restarted without being re-instantiated.

Specified by:

stop in interface LifecycleService

Throws:

SSchedulerException

SBonitaException

Since:

6.4.0

isExistingJob

boolean isExistingJob(String jobName)
               throws SSchedulerException

Check if a job exists.

Parameters:

jobName - The name of the job

Returns:

True if the job exists, else False.

Throws:

SSchedulerException

Since:

6.4.0

mayFireAgain

boolean mayFireAgain(String groupName,
 String jobName)
              throws SSchedulerException

Throws:

SSchedulerException