com.atlassian.sal.core.scheduling

Class DefaultPluginScheduler

java.lang.Object

com.atlassian.sal.core.scheduling.DefaultPluginScheduler

All Implemented Interfaces:

PluginScheduler, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

public class DefaultPluginScheduler
extends Object
implements PluginScheduler, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean

A plugin scheduler that is backed by the atlassian-scheduler library.

Since:

v3.0.0

Constructor Summary

Constructors

Constructor and Description
DefaultPluginScheduler(com.atlassian.scheduler.SchedulerService schedulerService)

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	destroy()
void	scheduleJob(String jobKey, Class<? extends PluginJob> jobClass, Map<String,Object> jobDataMap, Date startTime, long repeatInterval) Schedule the given job.
void	unscheduleJob(String jobKey) Unschedule the given job.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPluginScheduler

public DefaultPluginScheduler(com.atlassian.scheduler.SchedulerService schedulerService)

Method Detail

scheduleJob

public void scheduleJob(String jobKey,
               Class<? extends PluginJob> jobClass,
               Map<String,Object> jobDataMap,
               Date startTime,
               long repeatInterval)

Description copied from interface: PluginScheduler

Schedule the given job.

WARNING: it is very important not to try to call this method until the underlying application is fully started. You should implement LifecycleAware and call scheduleJob() only on LifecycleAware.onStart()

Specified by:

scheduleJob in interface PluginScheduler

Parameters:

jobKey - A unique key of the job

jobClass - The class for the job

jobDataMap - Any data that needs to be passed to the job. This map instance will always be the same instance that is given to the job when it executes.

startTime - The time the job is to start.

repeatInterval - How long the interval between repeats, in milliseconds. Note, some implementations

unscheduleJob

public void unscheduleJob(String jobKey)

Description copied from interface: PluginScheduler

Unschedule the given job. If the job doesn't exist then IllegalArgumentException will be thrown.

Specified by:

unscheduleJob in interface PluginScheduler

Parameters:

jobKey - The job key to unschedule

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

destroy

public void destroy()

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean