org.bonitasoft.engine.scheduler

Interface SchedulerService

All Superinterfaces:

org.bonitasoft.engine.commons.LifecycleService, org.bonitasoft.engine.commons.PlatformLifecycleService

All Known Implementing Classes:

SchedulerServiceImpl

public interface SchedulerService
extends org.bonitasoft.engine.commons.PlatformLifecycleService

Since:

6.0

Author:

Matthieu Chaffotte

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
void	addJobListener(List<AbstractBonitaPlatformJobListener> jobListeners) Add the given AbstractBonitaPlatformJobListeners to the Scheduler, and register it to receive events for all Jobs.
void	addJobListener(List<AbstractBonitaTenantJobListener> jobListeners, String groupName) Add the given AbstractBonitaTenantJobListeners to the Scheduler, and register it to receive events for Jobs that are matched by the group name.
boolean	delete(String jobName) Deletes a job according to its name.
void	deleteJobs() Deletes all jobs.
void	executeAgain(long jobDescriptorId)
void	executeAgain(long jobDescriptorId, List<SJobParameter> parameters) Schedules a job.
void	executeNow(SJobDescriptor jobDescriptor, List<SJobParameter> parameters) execute a job.
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
void	initializeScheduler() Initialize the scheduler if this method has not be previously called (after shutdown); otherwise, do nothing.
boolean	isExistingJob(String jobName) Check if a job exists.
boolean	isStarted() Checks whether the service is started.
boolean	isStillScheduled(SJobDescriptor jobDescriptor)
boolean	isStopped() Checks whether the service is shutdown.
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	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 Detail

JOB_DESCRIPTOR

static final String JOB_DESCRIPTOR

See Also:

Constant Field Values

JOB_PARAMETER

static final String JOB_PARAMETER

See Also:

Constant Field Values

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 Detail

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)
           throws SSchedulerException

Throws:

SSchedulerException

executeAgain

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

Schedules a job.

Parameters:

jobDescriptorId -

jobParameters -

Throws:

SSchedulerException - if an exception occurs.

executeNow

void executeNow(SJobDescriptor jobDescriptor,
                List<SJobParameter> parameters)
         throws SSchedulerException

execute a job.

Parameters:

jobDescriptor -

jobParameters -

Throws:

SSchedulerException - if an exception occurs.

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.

isStillScheduled

boolean isStillScheduled(SJobDescriptor jobDescriptor)
                  throws SSchedulerException

Throws:

SSchedulerException

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

addJobListener

void addJobListener(List<AbstractBonitaTenantJobListener> jobListeners,
                    String groupName)
             throws SSchedulerException

Add the given AbstractBonitaTenantJobListeners to the Scheduler, and register it to receive events for Jobs that are matched by the group name.

Parameters:

jobListeners - The job listeners to add to the scheduler

groupName - The group name to filter

Throws:

SSchedulerException

Since:

6.4.0

addJobListener

void addJobListener(List<AbstractBonitaPlatformJobListener> jobListeners)
             throws SSchedulerException

Add the given AbstractBonitaPlatformJobListeners to the Scheduler, and register it to receive events for all Jobs.

Parameters:

jobListeners - The job listeners to add to the scheduler

Throws:

SSchedulerException

Since:

6.4.0

initializeScheduler

void initializeScheduler()
                  throws SSchedulerException

Initialize the scheduler if this method has not be previously called (after shutdown); otherwise, do nothing.

Throws:

SSchedulerException

Since:

6.4.0

start

void start()
    throws org.bonitasoft.engine.commons.exceptions.SBonitaException

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

Specified by:

start in interface org.bonitasoft.engine.commons.LifecycleService

Throws:

SSchedulerException

org.bonitasoft.engine.commons.exceptions.SBonitaException

Since:

6.4.0

See Also:

#initializeScheduler()}

stop

void stop()
   throws org.bonitasoft.engine.commons.exceptions.SBonitaException

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

Specified by:

stop in interface org.bonitasoft.engine.commons.LifecycleService

Throws:

SSchedulerException

org.bonitasoft.engine.commons.exceptions.SBonitaException

Since:

6.4.0

See Also:

#initializeScheduler()}

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