org.bonitasoft.engine.scheduler.impl

Class SchedulerServiceImpl

java.lang.Object

org.bonitasoft.engine.scheduler.impl.SchedulerServiceImpl

All Implemented Interfaces:

LifecycleService, PlatformLifecycleService, SchedulerService

public class SchedulerServiceImpl
extends java.lang.Object
implements SchedulerService

Author:

Matthieu Chaffotte, Baptiste Mesta, Elias Ricken de Medeiros, Yanyan Liu, Celine Souchet

Field Summary

Fields inherited from interface org.bonitasoft.engine.scheduler.SchedulerService

JOB_DESCRIPTOR, JOB_FAILED, JOB_PARAMETER, SCHEDULER_STARTED, SCHEDULER_STOPPED

Constructor Summary

Constructors

Constructor and Description
SchedulerServiceImpl(SchedulerExecutor schedulerExecutor, JobService jobService, TechnicalLoggerService logger, EventService eventService, TransactionService transactionService, SessionAccessor sessionAccessor, ServicesResolver servicesResolver, PersistenceService persistenceService) Create a new instance of scheduler service.

Method Summary

Modifier and Type	Method and Description
boolean	delete(java.lang.String jobName) Deletes a job according to its name.
void	deleteJobs() Deletes all jobs.
void	executeAgain(long jobDescriptorId) Execute a job again
java.util.List<java.lang.String>	getAllJobs() Get all jobs on all tenants \/!\Must be replaced by a platform scheduler/!\
java.util.List<java.lang.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(java.lang.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	pause() Temporary halt the execution of this service.
void	pauseJobs(long tenantId) Pause all jobs running on the tenant
void	rescheduleErroneousTriggers()
java.util.Date	rescheduleJob(java.lang.String triggerName, java.lang.String groupName, java.util.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	resume() resume the execution the service
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, java.util.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, java.util.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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SchedulerServiceImpl

public SchedulerServiceImpl(SchedulerExecutor schedulerExecutor,
                            JobService jobService,
                            TechnicalLoggerService logger,
                            EventService eventService,
                            TransactionService transactionService,
                            SessionAccessor sessionAccessor,
                            ServicesResolver servicesResolver,
                            PersistenceService persistenceService)

Create a new instance of scheduler service.

Method Detail

schedule

public void schedule(SJobDescriptor jobDescriptor,
                     Trigger trigger)
              throws SSchedulerException

Description copied from interface: SchedulerService

Schedules a job.

Specified by:

schedule in interface SchedulerService

Throws:

SSchedulerException - if an exception occurs.

schedule

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

Description copied from interface: SchedulerService

Schedules a job.

Specified by:

schedule in interface SchedulerService

Throws:

SSchedulerException - if an exception occurs.

executeAgain

public void executeAgain(long jobDescriptorId)
                  throws SSchedulerException

Description copied from interface: SchedulerService

Execute a job again

Specified by:

executeAgain in interface SchedulerService

Parameters:

jobDescriptorId - the job to re execute

Throws:

SSchedulerException

retryJobThatFailed

public void retryJobThatFailed(long jobDescriptorId)
                        throws SSchedulerException

Description copied from interface: SchedulerService

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

Specified by:

retryJobThatFailed in interface SchedulerService

Parameters:

jobDescriptorId - the job to retry

Throws:

SSchedulerException

retryJobThatFailed

public void retryJobThatFailed(long jobDescriptorId,
                               java.util.List<SJobParameter> parameters)
                        throws SSchedulerException

Description copied from interface: SchedulerService

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

Specified by:

retryJobThatFailed in interface SchedulerService

Parameters:

jobDescriptorId - the job to retry

parameters - the new parameters for the job

Throws:

SSchedulerException

isStarted

public boolean isStarted()
                  throws SSchedulerException

Description copied from interface: SchedulerService

Checks whether the service is started.

Specified by:

isStarted in interface SchedulerService

Returns:

true if the service is started; false otherwise.

Throws:

SSchedulerException - if an exception occurs.

isStopped

public boolean isStopped()
                  throws SSchedulerException

Description copied from interface: SchedulerService

Checks whether the service is shutdown.

Specified by:

isStopped in interface SchedulerService

Returns:

true if the service is shutdown; false otherwise.

Throws:

SSchedulerException

start

public void start()
           throws SSchedulerException,
                  SFireEventException

Description copied from interface: SchedulerService

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

Specified by:

start in interface LifecycleService

Specified by:

start in interface SchedulerService

Throws:

SSchedulerException

SFireEventException

See Also:

#initializeScheduler()}

stop

public void stop()
          throws SSchedulerException,
                 SFireEventException

Description copied from interface: SchedulerService

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

Specified by:

stop in interface LifecycleService

Specified by:

stop in interface SchedulerService

Throws:

SSchedulerException

SFireEventException

See Also:

#initializeScheduler()}

pauseJobs

public void pauseJobs(long tenantId)
               throws SSchedulerException

Description copied from interface: SchedulerService

Pause all jobs running on the tenant

Specified by:

pauseJobs in interface SchedulerService

Throws:

SSchedulerException

resumeJobs

public void resumeJobs(long tenantId)
                throws SSchedulerException

Description copied from interface: SchedulerService

Resume all jobs paused on the tenant

Specified by:

resumeJobs in interface SchedulerService

Throws:

SSchedulerException

delete

public boolean delete(java.lang.String jobName)
               throws SSchedulerException

Description copied from interface: SchedulerService

Deletes a job according to its name.

Specified by:

delete in interface SchedulerService

Parameters:

jobName - the job name

Returns:

true if delete a job, otherwise return false.

Throws:

SSchedulerException - if an exception occurs.

deleteJobs

public void deleteJobs()
                throws SSchedulerException

Description copied from interface: SchedulerService

Deletes all jobs.

Specified by:

deleteJobs in interface SchedulerService

Throws:

SSchedulerException - if an exception occurs.

getJobs

public java.util.List<java.lang.String> getJobs()
                                         throws SSchedulerException

Description copied from interface: SchedulerService

Get all jobs on the current tenant

Specified by:

getJobs in interface SchedulerService

Returns:

all jobs on the current tenant

Throws:

SSchedulerException - if an exception occurs.

getAllJobs

public java.util.List<java.lang.String> getAllJobs()
                                            throws SSchedulerException

Description copied from interface: SchedulerService

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

Specified by:

getAllJobs in interface SchedulerService

Returns:

all jobs on the current tenant

Throws:

SSchedulerException - if an exception occurs.

isStillScheduled

public boolean isStillScheduled(SJobDescriptor jobDescriptor)
                         throws SSchedulerException

Specified by:

isStillScheduled in interface SchedulerService

Throws:

SSchedulerException

pause

public void pause()
           throws SBonitaException

Description copied from interface: LifecycleService

Temporary halt the execution of this service.

Specified by:

pause in interface LifecycleService

Throws:

SBonitaException

resume

public void resume()
            throws SBonitaException

Description copied from interface: LifecycleService

resume the execution the service

Specified by:

resume in interface LifecycleService

Throws:

SBonitaException

rescheduleErroneousTriggers

public void rescheduleErroneousTriggers()
                                 throws SSchedulerException

Specified by:

rescheduleErroneousTriggers in interface SchedulerService

Throws:

SSchedulerException

rescheduleJob

public java.util.Date rescheduleJob(java.lang.String triggerName,
                                    java.lang.String groupName,
                                    java.util.Date triggerStartTime)
                             throws SSchedulerException

Description copied from interface: SchedulerService

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.

Specified by:

rescheduleJob in interface SchedulerService

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

initializeScheduler

public void initializeScheduler()
                         throws SSchedulerException

Description copied from interface: SchedulerService

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

Specified by:

initializeScheduler in interface SchedulerService

Throws:

SSchedulerException

isExistingJob

public boolean isExistingJob(java.lang.String jobName)
                      throws SSchedulerException

Description copied from interface: SchedulerService

Check if a job exists.

Specified by:

isExistingJob in interface SchedulerService

Parameters:

jobName - The name of the job

Returns:

True if the job exists, else False.

Throws:

SSchedulerException