com.atlassian.scheduler.core

Interface LifecycleAwareSchedulerService

All Superinterfaces:

SchedulerService, SchedulerServiceController

All Known Implementing Classes:

AbstractSchedulerService, Quartz1SchedulerService, Quartz2SchedulerService, TenantAwareSchedulerService

public interface LifecycleAwareSchedulerService
extends SchedulerService, SchedulerServiceController

An interface that scheduler service implementations will generally be expected to implement so that they can be stopped from accepting jobs when the application is not at a point in its lifecycle where it should be running them. For example, if the plugin system has not finished coming up, then this node's scheduler should not be claiming jobs, because it would steal clustered jobs that another node in the cluster would be able to process when we know we are unlikely to be ready.

As a general rule, scheduler implementations should begin in SchedulerServiceController.standby() mode, where they will not run any jobs until explicitly started. Once started, the scheduler may be placed back into standby mode and restarted as often as needed. The SchedulerServiceController.shutdown() method should only be called when the SchedulerService is being disposed and will not be asked to start() again.

Since:

v1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LifecycleAwareSchedulerService.State A representation of the scheduler's current state.

Method Summary

Methods inherited from interface com.atlassian.scheduler.SchedulerService

calculateNextRunTime, getJobDetails, getJobRunnerKeysForAllScheduledJobs, getJobsByJobRunnerKey, getRegisteredJobRunnerKeys, registerJobRunner, scheduleJob, scheduleJobWithGeneratedId, unregisterJobRunner, unscheduleJob

Methods inherited from interface com.atlassian.scheduler.core.SchedulerServiceController

getLocallyRunningJobs, getState, shutdown, standby, start, waitUntilIdle