com.atlassian.scheduler.core

Interface SchedulerServiceController

All Known Subinterfaces:

LifecycleAwareSchedulerService

All Known Implementing Classes:

AbstractSchedulerService, Quartz1SchedulerService, Quartz2SchedulerService, TenantAwareSchedulerService

public interface SchedulerServiceController

Method Summary

Modifier and Type	Method and Description
Collection<RunningJob>	getLocallyRunningJobs() Returns the list of jobs that are currently executing on this node.
LifecycleAwareSchedulerService.State	getState() Returns the scheduler service's running state.
void	shutdown() Permanent shutdown of the scheduler.
void	standby() Places the scheduler into standby mode.
void	start() Starts the scheduler if it had never been started or had been placed in standby() mode.
boolean	waitUntilIdle(long timeout, TimeUnit units) Waits for up to timeout units for any currently executing jobs to complete.

Method Detail

start

void start()
    throws SchedulerServiceException

Starts the scheduler if it had never been started or had been placed in standby() mode. If the scheduler was already active, then the request has no effect.

Throws:

SchedulerServiceException - if the scheduler cannot be started

standby

void standby()
      throws SchedulerServiceException

Places the scheduler into standby mode. This stops jobs from running until it is started again. If the scheduler was already in standby, then the request has no effect. The standby mode only affects the local node's ability to schedule jobs. For any RunMode.RUN_ONCE_PER_CLUSTER jobs the jobs may still run on other nodes if they exist and have started. If a job should have run while the scheduler was in standby mode, the implementation may trigger those jobs when restarted, but this is not guaranteed.

Throws:

SchedulerServiceException - if the scheduler cannot be be placed in standby mode

shutdown

void shutdown()

Permanent shutdown of the scheduler. Once this has been called, no more jobs will be run and most requests will fail. The scheduler cannot be restarted once it has been shut down.

getLocallyRunningJobs

@Nonnull
Collection<RunningJob> getLocallyRunningJobs()

Returns the list of jobs that are currently executing on this node. In a clustered configuration, this will not reflect any jobs that are running on another node of the cluster. This is guaranteed to be safe to call even after a shutdown().

Returns:

the job IDs for all jobs that are currently running on this node.

Since:

v1.3

waitUntilIdle

boolean waitUntilIdle(long timeout,
                      TimeUnit units)
               throws InterruptedException

Waits for up to timeout units for any currently executing jobs to complete. Note that if the scheduler has not been shutdown() or placed in standby() mode, then jobs could start after this returns true. As with getLocallyRunningJobs(), this is only aware of jobs running on this node of the cluster, and it is guaranteed to be safe to call even after a shutdown().

Parameters:

timeout - the timeout period, in the specified units; non-positive values request an immediate poll — that is, it is equivalent to getLocallyRunningJobs().isEmpty()

Returns:

true if the scheduler is now idle; false if jobs are still executing.

Throws:

InterruptedException - if the current thread is interrupted while waiting for the scheduler to become idle.

IllegalArgumentException - if timeout is negative

Since:

v1.3

getState

@Nonnull
LifecycleAwareSchedulerService.State getState()

Returns the scheduler service's running state. The scheduler is initially in LifecycleAwareSchedulerService.State.STANDBY and can be moved between this state and LifecycleAwareSchedulerService.State.STANDBY freely. LifecycleAwareSchedulerService.State.SHUTDOWN is terminal — that is, once shut down, the scheduler's state can no longer be changed.

Returns:

the scheduler service's running state.